Firebird ADO.NET Provider SDK Documentation - v1.7

FbDbSchemaType Enumeration

NOTE: This enumeration is now obsolete.

Use the FbConnection.GetSchema() methods.


Retrieves the the type of schema table that can be used with the GetDbSchemaTable method.

[Visual Basic]
<Serializable, _  Obsolete(Message:="Use the FbConnection.GetSchema() methods.", IsError:=False)>
Public Enum FbDbSchemaType
[C#]
[Serializable]
[Obsolete(Message="Use the FbConnection.GetSchema() methods.", IsError=False)]
public enum FbDbSchemaType

Members

Member Name Description
CharacterSets

Retrieves the character sets defined in the database.

The list of returned columns for this schema type is:

Column Description *
CHARACTER_SET_CATALOG 0
CHARACTER_SET_SCHEMA 1
CHARACTER_SET_NAME The name of the character set. 2
CHARACTER_SET_ID The id of the character set.
DEFAULT_COLLATION The default collation of the character set.
BYTES_PER_CHARACTER The number of bytes per character.
DESCRIPTION The character set description

CheckConstraints

Retrieves the check constraints defined in the database.

The list of returned columns for this schema type is:

Column Description *
CONSTRAINT_CATALOG 0
CONSTRAINT_SCHEMA 1
CONSTRAINT_NAME The name of the constraint. 2
CHECK_CLAUSULE The chek clausule of the constraint.
DESCRIPTION The description of the check constraint

CheckConstraintsByTable

Retrieves the check constraints, by table,defined in the database.

The list of returned columns for this schema type is:

Column name Description *
CONSTRAINT_CATALOG 0
CONSTRAINT_SCHEMA 1
CONSTRAINT_NAME The name of the constraint. 2
TABLE_NAME The name of the table.
CHECK_CLAUSULE The clausule of the check constraint.
DESCRIPTION The description of the check constraint

Collations

Retrieves the collations defined in the database.

The list of returned columns for this schema type is:

Column name Description *
COLLATION_CATALOG 0
COLLATION_SCHEMA 1
COLLATION_NAME The name of the collation. 1
CHARACTER_SET_NAME The name of the character set.
DESCRIPTION The description of the collation.

Columns

Retrieves the columns of tables ( including views ) defined in the database.

The list of returned columns for this schema type is:

Column name Description *
TABLE_CATALOG 0
TABLE_SCHEMA 1
TABLE_NAME The name of the table. 2
COLUMN_NAME The name of the column. 3
COLUMN_DATA_TYPE The data type name of the column.
COLUMN_SUB_TYPE The sub type of the column.
COLUMN_SIZE The maximum possible length of a value in the column.
NUMERIC_PRECISION The maximum precision of the column for numeric data types.
NUMERIC_SCALE The maximum scale of the column for decimal and numeric data types.
CHARACTER_OCTET_LENGTH For char and varchar columns the maximun number of bytes in the column.
ORDINAL_POSITION The ordinal of the column.
COLUMN_DEFAULT The default value of the column.
IS_NULLABLE True if the column allows null values; otherwise false.
IS_READONLY True if the column cannot be modified; otherwise false.
IS_ARRAY True if the column has array data type; otherwise false.
CHARACTER_SET_NAME The caracter set name of the column.
COLLATION_NAME The collation name of the column.
DESCRIPTION Column description.

ColumnPrivileges Retrieves the columns Privileges defined in the database.

The list of returned columns for this schema type is:

Column name Description *
TABLE_CATALOG 0
TABLE_SCHEMA 1
TABLE_NAME The name of the table. 1
COLUMN_NAME The name of the column. 2
GRANTEE User name to who the privilege has been granted.
GRANTOR User who granted the privileges on the table.
PRIVILEGE Privilege type.
WITH_GRANT Privilege set with the grant option.

DataTypes Retrieves the data types supported by Firebird Server.

The list of returned columns for this schema type is:

Column name Description *

Domains Retrieves the domains defined in the database.

The list of returned columns for this schema type is:

Column name Description *
DOMAIN_CATALOG 0
DOMAIN_SCHEMA 1
DOMAIN_NAME The name of the domain. 2
DOMAIN_DATA_TYPE The data type name of the domain.
DOMAIN_SUB_TYPE The sub type of the domain.
DOMAIN_SIZE The maximum possible length of a value in the domain.
NUMERIC_PRECISION The maximum precision of the domain for numeric data types.
NUMERIC_SCALE The maximum scale of the domain for decimal and numeric data types.
CHARACTER_OCTET_LENGTH For char and varchar columns the maximun number of bytes in the column.
IS_NULLABLE True if the domain allows null values; otherwise false.
ARRAY_DIMENSIONS If the data type of the domain is an array type, the number of dimensions of the array.
DESCRIPTION Domain description.

ForeignKeys Retrieves the foreign keys defined in the database.

The list of returned columns for this schema type is:

Column name Description *
PK_TABLE_CATALOG 0
PK_TABLE_SCHEMA 1
PK_TABLE_NAME The name of the primary key table. 2
FK_TABLE_CATALOG 3
FK_TABLE_SCHEMA 4
FK_TABLE_NAME The name of the foreign key table. 5
PK_COLUMN_NAME The name of the primary key column.
FK_COLUMN_NAME The name of the foreign key column.
FK_NAME The name of the foreign key.
ORDINAL_POSITION The ordinal of the column.
MATCH_OPTION
UPDATE_RULE Update rule.
DELETE_RULE Delete rule.
IS_DEFERRABLE
DEFERRABLITY

Functions Retrieves the external Functions defined in the database.

The list of returned columns for this schema type is:

Column name Description *
FUNCTION_CATALOG 0
FUNCTION_SCHEMA 1
FUNCTION_NAME The name of the function. 2
IS_SYSTEM_FUNCTION Indicates wheter the function is a system function. 1
FUNCTION_TYPE The type of the function.
QUERY_NAME
FUNCTION_MODULE_NAME The name of the function module.
FUNCTION_ENTRY_POINT Entry point.
RETURN_ARGUMENT
DESCRIPTION The description of the function.

Generators Retrieves the generators defined in the database.

The list of returned columns for this schema type is:

Column name Description *
GENERATOR_CATALOG 0
GENERATOR_SCHEMA 1
GENERATOR_NAME The name of the generator. 2
IS_SYSTEM_GENERATOR Indcates wheter the genaror is a system generator. 1
GENERATOR_ID The id of the generator.

Indexes Retrieves the indexes defined in the database.

The list of returned columns for this schema type is:

Column name Description *
TABLE_CATALOG 0
TABLE_SCHEMA 1
TABLE_NAME The name of the table. 2
INDEX_NAME The name of the index. 3
INDEX_TYPE The type of the index
COLUMN_NAME The name of the column.
ORDINAL_POSITION The ordinal of the column.
IS_INACTIVE Indicates wheter the index is inactive.
IS_SYSTEM_INDEX Indicates wheter the index is a system index.
IS_UNIQUE Indicates wheter the index is aunique index.
INDEX_STATISTICS The statistics of the index.
DESCRIPTION The description of the index.

MetaDataCollections Retrieves the supported metadata collections (schemas).

The list of returned columns for this schema type is:

Column name Description *
CollectionName Metadata collection name.
NumberOfRestrictions Max number of restrictions allowed for the metadata collection.
NumberOfIdentifierParts Max number of restrictions allowed for the metadata collection.

PrimaryKeys Retrieves the primary key columns defined in the database.

The list of returned columns for this schema type is:

Column name Description *
TABLE_CATALOG
TABLE_SCHEMA
TABLE_NAME The name of the table. 0
COLUMN_NAME The name of the column.
ORDINAL_POSITION The ordinal of the column.
PK_NAME The name of the primary key.

ProcedureParameters Retrieves the parameters of stored procedures defined in the database.

The list of returned columns for this schema type is:

Column name Description *
PROCEDURE_CATALOG 0
PROCEDURE_SCHEMA 1
PROCEDURE_NAME The name of the stored procedure. 2
PARAMETER_NAME The of the stored procedure parameter
ORDINAL_POSITION The ordinal of the parameter.
PARAMETER_DIRECTION The direction of the stored procedure parameter (input/output)
PARAMETER_DATA_TYPE The data type name of the stored procedure parameter.
PARAMETER_SUB_TYPE The sub type of the stored procedure parameter.
PARAMETER_SIZE The maximum possible length of a value in the paremeter.
NUMERIC_PRECISION The maximum precision of the parameter for numeric data types.
NUMERIC_SCALE The maximum scale of the parameter for decimal and numeric data types.
CHARACTER_OCTET_LENGTH For char and varchar columns the maximun number of bytes in the column.
CHARACTER_SET_NAME Character set of the parameter.
COLLATION_NAME Collation of the parameter.
DESCRIPTION The description of the stored procedure parameter.

ProcedurePrivileges Retrieves the privileges of stored procedures defined in the database.

The list of returned columns for this schema type is:

Column name Description *
PROCEDURE_CATALOG 0
PROCEDURE_SCHEMA 1
PROCEDURE_NAME The name of the stored procedure. 2
GRANTEE User name to who the privilege has been granted.
GRANTOR User who granted the privileges on the table.
PRIVILEGE Privilege type.
WITH_GRANT Privilege set with the grant option.

Procedures Retrieves the stored procedures defined in the database.

The list of returned columns for this schema type is:

Column name Description *
PROCEDURE_CATALOG 0
PROCEDURE_SCHEMA 1
PROCEDURE_NAME The name of the stored procedure. 2
INPUTS The number of input parameters of the stored procedure.
OUTPUTS The number of output parameters of the stored procedure.
DESCRIPTION The description of the stored procedure.

Restrictions Retrieves the list of restrictions supported by each metadata collection.

The list of returned columns for this collection is:

Column name Description *
RestrictionName Metadata collection name.
RestrictionDefault
RestrictionNumber Ordinal of the colelction srestriction.

Roles Retrieves the user roles defined in the database.

The list of returned columns for this schema type is:

Column name Description *
ROLE_NAME The name of the role. 0
OWNER

TableConstraints 
TablePrivileges Retrieves the table privileges defined in the database.

The list of returned columns for this schema type is:

Column name Description *
TABLE_CATALOG 0
TABLE_SCHEMA 1
TABLE_NAME The name of the table. 2
GRANTEE User name to who the privilege has been granted.
GRANTOR User who granted the privileges on the table.
PRIVILEGE Privilege type.
WITH_GRANT Privilege set with the grant option.

Tables Retrieves the tables defined in the database.

The list of returned columns for this schema type is:

Column name Description *
TABLE_CATALOG 0
TABLE_SCHEMA 1
TABLE_NAME The name of the table. 2
TABLE_TYPE The type of the table. 3
IS_SYSTEM_TABLE Indicates wheter the table is a system table.
OWNER_NAME
DESCRIPTION The description of the table.

Triggers Retrieves the triggers defined in the database.

The list of returned columns for this schema type is:

Column name Description *
TABLE_CATALOG 0
TABLE_SCHEMA 1
TABLE_NAME The name of the table. 2
TRIGGER_NAME The name of the trigger. 3
IS_SYSTEM_TRIGGER Indicates wheter the trigger is a system trigger.
IS_INACTIVE Indicates wheter the trigger is inactive.
SEQUENCE Execution sequence number.
SOURCE The source of the trigger.
DESCRIPTION The description of the trigger.

UniqueKeys Retrieves the unique key columns defined in the database.

The list of returned columns for this schema type is:

Column name Description *
_CATALOG 0
TABLE_SCHEMA 1
TABLE_NAME The name of the table. 2
COLUMN_NAME The name of the column.
ORDINAL_POSITION The ordinal of the column.
UK_NAME The name of the unique key.

ViewColumnUsage Retrieves the view column usage information defined in the database.

The list of returned columns for this schema type is:

Column name Description *
VIEW_CATALOG 0
VIEW_SCHEMA 1
VIEW_NAME The name of the view. 2
COLUMN_NAME The name of the column. 3
COLUMN_DATA_TYPE The data type name of the column.
COLUMN_SUB_TYPE The sub type of the column.
COLUMN_SIZE The maximum possible length of a value in the column.
NUMERIC_PRECISION The maximum precision of the column for numeric data types.
NUMERIC_SCALE The maximum scale of the column for decimal and numeric data types.
CHARACTER_OCTET_LENGTH For char and varchar columns the maximun number of bytes in the column.
ORDINAL_POSITION The ordinal of the column.
COLUMN_DEFAULT The default value of the column.
IS_ARRAY True if the column has array data type; otherwise false.
IS_NULLABLE True if the column allows null values; otherwise false.
DESCRIPTION The description of the column.

ViewPrivileges Retrieves the view privileges defined in the database.

The list of returned columns for this schema type is:

Column name Description *
VIEW_CATALOG 0
VIEW_SCHEMA 1
VIEW_NAME The name of the view. 2
GRANTEE User name to who the privilege has been granted.
GRANTOR User who granted the privileges on the table.
PRIVILEGE Privilege type.
WITH_GRANT Privilege set with the grant option.

Views Retrieves the views defined in the database.

The list of returned columns for this schema type is:

Column name Description *
VIEW_CATALOG 0
VIEW_SCHEMA 1
VIEW_NAME The name of the view. 2
DEFINITION The SQL definition of the view.
DESCRIPTION The description of the view.

Requirements

Namespace: FirebirdSql.Data.Firebird

Assembly: FirebirdSql.Data.Firebird (in FirebirdSql.Data.Firebird.dll)

See Also

FirebirdSql.Data.Firebird Namespace