TZMySQLDatabaseMetadata Class Reference

Implements MySQL Database Metadata. More...

Inheritance diagram for TZMySQLDatabaseMetadata:

TZAbstractDatabaseMetadata IZDatabaseMetadata

List of all members.

Public Member Functions

Boolean AllProceduresAreCallable ()
 Can all the procedures returned by getProcedures be called by the current user?
Boolean AllTablesAreSelectable ()
 Can all the tables returned by getTable be SELECTed by the current user?
 ClearCache (const string Key)
 Clears specific cached metadata.
 ClearCache ()
 Clears all cached metadata.
Boolean DataDefinitionCausesTransactionCommit ()
 Does a data definition statement within a transaction force the transaction to commit?
Boolean DataDefinitionIgnoredInTransactions ()
 Is a data definition statement within a transaction ignored?
Boolean DoesMaxRowSizeIncludeBlobs ()
 Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY blobs?
IZResultSet GetBestRowIdentifier (const string Catalog, const string Schema, const string Table, Integer Scope, Boolean Nullable)
 Gets a description of a table's optimal set of columns that uniquely identifies a row.
string GetBestRowIdentifierCacheKey (const string Catalog, const string Schema, const string Table, const Integer Scope, const Boolean Nullable)
 returns cache key for GetBestRowIdentifier metadata entry
 GetCacheKeys (TStrings List)
 fills string list with the keys for the currently cached metadata entries
IZResultSet GetCatalogs ()
 Gets the catalog names available in this database.
string GetCatalogsCacheKey ()
 returns cache key for GetCatalogs metadata entry
string GetCatalogSeparator ()
 What's the separator between catalog and table name?
string GetCatalogTerm ()
 What's the database vendor's preferred term for "catalog"?
IZResultSet GetColumnPrivileges (const string Catalog, const string Schema, const string Table, const string ColumnNamePattern)
 Gets a description of the access rights for a table's columns.
string GetColumnPrivilegesCacheKey (const string Catalog, const string Schema, const string Table, const string ColumnNamePattern)
 returns cache key for GetColumnPrivileges metadata entry
IZResultSet GetColumns (const string Catalog, const string SchemaPattern, const string TableNamePattern, const string ColumnNamePattern)
 Gets a description of table columns available in the specified catalog.
string GetColumnsCacheKey (const string Catalog, const string SchemaPattern, const string TableNamePattern, const string ColumnNamePattern)
 returns cache key for GetColumns metadata entry
IZConnection GetConnection ()
 Retrieves the connection that produced this metadata object.
IZResultSet GetCrossReference (const string PrimaryCatalog, const string PrimarySchema, const string PrimaryTable, const string ForeignCatalog, const string ForeignSchema, const string ForeignTable)
 Gets a description of the foreign key columns in the foreign key table that reference the primary key columns of the primary key table (describe how one table imports another's key.
string GetCrossReferenceCacheKey (const string PrimaryCatalog, const string PrimarySchema, const string PrimaryTable, const string ForeignCatalog, const string ForeignSchema, const string ForeignTable)
 returns cache key for GetCrossReference metadata entry
string GetDatabaseProductName ()
 What's the name of this database product?
string GetDatabaseProductVersion ()
 What's the version of this database product?
TZTransactIsolationLevel GetDefaultTransactionIsolation ()
 What's the database's default transaction isolation level? The values are defined in java.sql.Connection.
Integer GetDriverMajorVersion ()
 What's this JDBC driver's major version number?
Integer GetDriverMinorVersion ()
 What's this JDBC driver's minor version number?
string GetDriverName ()
 What's the name of this JDBC driver?
string GetDriverVersion ()
 What's the version of this JDBC driver?
IZResultSet GetExportedKeys (const string Catalog, const string Schema, const string Table)
 Gets a description of the foreign key columns that reference a table's primary key columns (the foreign keys exported by a table).
string GetExportedKeysCacheKey (const string Catalog, const string Schema, const string Table)
 returns cache key for GetExportedKeys metadata entry
string GetExtraNameCharacters ()
 Gets all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _).
IZIdentifierConvertor GetIdentifierConvertor ()
 Creates ab identifier convertor object.
string GetIdentifierQuoteString ()
 What's the string used to quote SQL identifiers? This returns a space " " if identifier quoting isn't supported.
IZResultSet GetImportedKeys (const string Catalog, const string Schema, const string Table)
 Gets a description of the primary key columns that are referenced by a table's foreign key columns (the primary keys imported by a table).
string GetImportedKeysCacheKey (const string Catalog, const string Schema, const string Table)
 returns cache key for GetImportedKeys metadata entry
IZResultSet GetIndexInfo (const string Catalog, const string Schema, const string Table, Boolean Unique, Boolean Approximate)
 Gets a description of a table's indices and statistics.
string GetIndexInfoCacheKey (const string Catalog, const string Schema, const string Table, const Boolean Unique, const Boolean Approximate)
 returns cache key for GetIndexInfo metadata entry
Integer GetMaxBinaryLiteralLength ()
 How many hex characters can you have in an inline binary literal?
Integer GetMaxCatalogNameLength ()
 What's the maximum length of a catalog name?
Integer GetMaxCharLiteralLength ()
 What's the max length for a character literal?
Integer GetMaxColumnNameLength ()
 What's the limit on column name length?
Integer GetMaxColumnsInGroupBy ()
 What's the maximum number of columns in a "GROUP BY" clause?
Integer GetMaxColumnsInIndex ()
 What's the maximum number of columns allowed in an index?
Integer GetMaxColumnsInOrderBy ()
 What's the maximum number of columns in an "ORDER BY" clause?
Integer GetMaxColumnsInSelect ()
 What's the maximum number of columns in a "SELECT" list?
Integer GetMaxColumnsInTable ()
 What's the maximum number of columns in a table?
Integer GetMaxConnections ()
 How many active connections can we have at a time to this database?
Integer GetMaxCursorNameLength ()
 What's the maximum cursor name length?
Integer GetMaxIndexLength ()
 Retrieves the maximum number of bytes for an index, including all of the parts of the index.
Integer GetMaxProcedureNameLength ()
 What's the maximum length of a procedure name?
Integer GetMaxRowSize ()
 What's the maximum length of a single row?
Integer GetMaxSchemaNameLength ()
 What's the maximum length allowed for a schema name?
Integer GetMaxStatementLength ()
 What's the maximum length of an SQL statement?
Integer GetMaxStatements ()
 How many active statements can we have open at one time to this database?
Integer GetMaxTableNameLength ()
 What's the maximum length of a table name?
Integer GetMaxTablesInSelect ()
 What's the maximum number of tables in a SELECT statement?
Integer GetMaxUserNameLength ()
 What's the maximum length of a user name?
string GetNumericFunctions ()
 Gets a comma-separated list of math functions.
IZResultSet GetPrimaryKeys (const string Catalog, const string Schema, const string Table)
 Gets a description of a table's primary key columns.
string GetPrimaryKeysCacheKey (const string Catalog, const string Schema, const string Table)
 returns cache key for GetPrimaryKeys metadata entry
IZResultSet GetProcedureColumns (const string Catalog, const string SchemaPattern, const string ProcedureNamePattern, const string ColumnNamePattern)
 Gets a description of a catalog's stored procedure parameters and result columns.
string GetProcedureColumnsCacheKey (const string Catalog, const string SchemaPattern, const string ProcedureNamePattern, const string ColumnNamePattern)
 returns cache key for GetProcedureColumns metadata entry
IZResultSet GetProcedures (const string Catalog, const string SchemaPattern, const string ProcedureNamePattern)
 Gets a description of the stored procedures available in a catalog.
string GetProceduresCacheKey (const string Catalog, const string SchemaPattern, const string ProcedureNamePattern)
 returns cache key for GetProcedures metadata entry
string GetProcedureTerm ()
 What's the database vendor's preferred term for "procedure"?
IZResultSet GetSchemas ()
 Gets the schema names available in this database.
string GetSchemasCacheKey ()
 returns cache key for GetSchemas metadata entry
string GetSchemaTerm ()
 What's the database vendor's preferred term for "schema"?
string GetSearchStringEscape ()
 Gets the string that can be used to escape wildcard characters.
IZResultSet GetSequences (const string Catalog, const string SchemaPattern, const string SequenceNamePattern)
string GetSequencesCacheKey (const string Catalog, const string SchemaPattern, const string SequenceNamePattern)
 returns cache key for GetSequences metadata entry
string GetSQLKeywords ()
 Gets a comma-separated list of all a database's SQL keywords that are NOT also SQL92 keywords.
string GetStringFunctions ()
 Gets a comma-separated list of string functions.
string GetSystemFunctions ()
 Gets a comma-separated list of system functions.
IZResultSet GetTablePrivileges (const string Catalog, const string SchemaPattern, const string TableNamePattern)
 Gets a description of the access rights for each table available in a catalog.
string GetTablePrivilegesCacheKey (const string Catalog, const string SchemaPattern, const string TableNamePattern)
 returns cache key for GetTablePrivileges metadata entry
IZResultSet GetTables (const string Catalog, const string SchemaPattern, const string TableNamePattern, const TStringDynArray Types)
 Gets a description of tables available in a catalog.
string GetTablesCacheKey (const string Catalog, const string SchemaPattern, const string TableNamePattern, const TStringDynArray Types)
 returns cache key for GetTables metadata entry
IZResultSet GetTableTypes ()
 Gets the table types available in this database.
string GetTableTypesCacheKey ()
 returns cache key for GetTableTypes metadata entry
string GetTimeDateFunctions ()
 Gets a comma-separated list of time and date functions.
IZResultSet GetTypeInfo ()
 Gets a description of all the standard SQL types supported by this database.
string GetTypeInfoCacheKey ()
 returns cache key for GetTypeInfo metadata entry
IZResultSet GetUDTs (const string Catalog, const string SchemaPattern, const string TypeNamePattern, const TIntegerDynArray Types)
 Gets a description of the user-defined types defined in a particular schema.
string GetUDTsCacheKey (const string Catalog, const string SchemaPattern, const string TypeNamePattern, const TIntegerDynArray Types)
 returns cache key for GetUDTs metadata entry
string GetURL ()
 What's the url for this database?
string GetUserName ()
 What's our user name as known to the database?
IZResultSet GetVersionColumns (const string Catalog, const string Schema, const string Table)
 Gets a description of a table's columns that are automatically updated when any value in a row is updated.
string GetVersionColumnsCacheKey (const string Catalog, const string Schema, const string Table)
 returns cache key for GetVersionColumns metadata entry
Boolean IsCatalogAtStart ()
 Does a catalog appear at the start of a qualified table name? (Otherwise it appears at the end).
Boolean IsReadOnly ()
 Is the database in read-only mode?
Boolean NullPlusNonNullIsNull ()
 Are concatenations between NULL and non-NULL values NULL? For SQL-92 compliance, a JDBC technology-enabled driver will return true.
Boolean NullsAreSortedAtEnd ()
 Are NULL values sorted at the end regardless of sort order?
Boolean NullsAreSortedAtStart ()
 Are NULL values sorted at the start regardless of sort order?
Boolean NullsAreSortedHigh ()
 Are NULL values sorted high?
Boolean NullsAreSortedLow ()
 Are NULL values sorted low?
Boolean StoresLowerCaseIdentifiers ()
 Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in lower case?
Boolean StoresLowerCaseQuotedIdentifiers ()
 Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in lower case?
Boolean StoresMixedCaseIdentifiers ()
 Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in mixed case?
Boolean StoresMixedCaseQuotedIdentifiers ()
 Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in mixed case?
Boolean StoresUpperCaseIdentifiers ()
 Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in upper case?
Boolean StoresUpperCaseQuotedIdentifiers ()
 Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in upper case?
Boolean SupportsAlterTableWithAddColumn ()
 Is "ALTER TABLE" with add column supported?
Boolean SupportsAlterTableWithDropColumn ()
 Is "ALTER TABLE" with drop column supported?
Boolean SupportsANSI92EntryLevelSQL ()
 Is the ANSI92 entry level SQL grammar supported? All JDBC Compliant<font size="-2">TM</font> drivers must return true.
Boolean SupportsANSI92FullSQL ()
 Is the ANSI92 full SQL grammar supported?
Boolean SupportsANSI92IntermediateSQL ()
 Is the ANSI92 intermediate SQL grammar supported?
Boolean SupportsBatchUpdates ()
 Indicates whether the driver supports batch updates.
Boolean SupportsCatalogsInDataManipulation ()
 Can a catalog name be used in a data manipulation statement?
Boolean SupportsCatalogsInIndexDefinitions ()
 Can a catalog name be used in an index definition statement?
Boolean SupportsCatalogsInPrivilegeDefinitions ()
 Can a catalog name be used in a privilege definition statement?
Boolean SupportsCatalogsInProcedureCalls ()
 Can a catalog name be used in a procedure call statement?
Boolean SupportsCatalogsInTableDefinitions ()
 Can a catalog name be used in a table definition statement?
Boolean SupportsColumnAliasing ()
 Is column aliasing supported?
Boolean SupportsConvert ()
 Is the CONVERT function between SQL types supported?
Boolean SupportsConvertForTypes (TZSQLType FromType, TZSQLType ToType)
 Is CONVERT between the given SQL types supported?
Boolean SupportsCoreSQLGrammar ()
 Is the ODBC Core SQL grammar supported?
Boolean SupportsCorrelatedSubqueries ()
 Are correlated subqueries supported? A JDBC Compliant<font size="-2">TM</font> driver always returns true.
Boolean SupportsDataDefinitionAndDataManipulationTransactions ()
Boolean SupportsDataManipulationTransactionsOnly ()
 Are only data manipulation statements within a transaction supported?
Boolean SupportsDifferentTableCorrelationNames ()
 If table correlation names are supported, are they restricted to be different from the names of the tables?
Boolean SupportsExpressionsInOrderBy ()
 Are expressions in "ORDER BY" lists supported?
Boolean SupportsExtendedSQLGrammar ()
 Is the ODBC Extended SQL grammar supported?
Boolean SupportsFullOuterJoins ()
 Are full nested outer joins supported?
Boolean SupportsGroupBy ()
 Is some form of "GROUP BY" clause supported?
Boolean SupportsGroupByBeyondSelect ()
 Can a "GROUP BY" clause add columns not in the SELECT provided it specifies all the columns in the SELECT?
Boolean SupportsGroupByUnrelated ()
 Can a "GROUP BY" clause use columns not in the SELECT?
Boolean SupportsIntegrityEnhancementFacility ()
 Is the SQL Integrity Enhancement Facility supported?
Boolean SupportsLikeEscapeClause ()
 Is the escape character in "LIKE" clauses supported? A JDBC Compliant<font size="-2">TM</font> driver always returns true.
Boolean SupportsLimitedOuterJoins ()
 Is there limited support for outer joins? (This will be true if supportFullOuterJoins is true.
Boolean SupportsMinimumSQLGrammar ()
 Is the ODBC Minimum SQL grammar supported? All JDBC Compliant<font size="-2">TM</font> drivers must return true.
Boolean SupportsMixedCaseIdentifiers ()
 Does the database treat mixed case unquoted SQL identifiers as case sensitive and as a result store them in mixed case? A JDBC Compliant<font size="-2">TM</font> driver will always return false.
Boolean SupportsMixedCaseQuotedIdentifiers ()
 Does the database treat mixed case quoted SQL identifiers as case sensitive and as a result store them in mixed case? A JDBC Compliant<font size="-2">TM</font> driver will always return true.
Boolean SupportsMultipleResultSets ()
 Are multiple ResultSet from a single execute supported?
Boolean SupportsMultipleTransactions ()
 Can we have multiple transactions open at once (on different connections)?
Boolean SupportsNonNullableColumns ()
 Can columns be defined as non-nullable? A JDBC Compliant<font size="-2">TM</font> driver always returns true.
Boolean SupportsOpenCursorsAcrossCommit ()
 Can cursors remain open across commits?
Boolean SupportsOpenCursorsAcrossRollback ()
 Can cursors remain open across rollbacks?
Boolean SupportsOpenStatementsAcrossCommit ()
 Can statements remain open across commits?
Boolean SupportsOpenStatementsAcrossRollback ()
 Can statements remain open across rollbacks?
Boolean SupportsOrderByUnrelated ()
 Can an "ORDER BY" clause use columns not in the SELECT statement?
Boolean SupportsOuterJoins ()
 Is some form of outer join supported?
Boolean SupportsPositionedDelete ()
 Is positioned DELETE supported?
Boolean SupportsPositionedUpdate ()
 Is positioned UPDATE supported?
Boolean SupportsResultSetConcurrency (TZResultSetType _Type, TZResultSetConcurrency Concurrency)
 Does the database support the concurrency type in combination with the given result set type?
Boolean SupportsResultSetType (TZResultSetType _Type)
 Does the database support the given result set type?
Boolean SupportsSchemasInDataManipulation ()
 Can a schema name be used in a data manipulation statement?
Boolean SupportsSchemasInIndexDefinitions ()
 Can a schema name be used in an index definition statement?
Boolean SupportsSchemasInPrivilegeDefinitions ()
 Can a schema name be used in a privilege definition statement?
Boolean SupportsSchemasInProcedureCalls ()
 Can a schema name be used in a procedure call statement?
Boolean SupportsSchemasInTableDefinitions ()
 Can a schema name be used in a table definition statement?
Boolean SupportsSelectForUpdate ()
 Is SELECT for UPDATE supported?
Boolean SupportsStoredProcedures ()
 Are stored procedure calls using the stored procedure escape syntax supported?
Boolean SupportsSubqueriesInComparisons ()
 Are subqueries in comparison expressions supported? A JDBC Compliant<font size="-2">TM</font> driver always returns true.
Boolean SupportsSubqueriesInExists ()
 Are subqueries in 'exists' expressions supported? A JDBC Compliant<font size="-2">TM</font> driver always returns true.
Boolean SupportsSubqueriesInIns ()
 Are subqueries in 'in' statements supported? A JDBC Compliant<font size="-2">TM</font> driver always returns true.
Boolean SupportsSubqueriesInQuantifieds ()
 Are subqueries in quantified expressions supported? A JDBC Compliant<font size="-2">TM</font> driver always returns true.
Boolean SupportsTableCorrelationNames ()
 Are table correlation names supported? A JDBC Compliant<font size="-2">TM</font> driver always returns true.
Boolean SupportsTransactionIsolationLevel (TZTransactIsolationLevel Level)
 Does this database support the given transaction isolation level?
Boolean SupportsTransactions ()
 Are transactions supported? If not, invoking the method commit is a noop and the isolation level is TRANSACTION_NONE.
Boolean SupportsUnion ()
 Is SQL UNION supported?
Boolean SupportsUnionAll ()
 Is SQL UNION ALL supported?
 TZMySQLDatabaseMetadata (TZAbstractConnection Connection, string Url, TStrings Info)
 Constructs this object and assignes the main properties.
Boolean UsesLocalFilePerTable ()
 Does the database use a file for each table?
Boolean UsesLocalFiles ()
 Does the database store tables in a local file?
 ~TZMySQLDatabaseMetadata ()
 Destroys this object and cleanups the memory.

Protected Types

typedef array< char > WildcardsArray

Protected Member Functions

string AddEscapeCharToWildcards (const string Pattern)
 Add escape character in the pattern that has wildcards character.
 AddResultSetToCache (const string Key, IZResultSet ResultSet)
 Adds resultset to the internal cache.
IZResultSet CloneCachedResultSet (IZResultSet ResultSet)
 Clones the cached resultset.
IZVirtualResultSet ConstructVirtualResultSet (TZMetadataColumnDefs ColumnsDefs)
 Constructs a virtual result set object.
IZVirtualResultSet CopyToVirtualResultSet (IZResultSet SrcResultSet, IZVirtualResultSet DestResultSet)
 Copies on result set to another one from the current position.
 FillWildcards ()
 Set the Wildcards character for WildcardsArray variable.
 GetCatalogAndNamePattern (const string Catalog, const string SchemaPattern, const string NamePattern, string &OutCatalog, string &OutNamePattern)
IZResultSet GetResultSetFromCache (const string Key)
 Gets a resultset interface from the internal cache by key.
 GetVersion (integer &MajorVersion, integer &MinorVersion)
TZWildcardsSet GetWildcardsSet ()
 Get the Wildscards in set of char type.
IZResultSet UncachedGetBestRowIdentifier (const string Catalog, const string Schema, const string Table, Integer Scope, Boolean Nullable)
 Gets a description of a table's optimal set of columns that uniquely identifies a row.
IZResultSet UncachedGetCatalogs ()
 Gets the catalog names available in this database.
IZResultSet UncachedGetColumnPrivileges (const string Catalog, const string Schema, const string Table, const string ColumnNamePattern)
 Gets a description of the access rights for a table's columns.
IZResultSet UncachedGetColumns (const string Catalog, const string SchemaPattern, const string TableNamePattern, const string ColumnNamePattern)
 Gets a description of table columns available in the specified catalog.
IZResultSet UncachedGetCrossReference (const string PrimaryCatalog, const string PrimarySchema, const string PrimaryTable, const string ForeignCatalog, const string ForeignSchema, const string ForeignTable)
 Gets a description of the foreign key columns in the foreign key table that reference the primary key columns of the primary key table (describe how one table imports another's key.
IZResultSet UncachedGetExportedKeys (const string Catalog, const string Schema, const string Table)
 Gets a description of the foreign key columns that reference a table's primary key columns (the foreign keys exported by a table).
IZResultSet UncachedGetImportedKeys (const string Catalog, const string Schema, const string Table)
 Gets a description of the primary key columns that are referenced by a table's foreign key columns (the primary keys imported by a table).
IZResultSet UncachedGetIndexInfo (const string Catalog, const string Schema, const string Table, Boolean Unique, Boolean Approximate)
 Gets a description of a table's indices and statistics.
IZResultSet UncachedGetPrimaryKeys (const string Catalog, const string Schema, const string Table)
 Gets a description of a table's primary key columns.
IZResultSet UncachedGetProcedureColumns (const string Catalog, const string SchemaPattern, const string ProcedureNamePattern, const string ColumnNamePattern)
 Gets a description of a catalog's stored procedure parameters and result columns.
IZResultSet UncachedGetProcedures (const string Catalog, const string SchemaPattern, const string ProcedureNamePattern)
 Gets a description of the stored procedures available in a catalog.
IZResultSet UncachedGetSchemas ()
 Gets the schema names available in this database.
IZResultSet UncachedGetSequences (const string Catalog, const string SchemaPattern, const string SequenceNamePattern)
IZResultSet UncachedGetTablePrivileges (const string Catalog, const string SchemaPattern, const string TableNamePattern)
 Gets a description of the access rights for each table available in a catalog.
IZResultSet UncachedGetTables (const string Catalog, const string SchemaPattern, const string TableNamePattern, const TStringDynArray Types)
 Gets a description of tables available in a catalog.
IZResultSet UncachedGetTableTypes ()
 Gets the table types available in this database.
IZResultSet UncachedGetTypeInfo ()
 Gets a description of all the standard SQL types supported by this database.
IZResultSet UncachedGetUDTs (const string Catalog, const string SchemaPattern, const string TypeNamePattern, const TIntegerDynArray Types)
 Gets a description of the user-defined types defined in a particular schema.
IZResultSet UncachedGetVersionColumns (const string Catalog, const string Schema, const string Table)
 Gets a description of a table's columns that are automatically updated when any value in a row is updated.

Protected Attributes

IZHashMap CachedResultSets
TStrings Info
string Url

Private Attributes

string FDatabase


Detailed Description

Implements MySQL Database Metadata.

Definition at line 73 of file ZDbcMySqlMetadata.pas.


Member Typedef Documentation

typedef array<char> TZAbstractDatabaseMetadata::WildcardsArray [protected, inherited]

Definition at line 168 of file ZDbcMetadata.pas.


Constructor & Destructor Documentation

TZMySQLDatabaseMetadata::TZMySQLDatabaseMetadata ( TZAbstractConnection  Connection,
string  Url,
TStrings  Info 
)

Constructs this object and assignes the main properties.

Parameters:
Connection a database connection object.
Url a database connection url string.
Info an extra connection properties.

Definition at line 363 of file ZDbcMySqlMetadata.pas.

TZMySQLDatabaseMetadata::~TZMySQLDatabaseMetadata (  ) 

Destroys this object and cleanups the memory.

Definition at line 394 of file ZDbcMySqlMetadata.pas.

References P.


Member Function Documentation

string TZAbstractDatabaseMetadata::AddEscapeCharToWildcards ( const string  Pattern  )  [protected, inherited]

Add escape character in the pattern that has wildcards character.

Parameters:
Pattern The pattern that would be escaped
Returns:
Escaped Pattern

Reimplemented from IZDatabaseMetadata.

Definition at line 5052 of file ZDbcMetadata.pas.

TZAbstractDatabaseMetadata::AddResultSetToCache ( const string  Key,
IZResultSet  ResultSet 
) [protected, inherited]

Adds resultset to the internal cache.

Parameters:
Key a resultset unique key value.
ResultSet a resultset interface.

Definition at line 1206 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::AllProceduresAreCallable (  )  [inherited]

Can all the procedures returned by getProcedures be called by the current user?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 1373 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::AllTablesAreSelectable (  )  [inherited]

Can all the tables returned by getTable be SELECTed by the current user?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 1386 of file ZDbcMetadata.pas.

TZAbstractDatabaseMetadata::ClearCache ( const string  Key  )  [inherited]

Clears specific cached metadata.

Reimplemented from IZDatabaseMetadata.

Definition at line 1184 of file ZDbcMetadata.pas.

TZAbstractDatabaseMetadata::ClearCache (  )  [inherited]

Clears all cached metadata.

Reimplemented from IZDatabaseMetadata.

Definition at line 1173 of file ZDbcMetadata.pas.

IZResultSet TZAbstractDatabaseMetadata::CloneCachedResultSet ( IZResultSet  ResultSet  )  [protected, inherited]

Clones the cached resultset.

Parameters:
ResultSet the resultset to be cloned.
Returns:
the clone of the specified resultset.

Definition at line 1326 of file ZDbcMetadata.pas.

IZVirtualResultSet TZAbstractDatabaseMetadata::ConstructVirtualResultSet ( TZMetadataColumnDefs  ColumnsDefs  )  [protected, inherited]

Constructs a virtual result set object.

Parameters:
ColumnsDefs an array of column definition objects.
Returns:
a created result set.

Definition at line 1135 of file ZDbcMetadata.pas.

IZVirtualResultSet TZAbstractDatabaseMetadata::CopyToVirtualResultSet ( IZResultSet  SrcResultSet,
IZVirtualResultSet  DestResultSet 
) [protected, inherited]

Copies on result set to another one from the current position.

Parameters:
SrcResultSet a source result set.
DestResultSet a destination result set.
Returns:
a destination result set.

Definition at line 1255 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::DataDefinitionCausesTransactionCommit (  )  [inherited]

Does a data definition statement within a transaction force the transaction to commit?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 2873 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::DataDefinitionIgnoredInTransactions (  )  [inherited]

Is a data definition statement within a transaction ignored?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 2885 of file ZDbcMetadata.pas.

Boolean TZMySQLDatabaseMetadata::DoesMaxRowSizeIncludeBlobs (  ) 

Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY blobs?

Returns:
true if so; false otherwise

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 1033 of file ZDbcMySqlMetadata.pas.

TZAbstractDatabaseMetadata::FillWildcards (  )  [protected, inherited]

Set the Wildcards character for WildcardsArray variable.

Overrride this method if the wildcards character is different in other database

Definition at line 5076 of file ZDbcMetadata.pas.

IZResultSet TZAbstractDatabaseMetadata::GetBestRowIdentifier ( const string  Catalog,
const string  Schema,
const string  Table,
Integer  Scope,
Boolean  Nullable 
) [inherited]

Gets a description of a table's optimal set of columns that uniquely identifies a row.

They are ordered by SCOPE.

Each column description has the following columns:

  1. SCOPE short => actual scope of result
    • bestRowTemporary - very temporary, while using row
    • bestRowTransaction - valid for remainder of current transaction
    • bestRowSession - valid for remainder of current session
  2. COLUMN_NAME String => column name
  3. DATA_TYPE short => SQL data type from java.sql.Types
  4. TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified
  5. COLUMN_SIZE int => precision
  6. BUFFER_LENGTH int => not used
  7. DECIMAL_DIGITS short => scale
  8. PSEUDO_COLUMN short => is this a pseudo column like an Oracle ROWID
    • bestRowUnknown - may or may not be pseudo column
    • bestRowNotPseudo - is NOT a pseudo column
    • bestRowPseudo - is a pseudo column

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schema a schema name; "" retrieves those without a schema
table a table name
scope the scope of interest; use same values as SCOPE
nullable include columns that are nullable?
Returns:
ResultSet - each row is a column description

Reimplemented from IZDatabaseMetadata.

Definition at line 3764 of file ZDbcMetadata.pas.

string TZAbstractDatabaseMetadata::GetBestRowIdentifierCacheKey ( const string  Catalog,
const string  Schema,
const string  Table,
const Integer  Scope,
const Boolean  Nullable 
) [inherited]

returns cache key for GetBestRowIdentifier metadata entry

Parameters:
Catalog a catalog name
Schema a schema name
Table a table name
Scope the scope of interest
Nullable include columns that are nullable?
Returns:
the cache key string

Definition at line 5292 of file ZDbcMetadata.pas.

TZAbstractDatabaseMetadata::GetCacheKeys ( TStrings  List  )  [inherited]

fills string list with the keys for the currently cached metadata entries

Parameters:
List a string list to fill out

Definition at line 5497 of file ZDbcMetadata.pas.

TZMySQLDatabaseMetadata::GetCatalogAndNamePattern ( const string  Catalog,
const string  SchemaPattern,
const string  NamePattern,
string &  OutCatalog,
string &  OutNamePattern 
) [protected]

Definition at line 1157 of file ZDbcMySqlMetadata.pas.

IZResultSet TZAbstractDatabaseMetadata::GetCatalogs (  )  [inherited]

Gets the catalog names available in this database.

The results are ordered by catalog name.

The catalog column is:

  1. TABLE_CAT String => catalog name

Returns:
ResultSet - each row has a single String column that is a catalog name

Reimplemented from IZDatabaseMetadata.

Definition at line 3301 of file ZDbcMetadata.pas.

string TZAbstractDatabaseMetadata::GetCatalogsCacheKey (  )  [inherited]

returns cache key for GetCatalogs metadata entry

Returns:
the cache key string

Definition at line 5202 of file ZDbcMetadata.pas.

string TZAbstractDatabaseMetadata::GetCatalogSeparator (  )  [inherited]

What's the separator between catalog and table name?

Returns:
the separator string

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 2197 of file ZDbcMetadata.pas.

string TZMySQLDatabaseMetadata::GetCatalogTerm (  ) 

What's the database vendor's preferred term for "catalog"?

Returns:
the vendor term

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 750 of file ZDbcMySqlMetadata.pas.

IZResultSet TZAbstractDatabaseMetadata::GetColumnPrivileges ( const string  Catalog,
const string  Schema,
const string  Table,
const string  ColumnNamePattern 
) [inherited]

Gets a description of the access rights for a table's columns.

Only privileges matching the column name criteria are returned. They are ordered by COLUMN_NAME and PRIVILEGE.

Each privilige description has the following columns:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. COLUMN_NAME String => column name
  5. GRANTOR => grantor of access (may be null)
  6. GRANTEE String => grantee of access
  7. PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
  8. IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schema a schema name; "" retrieves those without a schema
table a table name
columnNamePattern a column name pattern
Returns:
ResultSet - each row is a column privilege description
See also:
getSearchStringEscape

Reimplemented from IZDatabaseMetadata.

Definition at line 3564 of file ZDbcMetadata.pas.

string TZAbstractDatabaseMetadata::GetColumnPrivilegesCacheKey ( const string  Catalog,
const string  Schema,
const string  Table,
const string  ColumnNamePattern 
) [inherited]

returns cache key for GetColumnPrivileges metadata entry

Parameters:
Catalog a catalog name
Schema a schema name
Table a table name
ColumnNamePattern a column name pattern
Returns:
the cache key string

Definition at line 5251 of file ZDbcMetadata.pas.

IZResultSet TZAbstractDatabaseMetadata::GetColumns ( const string  Catalog,
const string  SchemaPattern,
const string  TableNamePattern,
const string  ColumnNamePattern 
) [inherited]

Gets a description of table columns available in the specified catalog.

Only column descriptions matching the catalog, schema, table and column name criteria are returned. They are ordered by TABLE_SCHEM, TABLE_NAME and ORDINAL_POSITION.

Each column description has the following columns:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. COLUMN_NAME String => column name
  5. DATA_TYPE short => SQL type from java.sql.Types
  6. TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified
  7. COLUMN_SIZE int => column size. For char or date types this is the maximum number of characters, for numeric or decimal types this is precision.
  8. BUFFER_LENGTH is not used.
  9. DECIMAL_DIGITS int => the number of fractional digits
  10. NUM_PREC_RADIX int => Radix (typically either 10 or 2)
  11. NULLABLE int => is NULL allowed?
    • columnNoNulls - might not allow NULL values
    • columnNullable - definitely allows NULL values
    • columnNullableUnknown - nullability unknown
  12. REMARKS String => comment describing column (may be null)
  13. COLUMN_DEF String => default value (may be null)
  14. SQL_DATA_TYPE int => unused
  15. SQL_DATETIME_SUB int => unused
  16. CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column
  17. ORDINAL_POSITION int => index of column in table (starting at 1)
  18. IS_NULLABLE String => "NO" means column definitely does not allow NULL values; "YES" means the column might allow NULL values. An empty string means nobody knows.

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaPattern a schema name pattern; "" retrieves those without a schema
tableNamePattern a table name pattern
columnNamePattern a column name pattern
Returns:
ResultSet - each row is a column description
See also:
getSearchStringEscape

Reimplemented from IZDatabaseMetadata.

Definition at line 3448 of file ZDbcMetadata.pas.

string TZAbstractDatabaseMetadata::GetColumnsCacheKey ( const string  Catalog,
const string  SchemaPattern,
const string  TableNamePattern,
const string  ColumnNamePattern 
) [inherited]

returns cache key for GetColumns metadata entry

Parameters:
Catalog a catalog name
SchemaPattern a schema name pattern
TableNamePattern a table name pattern
ColumnNamePattern a column name pattern
Returns:
the cache key string

Definition at line 5230 of file ZDbcMetadata.pas.

IZConnection TZAbstractDatabaseMetadata::GetConnection (  )  [inherited]

Retrieves the connection that produced this metadata object.

Returns:
the connection that produced this metadata object

Reimplemented from IZDatabaseMetadata.

Definition at line 1122 of file ZDbcMetadata.pas.

IZResultSet TZAbstractDatabaseMetadata::GetCrossReference ( const string  PrimaryCatalog,
const string  PrimarySchema,
const string  PrimaryTable,
const string  ForeignCatalog,
const string  ForeignSchema,
const string  ForeignTable 
) [inherited]

Gets a description of the foreign key columns in the foreign key table that reference the primary key columns of the primary key table (describe how one table imports another's key.

) This should normally return a single foreign key/primary key pair (most tables only import a foreign key from a table once.) They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.

Each foreign key column description has the following columns:

  1. PKTABLE_CAT String => primary key table catalog (may be null)
  2. PKTABLE_SCHEM String => primary key table schema (may be null)
  3. PKTABLE_NAME String => primary key table name
  4. PKCOLUMN_NAME String => primary key column name
  5. FKTABLE_CAT String => foreign key table catalog (may be null) being exported (may be null)
  6. FKTABLE_SCHEM String => foreign key table schema (may be null) being exported (may be null)
  7. FKTABLE_NAME String => foreign key table name being exported
  8. FKCOLUMN_NAME String => foreign key column name being exported
  9. KEY_SEQ short => sequence number within foreign key
  10. UPDATE_RULE short => What happens to foreign key when primary is updated:
    • importedNoAction - do not allow update of primary key if it has been imported
    • importedKeyCascade - change imported key to agree with primary key update
    • importedKeySetNull - change imported key to NULL if its primary key has been updated
    • importedKeySetDefault - change imported key to default values if its primary key has been updated
    • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
  11. DELETE_RULE short => What happens to the foreign key when primary is deleted.
    • importedKeyNoAction - do not allow delete of primary key if it has been imported
    • importedKeyCascade - delete rows that import a deleted key
    • importedKeySetNull - change imported key to NULL if its primary key has been deleted
    • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
    • importedKeySetDefault - change imported key to default if its primary key has been deleted
  12. FK_NAME String => foreign key name (may be null)
  13. PK_NAME String => primary key name (may be null)
  14. DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
    • importedKeyInitiallyDeferred - see SQL92 for definition
    • importedKeyInitiallyImmediate - see SQL92 for definition
    • importedKeyNotDeferrable - see SQL92 for definition

Parameters:
primaryCatalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
primarySchema a schema name; "" retrieves those without a schema
primaryTable the table name that exports the key
foreignCatalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
foreignSchema a schema name; "" retrieves those without a schema
foreignTable the table name that imports the key
Returns:
ResultSet - each row is a foreign key column description
See also:
getImportedKeys

Reimplemented from IZDatabaseMetadata.

Definition at line 4474 of file ZDbcMetadata.pas.

string TZAbstractDatabaseMetadata::GetCrossReferenceCacheKey ( const string  PrimaryCatalog,
const string  PrimarySchema,
const string  PrimaryTable,
const string  ForeignCatalog,
const string  ForeignSchema,
const string  ForeignTable 
) [inherited]

returns cache key for GetCrossReference metadata entry

Parameters:
PrimaryCatalog a catalog name for the primary table
PrimarySchema a schema name for the primary table
PrimaryTable the table name that exports the key
ForeignCatalog a catalog name for the foreign table
ForeignSchema a schema name for the foreign table
ForeignTable the table name that imports the key
Returns:
the cache key string

Definition at line 5388 of file ZDbcMetadata.pas.

string TZMySQLDatabaseMetadata::GetDatabaseProductName (  ) 

What's the name of this database product?

Returns:
database product name

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 409 of file ZDbcMySqlMetadata.pas.

string TZMySQLDatabaseMetadata::GetDatabaseProductVersion (  ) 

What's the version of this database product?

Returns:
database version

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 421 of file ZDbcMySqlMetadata.pas.

TZTransactIsolationLevel TZMySQLDatabaseMetadata::GetDefaultTransactionIsolation (  ) 

What's the database's default transaction isolation level? The values are defined in java.sql.Connection.

Returns:
the default isolation level
See also:
Connection

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 1116 of file ZDbcMySqlMetadata.pas.

Integer TZMySQLDatabaseMetadata::GetDriverMajorVersion (  ) 

What's this JDBC driver's major version number?

Returns:
JDBC driver major version

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 445 of file ZDbcMySqlMetadata.pas.

Integer TZMySQLDatabaseMetadata::GetDriverMinorVersion (  ) 

What's this JDBC driver's minor version number?

Returns:
JDBC driver minor version number

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 457 of file ZDbcMySqlMetadata.pas.

string TZMySQLDatabaseMetadata::GetDriverName (  ) 

What's the name of this JDBC driver?

Returns:
JDBC driver name

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 433 of file ZDbcMySqlMetadata.pas.

string TZAbstractDatabaseMetadata::GetDriverVersion (  )  [inherited]

What's the version of this JDBC driver?

Returns:
JDBC driver version

Reimplemented from IZDatabaseMetadata.

Definition at line 1520 of file ZDbcMetadata.pas.

IZResultSet TZAbstractDatabaseMetadata::GetExportedKeys ( const string  Catalog,
const string  Schema,
const string  Table 
) [inherited]

Gets a description of the foreign key columns that reference a table's primary key columns (the foreign keys exported by a table).

They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.

Each foreign key column description has the following columns:

  1. PKTABLE_CAT String => primary key table catalog (may be null)
  2. PKTABLE_SCHEM String => primary key table schema (may be null)
  3. PKTABLE_NAME String => primary key table name
  4. PKCOLUMN_NAME String => primary key column name
  5. FKTABLE_CAT String => foreign key table catalog (may be null) being exported (may be null)
  6. FKTABLE_SCHEM String => foreign key table schema (may be null) being exported (may be null)
  7. FKTABLE_NAME String => foreign key table name being exported
  8. FKCOLUMN_NAME String => foreign key column name being exported
  9. KEY_SEQ short => sequence number within foreign key
  10. UPDATE_RULE short => What happens to foreign key when primary is updated:
    • importedNoAction - do not allow update of primary key if it has been imported
    • importedKeyCascade - change imported key to agree with primary key update
    • importedKeySetNull - change imported key to NULL if its primary key has been updated
    • importedKeySetDefault - change imported key to default values if its primary key has been updated
    • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
  11. DELETE_RULE short => What happens to the foreign key when primary is deleted.
    • importedKeyNoAction - do not allow delete of primary key if it has been imported
    • importedKeyCascade - delete rows that import a deleted key
    • importedKeySetNull - change imported key to NULL if its primary key has been deleted
    • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
    • importedKeySetDefault - change imported key to default if its primary key has been deleted
  12. FK_NAME String => foreign key name (may be null)
  13. PK_NAME String => primary key name (may be null)
  14. DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
    • importedKeyInitiallyDeferred - see SQL92 for definition
    • importedKeyInitiallyImmediate - see SQL92 for definition
    • importedKeyNotDeferrable - see SQL92 for definition

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schema a schema name; "" retrieves those without a schema
table a table name
Returns:
ResultSet - each row is a foreign key column description
See also:
getImportedKeys

Reimplemented from IZDatabaseMetadata.

Definition at line 4298 of file ZDbcMetadata.pas.

string TZAbstractDatabaseMetadata::GetExportedKeysCacheKey ( const string  Catalog,
const string  Schema,
const string  Table 
) [inherited]

returns cache key for GetExportedKeys metadata entry

Parameters:
Catalog a catalog name
Schema a schema name
Table a table name
Returns:
the cache key string

Definition at line 5367 of file ZDbcMetadata.pas.

string TZMySQLDatabaseMetadata::GetExtraNameCharacters (  ) 

Gets all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _).

Returns:
the string containing the extra characters

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 652 of file ZDbcMySqlMetadata.pas.

IZIdentifierConvertor TZAbstractDatabaseMetadata::GetIdentifierConvertor (  )  [inherited]

Creates ab identifier convertor object.

Returns:
an identifier convertor object.

Reimplemented from IZDatabaseMetadata.

Definition at line 5039 of file ZDbcMetadata.pas.

string TZMySQLDatabaseMetadata::GetIdentifierQuoteString (  ) 

What's the string used to quote SQL identifiers? This returns a space " " if identifier quoting isn't supported.

A JDBC Compliant<font size="-2">TM</font> driver always uses a double quote character.

Returns:
the quoting string

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 497 of file ZDbcMySqlMetadata.pas.

IZResultSet TZAbstractDatabaseMetadata::GetImportedKeys ( const string  Catalog,
const string  Schema,
const string  Table 
) [inherited]

Gets a description of the primary key columns that are referenced by a table's foreign key columns (the primary keys imported by a table).

They are ordered by PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME, and KEY_SEQ.

Each primary key column description has the following columns:

  1. PKTABLE_CAT String => primary key table catalog being imported (may be null)
  2. PKTABLE_SCHEM String => primary key table schema being imported (may be null)
  3. PKTABLE_NAME String => primary key table name being imported
  4. PKCOLUMN_NAME String => primary key column name being imported
  5. FKTABLE_CAT String => foreign key table catalog (may be null)
  6. FKTABLE_SCHEM String => foreign key table schema (may be null)
  7. FKTABLE_NAME String => foreign key table name
  8. FKCOLUMN_NAME String => foreign key column name
  9. KEY_SEQ short => sequence number within foreign key
  10. UPDATE_RULE short => What happens to foreign key when primary is updated:
    • importedNoAction - do not allow update of primary key if it has been imported
    • importedKeyCascade - change imported key to agree with primary key update
    • importedKeySetNull - change imported key to NULL if its primary key has been updated
    • importedKeySetDefault - change imported key to default values if its primary key has been updated
    • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
  11. DELETE_RULE short => What happens to the foreign key when primary is deleted.
    • importedKeyNoAction - do not allow delete of primary key if it has been imported
    • importedKeyCascade - delete rows that import a deleted key
    • importedKeySetNull - change imported key to NULL if its primary key has been deleted
    • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
    • importedKeySetDefault - change imported key to default if its primary key has been deleted
  12. FK_NAME String => foreign key name (may be null)
  13. PK_NAME String => primary key name (may be null)
  14. DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
    • importedKeyInitiallyDeferred - see SQL92 for definition
    • importedKeyInitiallyImmediate - see SQL92 for definition
    • importedKeyNotDeferrable - see SQL92 for definition

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schema a schema name; "" retrieves those without a schema
table a table name
Returns:
ResultSet - each row is a primary key column description
See also:
getExportedKeys

Reimplemented from IZDatabaseMetadata.

Definition at line 4130 of file ZDbcMetadata.pas.

string TZAbstractDatabaseMetadata::GetImportedKeysCacheKey ( const string  Catalog,
const string  Schema,
const string  Table 
) [inherited]

returns cache key for GetImportedKeys metadata entry

Parameters:
Catalog a catalog name
Schema a schema name
Table a table name
Returns:
the cache key string

Definition at line 5349 of file ZDbcMetadata.pas.

IZResultSet TZAbstractDatabaseMetadata::GetIndexInfo ( const string  Catalog,
const string  Schema,
const string  Table,
Boolean  Unique,
Boolean  Approximate 
) [inherited]

Gets a description of a table's indices and statistics.

They are ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION.

Each index column description has the following columns:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. NON_UNIQUE boolean => Can index values be non-unique? false when TYPE is tableIndexStatistic
  5. INDEX_QUALIFIER String => index catalog (may be null); null when TYPE is tableIndexStatistic
  6. INDEX_NAME String => index name; null when TYPE is tableIndexStatistic
  7. TYPE short => index type:
    • tableIndexStatistic - this identifies table statistics that are returned in conjuction with a table's index descriptions
    • tableIndexClustered - this is a clustered index
    • tableIndexHashed - this is a hashed index
    • tableIndexOther - this is some other style of index
  8. ORDINAL_POSITION short => column sequence number within index; zero when TYPE is tableIndexStatistic
  9. COLUMN_NAME String => column name; null when TYPE is tableIndexStatistic
  10. ASC_OR_DESC String => column sort sequence, "A" => ascending, "D" => descending, may be null if sort sequence is not supported; null when TYPE is tableIndexStatistic
  11. CARDINALITY int => When TYPE is tableIndexStatistic, then this is the number of rows in the table; otherwise, it is the number of unique values in the index.
  12. PAGES int => When TYPE is tableIndexStatisic then this is the number of pages used for the table, otherwise it is the number of pages used for the current index.
  13. FILTER_CONDITION String => Filter condition, if any. (may be null)

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schema a schema name; "" retrieves those without a schema
table a table name
unique when true, return only indices for unique values; when false, return indices regardless of whether unique or not
approximate when true, result is allowed to reflect approximate or out of data values; when false, results are requested to be accurate
Returns:
ResultSet - each row is an index column description

Reimplemented from IZDatabaseMetadata.

Definition at line 4760 of file ZDbcMetadata.pas.

string TZAbstractDatabaseMetadata::GetIndexInfoCacheKey ( const string  Catalog,
const string  Schema,
const string  Table,
const Boolean  Unique,
const Boolean  Approximate 
) [inherited]

returns cache key for GetIndexInfo metadata entry

Parameters:
Catalog a catalog name
Schema a schema name
Table a table name
Unique when true, return key for a metadata entry that should contain only indices for unique values; when false, return key for a metadata entry that may contain indices to non-unique values
Approximate when true, return key for a metadata entry that may include approximate or out of data values; when false, return key for a metadata entry that should contain only accurate results
Returns:
the cache key string

Definition at line 5429 of file ZDbcMetadata.pas.

Integer TZMySQLDatabaseMetadata::GetMaxBinaryLiteralLength (  ) 

How many hex characters can you have in an inline binary literal?

Returns:
max binary literal length in hex characters; a result of zero means that there is no limit or the limit is not known

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 862 of file ZDbcMySqlMetadata.pas.

Integer TZMySQLDatabaseMetadata::GetMaxCatalogNameLength (  ) 

What's the maximum length of a catalog name?

Returns:
max name length in bytes; a result of zero means that there is no limit or the limit is not known

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 1007 of file ZDbcMySqlMetadata.pas.

Integer TZMySQLDatabaseMetadata::GetMaxCharLiteralLength (  ) 

What's the max length for a character literal?

Returns:
max literal length; a result of zero means that there is no limit or the limit is not known

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 875 of file ZDbcMySqlMetadata.pas.

Integer TZMySQLDatabaseMetadata::GetMaxColumnNameLength (  ) 

What's the limit on column name length?

Returns:
max column name length; a result of zero means that there is no limit or the limit is not known

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 888 of file ZDbcMySqlMetadata.pas.

Integer TZMySQLDatabaseMetadata::GetMaxColumnsInGroupBy (  ) 

What's the maximum number of columns in a "GROUP BY" clause?

Returns:
max number of columns; a result of zero means that there is no limit or the limit is not known

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 901 of file ZDbcMySqlMetadata.pas.

References P.

Integer TZMySQLDatabaseMetadata::GetMaxColumnsInIndex (  ) 

What's the maximum number of columns allowed in an index?

Returns:
max number of columns; a result of zero means that there is no limit or the limit is not known

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 914 of file ZDbcMySqlMetadata.pas.

Integer TZMySQLDatabaseMetadata::GetMaxColumnsInOrderBy (  ) 

What's the maximum number of columns in an "ORDER BY" clause?

Returns:
max number of columns; a result of zero means that there is no limit or the limit is not known

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 927 of file ZDbcMySqlMetadata.pas.

References P.

Integer TZMySQLDatabaseMetadata::GetMaxColumnsInSelect (  ) 

What's the maximum number of columns in a "SELECT" list?

Returns:
max number of columns; a result of zero means that there is no limit or the limit is not known

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 940 of file ZDbcMySqlMetadata.pas.

Integer TZMySQLDatabaseMetadata::GetMaxColumnsInTable (  ) 

What's the maximum number of columns in a table?

Returns:
max number of columns; a result of zero means that there is no limit or the limit is not known

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 953 of file ZDbcMySqlMetadata.pas.

References P.

Integer TZMySQLDatabaseMetadata::GetMaxConnections (  ) 

How many active connections can we have at a time to this database?

Returns:
max number of active connections; a result of zero means that there is no limit or the limit is not known

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 966 of file ZDbcMySqlMetadata.pas.

Integer TZMySQLDatabaseMetadata::GetMaxCursorNameLength (  ) 

What's the maximum cursor name length?

Returns:
max cursor name length in bytes; a result of zero means that there is no limit or the limit is not known

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 979 of file ZDbcMySqlMetadata.pas.

Integer TZMySQLDatabaseMetadata::GetMaxIndexLength (  ) 

Retrieves the maximum number of bytes for an index, including all of the parts of the index.

Returns:
max index length in bytes, which includes the composite of all the constituent parts of the index; a result of zero means that there is no limit or the limit is not known

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 994 of file ZDbcMySqlMetadata.pas.

Integer TZAbstractDatabaseMetadata::GetMaxProcedureNameLength (  )  [inherited]

What's the maximum length of a procedure name?

Returns:
max name length in bytes; a result of zero means that there is no limit or the limit is not known

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 2684 of file ZDbcMetadata.pas.

Integer TZMySQLDatabaseMetadata::GetMaxRowSize (  ) 

What's the maximum length of a single row?

Returns:
max row size in bytes; a result of zero means that there is no limit or the limit is not known

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 1020 of file ZDbcMySqlMetadata.pas.

Integer TZAbstractDatabaseMetadata::GetMaxSchemaNameLength (  )  [inherited]

What's the maximum length allowed for a schema name?

Returns:
max name length in bytes; a result of zero means that there is no limit or the limit is not known

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 2671 of file ZDbcMetadata.pas.

Integer TZMySQLDatabaseMetadata::GetMaxStatementLength (  ) 

What's the maximum length of an SQL statement?

Returns:
max length in bytes; a result of zero means that there is no limit or the limit is not known

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 1046 of file ZDbcMySqlMetadata.pas.

Integer TZMySQLDatabaseMetadata::GetMaxStatements (  ) 

How many active statements can we have open at one time to this database?

Returns:
the maximum number of statements that can be open at one time; a result of zero means that there is no limit or the limit is not known

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 1060 of file ZDbcMySqlMetadata.pas.

Integer TZMySQLDatabaseMetadata::GetMaxTableNameLength (  ) 

What's the maximum length of a table name?

Returns:
max name length in bytes; a result of zero means that there is no limit or the limit is not known

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 1073 of file ZDbcMySqlMetadata.pas.

Integer TZMySQLDatabaseMetadata::GetMaxTablesInSelect (  ) 

What's the maximum number of tables in a SELECT statement?

Returns:
the maximum number of tables allowed in a SELECT statement; a result of zero means that there is no limit or the limit is not known

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 1086 of file ZDbcMySqlMetadata.pas.

Integer TZMySQLDatabaseMetadata::GetMaxUserNameLength (  ) 

What's the maximum length of a user name?

Returns:
max user name length in bytes; a result of zero means that there is no limit or the limit is not known

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 1099 of file ZDbcMySqlMetadata.pas.

string TZMySQLDatabaseMetadata::GetNumericFunctions (  ) 

Gets a comma-separated list of math functions.

These are the X/Open CLI math function names used in the JDBC function escape clause.

Returns:
the list

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 552 of file ZDbcMySqlMetadata.pas.

IZResultSet TZAbstractDatabaseMetadata::GetPrimaryKeys ( const string  Catalog,
const string  Schema,
const string  Table 
) [inherited]

Gets a description of a table's primary key columns.

They are ordered by COLUMN_NAME.

Each primary key column description has the following columns:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. COLUMN_NAME String => column name
  5. KEY_SEQ short => sequence number within primary key
  6. PK_NAME String => primary key name (may be null)

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schema a schema name; "" retrieves those without a schema
table a table name
Returns:
ResultSet - each row is a primary key column description
Exceptions:
SQLException if a database access error occurs

Reimplemented from IZDatabaseMetadata.

Definition at line 4007 of file ZDbcMetadata.pas.

string TZAbstractDatabaseMetadata::GetPrimaryKeysCacheKey ( const string  Catalog,
const string  Schema,
const string  Table 
) [inherited]

returns cache key for GetPrimaryKeys metadata entry

Parameters:
Catalog a catalog name
Schema a schema name
Table a table name
Returns:
the cache key string

Definition at line 5331 of file ZDbcMetadata.pas.

IZResultSet TZAbstractDatabaseMetadata::GetProcedureColumns ( const string  Catalog,
const string  SchemaPattern,
const string  ProcedureNamePattern,
const string  ColumnNamePattern 
) [inherited]

Gets a description of a catalog's stored procedure parameters and result columns.

Only descriptions matching the schema, procedure and parameter name criteria are returned. They are ordered by PROCEDURE_SCHEM and PROCEDURE_NAME. Within this, the return value, if any, is first. Next are the parameter descriptions in call order. The column descriptions follow in column number order.

Each row in the ResultSet is a parameter description or column description with the following fields:

  1. PROCEDURE_CAT String => procedure catalog (may be null)
  2. PROCEDURE_SCHEM String => procedure schema (may be null)
  3. PROCEDURE_NAME String => procedure name
  4. COLUMN_NAME String => column/parameter name
  5. COLUMN_TYPE Short => kind of column/parameter:
    • procedureColumnUnknown - nobody knows
    • procedureColumnIn - IN parameter
    • procedureColumnInOut - INOUT parameter
    • procedureColumnOut - OUT parameter
    • procedureColumnReturn - procedure return value
    • procedureColumnResult - result column in ResultSet
  6. DATA_TYPE short => SQL type from java.sql.Types
  7. TYPE_NAME String => SQL type name, for a UDT type the type name is fully qualified
  8. PRECISION int => precision
  9. LENGTH int => length in bytes of data
  10. SCALE short => scale
  11. RADIX short => radix
  12. NULLABLE short => can it contain NULL?
    • procedureNoNulls - does not allow NULL values
    • procedureNullable - allows NULL values
    • procedureNullableUnknown - nullability unknown
  13. REMARKS String => comment describing parameter/column

Note: Some databases may not return the column descriptions for a procedure. Additional columns beyond REMARKS can be defined by the database.

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaPattern a schema name pattern; "" retrieves those without a schema
procedureNamePattern a procedure name pattern
columnNamePattern a column name pattern
Returns:
ResultSet - each row describes a stored procedure parameter or column
See also:
getSearchStringEscape

Reimplemented from IZDatabaseMetadata.

Definition at line 3049 of file ZDbcMetadata.pas.

string TZAbstractDatabaseMetadata::GetProcedureColumnsCacheKey ( const string  Catalog,
const string  SchemaPattern,
const string  ProcedureNamePattern,
const string  ColumnNamePattern 
) [inherited]

returns cache key for GetProcedureColumns metadata entry

Parameters:
Catalog a catalog name
SchemaPattern a schema name pattern
ProcedureNamePattern a procedure name pattern
ColumnNamePattern a column name pattern
Returns:
the cache key string

Definition at line 5140 of file ZDbcMetadata.pas.

IZResultSet TZAbstractDatabaseMetadata::GetProcedures ( const string  Catalog,
const string  SchemaPattern,
const string  ProcedureNamePattern 
) [inherited]

Gets a description of the stored procedures available in a catalog.

Only procedure descriptions matching the schema and procedure name criteria are returned. They are ordered by PROCEDURE_SCHEM, and PROCEDURE_NAME.

Each procedure description has the the following columns:

  1. PROCEDURE_CAT String => procedure catalog (may be null)
  2. PROCEDURE_SCHEM String => procedure schema (may be null)
  3. PROCEDURE_NAME String => procedure name
  4. reserved for future use
  5. reserved for future use
  6. reserved for future use
  7. REMARKS String => explanatory comment on the procedure
  8. PROCEDURE_TYPE short => kind of procedure:
    • procedureResultUnknown - May return a result
    • procedureNoResult - Does not return a result
    • procedureReturnsResult - Returns a result

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaPattern a schema name pattern; "" retrieves those without a schema
procedureNamePattern a procedure name pattern
Returns:
ResultSet - each row is a procedure description
See also:
getSearchStringEscape

Reimplemented from IZDatabaseMetadata.

Definition at line 2926 of file ZDbcMetadata.pas.

string TZAbstractDatabaseMetadata::GetProceduresCacheKey ( const string  Catalog,
const string  SchemaPattern,
const string  ProcedureNamePattern 
) [inherited]

returns cache key for GetProcedures metadata entry

Parameters:
Catalog a catalog name
SchemaPattern a schema name pattern
ProcedureNamePattern a procedure name pattern
Returns:
the cache key string

Definition at line 5120 of file ZDbcMetadata.pas.

string TZMySQLDatabaseMetadata::GetProcedureTerm (  ) 

What's the database vendor's preferred term for "procedure"?

Returns:
the vendor term

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 738 of file ZDbcMySqlMetadata.pas.

IZResultSet TZAbstractDatabaseMetadata::GetResultSetFromCache ( const string  Key  )  [protected, inherited]

Gets a resultset interface from the internal cache by key.

Parameters:
Key a resultset unique key value.
Returns:
a cached resultset interface or nil otherwise.

Definition at line 1229 of file ZDbcMetadata.pas.

IZResultSet TZAbstractDatabaseMetadata::GetSchemas (  )  [inherited]

Gets the schema names available in this database.

The results are ordered by schema name.

The schema column is:

  1. TABLE_SCHEM String => schema name

Returns:
ResultSet - each row has a single String column that is a schema name

Reimplemented from IZDatabaseMetadata.

Definition at line 3249 of file ZDbcMetadata.pas.

string TZAbstractDatabaseMetadata::GetSchemasCacheKey (  )  [inherited]

returns cache key for GetSchemas metadata entry

Returns:
the cache key string

Definition at line 5190 of file ZDbcMetadata.pas.

string TZMySQLDatabaseMetadata::GetSchemaTerm (  ) 

What's the database vendor's preferred term for "schema"?

Returns:
the vendor term

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 726 of file ZDbcMySqlMetadata.pas.

string TZMySQLDatabaseMetadata::GetSearchStringEscape (  ) 

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

This is the string that can be used to escape '_' or '' in the string pattern style catalog search parameters.

The '_' character represents any single character.

The '' character represents any sequence of zero or more characters.

Returns:
the string used to escape wildcard characters

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 639 of file ZDbcMySqlMetadata.pas.

IZResultSet TZAbstractDatabaseMetadata::GetSequences ( const string  Catalog,
const string  SchemaPattern,
const string  SequenceNamePattern 
) [inherited]

Reimplemented from IZDatabaseMetadata.

Definition at line 4849 of file ZDbcMetadata.pas.

string TZAbstractDatabaseMetadata::GetSequencesCacheKey ( const string  Catalog,
const string  SchemaPattern,
const string  SequenceNamePattern 
) [inherited]

returns cache key for GetSequences metadata entry

Parameters:
Catalog a catalog name
SchemaPattern a schema name pattern
SequenceNamePattern a sequence name pattern
Returns:
the cache key string

Definition at line 5450 of file ZDbcMetadata.pas.

string TZMySQLDatabaseMetadata::GetSQLKeywords (  ) 

Gets a comma-separated list of all a database's SQL keywords that are NOT also SQL92 keywords.

Returns:
the list

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 510 of file ZDbcMySqlMetadata.pas.

string TZMySQLDatabaseMetadata::GetStringFunctions (  ) 

Gets a comma-separated list of string functions.

These are the X/Open CLI string function names used in the JDBC function escape clause.

Returns:
the list

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 570 of file ZDbcMySqlMetadata.pas.

string TZMySQLDatabaseMetadata::GetSystemFunctions (  ) 

Gets a comma-separated list of system functions.

These are the X/Open CLI system function names used in the JDBC function escape clause.

Returns:
the list

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 593 of file ZDbcMySqlMetadata.pas.

IZResultSet TZAbstractDatabaseMetadata::GetTablePrivileges ( const string  Catalog,
const string  SchemaPattern,
const string  TableNamePattern 
) [inherited]

Gets a description of the access rights for each table available in a catalog.

Note that a table privilege applies to one or more columns in the table. It would be wrong to assume that this priviledge applies to all columns (this may be true for some systems but is not true for all.)

Only privileges matching the schema and table name criteria are returned. They are ordered by TABLE_SCHEM, TABLE_NAME, and PRIVILEGE.

Each privilige description has the following columns:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. GRANTOR => grantor of access (may be null)
  5. GRANTEE String => grantee of access
  6. PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
  7. IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaPattern a schema name pattern; "" retrieves those without a schema
tableNamePattern a table name pattern
Returns:
ResultSet - each row is a table privilege description
See also:
getSearchStringEscape

Reimplemented from IZDatabaseMetadata.

Definition at line 3661 of file ZDbcMetadata.pas.

References P.

string TZAbstractDatabaseMetadata::GetTablePrivilegesCacheKey ( const string  Catalog,
const string  SchemaPattern,
const string  TableNamePattern 
) [inherited]

returns cache key for GetTablePrivileges metadata entry

Parameters:
Catalog a catalog name
SchemaPattern a schema name pattern
TableNamePattern a table name pattern
Returns:
the cache key string

Definition at line 5271 of file ZDbcMetadata.pas.

IZResultSet TZAbstractDatabaseMetadata::GetTables ( const string  Catalog,
const string  SchemaPattern,
const string  TableNamePattern,
const TStringDynArray  Types 
) [inherited]

Gets a description of tables available in a catalog.

Only table descriptions matching the catalog, schema, table name and type criteria are returned. They are ordered by TABLE_TYPE, TABLE_SCHEM and TABLE_NAME.

Each table description has the following columns:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
  5. REMARKS String => explanatory comment on the table

Note: Some databases may not return information for all tables.

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaPattern a schema name pattern; "" retrieves those without a schema
tableNamePattern a table name pattern
types a list of table types to include; null returns all types
Returns:
ResultSet - each row is a table description
See also:
getSearchStringEscape

Reimplemented from IZDatabaseMetadata.

Definition at line 3172 of file ZDbcMetadata.pas.

string TZAbstractDatabaseMetadata::GetTablesCacheKey ( const string  Catalog,
const string  SchemaPattern,
const string  TableNamePattern,
const TStringDynArray  Types 
) [inherited]

returns cache key for GetTables metadata entry

Parameters:
Catalog a catalog name
SchemaPattern a schema name pattern
TableNamePattern a table name pattern
Types table types list
Returns:
the cache key string

Definition at line 5161 of file ZDbcMetadata.pas.

IZResultSet TZAbstractDatabaseMetadata::GetTableTypes (  )  [inherited]

Gets the table types available in this database.

The results are ordered by table type.

The table type is:

  1. TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".

Returns:
ResultSet - each row has a single String column that is a table type

Reimplemented from IZDatabaseMetadata.

Definition at line 3355 of file ZDbcMetadata.pas.

string TZAbstractDatabaseMetadata::GetTableTypesCacheKey (  )  [inherited]

returns cache key for GetTableTypes metadata entry

Returns:
the cache key string

Definition at line 5214 of file ZDbcMetadata.pas.

string TZMySQLDatabaseMetadata::GetTimeDateFunctions (  ) 

Gets a comma-separated list of time and date functions.

Returns:
the list

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 610 of file ZDbcMySqlMetadata.pas.

IZResultSet TZAbstractDatabaseMetadata::GetTypeInfo (  )  [inherited]

Gets a description of all the standard SQL types supported by this database.

They are ordered by DATA_TYPE and then by how closely the data type maps to the corresponding JDBC SQL type.

Each type description has the following columns:

  1. TYPE_NAME String => Type name
  2. DATA_TYPE short => SQL data type from java.sql.Types
  3. PRECISION int => maximum precision
  4. LITERAL_PREFIX String => prefix used to quote a literal (may be null)
  5. LITERAL_SUFFIX String => suffix used to quote a literal (may be null)
  6. CREATE_PARAMS String => parameters used in creating the type (may be null)
  7. NULLABLE short => can you use NULL for this type?
    • typeNoNulls - does not allow NULL values
    • typeNullable - allows NULL values
    • typeNullableUnknown - nullability unknown
  8. CASE_SENSITIVE boolean=> is it case sensitive?
  9. SEARCHABLE short => can you use "WHERE" based on this type:
    • typePredNone - No support
    • typePredChar - Only supported with WHERE .. LIKE
    • typePredBasic - Supported except for WHERE .. LIKE
    • typeSearchable - Supported for all WHERE ..
  10. UNSIGNED_ATTRIBUTE boolean => is it unsigned?
  11. FIXED_PREC_SCALE boolean => can it be a money value?
  12. AUTO_INCREMENT boolean => can it be used for an auto-increment value?
  13. LOCAL_TYPE_NAME String => localized version of type name (may be null)
  14. MINIMUM_SCALE short => minimum scale supported
  15. MAXIMUM_SCALE short => maximum scale supported
  16. SQL_DATA_TYPE int => unused
  17. SQL_DATETIME_SUB int => unused
  18. NUM_PREC_RADIX int => usually 2 or 10

Returns:
ResultSet - each row is an SQL type description

Reimplemented from IZDatabaseMetadata.

Definition at line 4636 of file ZDbcMetadata.pas.

string TZAbstractDatabaseMetadata::GetTypeInfoCacheKey (  )  [inherited]

returns cache key for GetTypeInfo metadata entry

Returns:
the cache key string

Definition at line 5408 of file ZDbcMetadata.pas.

IZResultSet TZAbstractDatabaseMetadata::GetUDTs ( const string  Catalog,
const string  SchemaPattern,
const string  TypeNamePattern,
const TIntegerDynArray  Types 
) [inherited]

Gets a description of the user-defined types defined in a particular schema.

Schema-specific UDTs may have type JAVA_OBJECT, STRUCT, or DISTINCT.

Only types matching the catalog, schema, type name and type criteria are returned. They are ordered by DATA_TYPE, TYPE_SCHEM and TYPE_NAME. The type name parameter may be a fully-qualified name. In this case, the catalog and schemaPattern parameters are ignored.

Each type description has the following columns:

  1. TYPE_CAT String => the type's catalog (may be null)
  2. TYPE_SCHEM String => type's schema (may be null)
  3. TYPE_NAME String => type name
  4. CLASS_NAME String => Java class name
  5. DATA_TYPE String => type value defined in java.sql.Types. One of JAVA_OBJECT, STRUCT, or DISTINCT
  6. REMARKS String => explanatory comment on the type

Note: If the driver does not support UDTs, an empty result set is returned.

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaPattern a schema name pattern; "" retrieves those without a schema
typeNamePattern a type name pattern; may be a fully-qualified name
types a list of user-named types to include (JAVA_OBJECT, STRUCT, or DISTINCT); null returns all types
Returns:
ResultSet - each row is a type description

Reimplemented from IZDatabaseMetadata.

Definition at line 4962 of file ZDbcMetadata.pas.

string TZAbstractDatabaseMetadata::GetUDTsCacheKey ( const string  Catalog,
const string  SchemaPattern,
const string  TypeNamePattern,
const TIntegerDynArray  Types 
) [inherited]

returns cache key for GetUDTs metadata entry

Parameters:
Catalog a catalog name
SchemaPattern a schema name pattern
TypeNamePattern a type name pattern
Types a list of user-named types to include
Returns:
the cache key string

Definition at line 5470 of file ZDbcMetadata.pas.

string TZAbstractDatabaseMetadata::GetURL (  )  [inherited]

What's the url for this database?

Returns:
the url or null if it cannot be generated

Reimplemented from IZDatabaseMetadata.

Definition at line 1398 of file ZDbcMetadata.pas.

string TZAbstractDatabaseMetadata::GetUserName (  )  [inherited]

What's our user name as known to the database?

Returns:
our database user name

Reimplemented from IZDatabaseMetadata.

Definition at line 1410 of file ZDbcMetadata.pas.

TZMySQLDatabaseMetadata::GetVersion ( integer &  MajorVersion,
integer &  MinorVersion 
) [protected]

IZResultSet TZAbstractDatabaseMetadata::GetVersionColumns ( const string  Catalog,
const string  Schema,
const string  Table 
) [inherited]

Gets a description of a table's columns that are automatically updated when any value in a row is updated.

They are unordered.

Each column description has the following columns:

  1. SCOPE short => is not used
  2. COLUMN_NAME String => column name
  3. DATA_TYPE short => SQL data type from java.sql.Types
  4. TYPE_NAME String => Data source dependent type name
  5. COLUMN_SIZE int => precision
  6. BUFFER_LENGTH int => length of column value in bytes
  7. DECIMAL_DIGITS short => scale
  8. PSEUDO_COLUMN short => is this a pseudo column like an Oracle ROWID
    • versionColumnUnknown - may or may not be pseudo column
    • versionColumnNotPseudo - is NOT a pseudo column
    • versionColumnPseudo - is a pseudo column

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schema a schema name; "" retrieves those without a schema
table a table name
Returns:
ResultSet - each row is a column description
Exceptions:
SQLException if a database access error occurs

Reimplemented from IZDatabaseMetadata.

Definition at line 3921 of file ZDbcMetadata.pas.

string TZAbstractDatabaseMetadata::GetVersionColumnsCacheKey ( const string  Catalog,
const string  Schema,
const string  Table 
) [inherited]

returns cache key for GetVersionColumns metadata entry

Parameters:
Catalog a catalog name
Schema a schema name
Table a table name
Returns:
the cache key string

Definition at line 5313 of file ZDbcMetadata.pas.

TZWildcardsSet TZAbstractDatabaseMetadata::GetWildcardsSet (  )  [protected, inherited]

Get the Wildscards in set of char type.

Returns:
TZWildcardsSet type

Definition at line 5094 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::IsCatalogAtStart (  )  [inherited]

Does a catalog appear at the start of a qualified table name? (Otherwise it appears at the end).

Returns:
true if it appears at the start

Reimplemented from IZDatabaseMetadata.

Definition at line 2185 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::IsReadOnly (  )  [inherited]

Is the database in read-only mode?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 1424 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::NullPlusNonNullIsNull (  )  [inherited]

Are concatenations between NULL and non-NULL values NULL? For SQL-92 compliance, a JDBC technology-enabled driver will return true.

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 1846 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::NullsAreSortedAtEnd (  )  [inherited]

Are NULL values sorted at the end regardless of sort order?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 1472 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::NullsAreSortedAtStart (  )  [inherited]

Are NULL values sorted at the start regardless of sort order?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZASADatabaseMetadata.

Definition at line 1460 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::NullsAreSortedHigh (  )  [inherited]

Are NULL values sorted high?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 1436 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::NullsAreSortedLow (  )  [inherited]

Are NULL values sorted low?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 1448 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::StoresLowerCaseIdentifiers (  )  [inherited]

Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in lower case?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 1608 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::StoresLowerCaseQuotedIdentifiers (  )  [inherited]

Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in lower case?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 1661 of file ZDbcMetadata.pas.

Boolean TZMySQLDatabaseMetadata::StoresMixedCaseIdentifiers (  ) 

Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in mixed case?

Returns:
true if so; false otherwise

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 482 of file ZDbcMySqlMetadata.pas.

Boolean TZAbstractDatabaseMetadata::StoresMixedCaseQuotedIdentifiers (  )  [inherited]

Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in mixed case?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 1674 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::StoresUpperCaseIdentifiers (  )  [inherited]

Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in upper case?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 1595 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::StoresUpperCaseQuotedIdentifiers (  )  [inherited]

Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in upper case?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 1648 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsAlterTableWithAddColumn (  )  [inherited]

Is "ALTER TABLE" with add column supported?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 1803 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsAlterTableWithDropColumn (  )  [inherited]

Is "ALTER TABLE" with drop column supported?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 1815 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsANSI92EntryLevelSQL (  )  [inherited]

Is the ANSI92 entry level SQL grammar supported? All JDBC Compliant<font size="-2">TM</font> drivers must return true.

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 2063 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsANSI92FullSQL (  )  [inherited]

Is the ANSI92 full SQL grammar supported?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 2087 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsANSI92IntermediateSQL (  )  [inherited]

Is the ANSI92 intermediate SQL grammar supported?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 2075 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsBatchUpdates (  )  [inherited]

Indicates whether the driver supports batch updates.

Returns:
true if the driver supports batch updates; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 4919 of file ZDbcMetadata.pas.

Boolean TZMySQLDatabaseMetadata::SupportsCatalogsInDataManipulation (  ) 

Can a catalog name be used in a data manipulation statement?

Returns:
true if so; false otherwise

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 762 of file ZDbcMySqlMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsCatalogsInIndexDefinitions (  )  [inherited]

Can a catalog name be used in an index definition statement?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 2305 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsCatalogsInPrivilegeDefinitions (  )  [inherited]

Can a catalog name be used in a privilege definition statement?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 2317 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsCatalogsInProcedureCalls (  )  [inherited]

Can a catalog name be used in a procedure call statement?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 2281 of file ZDbcMetadata.pas.

Boolean TZMySQLDatabaseMetadata::SupportsCatalogsInTableDefinitions (  ) 

Can a catalog name be used in a table definition statement?

Returns:
true if so; false otherwise

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 783 of file ZDbcMySqlMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsColumnAliasing (  )  [inherited]

Is column aliasing supported?

If so, the SQL AS clause can be used to provide names for computed columns or to provide alias names for columns as required. A JDBC Compliant<font size="-2">TM</font> driver always returns true.

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 1832 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsConvert (  )  [inherited]

Is the CONVERT function between SQL types supported?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 1858 of file ZDbcMetadata.pas.

References P.

Boolean TZAbstractDatabaseMetadata::SupportsConvertForTypes ( TZSQLType  FromType,
TZSQLType  ToType 
) [inherited]

Is CONVERT between the given SQL types supported?

Parameters:
fromType the type to convert from
toType the type to convert to
Returns:
true if so; false otherwise
See also:
Types

Reimplemented from IZDatabaseMetadata.

Definition at line 1873 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsCoreSQLGrammar (  )  [inherited]

Is the ODBC Core SQL grammar supported?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 2038 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsCorrelatedSubqueries (  )  [inherited]

Are correlated subqueries supported? A JDBC Compliant<font size="-2">TM</font> driver always returns true.

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 2431 of file ZDbcMetadata.pas.

Boolean TZMySQLDatabaseMetadata::SupportsDataDefinitionAndDataManipulationTransactions (  ) 

Reimplemented from TZAbstractDatabaseMetadata.

Boolean TZMySQLDatabaseMetadata::SupportsDataManipulationTransactionsOnly (  ) 

Are only data manipulation statements within a transaction supported?

Returns:
true if so; false otherwise

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 1142 of file ZDbcMySqlMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsDifferentTableCorrelationNames (  )  [inherited]

If table correlation names are supported, are they restricted to be different from the names of the tables?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 1901 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsExpressionsInOrderBy (  )  [inherited]

Are expressions in "ORDER BY" lists supported?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 1913 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsExtendedSQLGrammar (  )  [inherited]

Is the ODBC Extended SQL grammar supported?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 2050 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsFullOuterJoins (  )  [inherited]

Are full nested outer joins supported?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 2123 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsGroupBy (  )  [inherited]

Is some form of "GROUP BY" clause supported?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 1937 of file ZDbcMetadata.pas.

Boolean TZMySQLDatabaseMetadata::SupportsGroupByBeyondSelect (  ) 

Can a "GROUP BY" clause add columns not in the SELECT provided it specifies all the columns in the SELECT?

Returns:
true if so; false otherwise

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 702 of file ZDbcMySqlMetadata.pas.

Boolean TZMySQLDatabaseMetadata::SupportsGroupByUnrelated (  ) 

Can a "GROUP BY" clause use columns not in the SELECT?

Returns:
true if so; false otherwise

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 689 of file ZDbcMySqlMetadata.pas.

Boolean TZMySQLDatabaseMetadata::SupportsIntegrityEnhancementFacility (  ) 

Is the SQL Integrity Enhancement Facility supported?

Returns:
true if so; false otherwise

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 714 of file ZDbcMySqlMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsLikeEscapeClause (  )  [inherited]

Is the escape character in "LIKE" clauses supported? A JDBC Compliant<font size="-2">TM</font> driver always returns true.

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 1975 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsLimitedOuterJoins (  )  [inherited]

Is there limited support for outer joins? (This will be true if supportFullOuterJoins is true.

)

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 2136 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsMinimumSQLGrammar (  )  [inherited]

Is the ODBC Minimum SQL grammar supported? All JDBC Compliant<font size="-2">TM</font> drivers must return true.

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 2026 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsMixedCaseIdentifiers (  )  [inherited]

Does the database treat mixed case unquoted SQL identifiers as case sensitive and as a result store them in mixed case? A JDBC Compliant<font size="-2">TM</font> driver will always return false.

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 1582 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsMixedCaseQuotedIdentifiers (  )  [inherited]

Does the database treat mixed case quoted SQL identifiers as case sensitive and as a result store them in mixed case? A JDBC Compliant<font size="-2">TM</font> driver will always return true.

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 1635 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsMultipleResultSets (  )  [inherited]

Are multiple ResultSet from a single execute supported?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 1987 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsMultipleTransactions (  )  [inherited]

Can we have multiple transactions open at once (on different connections)?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 2000 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsNonNullableColumns (  )  [inherited]

Can columns be defined as non-nullable? A JDBC Compliant<font size="-2">TM</font> driver always returns true.

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 2013 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsOpenCursorsAcrossCommit (  )  [inherited]

Can cursors remain open across commits?

Returns:
true if cursors always remain open; false if they might not remain open

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 2468 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsOpenCursorsAcrossRollback (  )  [inherited]

Can cursors remain open across rollbacks?

Returns:
true if cursors always remain open; false if they might not remain open

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 2481 of file ZDbcMetadata.pas.

Boolean TZMySQLDatabaseMetadata::SupportsOpenStatementsAcrossCommit (  ) 

Can statements remain open across commits?

Returns:
true if statements always remain open; false if they might not remain open

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 830 of file ZDbcMySqlMetadata.pas.

Boolean TZMySQLDatabaseMetadata::SupportsOpenStatementsAcrossRollback (  ) 

Can statements remain open across rollbacks?

Returns:
true if statements always remain open; false if they might not remain open

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 843 of file ZDbcMySqlMetadata.pas.

Boolean TZMySQLDatabaseMetadata::SupportsOrderByUnrelated (  ) 

Can an "ORDER BY" clause use columns not in the SELECT statement?

Returns:
true if so; false otherwise

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 667 of file ZDbcMySqlMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsOuterJoins (  )  [inherited]

Is some form of outer join supported?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 2111 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsPositionedDelete (  )  [inherited]

Is positioned DELETE supported?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 2329 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsPositionedUpdate (  )  [inherited]

Is positioned UPDATE supported?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 2341 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsResultSetConcurrency ( TZResultSetType  _Type,
TZResultSetConcurrency  Concurrency 
) [inherited]

Does the database support the concurrency type in combination with the given result set type?

Parameters:
type defined in java.sql.ResultSet
concurrency type defined in java.sql.ResultSet
Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 4905 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsResultSetType ( TZResultSetType  _Type  )  [inherited]

Does the database support the given result set type?

Parameters:
type defined in java.sql.ResultSet
Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 4888 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsSchemasInDataManipulation (  )  [inherited]

Can a schema name be used in a data manipulation statement?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 2209 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsSchemasInIndexDefinitions (  )  [inherited]

Can a schema name be used in an index definition statement?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 2245 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsSchemasInPrivilegeDefinitions (  )  [inherited]

Can a schema name be used in a privilege definition statement?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 2257 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsSchemasInProcedureCalls (  )  [inherited]

Can a schema name be used in a procedure call statement?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 2221 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsSchemasInTableDefinitions (  )  [inherited]

Can a schema name be used in a table definition statement?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 2233 of file ZDbcMetadata.pas.

References P.

Boolean TZAbstractDatabaseMetadata::SupportsSelectForUpdate (  )  [inherited]

Is SELECT for UPDATE supported?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 2353 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsStoredProcedures (  )  [inherited]

Are stored procedure calls using the stored procedure escape syntax supported?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 2366 of file ZDbcMetadata.pas.

References P.

Boolean TZMySQLDatabaseMetadata::SupportsSubqueriesInComparisons (  ) 

Are subqueries in comparison expressions supported? A JDBC Compliant<font size="-2">TM</font> driver always returns true.

Returns:
true if so; false otherwise

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 796 of file ZDbcMySqlMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsSubqueriesInExists (  )  [inherited]

Are subqueries in 'exists' expressions supported? A JDBC Compliant<font size="-2">TM</font> driver always returns true.

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 2392 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsSubqueriesInIns (  )  [inherited]

Are subqueries in 'in' statements supported? A JDBC Compliant<font size="-2">TM</font> driver always returns true.

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 2405 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsSubqueriesInQuantifieds (  )  [inherited]

Are subqueries in quantified expressions supported? A JDBC Compliant<font size="-2">TM</font> driver always returns true.

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 2418 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsTableCorrelationNames (  )  [inherited]

Are table correlation names supported? A JDBC Compliant<font size="-2">TM</font> driver always returns true.

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Definition at line 1888 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsTransactionIsolationLevel ( TZTransactIsolationLevel  Level  )  [inherited]

Does this database support the given transaction isolation level?

Parameters:
level the values are defined in java.sql.Connection
Returns:
true if so; false otherwise
See also:
Connection

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 2833 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsTransactions (  )  [inherited]

Are transactions supported? If not, invoking the method commit is a noop and the isolation level is TRANSACTION_NONE.

Returns:
true if transactions are supported; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, TZOracleDatabaseMetadata, TZPostgreSQLDatabaseMetadata, and TZSQLiteDatabaseMetadata.

Definition at line 2819 of file ZDbcMetadata.pas.

Boolean TZAbstractDatabaseMetadata::SupportsUnion (  )  [inherited]

Boolean TZMySQLDatabaseMetadata::SupportsUnionAll (  ) 

Is SQL UNION ALL supported?

Returns:
true if so; false otherwise

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 808 of file ZDbcMySqlMetadata.pas.

References P.

IZResultSet TZAbstractDatabaseMetadata::UncachedGetBestRowIdentifier ( const string  Catalog,
const string  Schema,
const string  Table,
Integer  Scope,
Boolean  Nullable 
) [protected, inherited]

Gets a description of a table's optimal set of columns that uniquely identifies a row.

They are ordered by SCOPE.

Each column description has the following columns:

  1. SCOPE short => actual scope of result
    • bestRowTemporary - very temporary, while using row
    • bestRowTransaction - valid for remainder of current transaction
    • bestRowSession - valid for remainder of current session
  2. COLUMN_NAME String => column name
  3. DATA_TYPE short => SQL data type from java.sql.Types
  4. TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified
  5. COLUMN_SIZE int => precision
  6. BUFFER_LENGTH int => not used
  7. DECIMAL_DIGITS short => scale
  8. PSEUDO_COLUMN short => is this a pseudo column like an Oracle ROWID
    • bestRowUnknown - may or may not be pseudo column
    • bestRowNotPseudo - is NOT a pseudo column
    • bestRowPseudo - is a pseudo column

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schema a schema name; "" retrieves those without a schema
table a table name
scope the scope of interest; use same values as SCOPE
nullable include columns that are nullable?
Returns:
ResultSet - each row is a column description

Definition at line 3826 of file ZDbcMetadata.pas.

IZResultSet TZMySQLDatabaseMetadata::UncachedGetCatalogs (  )  [protected]

Gets the catalog names available in this database.

The results are ordered by catalog name.

The catalog column is:

  1. TABLE_CAT String => catalog name

Returns:
ResultSet - each row has a single String column that is a catalog name

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 1277 of file ZDbcMySqlMetadata.pas.

IZResultSet TZMySQLDatabaseMetadata::UncachedGetColumnPrivileges ( const string  Catalog,
const string  Schema,
const string  Table,
const string  ColumnNamePattern 
) [protected]

Gets a description of the access rights for a table's columns.

Only privileges matching the column name criteria are returned. They are ordered by COLUMN_NAME and PRIVILEGE.

Each privilige description has the following columns:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. COLUMN_NAME String => column name
  5. GRANTOR => grantor of access (may be null)
  6. GRANTEE String => grantee of access
  7. PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
  8. IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schema a schema name; "" retrieves those without a schema
table a table name
columnNamePattern a column name pattern
Returns:
ResultSet - each row is a column privilege description
See also:
getSearchStringEscape

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 1642 of file ZDbcMySqlMetadata.pas.

IZResultSet TZMySQLDatabaseMetadata::UncachedGetColumns ( const string  Catalog,
const string  SchemaPattern,
const string  TableNamePattern,
const string  ColumnNamePattern 
) [protected]

Gets a description of table columns available in the specified catalog.

Only column descriptions matching the catalog, schema, table and column name criteria are returned. They are ordered by TABLE_SCHEM, TABLE_NAME and ORDINAL_POSITION.

Each column description has the following columns:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. COLUMN_NAME String => column name
  5. DATA_TYPE short => SQL type from java.sql.Types
  6. TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified
  7. COLUMN_SIZE int => column size. For char or date types this is the maximum number of characters, for numeric or decimal types this is precision.
  8. BUFFER_LENGTH is not used.
  9. DECIMAL_DIGITS int => the number of fractional digits
  10. NUM_PREC_RADIX int => Radix (typically either 10 or 2)
  11. NULLABLE int => is NULL allowed?
    • columnNoNulls - might not allow NULL values
    • columnNullable - definitely allows NULL values
    • columnNullableUnknown - nullability unknown
  12. REMARKS String => comment describing column (may be null)
  13. COLUMN_DEF String => default value (may be null)
  14. SQL_DATA_TYPE int => unused
  15. SQL_DATETIME_SUB int => unused
  16. CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column
  17. ORDINAL_POSITION int => index of column in table (starting at 1)
  18. IS_NULLABLE String => "NO" means column definitely does not allow NULL values; "YES" means the column might allow NULL values. An empty string means nobody knows.

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaPattern a schema name pattern; "" retrieves those without a schema
tableNamePattern a table name pattern
columnNamePattern a column name pattern
Returns:
ResultSet - each row is a column description
See also:
getSearchStringEscape

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 1368 of file ZDbcMySqlMetadata.pas.

References P.

IZResultSet TZMySQLDatabaseMetadata::UncachedGetCrossReference ( const string  PrimaryCatalog,
const string  PrimarySchema,
const string  PrimaryTable,
const string  ForeignCatalog,
const string  ForeignSchema,
const string  ForeignTable 
) [protected]

Gets a description of the foreign key columns in the foreign key table that reference the primary key columns of the primary key table (describe how one table imports another's key.

) This should normally return a single foreign key/primary key pair (most tables only import a foreign key from a table once.) They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.

Each foreign key column description has the following columns:

  1. PKTABLE_CAT String => primary key table catalog (may be null)
  2. PKTABLE_SCHEM String => primary key table schema (may be null)
  3. PKTABLE_NAME String => primary key table name
  4. PKCOLUMN_NAME String => primary key column name
  5. FKTABLE_CAT String => foreign key table catalog (may be null) being exported (may be null)
  6. FKTABLE_SCHEM String => foreign key table schema (may be null) being exported (may be null)
  7. FKTABLE_NAME String => foreign key table name being exported
  8. FKCOLUMN_NAME String => foreign key column name being exported
  9. KEY_SEQ short => sequence number within foreign key
  10. UPDATE_RULE short => What happens to foreign key when primary is updated:
    • importedNoAction - do not allow update of primary key if it has been imported
    • importedKeyCascade - change imported key to agree with primary key update
    • importedKeySetNull - change imported key to NULL if its primary key has been updated
    • importedKeySetDefault - change imported key to default values if its primary key has been updated
    • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
  11. DELETE_RULE short => What happens to the foreign key when primary is deleted.
    • importedKeyNoAction - do not allow delete of primary key if it has been imported
    • importedKeyCascade - delete rows that import a deleted key
    • importedKeySetNull - change imported key to NULL if its primary key has been deleted
    • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
    • importedKeySetDefault - change imported key to default if its primary key has been deleted
  12. FK_NAME String => foreign key name (may be null)
  13. PK_NAME String => primary key name (may be null)
  14. DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
    • importedKeyInitiallyDeferred - see SQL92 for definition
    • importedKeyInitiallyImmediate - see SQL92 for definition
    • importedKeyNotDeferrable - see SQL92 for definition

Parameters:
primaryCatalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
primarySchema a schema name; "" retrieves those without a schema
primaryTable the table name that exports the key
foreignCatalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
foreignSchema a schema name; "" retrieves those without a schema
foreignTable the table name that imports the key
Returns:
ResultSet - each row is a foreign key column description
See also:
getImportedKeys

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 2236 of file ZDbcMySqlMetadata.pas.

IZResultSet TZMySQLDatabaseMetadata::UncachedGetExportedKeys ( const string  Catalog,
const string  Schema,
const string  Table 
) [protected]

Gets a description of the foreign key columns that reference a table's primary key columns (the foreign keys exported by a table).

They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ.

Each foreign key column description has the following columns:

  1. PKTABLE_CAT String => primary key table catalog (may be null)
  2. PKTABLE_SCHEM String => primary key table schema (may be null)
  3. PKTABLE_NAME String => primary key table name
  4. PKCOLUMN_NAME String => primary key column name
  5. FKTABLE_CAT String => foreign key table catalog (may be null) being exported (may be null)
  6. FKTABLE_SCHEM String => foreign key table schema (may be null) being exported (may be null)
  7. FKTABLE_NAME String => foreign key table name being exported
  8. FKCOLUMN_NAME String => foreign key column name being exported
  9. KEY_SEQ short => sequence number within foreign key
  10. UPDATE_RULE short => What happens to foreign key when primary is updated:
    • importedNoAction - do not allow update of primary key if it has been imported
    • importedKeyCascade - change imported key to agree with primary key update
    • importedKeySetNull - change imported key to NULL if its primary key has been updated
    • importedKeySetDefault - change imported key to default values if its primary key has been updated
    • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
  11. DELETE_RULE short => What happens to the foreign key when primary is deleted.
    • importedKeyNoAction - do not allow delete of primary key if it has been imported
    • importedKeyCascade - delete rows that import a deleted key
    • importedKeySetNull - change imported key to NULL if its primary key has been deleted
    • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
    • importedKeySetDefault - change imported key to default if its primary key has been deleted
  12. FK_NAME String => foreign key name (may be null)
  13. PK_NAME String => primary key name (may be null)
  14. DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
    • importedKeyInitiallyDeferred - see SQL92 for definition
    • importedKeyInitiallyImmediate - see SQL92 for definition
    • importedKeyNotDeferrable - see SQL92 for definition

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schema a schema name; "" retrieves those without a schema
table a table name
Returns:
ResultSet - each row is a foreign key column description
See also:
getImportedKeys

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 2084 of file ZDbcMySqlMetadata.pas.

IZResultSet TZMySQLDatabaseMetadata::UncachedGetImportedKeys ( const string  Catalog,
const string  Schema,
const string  Table 
) [protected]

Gets a description of the primary key columns that are referenced by a table's foreign key columns (the primary keys imported by a table).

They are ordered by PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME, and KEY_SEQ.

Each primary key column description has the following columns:

  1. PKTABLE_CAT String => primary key table catalog being imported (may be null)
  2. PKTABLE_SCHEM String => primary key table schema being imported (may be null)
  3. PKTABLE_NAME String => primary key table name being imported
  4. PKCOLUMN_NAME String => primary key column name being imported
  5. FKTABLE_CAT String => foreign key table catalog (may be null)
  6. FKTABLE_SCHEM String => foreign key table schema (may be null)
  7. FKTABLE_NAME String => foreign key table name
  8. FKCOLUMN_NAME String => foreign key column name
  9. KEY_SEQ short => sequence number within foreign key
  10. UPDATE_RULE short => What happens to foreign key when primary is updated:
    • importedNoAction - do not allow update of primary key if it has been imported
    • importedKeyCascade - change imported key to agree with primary key update
    • importedKeySetNull - change imported key to NULL if its primary key has been updated
    • importedKeySetDefault - change imported key to default values if its primary key has been updated
    • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
  11. DELETE_RULE short => What happens to the foreign key when primary is deleted.
    • importedKeyNoAction - do not allow delete of primary key if it has been imported
    • importedKeyCascade - delete rows that import a deleted key
    • importedKeySetNull - change imported key to NULL if its primary key has been deleted
    • importedKeyRestrict - same as importedKeyNoAction (for ODBC 2.x compatibility)
    • importedKeySetDefault - change imported key to default if its primary key has been deleted
  12. FK_NAME String => foreign key name (may be null)
  13. PK_NAME String => primary key name (may be null)
  14. DEFERRABILITY short => can the evaluation of foreign key constraints be deferred until commit
    • importedKeyInitiallyDeferred - see SQL92 for definition
    • importedKeyInitiallyImmediate - see SQL92 for definition
    • importedKeyNotDeferrable - see SQL92 for definition

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schema a schema name; "" retrieves those without a schema
table a table name
Returns:
ResultSet - each row is a primary key column description
See also:
getExportedKeys

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 1940 of file ZDbcMySqlMetadata.pas.

References P.

IZResultSet TZMySQLDatabaseMetadata::UncachedGetIndexInfo ( const string  Catalog,
const string  Schema,
const string  Table,
Boolean  Unique,
Boolean  Approximate 
) [protected]

Gets a description of a table's indices and statistics.

They are ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION.

Each index column description has the following columns:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. NON_UNIQUE boolean => Can index values be non-unique? false when TYPE is tableIndexStatistic
  5. INDEX_QUALIFIER String => index catalog (may be null); null when TYPE is tableIndexStatistic
  6. INDEX_NAME String => index name; null when TYPE is tableIndexStatistic
  7. TYPE short => index type:
    • tableIndexStatistic - this identifies table statistics that are returned in conjuction with a table's index descriptions
    • tableIndexClustered - this is a clustered index
    • tableIndexHashed - this is a hashed index
    • tableIndexOther - this is some other style of index
  8. ORDINAL_POSITION short => column sequence number within index; zero when TYPE is tableIndexStatistic
  9. COLUMN_NAME String => column name; null when TYPE is tableIndexStatistic
  10. ASC_OR_DESC String => column sort sequence, "A" => ascending, "D" => descending, may be null if sort sequence is not supported; null when TYPE is tableIndexStatistic
  11. CARDINALITY int => When TYPE is tableIndexStatistic, then this is the number of rows in the table; otherwise, it is the number of unique values in the index.
  12. PAGES int => When TYPE is tableIndexStatisic then this is the number of pages used for the table, otherwise it is the number of pages used for the current index.
  13. FILTER_CONDITION String => Filter condition, if any. (may be null)

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schema a schema name; "" retrieves those without a schema
table a table name
unique when true, return only indices for unique values; when false, return indices regardless of whether unique or not
approximate when true, result is allowed to reflect approximate or out of data values; when false, results are requested to be accurate
Returns:
ResultSet - each row is an index column description

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 2493 of file ZDbcMySqlMetadata.pas.

IZResultSet TZMySQLDatabaseMetadata::UncachedGetPrimaryKeys ( const string  Catalog,
const string  Schema,
const string  Table 
) [protected]

Gets a description of a table's primary key columns.

They are ordered by COLUMN_NAME.

Each primary key column description has the following columns:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. COLUMN_NAME String => column name
  5. KEY_SEQ short => sequence number within primary key
  6. PK_NAME String => primary key name (may be null)

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schema a schema name; "" retrieves those without a schema
table a table name
Returns:
ResultSet - each row is a primary key column description
Exceptions:
SQLException if a database access error occurs

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 1823 of file ZDbcMySqlMetadata.pas.

IZResultSet TZAbstractDatabaseMetadata::UncachedGetProcedureColumns ( const string  Catalog,
const string  SchemaPattern,
const string  ProcedureNamePattern,
const string  ColumnNamePattern 
) [protected, inherited]

Gets a description of a catalog's stored procedure parameters and result columns.

Only descriptions matching the schema, procedure and parameter name criteria are returned. They are ordered by PROCEDURE_SCHEM and PROCEDURE_NAME. Within this, the return value, if any, is first. Next are the parameter descriptions in call order. The column descriptions follow in column number order.

Each row in the ResultSet is a parameter description or column description with the following fields:

  1. PROCEDURE_CAT String => procedure catalog (may be null)
  2. PROCEDURE_SCHEM String => procedure schema (may be null)
  3. PROCEDURE_NAME String => procedure name
  4. COLUMN_NAME String => column/parameter name
  5. COLUMN_TYPE Short => kind of column/parameter:
    • procedureColumnUnknown - nobody knows
    • procedureColumnIn - IN parameter
    • procedureColumnInOut - INOUT parameter
    • procedureColumnOut - OUT parameter
    • procedureColumnReturn - procedure return value
    • procedureColumnResult - result column in ResultSet
  6. DATA_TYPE short => SQL type from java.sql.Types
  7. TYPE_NAME String => SQL type name, for a UDT type the type name is fully qualified
  8. PRECISION int => precision
  9. LENGTH int => length in bytes of data
  10. SCALE short => scale
  11. RADIX short => radix
  12. NULLABLE short => can it contain NULL?
    • procedureNoNulls - does not allow NULL values
    • procedureNullable - allows NULL values
    • procedureNullableUnknown - nullability unknown
  13. REMARKS String => comment describing parameter/column

Note: Some databases may not return the column descriptions for a procedure. Additional columns beyond REMARKS can be defined by the database.

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaPattern a schema name pattern; "" retrieves those without a schema
procedureNamePattern a procedure name pattern
columnNamePattern a column name pattern
Returns:
ResultSet - each row describes a stored procedure parameter or column
See also:
getSearchStringEscape

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, and TZPostgreSQLDatabaseMetadata.

Definition at line 3130 of file ZDbcMetadata.pas.

IZResultSet TZAbstractDatabaseMetadata::UncachedGetProcedures ( const string  Catalog,
const string  SchemaPattern,
const string  ProcedureNamePattern 
) [protected, inherited]

Gets a description of the stored procedures available in a catalog.

Only procedure descriptions matching the schema and procedure name criteria are returned. They are ordered by PROCEDURE_SCHEM, and PROCEDURE_NAME.

Each procedure description has the the following columns:

  1. PROCEDURE_CAT String => procedure catalog (may be null)
  2. PROCEDURE_SCHEM String => procedure schema (may be null)
  3. PROCEDURE_NAME String => procedure name
  4. reserved for future use
  5. reserved for future use
  6. reserved for future use
  7. REMARKS String => explanatory comment on the procedure
  8. PROCEDURE_TYPE short => kind of procedure:
    • procedureResultUnknown - May return a result
    • procedureNoResult - Does not return a result
    • procedureReturnsResult - Returns a result

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaPattern a schema name pattern; "" retrieves those without a schema
procedureNamePattern a procedure name pattern
Returns:
ResultSet - each row is a procedure description
See also:
getSearchStringEscape

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZInterbase6DatabaseMetadata, and TZPostgreSQLDatabaseMetadata.

Definition at line 2982 of file ZDbcMetadata.pas.

IZResultSet TZAbstractDatabaseMetadata::UncachedGetSchemas (  )  [protected, inherited]

Gets the schema names available in this database.

The results are ordered by schema name.

The schema column is:

  1. TABLE_SCHEM String => schema name

Returns:
ResultSet - each row has a single String column that is a schema name

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, TZSybaseDatabaseMetadata, TZOracleDatabaseMetadata, and TZPostgreSQLDatabaseMetadata.

Definition at line 3281 of file ZDbcMetadata.pas.

IZResultSet TZAbstractDatabaseMetadata::UncachedGetSequences ( const string  Catalog,
const string  SchemaPattern,
const string  SequenceNamePattern 
) [protected, inherited]

Reimplemented in TZInterbase6DatabaseMetadata, and TZPostgreSQLDatabaseMetadata.

Definition at line 4872 of file ZDbcMetadata.pas.

IZResultSet TZMySQLDatabaseMetadata::UncachedGetTablePrivileges ( const string  Catalog,
const string  SchemaPattern,
const string  TableNamePattern 
) [protected]

Gets a description of the access rights for each table available in a catalog.

Note that a table privilege applies to one or more columns in the table. It would be wrong to assume that this priviledge applies to all columns (this may be true for some systems but is not true for all.)

Only privileges matching the schema and table name criteria are returned. They are ordered by TABLE_SCHEM, TABLE_NAME, and PRIVILEGE.

Each privilige description has the following columns:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. GRANTOR => grantor of access (may be null)
  5. GRANTEE String => grantee of access
  6. PRIVILEGE String => name of access (SELECT, INSERT, UPDATE, REFRENCES, ...)
  7. IS_GRANTABLE String => "YES" if grantee is permitted to grant to others; "NO" if not; null if unknown

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaPattern a schema name pattern; "" retrieves those without a schema
tableNamePattern a table name pattern
Returns:
ResultSet - each row is a table privilege description
See also:
getSearchStringEscape

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 1740 of file ZDbcMySqlMetadata.pas.

IZResultSet TZMySQLDatabaseMetadata::UncachedGetTables ( const string  Catalog,
const string  SchemaPattern,
const string  TableNamePattern,
const TStringDynArray  Types 
) [protected]

Gets a description of tables available in a catalog.

Only table descriptions matching the catalog, schema, table name and type criteria are returned. They are ordered by TABLE_TYPE, TABLE_SCHEM and TABLE_NAME.

Each table description has the following columns:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
  5. REMARKS String => explanatory comment on the table

Note: Some databases may not return information for all tables.

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaPattern a schema name pattern; "" retrieves those without a schema
tableNamePattern a table name pattern
types a list of table types to include; null returns all types
Returns:
ResultSet - each row is a table description
See also:
getSearchStringEscape

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 1210 of file ZDbcMySqlMetadata.pas.

IZResultSet TZMySQLDatabaseMetadata::UncachedGetTableTypes (  )  [protected]

Gets the table types available in this database.

The results are ordered by table type.

The table type is:

  1. TABLE_TYPE String => table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".

Returns:
ResultSet - each row has a single String column that is a table type

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 1306 of file ZDbcMySqlMetadata.pas.

IZResultSet TZMySQLDatabaseMetadata::UncachedGetTypeInfo (  )  [protected]

Gets a description of all the standard SQL types supported by this database.

They are ordered by DATA_TYPE and then by how closely the data type maps to the corresponding JDBC SQL type.

Each type description has the following columns:

  1. TYPE_NAME String => Type name
  2. DATA_TYPE short => SQL data type from java.sql.Types
  3. PRECISION int => maximum precision
  4. LITERAL_PREFIX String => prefix used to quote a literal (may be null)
  5. LITERAL_SUFFIX String => suffix used to quote a literal (may be null)
  6. CREATE_PARAMS String => parameters used in creating the type (may be null)
  7. NULLABLE short => can you use NULL for this type?
    • typeNoNulls - does not allow NULL values
    • typeNullable - allows NULL values
    • typeNullableUnknown - nullability unknown
  8. CASE_SENSITIVE boolean=> is it case sensitive?
  9. SEARCHABLE short => can you use "WHERE" based on this type:
    • typePredNone - No support
    • typePredChar - Only supported with WHERE .. LIKE
    • typePredBasic - Supported except for WHERE .. LIKE
    • typeSearchable - Supported for all WHERE ..
  10. UNSIGNED_ATTRIBUTE boolean => is it unsigned?
  11. FIXED_PREC_SCALE boolean => can it be a money value?
  12. AUTO_INCREMENT boolean => can it be used for an auto-increment value?
  13. LOCAL_TYPE_NAME String => localized version of type name (may be null)
  14. MINIMUM_SCALE short => minimum scale supported
  15. MAXIMUM_SCALE short => maximum scale supported
  16. SQL_DATA_TYPE int => unused
  17. SQL_DATETIME_SUB int => unused
  18. NUM_PREC_RADIX int => usually 2 or 10

Returns:
ResultSet - each row is an SQL type description

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 2371 of file ZDbcMySqlMetadata.pas.

IZResultSet TZAbstractDatabaseMetadata::UncachedGetUDTs ( const string  Catalog,
const string  SchemaPattern,
const string  TypeNamePattern,
const TIntegerDynArray  Types 
) [protected, inherited]

Gets a description of the user-defined types defined in a particular schema.

Schema-specific UDTs may have type JAVA_OBJECT, STRUCT, or DISTINCT.

Only types matching the catalog, schema, type name and type criteria are returned. They are ordered by DATA_TYPE, TYPE_SCHEM and TYPE_NAME. The type name parameter may be a fully-qualified name. In this case, the catalog and schemaPattern parameters are ignored.

Each type description has the following columns:

  1. TYPE_CAT String => the type's catalog (may be null)
  2. TYPE_SCHEM String => type's schema (may be null)
  3. TYPE_NAME String => type name
  4. CLASS_NAME String => Java class name
  5. DATA_TYPE String => type value defined in java.sql.Types. One of JAVA_OBJECT, STRUCT, or DISTINCT
  6. REMARKS String => explanatory comment on the type

Note: If the driver does not support UDTs, an empty result set is returned.

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schemaPattern a schema name pattern; "" retrieves those without a schema
typeNamePattern a type name pattern; may be a fully-qualified name
types a list of user-named types to include (JAVA_OBJECT, STRUCT, or DISTINCT); null returns all types
Returns:
ResultSet - each row is a type description

Reimplemented in TZAdoDatabaseMetadata, TZASADatabaseMetadata, TZMsSqlDatabaseMetadata, and TZSybaseDatabaseMetadata.

Definition at line 5022 of file ZDbcMetadata.pas.

IZResultSet TZMySQLDatabaseMetadata::UncachedGetVersionColumns ( const string  Catalog,
const string  Schema,
const string  Table 
) [protected]

Gets a description of a table's columns that are automatically updated when any value in a row is updated.

They are unordered.

Each column description has the following columns:

  1. SCOPE short => is not used
  2. COLUMN_NAME String => column name
  3. DATA_TYPE short => SQL data type from java.sql.Types
  4. TYPE_NAME String => Data source dependent type name
  5. COLUMN_SIZE int => precision
  6. BUFFER_LENGTH int => length of column value in bytes
  7. DECIMAL_DIGITS short => scale
  8. PSEUDO_COLUMN short => is this a pseudo column like an Oracle ROWID
    • versionColumnUnknown - may or may not be pseudo column
    • versionColumnNotPseudo - is NOT a pseudo column
    • versionColumnPseudo - is a pseudo column

Parameters:
catalog a catalog name; "" retrieves those without a catalog; null means drop catalog name from the selection criteria
schema a schema name; "" retrieves those without a schema
table a table name
Returns:
ResultSet - each row is a column description
Exceptions:
SQLException if a database access error occurs

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 2618 of file ZDbcMySqlMetadata.pas.

Boolean TZMySQLDatabaseMetadata::UsesLocalFilePerTable (  ) 

Does the database use a file for each table?

Returns:
true if the database uses a local file for each table

Reimplemented from TZAbstractDatabaseMetadata.

Definition at line 469 of file ZDbcMySqlMetadata.pas.

Boolean TZAbstractDatabaseMetadata::UsesLocalFiles (  )  [inherited]

Does the database store tables in a local file?

Returns:
true if so; false otherwise

Reimplemented from IZDatabaseMetadata.

Reimplemented in TZASADatabaseMetadata.

Definition at line 1556 of file ZDbcMetadata.pas.


Member Data Documentation

See also:
FCachedResultSets For reading

FCachedResultSets For writing

Definition at line 214 of file ZDbcMetadata.pas.

Definition at line 78 of file ZDbcMySqlMetadata.pas.

TStrings TZAbstractDatabaseMetadata::Info [protected, inherited]

See also:
FInfo For reading

Definition at line 210 of file ZDbcMetadata.pas.

string TZAbstractDatabaseMetadata::Url [protected, inherited]

See also:
FUrl For reading

Definition at line 203 of file ZDbcMetadata.pas.


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

Generated on Wed Dec 30 08:42:53 2009 for zeoslib by  doxygen 1.5.7.1