スキーマ情報の入手

アプリケーションは、データベースのメタデータを検索して返すよう、データプロバイダーに要求することができます。各データプロバイダー固有のスキーマコレクションは、テーブルや列などのデータベーススキーマ要素を公開します。データプロバイダーは Connection クラスの GetSchema メソッドを使用します。スキーマ情報は GetSchemaTable メソッドによって返される列で説明されているように、結果セットからも取得できます。

データプロバイダーにもプロバイダー固有のスキーマコレクションが含まれています。スキーマコレクション名 MetaDataCollections を使用すると、サポートされるスキーマコレクションの一覧と、それらがサポートする制限の数を返すことができます。

GetSchemaTable メソッドによって返される列

PsqlDataReader が開いている間は、結果セットからスキーマ情報を取得することができます。PsqlDataReader.GetSchemaTable() で生成された結果セットは、表 58 に説明されている列を、指定された順序で返します。

表 58

PsqlDataReader の GetSchemaTable で返される列

列

説明

ColumnName

列の名前。列名は一意でない場合もあります。判断できない場合は、null 値が返されます。この名前は、現在のビュー内またはコマンドテキスト内の列に対する最新の名前変更を常に反映した名前になります。

ColumnOrdinal

列の序数。この列に null 値を含めることはできません。行のブックマーク列（ある場合）はゼロになります。その他の列は 1 から順に番号が付けられます。

ColumnSize

列の値に許容される最大長。固定長データ型を使用する列では、そのデータ型のサイズになります。

NumericPrecision

列の精度。これは ProviderType での列の定義方法によって決まります。

ProviderType が数値データ型の場合、これは列の最大精度になります。

ProviderType が数値データ型以外の場合は、null 値になります。

NumericScale

小数点の右側の桁数。これは、ProviderType が DBTYPE_DECIMAL または DBTYPE_NUMERIC の場合です。それ以外の場合は、null 値になります。

この値は、ProviderType での列の定義方法によって決まります。

DataType

列を .NET Framework の型にマップします。

ProviderType

列のデータ型のインジケーター。この列に null 値を含めることはできません。

列のデータ型が行によって異なる場合は、Object である必要があります。

IsLong

非常に長いデータを格納する BLOB が列に含まれている場合に設定されます。このフラグの設定は、データ型の、PROVIDER_TYPES 行セット内の IS_LONG 列の値に対応します。

非常に長いデータの定義は、プロバイダーによって異なります。

AllowDBNull

コンシューマーが列に null 値を設定できる場合や、コンシューマーが列に null 値を設定できるかどうかをデータプロバイダーが判断できない場合に、設定されます。それ以外の場合は、設定されません。

列を null 値に設定できない場合でも、null 値が含まれている可能性があります。

IsReadOnly

列を変更できるかどうかを決定します。

列が変更できない場合は true、それ以外の場合は false です。

IsRowVersion

書き込み禁止で、行の識別以外に意味のない値を持つ永続的な行 ID が列に格納されている場合に、設定されます。

IsUnique

列自体がキーを構成しているか、あるいは、その列だけに適用される UNIQUE 型の制約があるかどうかを示します。

true に設定した場合、ベーステーブル（BaseTableName で返されるテーブル）の行は、この列に同じ値を格納できません。

false（デフォルトの初期値）に設定した場合は、ベーステーブルでこの列に重複する値を格納できます。

IsKey

列のセットが行セットの 1 行を一意に識別するかどうかを指定します。この列のセットは、ベーステーブルの主キー、一意の制約、または重複のないインデックスから生成することができます。

列が、行セット内の列のセットのうちの 1 つで、これらを基に行を一意に識別する場合は true です。列が行を一意に識別する必要がない場合は false です。

IsAutoIncrement

新しい行に固定インクリメントで値を割り当てるかどうかを指定します。

VARIANT_TRUE に設定すると、列は新しい行に固定インクリメントで値を割り当てます。

VARIANT_FALSE（デフォルトの初期値）に設定すると、列は新しい行に固定インクリメントで値を割り当てません。

BaseSchemaName

列を格納している、データベース内のスキーマの名前。基本スキーマ名を判断できない場合は null 値です。

デフォルトの初期値は null です。

BaseCatalogName

列を格納している、データストア内のカタログの名前。基本カタログ名を判断できない場合は null 値が使用されます。

デフォルトの初期値は null です。

BaseTableName

列を格納している、データストア内のテーブルまたはビューの名前。基本テーブル名を判断できない場合は null 値が使用されます。

デフォルトの初期値は null です。

BaseColumnName

データストア内での列名。エイリアスが使用された場合は、ColumnName 列に返される列名とは異なることがあります。基本列名を判断できない場合や、データベース内の列から派生した行セット列であるのにそれと一致しない場合は、null 値が使用されます。

デフォルトの初期値は null です。

IsAliased

列の名前がエイリアスであるかどうかを指定します。列名がエイリアスであれば、値 true が返されます。そうでなければ、false が返されます。

IsExpression

列の名前が式であるかどうかを指定します。列が式であれば、値 true が返されます。そうでなければ、false が返されます。

IsIdentity

列の名前が ID 列であるかどうかを指定します。列が ID 列であれば、値 true が返されます。そうでなければ、false が返されます。

IsHidden

列の名前が非表示であるかどうかを指定します。列が表示されない場合は、値 true が返されます。そうでなければ、false が返されます。

GetSchema メソッドによるスキーマメタデータの取得

アプリケーションでデータプロバイダーおよびデータソースに関するスキーマメタデータを取得する場合は、Connection オブジェクトの GetSchema メソッドを使用を使用します。各プロバイダーには 5 つの標準メタデータコレクションも含め、多数のスキーマコレクションが実装されています。

•

MetaDataCollections スキーマコレクション

•

DataSourceInformation スキーマコレクション

•

DataTypes コレクション

•

ReservedWords コレクション

•

Restrictions コレクション

追加のコレクションを指定したら、データプロバイダーからスキーマ情報を返す機能がサポートされるようにしておく必要があります。

データプロバイダーでサポートされるその他のコレクションの詳細については、Additional スキーマコレクションを参照してください。

メモ：各 ColumnName で必要なデータ型など、さらなるバックグラウンド機能要件については、.NET Framework ドキュメントを参照してください。

MetaDataCollections スキーマコレクション

MetaDataCollections スキーマコレクションは、ログインしているユーザーが利用できるスキーマコレクションの一覧です。MetaDataCollection は、表 59 に記載されているサポートされる列を任意の順序で返すことができます。

表 59

MetaDataCollections スキーマコレクションによって返される列

列名

説明

CollectionName

コレクションを返すために GetSchema メソッドに渡すコレクションの名前。

NumberOfRestrictions

コレクションに指定されている可能性のある制限の数。

NumberOfIdentifierParts

複合識別子/データベースオブジェクト名の構成要素の数。

DataSourceInformation スキーマコレクション

DataSourceInformation スキーマコレクションは、表 60 に記載されているサポートされる列を任意の順序で返すことができます。1 行のみ返されることに注意してください。

表 60

DataSourceInformation コレクションによって返される列名

列名

説明

CompositeIdentifierSeparatorPattern

複合識別子内の複合識別子に一致する正規表現。

DataSourceProductName

データプロバイダーがアクセスする製品の名前。

DataSourceProductVersion

データプロバイダーがアクセスする製品のバージョンをデータソースのネイティブ形式で示します。

DataSourceProductVersionNormalized

データソースの標準化されたバージョン。これにより、String.Compare() を使ってバージョンを比較できるようになります。

GroupByBehavior

GROUP BY 句内の列と、選択リスト内の集計されない列の間の関係を指定します。

Host

データプロバイダーが接続しているホスト。

IdentifierCase

引用符で囲まれていない識別子の大文字小文字を区別して処理するかどうかを示します。

IdentifierPattern

識別子に一致する正規表現で、識別子の適合値を持ちます。

OrderByColumnsInSelect

ORDER BY 句内の列は選択リスト内にある必要があるかどうかを指定します。true の値は、当該列が選択リストに存在しなければならないことを示し、false の値は選択リストに存在しなくてもよいことを示します。

ParameterMarkerFormat

パラメーターの書式設定方法を示す書式文字列。

ParameterMarkerPattern

パラメーターマーカーに一致する正規表現。もしあれば、パラメーター名の適合値を持ちます。

ParameterNameMaxLength

引用符で囲まれた識別子の大文字小文字を区別して処理するかどうかを示します。

QuotedIdentifierPattern

引用符で囲まれた識別子に一致する正規表現で、引用符の付いていない識別子自体の適合値を持ちます。

StatementSeparatorPattern

ステートメント区切り文字に一致する正規表現。

StringLiteralPattern

文字列リテラルに一致する正規表現で、リテラル自体の適合値を持ちます。

SupportedJoinOperators

データソースでサポートされる、SQL 結合ステートメントの種類を指定します。

DataTypes コレクション

表 61 では、DataTypes スキーマコレクションでサポートされる列について説明します。列は任意の順序で取得できます。

表 61

DataTypes コレクションによって返される列名

列名

説明

ColumnSize

数値以外の列またはパラメーターの長さは、この型の最大長もしくは、データプロバイダーがこの型に対して定義している長さを参照します。

CreateFormat

CREATE TABLE など、この列をデータ定義ステートメントに追加する方法を示す書式文字列。

CreateParameters

このデータ型の列を作成するときに指定する必要のある作成パラメーター。各作成パラメーターは文字列で、それらを提供する順にカンマで区切って列挙します。

たとえば、SQL データ型の DECIMAL には精度と小数点以下の桁数が必要です。この場合は、文字列 "精度, 小数位" を作成パラメーターに含める必要があります。

精度 10、小数位 2 の DECIMAL 列を作成するテキストコマンドでは、CreateFormat 列の値を "DECIMAL({0},{1})" とすることができます。完全な型指定は DECIMAL(10,2) となります。

DataType

データ型に対する .NET Framework 型の名前。

IsAutoIncrementable

データ型の値を自動インクリメントするかどうかを指定します。

true：このデータ型の値は自動インクリメントできます。

false：このデータ型の値は自動インクリメントできません。

IsBestMatch

このデータ型は、データストア内のすべてのデータ型と、DataType 列の値によって示される .NET Framework データ型の間で最適なものであるかどうかを指定します。

true：最適なデータ型です。

false：最適なデータ型ではありません。

IsCaseSensitive

データ型は文字型で、大文字小文字を区別するかどうかを指定します。

true：文字型で、大文字小文字を区別します。

false：文字型でないか、もしくは大文字小文字を区別しません。

IsConcurrencyType

true：このデータ型は行が変更されるたびにデータベースによって更新され、列の値は以前のあらゆる値と異なるものになります。

false：このデータ型は行が変更されるたびにデータベースによって更新されません。

IsFixedLength

true：データ定義言語（DDL）によって作成されるこのデータ型の列は固定長になります。

false：DDL によって作成されるこのデータ型の列は可変長になります。

IsFixedPrecisionScale

true：データ型は固定の精度と小数点以下の桁数を持ちます。

false：データ型は固定の精度と小数点以下の桁数を持ちません。

IsLiteralsSupported

true：データ型をリテラルで表すことができます。

false：データ型をリテラルで表すことはできません。

IsLong

true：データ型は非常に長いデータを格納します。非常に長いデータの定義は、プロバイダーによって異なります。

false：データ型は非常に長いデータを格納しません。

IsNullable

true：データ型はヌル値を許可します。

false：データ型はヌル値を許可しません。

IsSearchable

true：データ型は非常に長いデータを格納します。非常に長いデータの定義は、プロバイダーによって異なります。

false：データ型は非常に長いデータを格納しません。

IsSearchableWithLike

true：LIKE 述部で使用できません。

false：LIKE 述部で使用できません。

指定されたリテラルに適用するプレフィックス。

LiteralSuffix

指定されたリテラルに適用するサフィックス。

MaximumScale

型インジケーターが数値型の場合は、これは小数点の右側に割り当てられる最大桁数になります。

それ以外の場合、これは DBNull.Value になります。

MinimumScale

型インジケーターが数値型の場合は、これは小数点の右側に割り当てられる最小桁数になります。

それ以外の場合、これは DBNull.Value になります。

ProviderDbType

パラメーターの型を指定する場合に使用する必要のあるプロバイダー固有の型の値。

TypeName

プロバイダー固有のデータ型名。

ReservedWords コレクション

このスキーマコレクションは、データプロバイダーが接続するデータベースで予約されている語句についての情報を公開します。表 62 では、データプロバイダーがサポートする列について説明します。

表 62

ReservedWords スキーマコレクション

Restrictions スキーマコレクションは、現在データベースに接続しているデータプロバイダーでサポートされる制限に関する情報を公開します。表 63 では、データプロバイダーから返される列について説明します。列は任意の順序で取得できます。

ADO.NET データプロバイダーは標準化された名前を制限に使用します。データプロバイダーが Schema メソッドの制限をサポートしている場合は、制限に対して常に同じ名前を使用します。

制限値の大文字小文字の区別は基になるデータベースによって決定されますが、DataSourceInformation コレクションの IdentifierCase 値および QuotedIdentifierCase 値によっても決定することができます（DataSourceInformation スキーマコレクションを参照してください）。

表 63

Restrictions コレクションによって返される列名

列名

説明

CollectionName

指定した制限を適用するコレクションの名前。

この制限の、コレクション Restrictions 内における実際の場所。

IsRequired

制限が必要かどうかを指定します。

サポートされる追加のスキーマコレクションそれぞれに適用する制限については、Additional スキーマコレクションを参照してください。

Additional スキーマコレクション

Zen ADO.NET データプロバイダーは、以下に示す追加のスキーマコレクションをサポートしています。

•

Columns スキーマコレクション

•

ForeignKeys スキーマコレクション

•

Indexes スキーマコレクション

•

PrimaryKeys スキーマコレクション

•

ProcedureParameters スキーマコレクション

•

Procedures スキーマコレクション

•

TablePrivileges スキーマコレクション

•

Tables スキーマコレクション

•

Views スキーマコレクション

Columns スキーマコレクション

説明：Columns スキーマコレクションは、指定したユーザーがアクセスできるカタログに定義されているテーブル（ビューも含む）の列を識別します。表 64 では、指定したユーザーがアクセスできるカタログに定義されているテーブルの列を示します。

制限の数：3

使用可能な制限：TABLE_CATALOG、TABLE_NAME、COLUMN_NAME

ソート順：TABLE_CATALOG、TABLE_NAME、ORDINAL_POSITION

表 64

Columns スキーマコレクション

列名

.NET Framework データ型¹

説明

CHARACTER_MAXIMUM_LENGTH

Int32

列の値に許容される最大長。文字、バイナリ、またはビットの列の場合、これは次のいずれかになります。

•

いずれかの列が定義されている場合は、それぞれ文字単位、バイト単位、ビット単位の列の最大長。

•

列の長さが定義されていない場合は、それぞれ文字単位、バイト単位、ビット単位のデータ型の最大長。

•

列にもデータ型にも最大長が定義されていない場合、あるいは列が文字、バイナリ、ビットのいずれでもない場合は、ゼロ（0）。

CHARACTER_OCTET_LENGTH

Int32

列の型が文字またはバイナリの場合は、8 進数（バイト単位）で表す列の最大長。

値ゼロ（0）は、その列が最大長を持たないか、あるいは、文字またはバイナリの列でないことを意味します。