Skip navigation links

com.sigmadynamics.server.DataServices.DatabaseProvider
Interface DatabaseProviderMetaData

public interface DatabaseProviderMetaData

Field Summary

static java.lang.String[]

TABLE_TYPES

Method Summary

java.lang.String	getCatalog() Get the catalog.
StoredProcedureParameterInfo[]	getProcedureParameters(java.lang.String procedureName)
StoredProcedureParameterInfo[]	getProcedureParameters(java.lang.String catalog, java.lang.String schema, java.lang.String procedureName)
StoredProcedureInfo[]	getProcedures(java.lang.String procedureNamePattern) Get a result set from which you can get the names of stored procedures.
StoredProcedureInfo[]	getProcedures(java.lang.String catalog, java.lang.String schema, java.lang.String procedureNamePattern) Get a result set from which you can get the names of stored procedures.
ColumnInfo[]	getTableColumns(java.lang.String tableName) Get a set of ColumnInfo objects for a given table.
ColumnInfo[]	getTableColumns(java.lang.String catalog, java.lang.String schema, java.lang.String tableName) Get a set of ColumnInfo objects for a given table.
TableInfo[]	getTables(java.lang.String tableNamePattern, java.lang.String[] types) Get a result set from which you can get the names of tables or views.
TableInfo[]	getTables(java.lang.String catalog, java.lang.String schema, java.lang.String tableNamePattern, java.lang.String[] types) Get a result set from which you can get the names of tables or views.
void	setCatalog(java.lang.String catalog) Set the catalog.
void	setSchema(java.lang.String schema) Set the schema.

Field Detail

TABLE_TYPES

static final java.lang.String[] TABLE_TYPES

Method Detail

getTables

TableInfo[] getTables(java.lang.String catalog,
                      java.lang.String schema,
                      java.lang.String tableNamePattern,
                      java.lang.String[] types)

Get a result set from which you can get the names of tables or views. The tablePattern parameter is used to determine which names to return. A '%' is the wildcard. Hence, the pattern "T%" would return all names that start with a 'T'. Whether the pattern match is case sensitive or not is a function of the database. The types parameter allows you to specify whether you want the names of tables, view, or both returned. If the array contains "TABLE", then names of tables are returned. If the array contains "VIEW", then the names of views are returned. A call to this function closes the result set returned by the previous call.

Parameters:

catalog - - the database catalog

schema - - the schema

tableNamePattern - - the table name pattern

types - - identifies whether names of tables, views, or both are returned

getTables

TableInfo[] getTables(java.lang.String tableNamePattern,
                      java.lang.String[] types)

Get a result set from which you can get the names of tables or views. The tablePattern parameter is used to determine which names to return. A '%' is the wildcard. Hence, the pattern "T%" would return all names that start with a 'T'. Whether the pattern match is case sensitive or not is a function of the database. The types parameter allows you to specify whether you want the names of tables, view, or both returned. If the array contains "TABLE", then names of tables are returned. If the array contains "VIEW", then the names of views are returned. A call to this function closes the result set returned by the previous call.

Parameters:

tableNamePattern - - the table name pattern

types - - identifies whether names of tables, views, or both are returned

getProcedures

StoredProcedureInfo[] getProcedures(java.lang.String procedureNamePattern)

Get a result set from which you can get the names of stored procedures. The procedurePattern parameter is used to determine which names to return. A '%' is the wildcard. Whether the pattern match is case sensitive or not is a function of the database.

Parameters:

procedureNamePattern -

getProcedures

StoredProcedureInfo[] getProcedures(java.lang.String catalog,
                                    java.lang.String schema,
                                    java.lang.String procedureNamePattern)

Get a result set from which you can get the names of stored procedures. The procedurePattern parameter is used to determine which names to return. A '%' is the wildcard. Whether the pattern match is case sensitive or not is a function of the database.

Parameters:

procedureNamePattern -

catalog - - the catalog

schema - - the schema

getProcedureParameters

StoredProcedureParameterInfo[] getProcedureParameters(java.lang.String procedureName)

getProcedureParameters

StoredProcedureParameterInfo[] getProcedureParameters(java.lang.String catalog,
                                                      java.lang.String schema,
                                                      java.lang.String procedureName)

getTableColumns

ColumnInfo[] getTableColumns(java.lang.String tableName)

Get a set of ColumnInfo objects for a given table. The set returned contains ColumnInfo objects for the table or view. Unlike getColumnInfo, the tableName parameter is a full name and not a pattern. Also, the catalog and schema cannot be wildcarded, i.e. you can't make this call if you have called setCatalog(null) or setSchema(null). (Although you can pass a null for the catalog for Oracle.)

Parameters:

tableName -

Returns:

A set of ColumnInfo objects, or null if the table does not exist.

getTableColumns

ColumnInfo[] getTableColumns(java.lang.String catalog,
                             java.lang.String schema,
                             java.lang.String tableName)

Get a set of ColumnInfo objects for a given table. The set returned contains ColumnInfo objects for the table or view. Unlike getColumnInfo, the tableName parameter is a full name and not a pattern. Also, the catalog and schema cannot be wildcarded, i.e. you can't make this call if you have called setCatalog(null) or setSchema(null). (Although you can pass a null for the catalog for Oracle.)

Parameters:

catalog -

schema -

tableName -

Returns:

A set of ColumnInfo objects, or null if the table does not exist.

setCatalog

void setCatalog(java.lang.String catalog)

Set the catalog. This class automatically picks up the catalog and schema from the DataSource. However, if you want to specify a catalog rather than use the default from the DataSource, you can call this method. Passing a null value for the catalog means to use all catalogs, i.e. the catalog is not used to determine which table or view names to pick up.

Parameters:

catalog - - the catalog name or null.

getCatalog

java.lang.String getCatalog()

Get the catalog. This class automatically picks up the catalog and schema from the DataSource.

Returns:

The catalog name, or null if the catalog is not defined.

setSchema

void setSchema(java.lang.String schema)

Set the schema. This class automatically picks up the catalog and schema from the DataSource. However, if you want to specify a schema rather than use the default from the DataSource, you can call this method. Passing a null value for the schema means to use all catalogs, i.e. the schema is not used to determine which table or view names to pick up.

Parameters:

schema - - the schema name or null.

Skip navigation links