Skip to content

Latest commit

 

History

History
802 lines (581 loc) · 48.6 KB

schema-rowset-classes-and-typedef-classes.md

File metadata and controls

802 lines (581 loc) · 48.6 KB
description title ms.date f1_keywords helpviewer_keywords ms.assetid
Learn more about: Schema Rowset Classes and Typedef Classes
Schema Rowset Classes and Typedef Classes
11/04/2016
CAssertionInfo
CAssertions
CCatalogInfo
CCatalogs
CCharacterSetInfo
CCharacterSets
CCheckConstraintInfo
CCheckConstraints
CCollationInfo
CCollations
CColumnDomainUsage
CColumnDomainUsageInfo
CColumnPrivilegeInfo
CColumnPrivileges
CColumns
CColumnsInfo
CConstraintColumnUsage
CConstraintColumnUsageInfo
CConstraintTableUsage
CConstraintTableUsageInfo
CForeignKeys
CForeignKeysInfo
CHARACTER_MAXIMUM_LENGTH
CHARACTER_OCTET_LENGTH
CHARACTER_SET_CATALOG
CHARACTER_SET_NAME
CHARACTER_SET_SCHEMA
CHECK_CLAUSE
CHECK_CONSTRAINTS
CHECK_OPTION
CIndexes
CIndexInfo
CKeyColumnInfo
CKeyColumns
CLUSTERED
COLLATION
COLLATION_CATALOG
COLLATION_NAME
COLLATION_SCHEMA
COLLATIONS
COLUMN_DEFAULT
COLUMN_DOMAIN_USAGE
COLUMN_FLAGS
COLUMN_GUID
COLUMN_HASDEFAULT
COLUMN_PRIVILEGES
COLUMN_PROPID
COLUMN_SIZE
CONSTRAINT_CATALOG
CONSTRAINT_COLUMN_USAGE
CONSTRAINT_NAME
CONSTRAINT_SCHEMA
CONSTRAINT_TABLE_USAGE
CONSTRAINT_TYPE
CPrimaryKeyInfo
CPrimaryKeys
CProcedureColumnInfo
CProcedureColumns
CProcedureInfo
CProcedureParameters
CProcedureParamInfo
CProcedures
CProviderInfo
CProviderTypes
CReferentialConstraintInfo
CReferentialConstraints
CSchemata
CSchemataInfo
CSQLLanguageInfo
CSQLLanguages
CStatisticInfo
CStatistics
CTableConstraintInfo
CTableConstraints
CTableInfo
CTablePrivilegeInfo
CTablePrivileges
CTables
CTranslationInfo
CTranslations
CUsagePrivilegeInfo
CUsagePrivileges
CViewColumnInfo
CViewColumnUsage
CViewInfo
CViews
CViewTableInfo
CViewTableUsage
DATA_TYPE
DATETIME_PRECISION
DEFAULT_CHARACTER_SET_CATALOG
DEFAULT_CHARACTER_SET_NAME
DEFAULT_CHARACTER_SET_SCHEMA
DEFAULT_COLLATE_CATALOG
DEFAULT_COLLATE_NAME
DEFAULT_COLLATE_SCHEMA
DELETE_RULE
DOMAIN_CATALOG
DOMAIN_NAME
DOMAIN_SCHEMA
FILL_FACTOR
FILTER_CONDITION
FIXED_PREC_SCALE
FK_COLUMN_GUID
FK_COLUMN_NAME
FK_COLUMN_PROPID
FK_TABLE_CATALOG
FK_TABLE_NAME
FK_TABLE_SCHEMA
FORM_OF_USE
GRANTEE
GRANTOR
INDEX_CATALOG
INDEX_NAME
INDEX_SCHEMA
INITIAL_SIZE
INITIALLY_DEFERRED
IS_DEFERRABLE
IS_GRANTABLE
IS_LONG
IS_NULLABLE
IS_UPDATABLE
LITERAL_SUFFIX
LOCAL_TYPE_NAME
m_bAutoUniqueValue
m_bAutoUpdate
m_bBestMatch
m_bCaseSensitive
m_bCheckOption
m_bClustered
m_bColumnHasDefault
m_bFixedPrecScale
m_bHasDefault
m_bInitiallyDeferred
m_bIsDeferrable
m_bIsGrantable
m_bIsLong
m_bIsNullable
m_bIsUpdatable
m_bPrimaryKey
m_bSortBookmarks
m_bUnique
m_bUnsignedAttribute
m_guidColumn
m_guidFKColumn
m_guidPKColumn
m_guidTable
m_guidType
m_nCardinality
m_nCollation
m_nColumnFlags
m_nColumnPropID
m_nColumnSize
m_nDataType
m_nDateTimePrecision
m_nFillFactor
m_nFKColumnPropID
m_nInitialSize
m_nMaxLength
m_nMaxScale
m_nNullCollation
m_nNulls
m_nNumCharacters
m_nNumericPrecision
m_nNumericScale
m_nOctetLength
m_nOrdinal
m_nOrdinalPosition
m_nPages
m_nPKColumnPropID
m_nPrecision
m_nRowsetNumber
m_nScale
m_nSearchable
m_szBindingStyle
m_szCatalog
m_szCharCatalog
m_szCharName
m_szCharSchema
m_szCharSetCatalog
m_szCharSetName
m_szCharSetSchema
m_szCheckClause
m_szCollateCatalog
m_szCollateName
m_szCollateSchema
m_szCollationCatalog
m_szCollationName
m_szCollationSchema
m_szColumnDefault
m_szColumnName
m_szConformance
m_szConstraintCatalog
m_szConstraintName
m_szConstraintSchema
m_szCreateParams
m_szDefault
m_szDefinition
m_szDeleteRule
m_szDomainCatalog
m_szDomainName
m_szDomainSchema
m_szFilterCondition
m_szFKColumnName
m_szFKTableCatalog
m_szFKTableName
m_szFKTableSchema
m_szFormOfUse
m_szGrantee
m_szGrantor
m_szImplementation
m_szIndexCatalog
m_szIndexName
m_szIndexSchema
m_szIntegrity
m_szLiter alSuffix
m_szLiteralPrefix
m_szLocalTypeName
m_szMatchOption
m_szObjectCatalog
m_szObjectName
m_szObjectSchema
m_szObjectType
m_szOwner
m_szPadAttribute
m_szParameterName
m_szPKColumnName
m_szPKTableCatalog
m_szPKTableName
m_szPKTableSchema
m_szPrivilegeType
m_szProgrammingLanguage
m_szSchema
m_szSource
m_szSourceCatalog
m_szSourceName
m_szSourceSchema
m_szTableCatalog
m_szTableName
m_szTableSchema
m_szTargetCatalog
m_szTargetName
m_szTargetSchema
m_szType
m_szTypeLib
m_szTypeName
m_szUniqueCatalog
m_szUniqueName
m_szUniqueSchema
m_szUpdateRule
m_szVersion
m_szYear
MATCH_OPTION
MAXIMUM_SCALE
MINIMUM_SCALE
NULL_COLLATION
NULLS
NUMBER_OF_CHARACTERS
NUMERIC_PRECISION
NUMERIC_SCALE
OBJECT_CATALOG
OBJECT_NAME
OBJECT_SCHEMA
OBJECT_TYPE
ORDINAL
ORDINAL_POSITION
TABLE_CATALOG
TABLE_GUID
TABLE_NAME
TABLE_SCHEMA
schema rowsets
CAssertionInfo parameter class
CAssertions typedef class
CCatalogInfo parameter class
CCatalogs typedef class
CCharacterSetInfo parameter class
CCharacterSets typedef class
CCheckConstraintInfo parameter class
CCheckConstraints typedef class
CCollationInfo parameter class
CCollations typedef class
CColumnDomainUsage typedef class
CColumnDomainUsageInfo parameter class
CColumnPrivilegeInfo parameter class
CColumnPrivileges typedef class
CColumns typedef class
CColumnsInfo parameter class
CConstraintColumnUsage typedef class
CConstraintColumnUsageInfo parameter class
CConstraintTableUsage typedef class
CConstraintTableUsageInfo parameter class
CForeignKeys typedef class
CForeignKeysInfo parameter class
CHARACTER_MAXIMUM_LENGTH
CHARACTER_OCTET_LENGTH
CHARACTER_SET_CATALOG
CHARACTER_SET_NAME
CHARACTER_SET_SCHEMA
CHECK_CLAUSE
CHECK_CONSTRAINTS
CHECK_OPTION
CIndexes typedef class
CIndexInfo parameter class
CKeyColumnInfo parameter class
CKeyColumns typedef class
CLUSTERED
COLLATION_CATALOG
COLLATION_NAME
COLLATION_SCHEMA
COLLATIONS recordset
COLUMN_DEFAULT
COLUMN_DOMAIN_USAGE
COLUMN_FLAGS
COLUMN_GUID
COLUMN_HASDEFAULT
COLUMN_NAME
COLUMN_PRIVILEGES
COLUMN_PROPID
CONSTRAINT_CATALOG
CONSTRAINT_COLUMN_USAGE
CONSTRAINT_NAME
CONSTRAINT_SCHEMA
CONSTRAINT_TABLE_USAGE
CONSTRAINT_TYPE
CPrimaryKeyInfo parameter class
CPrimaryKeys typedef class
CProcedureColumnInfo parameter class
CProcedureColumns typedef class
CProcedureInfo parameter class
CProcedureParameters typedef class
CProcedureParamInfo parameter class
CProcedures typedef class
CProviderInfo parameter class
CProviderTypes typedef class
CReferentialConstraintInfo parameter class
CReferentialConstraints typedef class
CSchemata typedef class
CSchemataInfo parameter class
CSQLLanguageInfo parameter class
CSQLLanguages typedef class
CStatisticInfo parameter class
CStatistics typedef class
CTableConstraintInfo parameter class
CTableConstraints typedef class
CTableInfo parameter class
CTablePrivilegeInfo parameter class
CTablePrivileges typedef class
CTables typedef class
CTranslationInfo parameter class
CTranslations typedef class
CUsagePrivilegeInfo parameter class
CUsagePrivileges typedef class
CViewColumnInfo parameter class
CViewColumnUsage typedef class
CViewInfo parameter class
CViews typedef class
CViewTableInfo parameter class
CViewTableUsage typedef class
DATA_TYPE
DATETIME_PRECISION
DEFAULT_CHARACTER_SET_CATALOG
DEFAULT_CHARACTER_SET_NAME
DEFAULT_CHARACTER_SET_SCHEMA
DEFAULT_COLLATE_CATALOG
DEFAULT_COLLATE_NAME
DEFAULT_COLLATE_SCHEMA
DELETE_RULE
DESCRIPTION class data member
DOMAIN_CATALOG
DOMAIN_NAME
DOMAIN_SCHEMA
FILL_FACTOR
FILTER_CONDITION
FIXED_PREC_SCALE
FK_COLUMN_GUID
FK_COLUMN_NAME
FK_COLUMN_PROPID
FK_TABLE_CATALOG
FK_TABLE_NAME
FK_TABLE_SCHEMA
FORM_OF_USE OLE DB column
GRANTEE
GRANTOR
INDEX_CATALOG
INDEX_NAME
INDEX_SCHEMA
INITIAL_SIZE
INITIALLY_DEFERRED
IS_DEFERRABLE
IS_GRANTABLE
IS_LONG
IS_NULLABLE
IS_UPDATABLE
LITERAL_SUFFIX
LOCAL_TYPE_NAME
m_bAutoUniqueValue
m_bAutoUpdate
m_bBestMatch
m_bCaseSensitive
m_bCheckOption
m_bClustered
m_bColumnHasDefault
m_bFixedPrecScale
m_bHasDefault
m_bInitiallyDeferred
m_bIsDeferrable
m_bIsGrantable
m_bIsLong
m_bIsNullable
m_bIsUpdatable
m_bPrimaryKey
m_bSortBookmarks
m_bUnique
m_bUnsignedAttribute
m_guidColumn
m_guidFKColumn
m_guidTable
m_guidType
m_nCardinality
m_nCollation
m_nColumnFlags
m_nColumnPropID
m_nColumnSize
m_nDataType
m_nDateTimePrecision
m_nFillFactor
m_nFKColumnPropID
m_nInitialSize
m_nMaxLength
m_nMinScale
m_nNullCollation
m_nNulls
m_nNumCharacters
m_nNumericPrecision
m_nNumericScale
m_nOctetLength
m_nOrdinal
m_nOrdinalPosition
m_nPages
m_nPKColumnPropID
m_nPrecision
m_nRowsetNumber
m_nScale
m_nSearchable
m_nType
m_szBindingStyle
m_szCatalog
m_szCharCatalog
m_szCharName
m_szCharSchema
m_szCharSetCatalog
m_szCharSetName
m_szCharSetSchema
m_szCheckClause
m_szCollateCatalog
m_szCollateName
m_szCollateSchema
m_szCollationCatalog
m_szCollationName
m_szCollationSchema
m_szColumnDefault
m_szColumnName
m_szConformance
m_szConstraintCatalog
m_szConstraintName
m_szConstraintSchema
m_szCreateParams
m_szDefault
m_szDefinition
m_szDeleteRule
m_szDescription
m_szDomainCatalog
m_szDomainName
m_szDomainSchema
m_szFilterCondition
m_szFKColumnName
m_szFKTableCatalog
m_szFKTableName
m_szFKTableSchema
m_szFormOfUse
m_szGrantee
m_szGrantor
m_szImplementation
m_szIndexCatalog
m_szIndexName
m_szIndexSchema
m_szIntegrity
m_szLiteralPrefix
m_szLocalTypeName
m_szMatchOption
m_szName
m_szObjectCatalog
m_szObjectName
m_szObjectSchema
m_szObjectType
m_szOwner
m_szPadAttribute
m_szParameterName
m_szPKColumnName
m_szPKTableCatalog
m_szPKTableName
m_szPKTableSchema
m_szPrivilegeType
m_szPrivilegeType
m_szProgrammingLanguage
m_szSchema
m_szSource
m_szSourceCatalog
m_szSourceName
m_szSourceSchema
m_szTableCatalog
m_szTableName
m_szTableSchema
m_szTargetCatalog
m_szTargetName
m_szTargetSchema
m_szType
m_szTypeLib
m_szTypeName
m_szUniqueCatalog
m_szUniqueName
m_szUniqueSchema
m_szUpdateRule
m_szUpdateRule
m_szVersion
m_szYear
MATCH_OPTION
MAXIMUM_SCALE
MINIMUM_SCALE
NULL_COLLATION
NULLS
NUMBER_OF_CHARACTERS
NUMERIC_PRECISION
NUMERIC_SCALE
OBJECT_CATALOG
OBJECT_NAME
OBJECT_SCHEMA
OBJECT_TYPE
ORDINAL data member
ORDINAL_POSITION
TABLE_CATALOG
TABLE_GUID
TABLE_NAME
TABLE_SCHEMA
4bd881b3-26ca-4bdb-9226-d67560864f29

Schema Rowset Classes and Typedef Classes

A schema is a collection of database objects that are owned, or have been created by, a particular user. A catalog can contain one or more schemas, but must always contain a schema called INFORMATION_SCHEMA, which contains the views and domains of the information schema. Schema information in OLE DB is retrieved using predefined schema rowsets, and includes types, tables, columns, indexes, views, assertions and constraints, statistics, character sets, collations, and domains.

Schema rowsets are predefined rowsets representing metadata. Schema rowsets are generally used in dynamic programming, where the database structure is not known at compile time. You can use these schema rowsets to obtain information about a database at run time.

Use the typedef classes to instantiate the schema rowsets. The corresponding typedef and schema rowset classes are listed below. You must call CRestrictions::Open after you have created an instance of the schema rowset. This method returns a result set based on the restrictions you specify. See IDBSchemaRowset for information on restriction columns associated with each schema rowset.

The following table displays each OLE DB Schema Rowset and its corresponding OLE DB Templates typedef class and info class.

OLE DB Schema Rowset Typedef class Info class
ASSERTIONS CAssertions CAssertionInfo
CATALOGS CCatalogs CCatalogInfo
CHARACTER_SETS CCharacterSets CCharacterSetInfo
COLLATIONS CCollations CCollationInfo
COLUMN_PRIVILEGES CColumnPrivileges CColumnPrivilegeInfo
COLUMNS CColumns CColumnsInfo
CONSTRAINT_COLUMN_USAGE CConstraintColumnUsage CConstraintColumnUsageInfo
CONSTRAINT_TABLE_USAGE CConstraintTableUsage CConstraintTableUsageInfo
CHECK_CONSTRAINTS CCheckConstraints CCheckConstraintInfo
COLUMN_DOMAIN_USAGE CColumnDomainUsage CColumnDomainUsageInfo
FOREIGN_KEYS CForeignKeys CForeignKeysInfo
INDEXES CIndexes CIndexInfo
KEY_COLUMN_USAGE CKeyColumn CKeyColumnInfo
PRIMARY_KEYS CPrimaryKeys CPrimaryKeyInfo
PROCEDURES CProcedures CProcedureInfo
PROCEDURE_COLUMNS CProcedureColumns CProcedureColumnInfo
PROCEDURE_PARAMETERS CProcedureParameters CProcedureParameterInfo
PROVIDER_TYPES CProviderTypes CProviderInfo
REFERENTIAL_CONSTRAINTS CReferentialConstraints CReferentialConstraintInfo
SCHEMATA CSchemata CSchemataInfo
SQL_LANGUAGES CSQLLanguages CSQLLanguageInfo
STATISTICS CStatistics CStatisticInfo
TABLE_CONSTRAINTS CTableConstraints CTableConstraintInfo
TABLES CTables CTableInfo
TABLE_PRIVILEGES CTablePrivileges CTablePrivilegeInfo
TRANSLATIONS CTranslations CTranslationInfo
USAGE_PRIVILEGES CUsagePrivileges CUsagePrivilegeInfo
VIEW_COLUMN_USAGE CViewColumnUsage CViewColumnInfo
VIEWS CViews CViewInfo
VIEW_TABLE_USAGE CViewTableUsage CViewTableInfo

CAssertions, CAssertionInfo

Call the typedef class CAssertions to implement its parameter class CAssertionInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the assertions defined in the catalog that are owned by a given user.

The following table lists the class data members for CAssertionInfo and their corresponding OLE DB Columns. See ASSERTIONS Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szCatalog CONSTRAINT_CATALOG
m_szSchema CONSTRAINT_SCHEMA
m_szName CONSTRAINT_NAME
m_bIsDeferrable IS_DEFERRABLE
m_bInitiallyDeferred INITIALLY_DEFERRED
m_szDescription DESCRIPTION

CCatalogs, CCatalogInfo

Call the typedef class CCatalogs to implement its parameter class CCatalogInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the physical attributes associated with catalogs accessible from the DBMS.

The following table lists the class data members and their corresponding OLE DB Columns. See CATALOGS Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szName CATALOG_NAME
m_szDescription DESCRIPTION

CCharacterSets, CCharacterSetInfo

Call the typedef class CCharacterSets to implement its parameter class CCharacterSetInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the character sets defined in the catalog that are accessible to a given user.

The following table lists the class data members and their corresponding OLE DB Columns. See CHARACTER_SETS Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szCatalog CHARACTER_SET_CATALOG
m_szSchema CHARACTER_SET_SCHEMA
m_szName CHARACTER_SET_NAME
m_szFormOfUse FORM_OF_USE
m_nNumCharacters NUMBER_OF_CHARACTERS
m_szCollateCatalog DEFAULT_COLLATE_CATALOG
m_szCollateSchema DEFAULT_COLLATE_SCHEMA
m_szCollateName DEFAULT_COLLATE_NAME

CCheckConstraints, CCheckConstraintInfo

Call the typedef class CCheckConstraints to implement its parameter class CCheckConstraintInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the check constraints, defined in the catalog, that are owned by a given user. A check constraint specifies the data values or formats that are acceptable in one or more columns in a table.

The following table lists the class data members and their corresponding OLE DB Columns. See CHECK_CONSTRAINTS Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szCatalog CONSTRAINT_CATALOG
m_szSchema CONSTRAINT_SCHEMA
m_szName CONSTRAINT_NAME
m_szCheckClause CHECK_CLAUSE
m_szDescription DESCRIPTION

CCollations, CCollationInfo

Call the typedef class CCollations to implement its parameter class CCollationInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the character collations, defined in the catalog, that are accessible to a given user.

The following table lists the class data members and their corresponding OLE DB Columns. See COLLATIONS Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szCatalog COLLATION_CATALOG
m_szSchema COLLATION_SCHEMA
m_szName COLLATION_NAME
m_szCharSetCatalog CHARACTER_SET_CATALOG
m_szCharSetSchema CHARACTER_SET_SCHEMA
m_szCharSetName CHARACTER_SET_NAME
m_szPadAttribute PAD_ATTRIBUTE

CColumnDomainUsage, CColumnDomainUsageInfo

Call the typedef class CColumnDomainUsage to implement its parameter class CColumnDomainUsageInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the columns, defined in the catalog, that are dependent on a domain defined in the catalog and owned by a given user.

The following table lists the class data members and their corresponding OLE DB Columns. See COLUMN_DOMAIN_USAGE Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szCatalog DOMAIN_CATALOG
m_szSchema DOMAIN_SCHEMA
m_szName DOMAIN_NAME
m_szTableCatalog TABLE_CATALOG
m_szTableSchema TABLE_SCHEMA
m_szTableName TABLE_NAME
m_szColumnName COLUMN_NAME
m_guidColumn COLUMN_GUID
m_nColumnPropID COLUMN_PROPID

CColumnPrivileges, CColumnPrivilegeInfo

Call the typedef class CColumnPrivileges to implement its parameter class CColumnPrivilegeInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the privileges on columns of tables, defined in the catalog, that are available to or granted by a given user.

The following table lists the class data members and their corresponding OLE DB Columns. See COLUMN_PRIVILEGES Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szGrantor GRANTOR
m_szGrantee GRANTEE
m_szTableCatalog TABLE_CATALOG
m_szTableSchema TABLE_SCHEMA
m_szTableName TABLE_NAME
m_szColumnName COLUMN_NAME
m_guidColumn COLUMN_GUID
m_nColumnPropID COLUMN_PROPID
m_szPrivilegeType PRIVILEGE_TYPE
m_bIsGrantable IS_GRANTABLE

CColumns, CColumnsInfo

Call the typedef class CColumns to implement its parameter class CColumnsInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the columns of tables defined in the catalog that are accessible to a given user.

The following table lists the class data members and their corresponding OLE DB Columns. See COLUMNS Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szTableCatalog TABLE_CATALOG
m_szTableSchema TABLE_SCHEMA
m_szTableName TABLE_NAME
m_szColumnName COLUMN_NAME
m_guidColumn COLUMN_GUID
m_nColumnPropID COLUMN_PROPID
m_nOrdinalPosition ORDINAL_POSITION
m_bColumnHasDefault COLUMN_HASDEFAULT
m_szColumnDefault COLUMN_DEFAULT
m_nColumnFlags COLUMN_FLAGS
m_bIsNullable IS_NULLABLE
m_nDataType DATA_TYPE
m_guidType TYPE_GUID
m_nMaxLength CHARACTER_MAXIMUM_LENGTH
m_nOctetLength CHARACTER_OCTET_LENGTH
m_nNumericPrecision NUMERIC_PRECISION
m_nNumericScale NUMERIC_SCALE
m_nDateTimePrecision DATETIME_PRECISION
m_szCharSetCatalog CHARACTER_SET_CATALOG
m_szCharSetSchema CHARACTER_SET_SCHEMA
m_szCharSetName CHARACTER_SET_NAME
m_szCollationCatalog COLLATION_CATALOG
m_szCollationSchema COLLATION_SCHEMA
m_szCollationName COLLATION_NAME
m_szDomainCatalog DOMAIN_CATALOG
m_szDomainSchema DOMAIN_SCHEMA
m_szDomainName DOMAIN_NAME
m_szDescription DESCRIPTION

CConstraintColumnUsage, CConstraintColumnUsageInfo

Call the typedef class CConstraintColumnUsage to implement its parameter class CConstraintColumnUsageInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the columns used by referential constraints, unique constraints, check constraints, and assertions, defined in the catalog and owned by a given user.

The following table lists the class data members and their corresponding OLE DB Columns. See CONSTRAINT_COLUMN_USAGE Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szTableCatalog TABLE_CATALOG
m_szTableSchema TABLE_SCHEMA
m_szTableName TABLE_NAME
m_szColumnName COLUMN_NAME
m_guidColumn COLUMN_GUID
m_nColumnPropID COLUMN_PROPID
m_szConstraintCatalog CONSTRAINT_CATALOG
m_szConstraintSchema CONSTRAINT_SCHEMA
m_szConstraintName CONSTRAINT_NAME

CConstraintTableUsage, CConstraintTableUsageInfo

Call the typedef class CConstraintTableUsage to implement its parameter class CConstraintTableUsageInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the tables used by referential constraints, unique constraints, check constraints, and assertions, defined in the catalog and owned by a given user.

The following table lists the class data members and their corresponding OLE DB Columns. See CONSTRAINT_TABLE_USAGE Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szTableCatalog TABLE_CATALOG
m_szTableSchema TABLE_SCHEMA
m_szTableName TABLE_NAME
m_szConstraintCatalog CONSTRAINT_CATALOG
m_szConstraintSchema CONSTRAINT_SCHEMA
m_szConstraintName CONSTRAINT_NAME

CForeignKeys, CForeignKeysInfo

Call the typedef class CForeignKeys to implement its parameter class CForeignKeysInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the foreign key columns defined in the catalog by a given user.

The following table lists the class data members and their corresponding OLE DB Columns. See FOREIGN_KEYS Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szPKTableCatalog PK_TABLE_CATALOG
m_szPKTableSchema PK_TABLE_SCHEMA
m_szPKTableName PK_TABLE_NAME
m_szPKColumnName PK_COLUMN_NAME
m_guidPKColumn PK_COLUMN_GUID
m_nPKColumnPropID PK_COLUMN_PROPID
m_szFKTableCatalog FK_TABLE_CATALOG
m_szFKTableSchema FK_TABLE_SCHEMA
m_szFKTableName FK_TABLE_NAME
m_szFKColumnName FK_COLUMN_NAME
m_guidFKColumn FK_COLUMN_GUID
m_nFKColumnPropID FK_COLUMN_PROPID
m_nOrdinal ORDINAL
m_szUpdateRule UPDATE_RULE
m_szDeleteRule DELETE_RULE

CIndexes, CIndexInfo

Call the typedef class CIndexes to implement its parameter class CIndexInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the indexes, defined in the catalog, that are owned by a given user.

The following table lists the class data members and their corresponding OLE DB Columns. See INDEXES Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szTableCatalog TABLE_CATALOG
m_szTableSchema TABLE_SCHEMA
m_szTableName TABLE_NAME
m_szIndexCatalog INDEX_CATALOG
m_szIndexSchema INDEX_SCHEMA
m_szIndexName INDEX_NAME
m_bPrimaryKey PRIMARY_KEY
m_bUnique UNIQUE
m_bClustered CLUSTERED
m_nType TYPE
m_nFillFactor FILL_FACTOR
m_nInitialSize INITIAL_SIZE
m_nNulls NULLS
m_bSortBookmarks SORT_BOOKMARKS
m_bAutoUpdate AUTO_UPDATE
m_nNullCollation NULL_COLLATION
m_nOrdinalPosition ORDINAL_POSITION
m_szColumnName COLUMN_NAME
m_guidColumn COLUMN_GUID
m_nColumnPropID COLUMN_PROPID
m_nCollation COLLATION
m_nCardinality CARDINALITY
m_nPages PAGES
m_szFilterCondition FILTER_CONDITION

CKeyColumns, CKeyColumnInfo

Call the typedef class CKeyColumns to implement its parameter class CKeyColumnInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the columns, defined in the catalog, that are constrained as keys by a given user.

The following table lists the class data members and their corresponding OLE DB Columns. See KEY_COLUMN_USAGE Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szConstraintCatalog CONSTRAINT_CATALOG
m_szConstraintSchema CONSTRAINT_SCHEMA
m_szConstraintName CONSTRAINT_NAME
m_szTableCatalog TABLE_CATALOG
m_szTableSchema TABLE_SCHEMA
m_szTableName TABLE_NAME
m_szColumnName COLUMN_NAME
m_guidColumn COLUMN_GUID
m_nColumnPropID COLUMN_PROPID
m_nOrdinalPosition ORDINAL_POSITION

CPrimaryKeys, CPrimaryKeyInfo

Call the typedef class CPrimaryKeys to implement its parameter class CPrimaryKeyInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the primary key columns defined in the catalog by a given user.

The following table lists the class data members and their corresponding OLE DB Columns. See PRIMARY_KEYS Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szTableCatalog TABLE_CATALOG
m_szTableSchema TABLE_SCHEMA
m_szTableName TABLE_NAME
m_szColumnName COLUMN_NAME
m_guidColumn COLUMN_GUID
m_nColumnPropID COLUMN_PROPID
m_nOrdinal ORDINAL

CProcedureColumns, CProcedureColumnInfo

Call the typedef class CProcedureColumns to implement its parameter class CProcedureColumnInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class returns information about the columns of rowsets returned by procedures.

The following table lists the class data members and their corresponding OLE DB Columns. See PROCEDURE_COLUMNS Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szCatalog PROCEDURE_CATALOG
m_szSchema PROCEDURE_SCHEMA
m_szName PROCEDURE_NAME
m_szColumnName COLUMN_NAME
m_guidColumn COLUMN_GUID
m_nColumnPropID COLUMN_PROPID
m_nRowsetNumber ROWSET_NUMBER
m_nOrdinalPosition ORDINAL_POSITION
m_bIsNullable IS_NULLABLE
m_nDataType DATA_TYPE
m_guidType TYPE_GUID
m_nMaxLength CHARACTER_MAXIMUM_LENGTH
m_nOctetLength CHARACTER_OCTET_LENGTH
m_nPrecision NUMERIC_PRECISION
m_nScale NUMERIC_SCALE
m_szDescription DESCRIPTION

CProcedureParameters CProcedureParamInfo

Call the typedef class CProcedureParameters to implement its parameter class CProcedureParamInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class returns information about the parameters and return codes of procedures.

The following table lists the class data members and their corresponding OLE DB Columns. See PROCEDURE_PARAMETERS Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szCatalog PROCEDURE_CATALOG
m_szSchema PROCEDURE_SCHEMA
m_szName PROCEDURE_NAME
m_szParameterName PARAMETER_NAME
m_nOrdinalPosition ORDINAL_POSITION
m_nType PARAMETER_TYPE
m_bHasDefault PARAMETER_HASDEFAULT
m_szDefault PARAMETER_DEFAULT
m_bIsNullable IS_NULLABLE
m_nDataType DATA_TYPE
m_nMaxLength CHARACTER_MAXIMUM_LENGTH
m_nOctetLength CHARACTER_OCTET_LENGTH
m_nPrecision NUMERIC_PRECISION
m_nScale NUMERIC_SCALE
m_szDescription DESCRIPTION

CProcedures, CProcedureInfo

Call the typedef class CProcedures to implement its parameter class CProcedureInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the procedures, defined in the catalog, that are owned by a given user.

The following table lists the class data members and their corresponding OLE DB Columns. See PROCEDURES Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szCatalog PROCEDURE_CATALOG
m_szSchema PROCEDURE_SCHEMA
m_szName PROCEDURE_NAME
m_nType PROCEDURE_TYPE
m_szDefinition PROCEDURE_DEFINITION
m_szDescription DESCRIPTION

CProviderTypes, CProviderInfo

Call the typedef class CProviderTypes to implement its parameter class CProviderInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the (base) data types supported by the data provider.

The following table lists the class data members and their corresponding OLE DB Columns. See PROVIDER_TYPES Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szTypeName TYPE_NAME
m_nDataType DATA_TYPE
m_nColumnSize COLUMN_SIZE
m_szLiteralPrefix LITERAL_PREFIX
m_szLiteralSuffix LITERAL_SUFFIX
m_szCreateParams CREATE_PARAMS
m_bIsNullable IS_NULLABLE
m_bCaseSensitive CASE_SENSITIVE
m_nSearchable SEARCHABLE
m_bUnsignedAttribute UNSIGNED_ATTRIBUTE
m_bFixedPrecScale FIXED_PREC_SCALE
m_bAutoUniqueValue AUTO_UNIQUE_VALUE
m_szLocalTypeName LOCAL_TYPE_NAME
m_nMinScale MINIMUM_SCALE
m_nMaxScale MAXIMUM_SCALE
m_guidType GUID
m_szTypeLib TYPELIB
m_szVersion VERSION
m_bIsLong IS_LONG
m_bBestMatch BEST_MATCH

CReferentialConstraints, CReferentialConstraintInfo

Call the typedef class CReferentialConstraints to implement its parameter class CReferentialConstraintInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the referential constraints, defined in the catalog, that are owned by a given user.

The following table lists the class data members and their corresponding OLE DB Columns. See REFERENTIAL_CONSTRAINTS Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szCatalog CONSTRAINT_CATALOG
m_szSchema CONSTRAINT_SCHEMA
m_szName CONSTRAINT_NAME
m_szUniqueCatalog UNIQUE_CONSTRAINT_CATALOG
m_szUniqueSchema UNIQUE_CONSTRAINT_SCHEMA
m_szUniqueName UNIQUE_CONSTRAINT_NAME
m_szMatchOption MATCH_OPTION
m_szUpdateRule UPDATE_RULE
m_szDeleteRule DELETE_RULE
m_szDescription DESCRIPTION

CSchemata, CSchemataInfo

Call the typedef class CSchemata to implement its parameter class CSchemataInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the schemas that are owned by a given user.

The following table lists the class data members and their corresponding OLE DB Columns. See SCHEMATA Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szCatalog CATALOG_NAME
m_szName SCHEMA_NAME
m_szOwner SCHEMA_OWNER
m_szCharCatalog DEFAULT_CHARACTER_SET_CATALOG
m_szCharSchema DEFAULT_CHARACTER_SET_SCHEMA
m_szCharName DEFAULT_CHARACTER_SET_NAME

CSQLLanguages, CSQLLanguageInfo

Call the typedef class CSQLLanguages to implement its parameter class CSQLLanguageInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the conformance levels, options, and dialects supported by the SQL-implementation processing data defined in the catalog.

The following table lists the class data members and their corresponding OLE DB Columns. See SQL_LANGUAGES Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szSource SQL_LANGUAGE_SOURCE
m_szYear SQL_LANGUAGE_YEAR
m_szConformance SQL_LANGUAGE_CONFORMANCE
m_szIntegrity SQL_LANGUAGE_INTEGRITY
m_szImplementation SQL_LANGUAGE_IMPLEMENTATION
m_szBindingStyle SQL_LANGUAGE_BINDING_STYLE
m_szProgrammingLanguage SQL_LANGUAGE_PROGRAMMING_LANGUAGE

CStatistics, CStatisticInfo

Call the typedef class CStatistics to implement its parameter class CStatisticInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the statistics, defined in the catalog, that are owned by a given user.

The following table lists the class data members and their corresponding OLE DB Columns. See STATISTICS Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szTableCatalog TABLE_CATALOG
m_szTableSchema TABLE_SCHEMA
m_szTableName TABLE_NAME
m_nCardinality CARDINALITY

CTableConstraints, CTableConstraintInfo

Call the typedef class CTableConstraints to implement its parameter class CTableConstraintInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the table constraints, defined in the catalog, that are owned by a given user.

The following table lists the class data members and their corresponding OLE DB Columns. See TABLE_CONSTRAINTS Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szCatalog CONSTRAINT_CATALOG
m_szSchema CONSTRAINT_SCHEMA
m_szName CONSTRAINT_NAME
m_szTableCatalog TABLE_CATALOG
m_szTableSchema TABLE_SCHEMA
m_szTableName TABLE_NAME
m_szType CONSTRAINT_TYPE
m_bIsDeferrable IS_DEFERRABLE
m_bInitiallyDeferred INITIALLY_DEFERRED
m_szDescription DESCRIPTION

CTablePrivileges, CTablePrivilegeInfo

Call the typedef class CTablePrivileges to implement its parameter class CTablePrivilegeInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the tables defined in the catalog that are accessible to a given user.

The following table lists the class data members and their corresponding OLE DB Columns. See TABLE_PRIVILEGES Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szGrantor GRANTOR
m_szGrantee GRANTEE
m_szCatalog TABLE_CATALOG
m_szSchema TABLE_SCHEMA
m_szName TABLE_NAME
m_szType PRIVILEGE_TYPE
m_bIsGrantable IS_GRANTABLE

CTables, CTableInfo

Call the typedef class CTables to implement its parameter class CTableInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the privileges on tables, defined in the catalog, that are available to or granted by a given user.

The following table lists the class data members and their corresponding OLE DB Columns. See TABLES Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szCatalog TABLE_CATALOG
m_szSchema TABLE_SCHEMA
m_szName TABLE_NAME
m_szType TABLE_TYPE
m_guidTable TABLE_GUID
m_szDescription DESCRIPTION

CTranslations, CTranslationInfo

Call the typedef class CTranslations to implement its parameter class CTranslationInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the character translations defined in the catalog that are accessible to a given user.

The following table lists the class data members and their corresponding OLE DB Columns. See TRANSLATIONS Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szCatalog TRANSLATION_CATALOG
m_szSchema TRANSLATION_SCHEMA
m_szName TRANSLATION_NAME
m_szSourceCatalog SOURCE_CHARACTER_SET_CATALOG
m_szSourceSchema SOURCE_CHARACTER_SET_SCHEMA
m_szSourceName SOURCE_CHARACTER_SET_NAME
m_szTargetCatalog TARGET_CHARACTER_SET_CATALOG
m_szTargetSchema TARGET_CHARACTER_SET_SCHEMA
m_szTargetName TARGET_CHARACTER_SET_NAME

CUsagePrivileges, CUsagePrivilegeInfo

Call the typedef class CUsagePrivileges to implement its parameter class CUsagePrivilegeInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the USAGE privileges on objects defined in the catalog that are available to or granted by a given user.

The following table lists the class data members and their corresponding OLE DB Columns. See USAGE_PRIVILEGES Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szGrantor GRANTOR
m_szGrantee GRANTEE
m_szObjectCatalog OBJECT_CATALOG
m_szObjectSchema OBJECT_SCHEMA
m_szObjectName OBJECT_NAME
m_szObjectType OBJECT_TYPE
m_szPrivilegeType PRIVILEGE_TYPE
m_bIsGrantable IS_GRANTABLE

CViewColumnUsage, CViewColumnInfo

Call the typedef class CViewColumnUsage to implement its parameter class CViewColumnInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the columns on which viewed tables, defined in the catalog and owned by a given user, are dependent.

The following table lists the class data members and their corresponding OLE DB Columns. See VIEW_COLUMN_USAGE Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szCatalog VIEW_CATALOG
m_szSchema VIEW_SCHEMA
m_szName VIEW_NAME
m_szTableCatalog TABLE_CATALOG
m_szTableSchema TABLE_SCHEMA
m_szTableName TABLE_NAME
m_szColumnName COLUMN_NAME
m_guidColumn COLUMN_GUID
m_nColumnPropID COLUMN_PROPID

CViews, CViewInfo

Call the typedef class CViews to implement its parameter class CViewInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the tables on which viewed tables, defined in the catalog and owned by a given user, are dependent.

The following table lists the class data members and their corresponding OLE DB Columns. See VIEWS Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szTableCatalog TABLE_CATALOG
m_szTableSchema TABLE_SCHEMA
m_szTableName TABLE_NAME
m_szDefinition VIEW_DEFINITION
m_bCheckOption CHECK_OPTION
m_bIsUpdatable IS_UPDATABLE
m_szDescription DESCRIPTION

CViewTableUsage, CViewTableInfo

Call the typedef class CViewTableUsage to implement its parameter class CViewTableInfo.

Remarks

See Schema Rowset Classes and Typedef Classes for more information on using typedef classes.

This class identifies the viewed tables, defined in the catalog, that are accessible to a given user.

The following table lists the class data members and their corresponding OLE DB Columns. See VIEW_TABLE_USAGE Rowset in the OLE DB Programmer's Reference for more information about the schema and columns.

Data members OLE DB columns
m_szCatalog VIEW_CATALOG
m_szSchema VIEW_SCHEMA
m_szName VIEW_NAME
m_szTableCatalog TABLE_CATALOG
m_szTableSchema TABLE_SCHEMA
m_szTableName TABLE_NAME

Requirements

Header: atldbsch.h

See also

CRestrictions Class