odbc::DatabaseMetaData Class Reference

Detailed Description

Provides several tons of information about a data source.

Warning:: The column names in ResultSets returned by methods of DatabaseMetaData can differ depending on what ODBC version the current driver supports. To avoid problems, columns should be referenced by number, and not by name. Also note that ODBC version 2 drivers do not return some of the specified columns.

Definition at line 43 of file databasemetadata.h.

Public Types

enum { bestRowTemporary = SQL_SCOPE_CURROW, bestRowTransaction = SQL_SCOPE_TRANSACTION, bestRowSession = SQL_SCOPE_SESSION }

Constants for the ResultSet returned by getBestRowIdentifier. More...

enum { bestRowUnknown = SQL_PC_UNKNOWN, bestRowPseudo = SQL_PC_PSEUDO, bestRowNotPseudo = SQL_PC_NOT_PSEUDO }

Constants for the ResultSet returned by getBestRowIdentifier. More...

enum { versionColumnNotPseudo = SQL_PC_NOT_PSEUDO, versionColumnPseudo = SQL_PC_PSEUDO, versionColumnUnknown = SQL_PC_UNKNOWN }

Version column constants for getVersionColumns(). More...

enum { typeNoNulls = SQL_NO_NULLS, typeNullable = SQL_NULLABLE, typeNullableUnknown = SQL_NULLABLE_UNKNOWN }

Nullability constants for the resultset returned by getTypes(). More...

enum { columnNoNulls = SQL_NO_NULLS, columnNullable = SQL_NULLABLE, columnNullableUnknown = SQL_NULLABLE_UNKNOWN }

Nullability constants for the resultset returned by getColumns(). More...

enum { typePredNone = SQL_UNSEARCHABLE, typePredChar = SQL_LIKE_ONLY, typePredBasic = SQL_ALL_EXCEPT_LIKE, typeSearchable = SQL_SEARCHABLE }

Searchability constants. More...

enum {
  importedKeyCascade = SQL_CASCADE, importedKeySetNull = SQL_SET_NULL, importedKeyRestrict = SQL_RESTRICT, importedKeyNoAction = SQL_RESTRICT,
  importedKeySetDefault
}

Imported key UPDATE_RULE and DELETE_RULE constants. More...

enum { tableIndexClustered = SQL_INDEX_CLUSTERED, tableIndexHashed = SQL_INDEX_HASHED, tableIndexOther = SQL_INDEX_OTHER, tableIndexStatistic = SQL_TABLE_STAT }

Index type constants. More...

enum {
  procedureColumnIn = SQL_PARAM_INPUT, procedureColumnInOut = SQL_PARAM_INPUT_OUTPUT, procedureColumnOut = SQL_PARAM_OUTPUT, procedureColumnResult = SQL_RESULT_COL,
  procedureColumnReturn = SQL_RETURN_VALUE, procedureColumnUnknown = SQL_PARAM_TYPE_UNKNOWN
}

Procedure column type constants for getProcedureColumns(). More...

enum { procedureNoNulls = SQL_NO_NULLS, procedureNullable = SQL_NULLABLE, procedureNullableUnknown = SQL_NULLABLE_UNKNOWN }

Procedure column nullability constants for getProcedureColumns(). More...

enum { procedureReturnsResult = SQL_PT_FUNCTION, procedureNoResult = SQL_PT_PROCEDURE, procedureResultUnknown = SQL_PT_UNKNOWN }

Procedure type constants for PROCEDURE_TYPE in getProcedures(). More...

enum { bestRowTemporary = SQL_SCOPE_CURROW, bestRowTransaction = SQL_SCOPE_TRANSACTION, bestRowSession = SQL_SCOPE_SESSION }

Constants for the ResultSet returned by getBestRowIdentifier. More...

enum { bestRowUnknown = SQL_PC_UNKNOWN, bestRowPseudo = SQL_PC_PSEUDO, bestRowNotPseudo = SQL_PC_NOT_PSEUDO }

Constants for the ResultSet returned by getBestRowIdentifier. More...

enum { versionColumnNotPseudo = SQL_PC_NOT_PSEUDO, versionColumnPseudo = SQL_PC_PSEUDO, versionColumnUnknown = SQL_PC_UNKNOWN }

Version column constants for getVersionColumns(). More...

enum { typeNoNulls = SQL_NO_NULLS, typeNullable = SQL_NULLABLE, typeNullableUnknown = SQL_NULLABLE_UNKNOWN }

Nullability constants for the resultset returned by getTypes(). More...

enum { columnNoNulls = SQL_NO_NULLS, columnNullable = SQL_NULLABLE, columnNullableUnknown = SQL_NULLABLE_UNKNOWN }

Nullability constants for the resultset returned by getColumns(). More...

enum { typePredNone = SQL_UNSEARCHABLE, typePredChar = SQL_LIKE_ONLY, typePredBasic = SQL_ALL_EXCEPT_LIKE, typeSearchable = SQL_SEARCHABLE }

Searchability constants. More...

enum {
  importedKeyCascade = SQL_CASCADE, importedKeySetNull = SQL_SET_NULL, importedKeyRestrict = SQL_RESTRICT, importedKeyNoAction = SQL_RESTRICT,
  importedKeySetDefault
}

Imported key UPDATE_RULE and DELETE_RULE constants. More...

enum { tableIndexClustered = SQL_INDEX_CLUSTERED, tableIndexHashed = SQL_INDEX_HASHED, tableIndexOther = SQL_INDEX_OTHER, tableIndexStatistic = SQL_TABLE_STAT }

Index type constants. More...

enum {
  procedureColumnIn = SQL_PARAM_INPUT, procedureColumnInOut = SQL_PARAM_INPUT_OUTPUT, procedureColumnOut = SQL_PARAM_OUTPUT, procedureColumnResult = SQL_RESULT_COL,
  procedureColumnReturn = SQL_RETURN_VALUE, procedureColumnUnknown = SQL_PARAM_TYPE_UNKNOWN
}

Procedure column type constants for getProcedureColumns(). More...

enum { procedureNoNulls = SQL_NO_NULLS, procedureNullable = SQL_NULLABLE, procedureNullableUnknown = SQL_NULLABLE_UNKNOWN }

Procedure column nullability constants for getProcedureColumns(). More...

enum { procedureReturnsResult = SQL_PT_FUNCTION, procedureNoResult = SQL_PT_PROCEDURE, procedureResultUnknown = SQL_PT_UNKNOWN }

Procedure type constants for PROCEDURE_TYPE in getProcedures(). More...

Public Member Functions

bool allProceduresAreCallable ()

Returns true if all procedures returned by getProcedures() are callable by the current user.

bool allProceduresAreCallable ()

Returns true if all procedures returned by getProcedures() are callable by the current user.

bool allTablesAreSelectable ()

Returns true if all tables returned by getTables() are selectable by the current user.

bool allTablesAreSelectable ()

Returns true if all tables returned by getTables() are selectable by the current user.

bool dataDefinitionCausesTransactionCommit ()

Checks if DDL in a transaction will cause the transaction to be committed.

bool dataDefinitionCausesTransactionCommit ()

Checks if DDL in a transaction will cause the transaction to be committed.

bool dataDefinitionIgnoredInTransactions ()

Checks if DDL in a transaction is ignored.

bool dataDefinitionIgnoredInTransactions ()

Checks if DDL in a transaction is ignored.

bool deletesAreDetected (int type)

Returns true if a deleted row can be detected with ResultSet::rowDeleted().

bool deletesAreDetected (int type)

Returns true if a deleted row can be detected with ResultSet::rowDeleted().

bool doesMaxRowSizeIncludeBlobs ()

Returns true if the value returned by getMaxRowSize() includes BLOBs.

bool doesMaxRowSizeIncludeBlobs ()

Returns true if the value returned by getMaxRowSize() includes BLOBs.

ResultSet * getBestRowIdentifier (const ODBCXX_STRING &catalog, const ODBCXX_STRING &schema, const ODBCXX_STRING &table, int scope, bool nullable)

Returns the optimal set of columns that identifies a row.

ResultSet * getBestRowIdentifier (const ODBCXX_STRING &catalog, const ODBCXX_STRING &schema, const ODBCXX_STRING &table, int scope, bool nullable)

Returns the optimal set of columns that identifies a row.

ResultSet * getCatalogs ()

Returns a list of available catalogs in the database.

ResultSet * getCatalogs ()

Returns a list of available catalogs in the database.

ODBCXX_STRING getCatalogSeparator ()

Returns the string used to separate a catalog in a fully qualified identifier.

ODBCXX_STRING getCatalogSeparator ()

Returns the string used to separate a catalog in a fully qualified identifier.

ODBCXX_STRING getCatalogTerm ()

Returns the term for catalog used by the data source.

ODBCXX_STRING getCatalogTerm ()

Returns the term for catalog used by the data source.

ResultSet * getColumnPrivileges (const ODBCXX_STRING &catalog, const ODBCXX_STRING &schema, const ODBCXX_STRING &table, const ODBCXX_STRING &columnNamePattern)

Fetches a list of access rights for a table's columns.

ResultSet * getColumnPrivileges (const ODBCXX_STRING &catalog, const ODBCXX_STRING &schema, const ODBCXX_STRING &table, const ODBCXX_STRING &columnNamePattern)

Fetches a list of access rights for a table's columns.

ResultSet * getColumns (const ODBCXX_STRING &catalog, const ODBCXX_STRING &schemaPattern, const ODBCXX_STRING &tableNamePattern, const ODBCXX_STRING &columnNamePattern)

Fetches the available columns in a catalog.

ResultSet * getColumns (const ODBCXX_STRING &catalog, const ODBCXX_STRING &schemaPattern, const ODBCXX_STRING &tableNamePattern, const ODBCXX_STRING &columnNamePattern)

Fetches the available columns in a catalog.

Connection * getConnection ()

Returns the Connection this came from.

Connection * getConnection ()

Returns the Connection this came from.

ResultSet * getCrossReference (const ODBCXX_STRING &primaryCatalog, const ODBCXX_STRING &primarySchema, const ODBCXX_STRING &primaryTable, const ODBCXX_STRING &foreignCatalog, const ODBCXX_STRING &foreignSchema, const ODBCXX_STRING &foreignTable)

Figures out in which way a foreign key table references a primary key table.

ResultSet * getCrossReference (const ODBCXX_STRING &primaryCatalog, const ODBCXX_STRING &primarySchema, const ODBCXX_STRING &primaryTable, const ODBCXX_STRING &foreignCatalog, const ODBCXX_STRING &foreignSchema, const ODBCXX_STRING &foreignTable)

Figures out in which way a foreign key table references a primary key table.

ODBCXX_STRING getDatabaseProductName ()

Returns the name of the database product.

ODBCXX_STRING getDatabaseProductName ()

Returns the name of the database product.

ODBCXX_STRING getDatabaseProductVersion ()

Returns the version of the database product as a string.

ODBCXX_STRING getDatabaseProductVersion ()

Returns the version of the database product as a string.

int getDefaultTransactionIsolation ()

Returns the default transaction isolation level.

int getDefaultTransactionIsolation ()

Returns the default transaction isolation level.

int getDriverMajorVersion ()

Returns the major ODBC version of the driver used.

int getDriverMajorVersion ()

Returns the major ODBC version of the driver used.

int getDriverMinorVersion ()

Returns the minor ODBC version of the driver used.

int getDriverMinorVersion ()

Returns the minor ODBC version of the driver used.

ODBCXX_STRING getDriverName ()

Returns the name of the ODBC driver used.

ODBCXX_STRING getDriverName ()

Returns the name of the ODBC driver used.

ODBCXX_STRING getDriverVersion ()

Returns the version of the ODBC driver used.

ODBCXX_STRING getDriverVersion ()

Returns the version of the ODBC driver used.

ResultSet * getExportedKeys (const ODBCXX_STRING &catalog, const ODBCXX_STRING &schema, const ODBCXX_STRING &table)

Fetches a list of columns that reference a table's primary keys.

ResultSet * getExportedKeys (const ODBCXX_STRING &catalog, const ODBCXX_STRING &schema, const ODBCXX_STRING &table)

Fetches a list of columns that reference a table's primary keys.

ODBCXX_STRING getExtraNameCharacters ()

Returns the extra characters beyond A-Z, a-z, 0-9 and _ that can be used in unquoted identifier names.

ODBCXX_STRING getExtraNameCharacters ()

Returns the extra characters beyond A-Z, a-z, 0-9 and _ that can be used in unquoted identifier names.

ODBCXX_STRING getIdentifierQuoteString ()

Returns the string that can be used to quote identifiers.

ODBCXX_STRING getIdentifierQuoteString ()

Returns the string that can be used to quote identifiers.

ResultSet * getImportedKeys (const ODBCXX_STRING &catalog, const ODBCXX_STRING &schema, const ODBCXX_STRING &table)

Fetches a list of columns that are foreign keys to other tables' primary keys.

ResultSet * getImportedKeys (const ODBCXX_STRING &catalog, const ODBCXX_STRING &schema, const ODBCXX_STRING &table)

Fetches a list of columns that are foreign keys to other tables' primary keys.

ResultSet * getIndexInfo (const ODBCXX_STRING &catalog, const ODBCXX_STRING &schema, const ODBCXX_STRING &table, bool unique, bool approximate)

Fetches a list of indices and statistics for a table.

ResultSet * getIndexInfo (const ODBCXX_STRING &catalog, const ODBCXX_STRING &schema, const ODBCXX_STRING &table, bool unique, bool approximate)

Fetches a list of indices and statistics for a table.

int getMaxBinaryLiteralLength ()

Returns the max number of hex characters allowed in an inline binary literal.

int getMaxBinaryLiteralLength ()

Returns the max number of hex characters allowed in an inline binary literal.

int getMaxCatalogNameLength ()

Returns the maximum length of a catalog name.

int getMaxCatalogNameLength ()

Returns the maximum length of a catalog name.

int getMaxCharLiteralLength ()

Returns the maximum length of an inline character string.

int getMaxCharLiteralLength ()

Returns the maximum length of an inline character string.

int getMaxColumnNameLength ()

Returns the maximum length of a column name.

int getMaxColumnNameLength ()

Returns the maximum length of a column name.

int getMaxColumnsInGroupBy ()

Returns the maximum number of columns this data source can have in a GROUP BY clause.

int getMaxColumnsInGroupBy ()

Returns the maximum number of columns this data source can have in a GROUP BY clause.

int getMaxColumnsInIndex ()

Returns the maximum number of columns allowed in an index.

int getMaxColumnsInIndex ()

Returns the maximum number of columns allowed in an index.

int getMaxColumnsInOrderBy ()

Returns the maximum number of columns this data source can have in an ORDER BY clause.

int getMaxColumnsInOrderBy ()

Returns the maximum number of columns this data source can have in an ORDER BY clause.

int getMaxColumnsInSelect ()

Returns the maximum number of columns this data source can SELECT.

int getMaxColumnsInSelect ()

Returns the maximum number of columns this data source can SELECT.

int getMaxColumnsInTable ()

Returns the maximum number of columns a table can consist of.

int getMaxColumnsInTable ()

Returns the maximum number of columns a table can consist of.

int getMaxConnections ()

Returns the maximum number of connections we can have open to this data source.

int getMaxConnections ()

Returns the maximum number of connections we can have open to this data source.

int getMaxCursorNameLength ()

Returns the maximum length of a cursor name.

int getMaxCursorNameLength ()

Returns the maximum length of a cursor name.

int getMaxIndexLength ()

Returns the maximum length of an index in bytes.

int getMaxIndexLength ()

Returns the maximum length of an index in bytes.

int getMaxProcedureNameLength ()

Returns the maximum length of a procedure name.

int getMaxProcedureNameLength ()

Returns the maximum length of a procedure name.

int getMaxRowSize ()

Returns the maximum size of a row in bytes.

int getMaxRowSize ()

Returns the maximum size of a row in bytes.

int getMaxSchemaNameLength ()

Returns the maximum length of a schema name.

int getMaxSchemaNameLength ()

Returns the maximum length of a schema name.

int getMaxStatementLength ()

Returns the maximum length of a statement (query).

int getMaxStatementLength ()

Returns the maximum length of a statement (query).

int getMaxStatements ()

Returns the maximim number of statements that can be open on this connection.

int getMaxStatements ()

Returns the maximim number of statements that can be open on this connection.

int getMaxTableNameLength ()

Returns the maximum length of a table name.

int getMaxTableNameLength ()

Returns the maximum length of a table name.

int getMaxTablesInSelect ()

Returns the maximum number of tables that can be joined at once.

int getMaxTablesInSelect ()

Returns the maximum number of tables that can be joined at once.

int getMaxUserNameLength ()

Returns the maximum length of a username.

int getMaxUserNameLength ()

Returns the maximum length of a username.

ODBCXX_STRING getNumericFunctions ()

Returns a comma-separated list of all numeric functions supported.

ODBCXX_STRING getNumericFunctions ()

Returns a comma-separated list of all numeric functions supported.

ResultSet * getPrimaryKeys (const ODBCXX_STRING &catalog, const ODBCXX_STRING &schema, const ODBCXX_STRING &table)

Fetches a list of primary keys for a table.

ResultSet * getPrimaryKeys (const ODBCXX_STRING &catalog, const ODBCXX_STRING &schema, const ODBCXX_STRING &table)

Fetches a list of primary keys for a table.

ResultSet * getProcedureColumns (const ODBCXX_STRING &catalog, const ODBCXX_STRING &schemaPattern, const ODBCXX_STRING &procedureNamePattern, const ODBCXX_STRING &columnNamePattern)

Returns available procedure columns in a catalog.

ResultSet * getProcedureColumns (const ODBCXX_STRING &catalog, const ODBCXX_STRING &schemaPattern, const ODBCXX_STRING &procedureNamePattern, const ODBCXX_STRING &columnNamePattern)

Returns available procedure columns in a catalog.

ResultSet * getProcedures (const ODBCXX_STRING &catalog, const ODBCXX_STRING &schemaPattern, const ODBCXX_STRING &procedureNamePattern)

Returns available procedures in a catalog.

ResultSet * getProcedures (const ODBCXX_STRING &catalog, const ODBCXX_STRING &schemaPattern, const ODBCXX_STRING &procedureNamePattern)

Returns available procedures in a catalog.

ODBCXX_STRING getProcedureTerm ()

Returns the term the data source uses for a procedure, for example "stored procedure".

ODBCXX_STRING getProcedureTerm ()

Returns the term the data source uses for a procedure, for example "stored procedure".

ResultSet * getSchemas ()

Returns a list of available schemas in the database.

ResultSet * getSchemas ()

Returns a list of available schemas in the database.

ODBCXX_STRING getSchemaTerm ()

Returns the term for schema used by the data source, for example "owner" or just "schema".

ODBCXX_STRING getSchemaTerm ()

Returns the term for schema used by the data source, for example "owner" or just "schema".

ODBCXX_STRING getSearchStringEscape ()

Returns the string that can be used to escape wildcard characters.

ODBCXX_STRING getSearchStringEscape ()

Returns the string that can be used to escape wildcard characters.

ODBCXX_STRING getSQLKeywords ()

Returns a comma-separated list of all non-ODBC keywords specific to this data source.

ODBCXX_STRING getSQLKeywords ()

Returns a comma-separated list of all non-ODBC keywords specific to this data source.

ODBCXX_STRING getStringFunctions ()

Returns a comma-separated list of all string functions supported.

ODBCXX_STRING getStringFunctions ()

Returns a comma-separated list of all string functions supported.

ODBCXX_STRING getSystemFunctions ()

Returns a comma-separated list of all system functions supported.

ODBCXX_STRING getSystemFunctions ()

Returns a comma-separated list of all system functions supported.

ResultSet * getTablePrivileges (const ODBCXX_STRING &catalog, const ODBCXX_STRING &schemaPattern, const ODBCXX_STRING &tableNamePattern)

Fetches a list of access rights for tables in a catalog.

ResultSet * getTablePrivileges (const ODBCXX_STRING &catalog, const ODBCXX_STRING &schemaPattern, const ODBCXX_STRING &tableNamePattern)

Fetches a list of access rights for tables in a catalog.

ResultSet * getTables (const ODBCXX_STRING &catalog, const ODBCXX_STRING &schemaPattern, const ODBCXX_STRING &tableNamePattern, const std::vector< ODBCXX_STRING > &types)

Fetches the available tables in the data source.

ResultSet * getTables (const ODBCXX_STRING &catalog, const ODBCXX_STRING &schemaPattern, const ODBCXX_STRING &tableNamePattern, const std::vector< ODBCXX_STRING > &types)

Fetches the available tables in the data source.

ODBCXX_STRING getTableTerm ()

Returns the term for table used by the data source.

ODBCXX_STRING getTableTerm ()

Returns the term for table used by the data source.

ResultSet * getTableTypes ()

Fetches the table types the database supports.

ResultSet * getTableTypes ()

Fetches the table types the database supports.

ODBCXX_STRING getTimeDateFunctions ()

Returns a comma-separated list of all time and date functions supported.

ODBCXX_STRING getTimeDateFunctions ()

Returns a comma-separated list of all time and date functions supported.

ResultSet * getTypeInfo ()

Fetches a list of data types supported by this data source.

ResultSet * getTypeInfo ()

Fetches a list of data types supported by this data source.

ODBCXX_STRING getUserName ()

Returns the user name of the connection.

ODBCXX_STRING getUserName ()

Returns the user name of the connection.

ResultSet * getVersionColumns (const ODBCXX_STRING &catalog, const ODBCXX_STRING &schema, const ODBCXX_STRING &table)

Returns a list of columns for a table that are automatically updated when anything in a row is updated.

ResultSet * getVersionColumns (const ODBCXX_STRING &catalog, const ODBCXX_STRING &schema, const ODBCXX_STRING &table)

Returns a list of columns for a table that are automatically updated when anything in a row is updated.

bool insertsAreDetected (int type)

Returns true if an inserted row can be detected with ResultSet::rowInserted().

bool insertsAreDetected (int type)

Returns true if an inserted row can be detected with ResultSet::rowInserted().

bool isCatalogAtStart ()

Returns true if the catalog is positioned at the beginning of a fully qualified identifier.

bool isCatalogAtStart ()

Returns true if the catalog is positioned at the beginning of a fully qualified identifier.

bool isReadOnly ()

Returns true if the data source or the current connection is in read-only mode.

bool isReadOnly ()

Returns true if the data source or the current connection is in read-only mode.

bool nullPlusNonNullIsNull ()

Returns true if NULL plus a non-NULL value yields NULL.

bool nullPlusNonNullIsNull ()

Returns true if NULL plus a non-NULL value yields NULL.

bool nullsAreSortedAtEnd ()

Returns true if NULL values are sorted last, regardless of the sort order.

bool nullsAreSortedAtEnd ()

Returns true if NULL values are sorted last, regardless of the sort order.

bool nullsAreSortedAtStart ()

Returns true if NULL values are sorted first, regardless of the sort order.

bool nullsAreSortedAtStart ()

Returns true if NULL values are sorted first, regardless of the sort order.

bool nullsAreSortedHigh ()

Returns true if NULL values are sorted high.

bool nullsAreSortedHigh ()

Returns true if NULL values are sorted high.

bool nullsAreSortedLow ()

Returns true if NULL values are sorted low.

bool nullsAreSortedLow ()

Returns true if NULL values are sorted low.

bool othersDeletesAreVisible (int type)

Returns true if rows deleted by others disapear from a ResultSet.

bool othersDeletesAreVisible (int type)

Returns true if rows deleted by others disapear from a ResultSet.

bool othersInsertsAreVisible (int type)

Returns true if rows inserted by others become available in a ResultSet.

bool othersInsertsAreVisible (int type)

Returns true if rows inserted by others become available in a ResultSet.

bool othersUpdatesAreVisible (int type)

Returns true if rows updated by others are visible with their new values.

bool othersUpdatesAreVisible (int type)

Returns true if rows updated by others are visible with their new values.

bool ownDeletesAreVisible (int type)

Returns true if deleted rows dissapear from a ResultSet.

bool ownDeletesAreVisible (int type)

Returns true if deleted rows dissapear from a ResultSet.

bool ownInsertsAreVisible (int type)

Returns true if inserted rows become available in a ResultSet.

bool ownInsertsAreVisible (int type)

Returns true if inserted rows become available in a ResultSet.

bool ownUpdatesAreVisible (int type)

Returns true if updated rows are available with their new values in the ResultSet.

bool ownUpdatesAreVisible (int type)

Returns true if updated rows are available with their new values in the ResultSet.

bool storesLowerCaseIdentifiers ()

Returns true if the data source treats identifiers as case insensitive and stores them in lower case.

bool storesLowerCaseIdentifiers ()

Returns true if the data source treats identifiers as case insensitive and stores them in lower case.

bool storesLowerCaseQuotedIdentifiers ()

Returns true if the data source treats quoted identifiers as case insensitive and stores them in lower case.

bool storesLowerCaseQuotedIdentifiers ()

Returns true if the data source treats quoted identifiers as case insensitive and stores them in lower case.

bool storesMixedCaseIdentifiers ()

Returns true if the data source treats identifiers as case insensitive and stores them in mixed case.

bool storesMixedCaseIdentifiers ()

Returns true if the data source treats identifiers as case insensitive and stores them in mixed case.

bool storesMixedCaseQuotedIdentifiers ()

Returns true if the data source treats quoted identifiers as case insensitive and stores them in mixed case.

bool storesMixedCaseQuotedIdentifiers ()

Returns true if the data source treats quoted identifiers as case insensitive and stores them in mixed case.

bool storesUpperCaseIdentifiers ()

Returns true if the data source treats identifiers as case insensitive and stores them in upper case.

bool storesUpperCaseIdentifiers ()

Returns true if the data source treats identifiers as case insensitive and stores them in upper case.

bool storesUpperCaseQuotedIdentifiers ()

Returns true if the data source treats quoted identifiers as case insensitive and stores them in upper case.

bool storesUpperCaseQuotedIdentifiers ()

Returns true if the data source treats quoted identifiers as case insensitive and stores them in upper case.

bool supportsAlterTableWithAddColumn ()

Returns true if ALTER TABLE with add column is supported.

bool supportsAlterTableWithAddColumn ()

Returns true if ALTER TABLE with add column is supported.

bool supportsAlterTableWithDropColumn ()

Returns true if ALTER TABLE with drop column is supported.

bool supportsAlterTableWithDropColumn ()

Returns true if ALTER TABLE with drop column is supported.

bool supportsANSI92EntryLevelSQL ()

Returns true if the data source supports the ANSI92 entry level SQL grammar.

bool supportsANSI92EntryLevelSQL ()

Returns true if the data source supports the ANSI92 entry level SQL grammar.

bool supportsANSI92FullSQL ()

Returns true if the data source supports the full ANSI92 SQL grammar.

bool supportsANSI92FullSQL ()

Returns true if the data source supports the full ANSI92 SQL grammar.

bool supportsANSI92IntermediateSQL ()

Returns true if the data source supports the ANSI92 intermediate level SQL grammar.

bool supportsANSI92IntermediateSQL ()

Returns true if the data source supports the ANSI92 intermediate level SQL grammar.

bool supportsBatchUpdates ()

Whether the data source supports batch updates.

bool supportsBatchUpdates ()

Whether the data source supports batch updates.

bool supportsCatalogsInDataManipulation ()

Returns true if catalogs are supported in DML.

bool supportsCatalogsInDataManipulation ()

Returns true if catalogs are supported in DML.

bool supportsCatalogsInIndexDefinitions ()

Returns true if catalogs are supported in index definitions.

bool supportsCatalogsInIndexDefinitions ()

Returns true if catalogs are supported in index definitions.

bool supportsCatalogsInPrivilegeDefinitions ()

Returns true if catalogs are supported in privilege definition statements.

bool supportsCatalogsInPrivilegeDefinitions ()

Returns true if catalogs are supported in privilege definition statements.

bool supportsCatalogsInProcedureCalls ()

Returns true if catalogs are supported in procedure call statements.

bool supportsCatalogsInProcedureCalls ()

Returns true if catalogs are supported in procedure call statements.

bool supportsCatalogsInTableDefinitions ()

Returns true if catalogs are supported in CREATE/ALTER TABLE statements.

bool supportsCatalogsInTableDefinitions ()

Returns true if catalogs are supported in CREATE/ALTER TABLE statements.

bool supportsColumnAliasing ()

Returns true if the data source supports column aliasing, for example SELECT COLUMN1 [AS] C1 FROM TABLE.

bool supportsColumnAliasing ()

Returns true if the data source supports column aliasing, for example SELECT COLUMN1 [AS] C1 FROM TABLE.

bool supportsConvert (int fromType, int toType)

Returns true if CONVERT between fromType and toType is supported.

bool supportsConvert ()

Returns true if the CONVERT function is supported by the data source.

bool supportsConvert (int fromType, int toType)

Returns true if CONVERT between fromType and toType is supported.

bool supportsConvert ()

Returns true if the CONVERT function is supported by the data source.

bool supportsCoreSQLGrammar ()

Returns true if the data source supports the core ODBC SQL grammar.

bool supportsCoreSQLGrammar ()

Returns true if the data source supports the core ODBC SQL grammar.

bool supportsCorrelatedSubqueries ()

Returns true if the data source supports correlated subqueries.

bool supportsCorrelatedSubqueries ()

Returns true if the data source supports correlated subqueries.

bool supportsDataDefinitionAndDataManipulationTransactions ()

Checks if the data source supports both DML and DDL in transactions.

bool supportsDataDefinitionAndDataManipulationTransactions ()

Checks if the data source supports both DML and DDL in transactions.

bool supportsDataManipulationTransactionsOnly ()

Checks if the data source only supports DML in transactions.

bool supportsDataManipulationTransactionsOnly ()

Checks if the data source only supports DML in transactions.

bool supportsExtendedSQLGrammar ()

Returns true if the data source supports the ODBC extended SQL grammar.

bool supportsExtendedSQLGrammar ()

Returns true if the data source supports the ODBC extended SQL grammar.

bool supportsFullOuterJoins ()

Returns true if the data source fully supports outer joins.

bool supportsFullOuterJoins ()

Returns true if the data source fully supports outer joins.

bool supportsGroupBy ()

Returns true if the data source supports the GROUP BY clause.

bool supportsGroupBy ()

Returns true if the data source supports the GROUP BY clause.

bool supportsGroupByBeyondSelect ()

Returns true if the columns in a GROUP BY don't have to be selected.

bool supportsGroupByBeyondSelect ()

Returns true if the columns in a GROUP BY don't have to be selected.

bool supportsGroupByUnrelated ()

Returns true if the columns in a GROUP BY clause are independent of the selected ones.

bool supportsGroupByUnrelated ()

Returns true if the columns in a GROUP BY clause are independent of the selected ones.

bool supportsIntegrityEnhancementFacility ()

Returns true if the data source supports the SQL Integrity Enhancement Facility.

bool supportsIntegrityEnhancementFacility ()

Returns true if the data source supports the SQL Integrity Enhancement Facility.

bool supportsLikeEscapeClause ()

Returns true if the escape character is supported in LIKE clauses.

bool supportsLikeEscapeClause ()

Returns true if the escape character is supported in LIKE clauses.

bool supportsLimitedOuterJoins ()

Returns true if the data source only supports certain types of outer joins.

bool supportsLimitedOuterJoins ()

Returns true if the data source only supports certain types of outer joins.

bool supportsMinimumSQLGrammar ()

Returns true if the data source supports ODBC minimum SQL grammar.

bool supportsMinimumSQLGrammar ()

Returns true if the data source supports ODBC minimum SQL grammar.

bool supportsMixedCaseIdentifiers ()

Returns true if the data source supports case sensitive mixed case identifiers.

bool supportsMixedCaseIdentifiers ()

Returns true if the data source supports case sensitive mixed case identifiers.

bool supportsMixedCaseQuotedIdentifiers ()

Returns true if the data source supports case sensitive mixed case quoted identifiers.

bool supportsMixedCaseQuotedIdentifiers ()

Returns true if the data source supports case sensitive mixed case quoted identifiers.

bool supportsMultipleResultSets ()

Returns true if a query can return multiple ResultSets.

bool supportsMultipleResultSets ()

Returns true if a query can return multiple ResultSets.

bool supportsMultipleTransactions ()

Returns true if multiple transactions can be open at once on different connections.

bool supportsMultipleTransactions ()

Returns true if multiple transactions can be open at once on different connections.

bool supportsNonNullableColumns ()

Returns true if columns can be defined as non-nullable.

bool supportsNonNullableColumns ()

Returns true if columns can be defined as non-nullable.

bool supportsOpenCursorsAcrossCommit ()

Returns true if the data source and the driver can handle open cursors (eg.

bool supportsOpenCursorsAcrossCommit ()

Returns true if the data source and the driver can handle open cursors (eg.

bool supportsOpenCursorsAcrossRollback ()

Returns true if the data source and the driver can handle open cursors (eg.

bool supportsOpenCursorsAcrossRollback ()

Returns true if the data source and the driver can handle open cursors (eg.

bool supportsOpenStatementsAcrossCommit ()

Returns true if the data source and the driver can handle open statements across a commit, or false if they are invalidated.

bool supportsOpenStatementsAcrossCommit ()

Returns true if the data source and the driver can handle open statements across a commit, or false if they are invalidated.

bool supportsOpenStatementsAcrossRollback ()

Returns true if the data source and the driver can handle open statements across a rollback, or false if they are invalidated.

bool supportsOpenStatementsAcrossRollback ()

Returns true if the data source and the driver can handle open statements across a rollback, or false if they are invalidated.

bool supportsOuterJoins ()

Returns true if the data source supports some form of outer joins.

bool supportsOuterJoins ()

Returns true if the data source supports some form of outer joins.

bool supportsPositionedDelete ()

Checks if the data source supports positioned delete.

bool supportsPositionedDelete ()

Checks if the data source supports positioned delete.

bool supportsPositionedUpdate ()

Checks if the data source supports positioned update.

bool supportsPositionedUpdate ()

Checks if the data source supports positioned update.

bool supportsResultSetConcurrency (int type, int concurrency)

Returns true if the data source supports the given result set concurrency for the given result set type.

bool supportsResultSetConcurrency (int type, int concurrency)

Returns true if the data source supports the given result set concurrency for the given result set type.

bool supportsResultSetType (int type)

Returns true if the data source supports the given result set type.

bool supportsResultSetType (int type)

Returns true if the data source supports the given result set type.

bool supportsSchemasInDataManipulation ()

Returns true if schemas are supported in DML.

bool supportsSchemasInDataManipulation ()

Returns true if schemas are supported in DML.

bool supportsSchemasInIndexDefinitions ()

Returns true if schemas are supported in index definitions.

bool supportsSchemasInIndexDefinitions ()

Returns true if schemas are supported in index definitions.

bool supportsSchemasInPrivilegeDefinitions ()

Returns true if schemas are supported in privilege definition statements.

bool supportsSchemasInPrivilegeDefinitions ()

Returns true if schemas are supported in privilege definition statements.

bool supportsSchemasInProcedureCalls ()

Returns true if schemas are supported in procedure call statements.

bool supportsSchemasInProcedureCalls ()

Returns true if schemas are supported in procedure call statements.

bool supportsSchemasInTableDefinitions ()

Returns true if schemas are supported in CREATE/ALTER TABLE statements.

bool supportsSchemasInTableDefinitions ()

Returns true if schemas are supported in CREATE/ALTER TABLE statements.

bool supportsSelectForUpdate ()

Checks if the data source supports.

bool supportsSelectForUpdate ()

Checks if the data source supports.

bool supportsStoredProcedures ()

Returns true if the data source supports some form of stored procedures.

bool supportsStoredProcedures ()

Returns true if the data source supports some form of stored procedures.

bool supportsSubqueriesInComparisons ()

Returns true if the data source supports subqueries in comparisons.

bool supportsSubqueriesInComparisons ()

Returns true if the data source supports subqueries in comparisons.

bool supportsSubqueriesInExists ()

Returns true if the data source supports subqueries in "EXISTS" expressions.

bool supportsSubqueriesInExists ()

Returns true if the data source supports subqueries in "EXISTS" expressions.

bool supportsSubqueriesInIns ()

Returns true if the data source supports subqueries in "IN" expressions.

bool supportsSubqueriesInIns ()

Returns true if the data source supports subqueries in "IN" expressions.

bool supportsSubqueriesInQuantifieds ()

Returns true if the data source supports subqueries in quantified expressions.

bool supportsSubqueriesInQuantifieds ()

Returns true if the data source supports subqueries in quantified expressions.

bool supportsTransactionIsolationLevel (int lev)

Returns true if the data source supports the specified transaction isolation level.

bool supportsTransactionIsolationLevel (int lev)

Returns true if the data source supports the specified transaction isolation level.

bool supportsTransactions ()

Returns true if the data source supports transactions.

bool supportsTransactions ()

Returns true if the data source supports transactions.

bool supportsUnion ()

Returns true if the data source supports UNION joins.

bool supportsUnion ()

Returns true if the data source supports UNION joins.

bool supportsUnionAll ()

Returns true if the data source supports UNION ALL joins.

bool supportsUnionAll ()

Returns true if the data source supports UNION ALL joins.

bool updatesAreDetected (int type)

Returns true if ResultSet::rowUpdated can determine whether a row has been updated.

bool updatesAreDetected (int type)

Returns true if ResultSet::rowUpdated can determine whether a row has been updated.

bool usesLocalFilePerTable ()

Returns true if the data source uses a file for each table.

bool usesLocalFilePerTable ()

Returns true if the data source uses a file for each table.

bool usesLocalFiles ()

Returns true if the data source uses local files.

bool usesLocalFiles ()

Returns true if the data source uses local files.

Member Enumeration Documentation

anonymous enum

Constants for the ResultSet returned by getBestRowIdentifier.

Enumerator:

bestRowTemporary
bestRowTransaction
bestRowSession

Definition at line 76 of file databasemetadata.h.

anonymous enum

Constants for the ResultSet returned by getBestRowIdentifier.

Enumerator:

bestRowUnknown
bestRowPseudo
bestRowNotPseudo

Definition at line 83 of file databasemetadata.h.

anonymous enum

Version column constants for getVersionColumns().

See also:: getVersionColumns()

Enumerator:

versionColumnNotPseudo
versionColumnPseudo
versionColumnUnknown

Definition at line 93 of file databasemetadata.h.

anonymous enum

Nullability constants for the resultset returned by getTypes().

See also:: getTypes()

Enumerator:

typeNoNulls
typeNullable
typeNullableUnknown

Definition at line 103 of file databasemetadata.h.

anonymous enum

Nullability constants for the resultset returned by getColumns().

See also:: getColumns()

Enumerator:

columnNoNulls
columnNullable
columnNullableUnknown

Definition at line 113 of file databasemetadata.h.

anonymous enum

Searchability constants.

Enumerator:

typePredNone	Column is unsearchable.
typePredChar	Column can only be used in a LIKE clause.
typePredBasic	Column can be used in searches, except in LIKE.
typeSearchable	Column is searchable.

Definition at line 120 of file databasemetadata.h.

anonymous enum

Imported key UPDATE_RULE and DELETE_RULE constants.

See also:: getImportedKeys()

Enumerator:

importedKeyCascade
importedKeySetNull
importedKeyRestrict
importedKeyNoAction
importedKeySetDefault

Definition at line 145 of file databasemetadata.h.

anonymous enum

Index type constants.

Enumerator:

tableIndexClustered
tableIndexHashed
tableIndexOther
tableIndexStatistic

Definition at line 169 of file databasemetadata.h.

anonymous enum

Procedure column type constants for getProcedureColumns().

See also:: getProcedureColumns()

Enumerator:

procedureColumnIn
procedureColumnInOut
procedureColumnOut
procedureColumnResult
procedureColumnReturn
procedureColumnUnknown

Definition at line 179 of file databasemetadata.h.

anonymous enum

Procedure column nullability constants for getProcedureColumns().

See also:: getProcedureColumns()

Enumerator:

procedureNoNulls
procedureNullable
procedureNullableUnknown

Definition at line 191 of file databasemetadata.h.

anonymous enum

Procedure type constants for PROCEDURE_TYPE in getProcedures().

See also:: getProcedures()

Enumerator:

procedureReturnsResult
procedureNoResult
procedureResultUnknown

Definition at line 200 of file databasemetadata.h.

anonymous enum

Constants for the ResultSet returned by getBestRowIdentifier.

Enumerator:

bestRowTemporary
bestRowTransaction
bestRowSession

Definition at line 76 of file databasemetadata.h.

anonymous enum

Constants for the ResultSet returned by getBestRowIdentifier.

Enumerator:

bestRowUnknown
bestRowPseudo
bestRowNotPseudo

Definition at line 83 of file databasemetadata.h.

anonymous enum

Version column constants for getVersionColumns().

See also:: getVersionColumns()

Enumerator:

versionColumnNotPseudo
versionColumnPseudo
versionColumnUnknown

Definition at line 93 of file databasemetadata.h.

anonymous enum

Nullability constants for the resultset returned by getTypes().

See also:: getTypes()

Enumerator:

typeNoNulls
typeNullable
typeNullableUnknown

Definition at line 103 of file databasemetadata.h.

anonymous enum

Nullability constants for the resultset returned by getColumns().

See also:: getColumns()

Enumerator:

columnNoNulls
columnNullable
columnNullableUnknown

Definition at line 113 of file databasemetadata.h.

anonymous enum

Searchability constants.

Enumerator:

typePredNone	Column is unsearchable.
typePredChar	Column can only be used in a LIKE clause.
typePredBasic	Column can be used in searches, except in LIKE.
typeSearchable	Column is searchable.

Definition at line 120 of file databasemetadata.h.

anonymous enum

Imported key UPDATE_RULE and DELETE_RULE constants.

See also:: getImportedKeys()

Enumerator:

importedKeyCascade
importedKeySetNull
importedKeyRestrict
importedKeyNoAction
importedKeySetDefault

Definition at line 145 of file databasemetadata.h.

anonymous enum

Index type constants.

Enumerator:

tableIndexClustered
tableIndexHashed
tableIndexOther
tableIndexStatistic

Definition at line 169 of file databasemetadata.h.

anonymous enum

Procedure column type constants for getProcedureColumns().

See also:: getProcedureColumns()

Enumerator:

procedureColumnIn
procedureColumnInOut
procedureColumnOut
procedureColumnResult
procedureColumnReturn
procedureColumnUnknown

Definition at line 179 of file databasemetadata.h.

anonymous enum

Procedure column nullability constants for getProcedureColumns().

See also:: getProcedureColumns()

Enumerator:

procedureNoNulls
procedureNullable
procedureNullableUnknown

Definition at line 191 of file databasemetadata.h.

anonymous enum

Procedure type constants for PROCEDURE_TYPE in getProcedures().

See also:: getProcedures()

Enumerator:

procedureReturnsResult
procedureNoResult
procedureResultUnknown

Definition at line 200 of file databasemetadata.h.

Member Function Documentation

bool odbc::DatabaseMetaData::dataDefinitionCausesTransactionCommit ( )

Checks if DDL in a transaction will cause the transaction to be committed.

Returns:: true if the data source only supports data manipulation (eg. UPDATE, INSERT) within a transaction and any data definition (eg. CREATE TABLE) will cause the transaction to be committed.

If this method returns true, supportsDataDefinitionAndDataManipulationTransactions(), supportsDataManipulationTransactionsOnly() and dataDefinitionIgnoredInTransactions() all return false.

bool odbc::DatabaseMetaData::dataDefinitionCausesTransactionCommit ( )

Checks if DDL in a transaction will cause the transaction to be committed.

Returns:: true if the data source only supports data manipulation (eg. UPDATE, INSERT) within a transaction and any data definition (eg. CREATE TABLE) will cause the transaction to be committed.

If this method returns true, supportsDataDefinitionAndDataManipulationTransactions(), supportsDataManipulationTransactionsOnly() and dataDefinitionIgnoredInTransactions() all return false.

bool odbc::DatabaseMetaData::dataDefinitionIgnoredInTransactions ( )

Checks if DDL in a transaction is ignored.

Returns:: true if the data source only supports data manipulation (eg. UPDATE, INSERT) within a transaction and any data definition (eg. CREATE TABLE) will be ignored.

If this method returns true, supportsDataDefinitionAndDataManipulationTransactions(), supportsDataManipulationTransactionsOnly() and dataDefinitionCausesTransactionCommit() all return false.

bool odbc::DatabaseMetaData::dataDefinitionIgnoredInTransactions ( )

Checks if DDL in a transaction is ignored.

Returns:: true if the data source only supports data manipulation (eg. UPDATE, INSERT) within a transaction and any data definition (eg. CREATE TABLE) will be ignored.

If this method returns true, supportsDataDefinitionAndDataManipulationTransactions(), supportsDataManipulationTransactionsOnly() and dataDefinitionCausesTransactionCommit() all return false.

bool odbc::DatabaseMetaData::deletesAreDetected ( int type )

Returns true if a deleted row can be detected with ResultSet::rowDeleted().

Parameters:

type

The type of ResultSet of interest

bool odbc::DatabaseMetaData::deletesAreDetected ( int type )

Returns true if a deleted row can be detected with ResultSet::rowDeleted().

Parameters:

type

The type of ResultSet of interest

ResultSet* odbc::DatabaseMetaData::getBestRowIdentifier	(	const ODBCXX_STRING &	catalog,
		const ODBCXX_STRING &	schema,
		const ODBCXX_STRING &	table,
		int	scope,
		bool	nullable
	)

Returns the optimal set of columns that identifies a row.

The returned ResultSet is ordered by SCOPE and has the following columns:

SCOPE - short - scope of this result:
- bestRowTemporary - temporary, only while a ResultSet is using the row
- bestRowTransaction - valid until the current transaction ends
- bestRowSession - valid through the whole session - until the connection is closed
COLUMN_NAME - string - the column name
DATA_TYPE - short - the type of the column from Types
TYPE_NAME - string - native type name (data source dependent)
COLUMN_SIZE - int - the size (precision) of the column.
BUFFER_LENGTH - int - unused
DECIMAL_DIGITS - short - scale if applicable. Can be NULL.
PSEUDO_COLUMN - short - whether this is a pseudo column:
- bestRowUnknown - it is unknown whether this is a pseudo column
- bestRowNotPseudo - it is definitely not a pseudo column
- bestRowPseudo - it is definitely a pseudo column

Parameters:

	catalog	the catalog name
	schema	the schema name
	table	the table name
	scope	the scope of interest, same values as the SCOPE column.
	nullable	whether nullable columns should be included

ResultSet* odbc::DatabaseMetaData::getBestRowIdentifier	(	const ODBCXX_STRING &	catalog,
		const ODBCXX_STRING &	schema,
		const ODBCXX_STRING &	table,
		int	scope,
		bool	nullable
	)

Returns the optimal set of columns that identifies a row.

The returned ResultSet is ordered by SCOPE and has the following columns:

SCOPE - short - scope of this result:
- bestRowTemporary - temporary, only while a ResultSet is using the row
- bestRowTransaction - valid until the current transaction ends
- bestRowSession - valid through the whole session - until the connection is closed
COLUMN_NAME - string - the column name
DATA_TYPE - short - the type of the column from Types
TYPE_NAME - string - native type name (data source dependent)
COLUMN_SIZE - int - the size (precision) of the column.
BUFFER_LENGTH - int - unused
DECIMAL_DIGITS - short - scale if applicable. Can be NULL.
PSEUDO_COLUMN - short - whether this is a pseudo column:
- bestRowUnknown - it is unknown whether this is a pseudo column
- bestRowNotPseudo - it is definitely not a pseudo column
- bestRowPseudo - it is definitely a pseudo column

Parameters:

	catalog	the catalog name
	schema	the schema name
	table	the table name
	scope	the scope of interest, same values as the SCOPE column.
	nullable	whether nullable columns should be included

ResultSet* odbc::DatabaseMetaData::getCatalogs ( )

Returns a list of available catalogs in the database.

The returned ResultSet is the same as with getTables(), except that all columns but TABLE_CAT are NULL values.

ResultSet* odbc::DatabaseMetaData::getCatalogs ( )

Returns a list of available catalogs in the database.

The returned ResultSet is the same as with getTables(), except that all columns but TABLE_CAT are NULL values.

ODBCXX_STRING odbc::DatabaseMetaData::getCatalogSeparator ( )

Returns the string used to separate a catalog in a fully qualified identifier.

For example Oracle would return a "@", while mysql would say ".".

ODBCXX_STRING odbc::DatabaseMetaData::getCatalogSeparator ( )

Returns the string used to separate a catalog in a fully qualified identifier.

For example Oracle would return a "@", while mysql would say ".".

ODBCXX_STRING odbc::DatabaseMetaData::getCatalogTerm ( )

Returns the term for catalog used by the data source.

Can be for example "directory" or "database".

ODBCXX_STRING odbc::DatabaseMetaData::getCatalogTerm ( )

Returns the term for catalog used by the data source.

Can be for example "directory" or "database".

ResultSet* odbc::DatabaseMetaData::getColumnPrivileges	(	const ODBCXX_STRING &	catalog,
		const ODBCXX_STRING &	schema,
		const ODBCXX_STRING &	table,
		const ODBCXX_STRING &	columnNamePattern
	)

Fetches a list of access rights for a table's columns.

The returned ResultSet is ordered by COLUMN_NAME and PRIVILEGE. It contains the following columns:

TABLE_CAT - string - table catalog (can be NULL)
TABLE_SCHEM - string - table schema (can be NULL)
TABLE_NAME - string - table name
COLUMN_NAME - string - column name
GRANTOR - string - grantor (can be NULL). If GRANTEE owns the object, GRANTOR is "SYSTEM".
GRANTEE - string - grantee
PRIVILEGE - string - one of "SELECT", "INSERT", "UPDATE", "DELETE", "REFERENCES" or a data source specific value
IS_GRANTABLE - string - "YES" if GRANTEE can grant this privilege to other users. "NO" if not. NULL if unknown.

ResultSet* odbc::DatabaseMetaData::getColumnPrivileges	(	const ODBCXX_STRING &	catalog,
		const ODBCXX_STRING &	schema,
		const ODBCXX_STRING &	table,
		const ODBCXX_STRING &	columnNamePattern
	)

Fetches a list of access rights for a table's columns.

The returned ResultSet is ordered by COLUMN_NAME and PRIVILEGE. It contains the following columns:

TABLE_CAT - string - table catalog (can be NULL)
TABLE_SCHEM - string - table schema (can be NULL)
TABLE_NAME - string - table name
COLUMN_NAME - string - column name
GRANTOR - string - grantor (can be NULL). If GRANTEE owns the object, GRANTOR is "SYSTEM".
GRANTEE - string - grantee
PRIVILEGE - string - one of "SELECT", "INSERT", "UPDATE", "DELETE", "REFERENCES" or a data source specific value
IS_GRANTABLE - string - "YES" if GRANTEE can grant this privilege to other users. "NO" if not. NULL if unknown.

ResultSet* odbc::DatabaseMetaData::getColumns	(	const ODBCXX_STRING &	catalog,
		const ODBCXX_STRING &	schemaPattern,
		const ODBCXX_STRING &	tableNamePattern,
		const ODBCXX_STRING &	columnNamePattern
	)

Fetches the available columns in a catalog.

The returned ResultSet has the following columns:

TABLE_CAT - string - table catalog (can be NULL)
TABLE_SCHEM - string - table schema (can be NULL)
TABLE_NAME - string - table name
COLUMN_NAME - string - column name
COLUMN_TYPE - short - see Types
TYPE_NAME - string - the name of the type. Data source dependent.
COLUMN_SIZE - int - column size. For character and date types, this is the maximum number of characters. For numeric types this is the precision.
BUFFER_LENGTH - not used
DECIMAL_DIGITS - int - the number of fractional digits.
NUM_PREC_RADIX - int - radix
NULLABLE - int - whether the column allows NULLs
- columnNoNulls - might not allow NULLs
- columnNullable - definitely allows NULLs
- columnNullableUnknown - nullability is unknown
REMARKS - string - comments on the column (can be NULL)
COLUMN_DEF - string - default value (can be NULL)
SQL_DATA_TYPE - short -
SQL_DATETIME_SUB - short -
CHAR_OCTET_LENGTH - int - for character data types the maximum number of bytes in the column
ORDINAL_POSITION - int - 1-based index in the table
IS_NULLABLE - string - "NO" means in no way nullable, "YES" means possibly nullable. Empty string means nobody knows.

ResultSet* odbc::DatabaseMetaData::getColumns	(	const ODBCXX_STRING &	catalog,
		const ODBCXX_STRING &	schemaPattern,
		const ODBCXX_STRING &	tableNamePattern,
		const ODBCXX_STRING &	columnNamePattern
	)

Fetches the available columns in a catalog.

The returned ResultSet has the following columns:

TABLE_CAT - string - table catalog (can be NULL)
TABLE_SCHEM - string - table schema (can be NULL)
TABLE_NAME - string - table name
COLUMN_NAME - string - column name
COLUMN_TYPE - short - see Types
TYPE_NAME - string - the name of the type. Data source dependent.
COLUMN_SIZE - int - column size. For character and date types, this is the maximum number of characters. For numeric types this is the precision.
BUFFER_LENGTH - not used
DECIMAL_DIGITS - int - the number of fractional digits.
NUM_PREC_RADIX - int - radix
NULLABLE - int - whether the column allows NULLs
- columnNoNulls - might not allow NULLs
- columnNullable - definitely allows NULLs
- columnNullableUnknown - nullability is unknown
REMARKS - string - comments on the column (can be NULL)
COLUMN_DEF - string - default value (can be NULL)
SQL_DATA_TYPE - short -
SQL_DATETIME_SUB - short -
CHAR_OCTET_LENGTH - int - for character data types the maximum number of bytes in the column
ORDINAL_POSITION - int - 1-based index in the table
IS_NULLABLE - string - "NO" means in no way nullable, "YES" means possibly nullable. Empty string means nobody knows.

ResultSet* odbc::DatabaseMetaData::getCrossReference	(	const ODBCXX_STRING &	primaryCatalog,
		const ODBCXX_STRING &	primarySchema,
		const ODBCXX_STRING &	primaryTable,
		const ODBCXX_STRING &	foreignCatalog,
		const ODBCXX_STRING &	foreignSchema,
		const ODBCXX_STRING &	foreignTable
	)

Figures out in which way a foreign key table references a primary key table.

Returns it's findings in a ResultSet, ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME and KEY_SEQ. The ResultSet contains the following columns:

PKTABLE_CAT - string - primary key table catalog
PKTABLE_SCHEM - string - primary key table schema
PKTABLE_NAME - string - primary key table name
PKCOLUMN_NAME - string - primary key column name
FKTABLE_CAT - string - foreign key table catalog
FKTABLE_SCHEM - string - foreign key table schema
FKTABLE_NAME - string - foreign key table name
FKCOLUMN_NAME - string - foreign key column name
KEY_SEQ - short - column sequence number in key (1-based)
UPDATE_RULE - short - what happens to the foreign key when the primary is updated:
- importedKeyNoAction - nothing happends since the primary key can not be updated
- importedKeyCascade - change imported key to match the primary key
- importedKeySetNull - update the imported key to NULL
- importedKeySetDefault - update the impored key to it's default value
- importedKeyRestrict - same as importedKeyNoAction
DELETE_RULE - short - what happens to the foreign key when the primary is deleted:
- importedKeyNoAction - nothing happends since the primary key can not be deleted
- importedKeyCascade - imported key is deleted as well
- importedKeySetNull - imported key is set to NULL
- importedKeySetDefault - imported key is set to it's default value
- importedKeyRestrict - same as importedKeyNoAction

ResultSet* odbc::DatabaseMetaData::getCrossReference	(	const ODBCXX_STRING &	primaryCatalog,
		const ODBCXX_STRING &	primarySchema,
		const ODBCXX_STRING &	primaryTable,
		const ODBCXX_STRING &	foreignCatalog,
		const ODBCXX_STRING &	foreignSchema,
		const ODBCXX_STRING &	foreignTable
	)

Figures out in which way a foreign key table references a primary key table.

Returns it's findings in a ResultSet, ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME and KEY_SEQ. The ResultSet contains the following columns:

PKTABLE_CAT - string - primary key table catalog
PKTABLE_SCHEM - string - primary key table schema
PKTABLE_NAME - string - primary key table name
PKCOLUMN_NAME - string - primary key column name
FKTABLE_CAT - string - foreign key table catalog
FKTABLE_SCHEM - string - foreign key table schema
FKTABLE_NAME - string - foreign key table name
FKCOLUMN_NAME - string - foreign key column name
KEY_SEQ - short - column sequence number in key (1-based)
UPDATE_RULE - short - what happens to the foreign key when the primary is updated:
- importedKeyNoAction - nothing happends since the primary key can not be updated
- importedKeyCascade - change imported key to match the primary key
- importedKeySetNull - update the imported key to NULL
- importedKeySetDefault - update the impored key to it's default value
- importedKeyRestrict - same as importedKeyNoAction
DELETE_RULE - short - what happens to the foreign key when the primary is deleted:
- importedKeyNoAction - nothing happends since the primary key can not be deleted
- importedKeyCascade - imported key is deleted as well
- importedKeySetNull - imported key is set to NULL
- importedKeySetDefault - imported key is set to it's default value
- importedKeyRestrict - same as importedKeyNoAction

int odbc::DatabaseMetaData::getDefaultTransactionIsolation ( )

Returns the default transaction isolation level.

See also:: Connection

int odbc::DatabaseMetaData::getDefaultTransactionIsolation ( )

Returns the default transaction isolation level.

See also:: Connection

int odbc::DatabaseMetaData::getDriverMajorVersion ( )

Returns the major ODBC version of the driver used.

int odbc::DatabaseMetaData::getDriverMajorVersion ( )

Returns the major ODBC version of the driver used.

int odbc::DatabaseMetaData::getDriverMinorVersion ( )

Returns the minor ODBC version of the driver used.

int odbc::DatabaseMetaData::getDriverMinorVersion ( )

Returns the minor ODBC version of the driver used.

ResultSet* odbc::DatabaseMetaData::getExportedKeys	(	const ODBCXX_STRING &	catalog,
		const ODBCXX_STRING &	schema,
		const ODBCXX_STRING &	table
	)			`[inline]`

Fetches a list of columns that reference a table's primary keys.

The returned ResultSet is identical to the one returned by getCrossReference().

Definition at line 1172 of file databasemetadata.h.

ResultSet* odbc::DatabaseMetaData::getExportedKeys	(	const ODBCXX_STRING &	catalog,
		const ODBCXX_STRING &	schema,
		const ODBCXX_STRING &	table
	)			`[inline]`

Fetches a list of columns that reference a table's primary keys.

The returned ResultSet is identical to the one returned by getCrossReference().

Definition at line 1172 of file databasemetadata.h.

ODBCXX_STRING odbc::DatabaseMetaData::getIdentifierQuoteString ( )

Returns the string that can be used to quote identifiers.

If the data source doesn't support it, returns an empty string.

ODBCXX_STRING odbc::DatabaseMetaData::getIdentifierQuoteString ( )

Returns the string that can be used to quote identifiers.

If the data source doesn't support it, returns an empty string.

ResultSet* odbc::DatabaseMetaData::getImportedKeys	(	const ODBCXX_STRING &	catalog,
		const ODBCXX_STRING &	schema,
		const ODBCXX_STRING &	table
	)			`[inline]`

Fetches a list of columns that are foreign keys to other tables' primary keys.

The returned ResultSet is identical to the one returned by getCrossReference(), except it's ordered by PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME and KEY_SEQ.

Definition at line 1155 of file databasemetadata.h.

ResultSet* odbc::DatabaseMetaData::getImportedKeys	(	const ODBCXX_STRING &	catalog,
		const ODBCXX_STRING &	schema,
		const ODBCXX_STRING &	table
	)			`[inline]`

Fetches a list of columns that are foreign keys to other tables' primary keys.

The returned ResultSet is identical to the one returned by getCrossReference(), except it's ordered by PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME and KEY_SEQ.

Definition at line 1155 of file databasemetadata.h.

ResultSet* odbc::DatabaseMetaData::getIndexInfo	(	const ODBCXX_STRING &	catalog,
		const ODBCXX_STRING &	schema,
		const ODBCXX_STRING &	table,
		bool	unique,
		bool	approximate
	)

Fetches a list of indices and statistics for a table.

The returned ResultSet is ordered by NON_UNIQUE, TYPE, INDEX_QUALIFIER, INDEX_NAME and ORDINAL_POSITION. It contains the following columns:

TABLE_CAT - string - table catalog (can be NULL)
TABLE_SCHEM - string - table schema (can be NULL)
TABLE_NAME - string - table name
NON_UNIQUE - bool - true if index values can be non-unique. NULL if TYPE is tableIndexStatistic
INDEX_QUALIFIER - string - index catalog, NULL if TYPE is tableIndexStatistic
INDEX_NAME - string - index name, NULL if TYPE is tableIndexStatistic
TYPE - short - index type:
- tableIndexStatistic - no real index - a statistic for the table
- tableIndexClustered - this index is clustered
- tableIndexHashed - this index is hashed
- tableIndexOther - this is some other kind of index
ORDINAL_POSITION - short - column sequence number in index (1-based). NULL if TYPE is tableIndexStatistic.
COLUMN_NAME - string - column name. NULL if TYPE is tableIndexStatistic.
ASC_OR_DESC - string - "A" for ascending, "D" for descending index. NULL if TYPE is tableIndexStatistic.
CARDINALITY - int - If TYPE is tableIndexStatistic, the number of rows in the table. Otherwise, the number of unique values in the index.
PAGES - int - Number of pages used for the table if TYPE is tableIndexStatistic. Otherwise the number of pages used for the index.
FILTER_CONDITION - string - filter condition (if any)

Parameters:

	catalog	the catalog name
	schema	the schema name
	table	the table name
	unique	whether only unique indices should be looked at
	approximate	whether only accurate values should be retrieved

ResultSet* odbc::DatabaseMetaData::getIndexInfo	(	const ODBCXX_STRING &	catalog,
		const ODBCXX_STRING &	schema,
		const ODBCXX_STRING &	table,
		bool	unique,
		bool	approximate
	)

Fetches a list of indices and statistics for a table.

The returned ResultSet is ordered by NON_UNIQUE, TYPE, INDEX_QUALIFIER, INDEX_NAME and ORDINAL_POSITION. It contains the following columns:

TABLE_CAT - string - table catalog (can be NULL)
TABLE_SCHEM - string - table schema (can be NULL)
TABLE_NAME - string - table name
NON_UNIQUE - bool - true if index values can be non-unique. NULL if TYPE is tableIndexStatistic
INDEX_QUALIFIER - string - index catalog, NULL if TYPE is tableIndexStatistic
INDEX_NAME - string - index name, NULL if TYPE is tableIndexStatistic
TYPE - short - index type:
- tableIndexStatistic - no real index - a statistic for the table
- tableIndexClustered - this index is clustered
- tableIndexHashed - this index is hashed
- tableIndexOther - this is some other kind of index
ORDINAL_POSITION - short - column sequence number in index (1-based). NULL if TYPE is tableIndexStatistic.
COLUMN_NAME - string - column name. NULL if TYPE is tableIndexStatistic.
ASC_OR_DESC - string - "A" for ascending, "D" for descending index. NULL if TYPE is tableIndexStatistic.
CARDINALITY - int - If TYPE is tableIndexStatistic, the number of rows in the table. Otherwise, the number of unique values in the index.
PAGES - int - Number of pages used for the table if TYPE is tableIndexStatistic. Otherwise the number of pages used for the index.
FILTER_CONDITION - string - filter condition (if any)

Parameters:

	catalog	the catalog name
	schema	the schema name
	table	the table name
	unique	whether only unique indices should be looked at
	approximate	whether only accurate values should be retrieved

int odbc::DatabaseMetaData::getMaxTablesInSelect ( )

Returns the maximum number of tables that can be joined at once.

Returns:: zero if unknown.

int odbc::DatabaseMetaData::getMaxTablesInSelect ( )

Returns the maximum number of tables that can be joined at once.

Returns:: zero if unknown.

ResultSet* odbc::DatabaseMetaData::getPrimaryKeys	(	const ODBCXX_STRING &	catalog,
		const ODBCXX_STRING &	schema,
		const ODBCXX_STRING &	table
	)

Fetches a list of primary keys for a table.

The returned ResultSet is ordered by TABLE_CAT, TABLE_SCHEM, TABLE_NAME and KEY_SEQ. It contains the following columns:

TABLE_CAT - string - table catalog (can be NULL)
TABLE_SCHEM - string - table schema (can be NULL)
TABLE_NAME - string - table name
COLUMN_NAME - string - column name
KEY_SEQ - string - sequence number in primary key (1-based)
PK_NAME - string - primary key (constraint) name. Can be NULL.

ResultSet* odbc::DatabaseMetaData::getPrimaryKeys	(	const ODBCXX_STRING &	catalog,
		const ODBCXX_STRING &	schema,
		const ODBCXX_STRING &	table
	)

Fetches a list of primary keys for a table.

The returned ResultSet is ordered by TABLE_CAT, TABLE_SCHEM, TABLE_NAME and KEY_SEQ. It contains the following columns:

TABLE_CAT - string - table catalog (can be NULL)
TABLE_SCHEM - string - table schema (can be NULL)
TABLE_NAME - string - table name
COLUMN_NAME - string - column name
KEY_SEQ - string - sequence number in primary key (1-based)
PK_NAME - string - primary key (constraint) name. Can be NULL.

ResultSet* odbc::DatabaseMetaData::getProcedureColumns	(	const ODBCXX_STRING &	catalog,
		const ODBCXX_STRING &	schemaPattern,
		const ODBCXX_STRING &	procedureNamePattern,
		const ODBCXX_STRING &	columnNamePattern
	)

Returns available procedure columns in a catalog.

The returned ResultSet is ordered by PROCEDURE_CAT, PROCEDURE_SCHEM, PROCEDURE_NAME and COLUMN_NAME. It contains the following columns:

PROCEDURE_CAT - string - the procedure catalog
PROCEDURE_SCHEM - string - the procedure schema
PROCEDURE_NAME - string - the procedure name
COLUMN_NAME - string - the column name
COLUMN_TYPE - short - the column type
- procedureColumnUnknown - beats the driver
- procedureColumnIn - IN parameter
- procedureColumnInOut - IN OUT parameter
- procedureColumnOut - OUT parameter
- procedureColumnReturn - procedure return value (eg. this procedure is actually a function)
- procedureColumnResult - this column is part of a ResultSet this procedure returns
DATA_TYPE - int - SQL type of the column
TYPE_NAME - string - native type name
COLUMN_SIZE - int - the precision of the column
BUFFER_LENGTH - int - nothing of interest
DECIMAL_DIGITS - short - scale, if applicable
NUM_PREC_RADIX - short - radix, if applicable
NULLABLE - short - whether the column is nullable
- procedureNoNulls - not nullable
- procedureNullable - nullable
- procedureNullableUnknown - nobody knows
REMARKS - string - comments on the column

Note: more columns can be returned depending on the driver.

ResultSet* odbc::DatabaseMetaData::getProcedureColumns	(	const ODBCXX_STRING &	catalog,
		const ODBCXX_STRING &	schemaPattern,
		const ODBCXX_STRING &	procedureNamePattern,
		const ODBCXX_STRING &	columnNamePattern
	)

Returns available procedure columns in a catalog.

The returned ResultSet is ordered by PROCEDURE_CAT, PROCEDURE_SCHEM, PROCEDURE_NAME and COLUMN_NAME. It contains the following columns:

PROCEDURE_CAT - string - the procedure catalog
PROCEDURE_SCHEM - string - the procedure schema
PROCEDURE_NAME - string - the procedure name
COLUMN_NAME - string - the column name
COLUMN_TYPE - short - the column type
- procedureColumnUnknown - beats the driver
- procedureColumnIn - IN parameter
- procedureColumnInOut - IN OUT parameter
- procedureColumnOut - OUT parameter
- procedureColumnReturn - procedure return value (eg. this procedure is actually a function)
- procedureColumnResult - this column is part of a ResultSet this procedure returns
DATA_TYPE - int - SQL type of the column
TYPE_NAME - string - native type name
COLUMN_SIZE - int - the precision of the column
BUFFER_LENGTH - int - nothing of interest
DECIMAL_DIGITS - short - scale, if applicable
NUM_PREC_RADIX - short - radix, if applicable
NULLABLE - short - whether the column is nullable
- procedureNoNulls - not nullable
- procedureNullable - nullable
- procedureNullableUnknown - nobody knows
REMARKS - string - comments on the column

Note: more columns can be returned depending on the driver.

ResultSet* odbc::DatabaseMetaData::getProcedures	(	const ODBCXX_STRING &	catalog,
		const ODBCXX_STRING &	schemaPattern,
		const ODBCXX_STRING &	procedureNamePattern
	)

Returns available procedures in a catalog.

The returned ResultSet is ordered by PROCEDURE_CAT, PROCEDURE_SCHEM and PROCEDURE_NAME. It contains the following columns:

PROCEDURE_CAT - string - the procedure catalog
PROCEDURE_SCHEM - string - the procedure schema
PROCEDURE_NAME - string - the procedure name
NUM_INPUT_PARAMS - reserved for future use
NUM_OUTPUT_PARAMS - reserved for future use
NUM_RESULT_SETS - reserved for future use
REMARKS - string - comments on the procedure
PROCEDURE_TYPE - short - the procedure type:
- procedureResultUnknown - can possibly return a result, but nobody is sure
- procedureNoResult - does not return a result
- procedureReturnsResult - returns a result

ResultSet* odbc::DatabaseMetaData::getProcedures	(	const ODBCXX_STRING &	catalog,
		const ODBCXX_STRING &	schemaPattern,
		const ODBCXX_STRING &	procedureNamePattern
	)

Returns available procedures in a catalog.

The returned ResultSet is ordered by PROCEDURE_CAT, PROCEDURE_SCHEM and PROCEDURE_NAME. It contains the following columns:

PROCEDURE_CAT - string - the procedure catalog
PROCEDURE_SCHEM - string - the procedure schema
PROCEDURE_NAME - string - the procedure name
NUM_INPUT_PARAMS - reserved for future use
NUM_OUTPUT_PARAMS - reserved for future use
NUM_RESULT_SETS - reserved for future use
REMARKS - string - comments on the procedure
PROCEDURE_TYPE - short - the procedure type:
- procedureResultUnknown - can possibly return a result, but nobody is sure
- procedureNoResult - does not return a result
- procedureReturnsResult - returns a result

ResultSet* odbc::DatabaseMetaData::getSchemas ( )

Returns a list of available schemas in the database.

The returned ResultSet is the same as with getTables(), except that all columns but TABLE_SCHEM contain NULL values.

ResultSet* odbc::DatabaseMetaData::getSchemas ( )

Returns a list of available schemas in the database.

The returned ResultSet is the same as with getTables(), except that all columns but TABLE_SCHEM contain NULL values.

ResultSet* odbc::DatabaseMetaData::getTablePrivileges	(	const ODBCXX_STRING &	catalog,
		const ODBCXX_STRING &	schemaPattern,
		const ODBCXX_STRING &	tableNamePattern
	)

Fetches a list of access rights for tables in a catalog.

A table privilege applies to one or more columns in a table. Do not assume that this privilege is valid for all columns.

The returned ResultSet is ordered by TABLE_CAT, TABLE_SCHEM, TABLE_NAME and PRIVILEGE. It contains the following columns:

TABLE_CAT - string - table catalog (can be NULL)
TABLE_SCHEM - string - table schema (can be NULL)
TABLE_NAME - string - table name
GRANTOR - string - grantor (can be NULL). If GRANTEE owns the object, GRANTOR is "SYSTEM".
GRANTEE - string - grantee
PRIVILEGE - string - one of "SELECT", "INSERT", "UPDATE", "DELETE", "REFERENCES" or a data source specific value
IS_GRANTABLE - string - "YES" if GRANTEE can grant this privilege to other users. "NO" if not. NULL if unknown.

ResultSet* odbc::DatabaseMetaData::getTablePrivileges	(	const ODBCXX_STRING &	catalog,
		const ODBCXX_STRING &	schemaPattern,
		const ODBCXX_STRING &	tableNamePattern
	)

Fetches a list of access rights for tables in a catalog.

A table privilege applies to one or more columns in a table. Do not assume that this privilege is valid for all columns.

The returned ResultSet is ordered by TABLE_CAT, TABLE_SCHEM, TABLE_NAME and PRIVILEGE. It contains the following columns:

TABLE_CAT - string - table catalog (can be NULL)
TABLE_SCHEM - string - table schema (can be NULL)
TABLE_NAME - string - table name
GRANTOR - string - grantor (can be NULL). If GRANTEE owns the object, GRANTOR is "SYSTEM".
GRANTEE - string - grantee
PRIVILEGE - string - one of "SELECT", "INSERT", "UPDATE", "DELETE", "REFERENCES" or a data source specific value
IS_GRANTABLE - string - "YES" if GRANTEE can grant this privilege to other users. "NO" if not. NULL if unknown.

ResultSet* odbc::DatabaseMetaData::getTables	(	const ODBCXX_STRING &	catalog,
		const ODBCXX_STRING &	schemaPattern,
		const ODBCXX_STRING &	tableNamePattern,
		const std::vector< ODBCXX_STRING > &	types
	)

Fetches the available tables in the data source.

The returned ResultSet has the following columns:

TABLE_CAT - string - table catalog (can be NULL)
TABLE_SCHEM - string - table schema (can be NULL)
TABLE_NAME - string - table name
TABLE_TYPE - string - table type
REMARKS - string - comments on the table

Parameters:

	catalog	the catalog name
	schemaPattern	schema name search pattern
	tableNamePattern	table name search pattern
	types	a list of table types. An empty list returns all table types.

ResultSet* odbc::DatabaseMetaData::getTables	(	const ODBCXX_STRING &	catalog,
		const ODBCXX_STRING &	schemaPattern,
		const ODBCXX_STRING &	tableNamePattern,
		const std::vector< ODBCXX_STRING > &	types
	)

Fetches the available tables in the data source.

The returned ResultSet has the following columns:

TABLE_CAT - string - table catalog (can be NULL)
TABLE_SCHEM - string - table schema (can be NULL)
TABLE_NAME - string - table name
TABLE_TYPE - string - table type
REMARKS - string - comments on the table

Parameters:

	catalog	the catalog name
	schemaPattern	schema name search pattern
	tableNamePattern	table name search pattern
	types	a list of table types. An empty list returns all table types.

ResultSet* odbc::DatabaseMetaData::getTableTypes ( )

Fetches the table types the database supports.

The returned ResultSet is the same as with getTables(), except that all columns but TABLE_TYPE contain NULL values.

ResultSet* odbc::DatabaseMetaData::getTableTypes ( )

Fetches the table types the database supports.

The returned ResultSet is the same as with getTables(), except that all columns but TABLE_TYPE contain NULL values.

ResultSet* odbc::DatabaseMetaData::getTypeInfo ( )

Fetches a list of data types supported by this data source.

The returned ResultSet is ordered by DATA_TYPE and then by how closely the type maps to the corresponding ODBC SQL type. It contains the following columns:

TYPE_NAME - string - native type name
DATA_TYPE - short - SQL data type from Types
COLUMN_SIZE - int - maximum precision
LITERAL_PREFIX - string - prefix used to quote a literal. Can be NULL.
LITERAL_SUFFIX - string - suffix used to quote a literal. Can be NULL.
CREATE_PARAMS - string - comma separated possible list of parameters to creating a column of this type
NULLABLE - short - whether this type can contain NULLs:
- typeNoNulls - no
- typeNullable - yes, can be nullable
- typeNullableUnknown - nobody knows
CASE_SENSITIVE - bool - whether this type is case sensitive
SEARCHABLE - bool - whether this type can be searched, eg used in WHERE-clauses:
- typePredNone - no
- typePredChar - yes, but only with a LIKE predicate
- typePredBasic - yes, except in a LIKE predicate
- typeSearchable - yes
UNSIGNED_ATTRIBUTE - bool - true if this type is unsigned
FIXED_PREC_SCALE - bool - whether this type has predefined fixed precision and scale (eg is useful for money)
AUTO_UNIQUE_VALUE - bool - whether this type can be used for an autoincrementing value. NULL if not applicable.
LOCAL_TYPE_NAME - string - localized native type name. Can be NULL.
MINIMUM_SCALE - short - minimum supported scale, if applicable
MAXIMUM_SCALE - short - maximum supported scale, if applicable
SQL_DATA_TYPE - short - unused
SQL_DATETIME_SUB - short - unused
NUM_PREC_RADIX - int - radix, if applicable

ResultSet* odbc::DatabaseMetaData::getTypeInfo ( )

Fetches a list of data types supported by this data source.

The returned ResultSet is ordered by DATA_TYPE and then by how closely the type maps to the corresponding ODBC SQL type. It contains the following columns:

TYPE_NAME - string - native type name
DATA_TYPE - short - SQL data type from Types
COLUMN_SIZE - int - maximum precision
LITERAL_PREFIX - string - prefix used to quote a literal. Can be NULL.
LITERAL_SUFFIX - string - suffix used to quote a literal. Can be NULL.
CREATE_PARAMS - string - comma separated possible list of parameters to creating a column of this type
NULLABLE - short - whether this type can contain NULLs:
- typeNoNulls - no
- typeNullable - yes, can be nullable
- typeNullableUnknown - nobody knows
CASE_SENSITIVE - bool - whether this type is case sensitive
SEARCHABLE - bool - whether this type can be searched, eg used in WHERE-clauses:
- typePredNone - no
- typePredChar - yes, but only with a LIKE predicate
- typePredBasic - yes, except in a LIKE predicate
- typeSearchable - yes
UNSIGNED_ATTRIBUTE - bool - true if this type is unsigned
FIXED_PREC_SCALE - bool - whether this type has predefined fixed precision and scale (eg is useful for money)
AUTO_UNIQUE_VALUE - bool - whether this type can be used for an autoincrementing value. NULL if not applicable.
LOCAL_TYPE_NAME - string - localized native type name. Can be NULL.
MINIMUM_SCALE - short - minimum supported scale, if applicable
MAXIMUM_SCALE - short - maximum supported scale, if applicable
SQL_DATA_TYPE - short - unused
SQL_DATETIME_SUB - short - unused
NUM_PREC_RADIX - int - radix, if applicable

ResultSet* odbc::DatabaseMetaData::getVersionColumns	(	const ODBCXX_STRING &	catalog,
		const ODBCXX_STRING &	schema,
		const ODBCXX_STRING &	table
	)

Returns a list of columns for a table that are automatically updated when anything in a row is updated.

The returned ResultSet has the following unordered columns:

SCOPE - short - unused
COLUMN_NAME - string - the column name
DATA_TYPE - short - the type of the column from Types
TYPE_NAME - string - native type name (data source dependent)
COLUMN_SIZE - int - the size (precision) of the column.
BUFFER_LENGTH - int - unused
DECIMAL_DIGITS - short - scale if applicable. Can be NULL.
PSEUDO_COLUMN - short - whether this is a pseudo column:
- versionColumnUnknown - it is unknown whether this is a pseudo column
- versionColumnNotPseudo - it is definitely not a pseudo column
- versionColumnPseudo - it is definitely a pseudo column

ResultSet* odbc::DatabaseMetaData::getVersionColumns	(	const ODBCXX_STRING &	catalog,
		const ODBCXX_STRING &	schema,
		const ODBCXX_STRING &	table
	)

Returns a list of columns for a table that are automatically updated when anything in a row is updated.

The returned ResultSet has the following unordered columns:

SCOPE - short - unused
COLUMN_NAME - string - the column name
DATA_TYPE - short - the type of the column from Types
TYPE_NAME - string - native type name (data source dependent)
COLUMN_SIZE - int - the size (precision) of the column.
BUFFER_LENGTH - int - unused
DECIMAL_DIGITS - short - scale if applicable. Can be NULL.
PSEUDO_COLUMN - short - whether this is a pseudo column:
- versionColumnUnknown - it is unknown whether this is a pseudo column
- versionColumnNotPseudo - it is definitely not a pseudo column
- versionColumnPseudo - it is definitely a pseudo column

bool odbc::DatabaseMetaData::insertsAreDetected ( int type )

Returns true if an inserted row can be detected with ResultSet::rowInserted().

Parameters:

type

The type of ResultSet of interest

bool odbc::DatabaseMetaData::insertsAreDetected ( int type )

Returns true if an inserted row can be detected with ResultSet::rowInserted().

Parameters:

type

The type of ResultSet of interest

bool odbc::DatabaseMetaData::isCatalogAtStart ( )

Returns true if the catalog is positioned at the beginning of a fully qualified identifier.

For example mysql would say true, while oracle would say false.

bool odbc::DatabaseMetaData::isCatalogAtStart ( )

Returns true if the catalog is positioned at the beginning of a fully qualified identifier.

For example mysql would say true, while oracle would say false.

bool odbc::DatabaseMetaData::othersDeletesAreVisible ( int type )

Returns true if rows deleted by others disapear from a ResultSet.

Parameters:

type

The type of ResultSet of interest

bool odbc::DatabaseMetaData::othersDeletesAreVisible ( int type )

Returns true if rows deleted by others disapear from a ResultSet.

Parameters:

type

The type of ResultSet of interest

bool odbc::DatabaseMetaData::othersInsertsAreVisible ( int type )

Returns true if rows inserted by others become available in a ResultSet.

Parameters:

type

The type of ResultSet of interest

bool odbc::DatabaseMetaData::othersInsertsAreVisible ( int type )

Returns true if rows inserted by others become available in a ResultSet.

Parameters:

type

The type of ResultSet of interest

bool odbc::DatabaseMetaData::othersUpdatesAreVisible ( int type )

Returns true if rows updated by others are visible with their new values.

Parameters:

type

The type of ResultSet of interest

bool odbc::DatabaseMetaData::othersUpdatesAreVisible ( int type )

Returns true if rows updated by others are visible with their new values.

Parameters:

type

The type of ResultSet of interest

bool odbc::DatabaseMetaData::ownDeletesAreVisible ( int type )

Returns true if deleted rows dissapear from a ResultSet.

Parameters:

type

The type of ResultSet of interest

bool odbc::DatabaseMetaData::ownDeletesAreVisible ( int type )

Returns true if deleted rows dissapear from a ResultSet.

Parameters:

type

The type of ResultSet of interest

bool odbc::DatabaseMetaData::ownInsertsAreVisible ( int type )

Returns true if inserted rows become available in a ResultSet.

Parameters:

type

The type of ResultSet of interest

bool odbc::DatabaseMetaData::ownInsertsAreVisible ( int type )

Returns true if inserted rows become available in a ResultSet.

Parameters:

type

The type of ResultSet of interest

bool odbc::DatabaseMetaData::ownUpdatesAreVisible ( int type )

Returns true if updated rows are available with their new values in the ResultSet.

Parameters:

type

The type of ResultSet of interest

bool odbc::DatabaseMetaData::ownUpdatesAreVisible ( int type )

Returns true if updated rows are available with their new values in the ResultSet.

Parameters:

type

The type of ResultSet of interest

bool odbc::DatabaseMetaData::supportsDataDefinitionAndDataManipulationTransactions ( )

Checks if the data source supports both DML and DDL in transactions.

Returns:: true if the data source supports both data manipulation (eg. UPDATE, INSERT) and data definition (eg. CREATE TABLE) within a transaction.

If this method returns true, supportsDataManipulationTransactionsOnly(), dataDefinitionCausesTransactionCommit() and dataDefinitionIgnoredInTransactions() all return false.

bool odbc::DatabaseMetaData::supportsDataDefinitionAndDataManipulationTransactions ( )

Checks if the data source supports both DML and DDL in transactions.

Returns:: true if the data source supports both data manipulation (eg. UPDATE, INSERT) and data definition (eg. CREATE TABLE) within a transaction.

If this method returns true, supportsDataManipulationTransactionsOnly(), dataDefinitionCausesTransactionCommit() and dataDefinitionIgnoredInTransactions() all return false.

bool odbc::DatabaseMetaData::supportsDataManipulationTransactionsOnly ( )

Checks if the data source only supports DML in transactions.

Returns:: true if the data source only supports data manipulation (eg. UPDATE, INSERT) within a transaction.

Attempts to use data definition (eg. CREATE TABLE) in a transaction will trigger an error.

If this method returns true, supportsDataDefinitionAndDataManipulationTransactions(), dataDefinitionCausesTransactionCommit() and dataDefinitionIgnoredInTransactions() all return false.

bool odbc::DatabaseMetaData::supportsDataManipulationTransactionsOnly ( )

Checks if the data source only supports DML in transactions.

Returns:: true if the data source only supports data manipulation (eg. UPDATE, INSERT) within a transaction.

Attempts to use data definition (eg. CREATE TABLE) in a transaction will trigger an error.

If this method returns true, supportsDataDefinitionAndDataManipulationTransactions(), dataDefinitionCausesTransactionCommit() and dataDefinitionIgnoredInTransactions() all return false.

bool odbc::DatabaseMetaData::supportsOpenCursorsAcrossCommit ( )

Returns true if the data source and the driver can handle open cursors (eg.

ResultSets) across a commit, or false if they are invalidated.

bool odbc::DatabaseMetaData::supportsOpenCursorsAcrossCommit ( )

Returns true if the data source and the driver can handle open cursors (eg.

ResultSets) across a commit, or false if they are invalidated.

bool odbc::DatabaseMetaData::supportsOpenCursorsAcrossRollback ( )

Returns true if the data source and the driver can handle open cursors (eg.

ResultSets) across a rollback, or false if they are invalidated.

bool odbc::DatabaseMetaData::supportsOpenCursorsAcrossRollback ( )

Returns true if the data source and the driver can handle open cursors (eg.

ResultSets) across a rollback, or false if they are invalidated.

bool odbc::DatabaseMetaData::supportsPositionedDelete ( )

Checks if the data source supports positioned delete.

Returns:: true if ("DELETE WHERE CURRENT OF ...") is supported

bool odbc::DatabaseMetaData::supportsPositionedDelete ( )

Checks if the data source supports positioned delete.

Returns:: true if ("DELETE WHERE CURRENT OF ...") is supported

bool odbc::DatabaseMetaData::supportsPositionedUpdate ( )

Checks if the data source supports positioned update.

Returns:: true if ("UPDATE ... WHERE CURRENT OF ...") is supported

bool odbc::DatabaseMetaData::supportsPositionedUpdate ( )

Checks if the data source supports positioned update.

Returns:: true if ("UPDATE ... WHERE CURRENT OF ...") is supported

bool odbc::DatabaseMetaData::supportsResultSetConcurrency	(	int	type,
		int	concurrency
	)

Returns true if the data source supports the given result set concurrency for the given result set type.

Parameters:

	type	The type to check for.
	concurrency	The concurrency level to check for.

See also:: ResultSet

bool odbc::DatabaseMetaData::supportsResultSetConcurrency	(	int	type,
		int	concurrency
	)

Returns true if the data source supports the given result set concurrency for the given result set type.

Parameters:

	type	The type to check for.
	concurrency	The concurrency level to check for.

See also:: ResultSet

bool odbc::DatabaseMetaData::supportsResultSetType ( int type )

Returns true if the data source supports the given result set type.

Parameters:

type

The type to check for

See also:: ResultSet

bool odbc::DatabaseMetaData::supportsResultSetType ( int type )

Returns true if the data source supports the given result set type.

Parameters:

type

The type to check for

See also:: ResultSet

bool odbc::DatabaseMetaData::supportsSelectForUpdate ( )

Checks if the data source supports.

Returns:: true if ("SELECT ... FOR UPDATE") is supported

bool odbc::DatabaseMetaData::supportsSelectForUpdate ( )

Checks if the data source supports.

Returns:: true if ("SELECT ... FOR UPDATE") is supported

bool odbc::DatabaseMetaData::supportsTransactionIsolationLevel ( int lev )

Returns true if the data source supports the specified transaction isolation level.

Parameters:

lev

The isolation level to check for

bool odbc::DatabaseMetaData::supportsTransactionIsolationLevel ( int lev )

Returns true if the data source supports the specified transaction isolation level.

Parameters:

lev

The isolation level to check for

bool odbc::DatabaseMetaData::updatesAreDetected ( int type )

Returns true if ResultSet::rowUpdated can determine whether a row has been updated.

Parameters:

type

The type of ResultSet of interest

bool odbc::DatabaseMetaData::updatesAreDetected ( int type )

Returns true if ResultSet::rowUpdated can determine whether a row has been updated.

Parameters:

type

The type of ResultSet of interest

The documentation for this class was generated from the following files:

core/odbc++/databasemetadata.h
tape_ODBC/odbc++/databasemetadata.h

GridLAB-D^TM Version 1.0

An open-source project initiated by the US Department of Energy