com.spotfire.ws.im.ds.sql
Interface JDBCContext

public interface JDBCContext

Properties for a JDBC data source instance.

Since:

7.2

Method Summary

int	getBatchSize(int columnCount) Returns the batch size that specifies the amount of data in each batch update.
Connection	getConnection() Returns a database connection.
String	getDataSourceName() Returns the name of the data source instance.
int	getFetchSize(int columnCount) Returns the fetch size that specifies the amount of data fetched with each database round trip for a query.
JDBCMetadataProvider	getMetadataProvider() Returns a new instance of a metadata provider.
SQLRuntime	getSQLRuntime() Returns a new instance of a SQL Runtime.
MetadataItem[]	getTableAliases(String catalog, String schema) Returns all table aliases for tables in the specified catalog and schema.
String	getTypeName() Returns the name of the JDBC type configuration.
JDBCTypeSettings	getTypeSettings() Returns the JDBC type configuration.
boolean	isReadOnly() Tells if the data source is readonly.
SourceTable	resolveTable(SourceTable tableAlias) Resolves a table alias to a real source table.

Method Detail

getDataSourceName

String getDataSourceName()

Returns the name of the data source instance.

Returns:

a data source name

getConnection

Connection getConnection()

Returns a database connection.

Returns:

a JDBC connection

getTypeName

String getTypeName()

Returns the name of the JDBC type configuration.

Returns:

a type name

getTypeSettings

JDBCTypeSettings getTypeSettings()

Returns the JDBC type configuration.

Returns:

a JDBCTypeSettings instance

getMetadataProvider

JDBCMetadataProvider getMetadataProvider()

Returns a new instance of a metadata provider.

Returns:

a JDBCMetadataProvider instance

getSQLRuntime

SQLRuntime getSQLRuntime()

Returns a new instance of a SQL Runtime.

Returns:

a SQLRuntime instance

getFetchSize

int getFetchSize(int columnCount)

Returns the fetch size that specifies the amount of data fetched with each database round trip for a query.

The fetch size is the number of rows caluclated from the given column count.

Parameters:

columnCount - number of columns in each row

Returns:

a fetch size

getBatchSize

int getBatchSize(int columnCount)

Returns the batch size that specifies the amount of data in each batch update.

The batch size is the number of operation calculated from the given column count.

Parameters:

column - number of columns in each operation

Returns:

a batch size

isReadOnly

boolean isReadOnly()

Tells if the data source is readonly.

A data source that are readonly indicates that no SQL commands other than queries are allowed, i.e. use of temporary tables are prohibited.

Returns:

true if read only, false otherwise

resolveTable

SourceTable resolveTable(SourceTable tableAlias)

Resolves a table alias to a real source table.

Parameters:

tableAlias - a SourceTable value

Returns:

the resolved SourceTable if the provided table was a known table alias, otherwise, the same SourceTable is returned.

getTableAliases

MetadataItem[] getTableAliases(String catalog,
                               String schema)

Returns all table aliases for tables in the specified catalog and schema.

Parameters:

catalog - a catalog name, if null

schema -

Returns: