OleDbConnection.GetOleDbSchemaTable メソッドとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

OleDbConnection.GetOleDbSchemaTable メソッド

GUID によって指定したデータソースのスキーマ情報を、指定した制約の適用後に返します。

名前空間: System.Data.OleDb
アセンブリ: System.Data (system.data.dll 内)
構文

Visual Basic (宣言)

Public Function GetOleDbSchemaTable ( _
    schema As Guid, _
    restrictions As Object() _
) As DataTable

Visual Basic (使用法)

Dim instance As OleDbConnection
Dim schema As Guid
Dim restrictions As Object()
Dim returnValue As DataTable

returnValue = instance.GetOleDbSchemaTable(schema, restrictions)

public DataTable GetOleDbSchemaTable (
    Guid schema,
    Object[] restrictions
)

C++

public:
DataTable^ GetOleDbSchemaTable (
    Guid schema, 
    array<Object^>^ restrictions
)

public DataTable GetOleDbSchemaTable (
    Guid schema, 
    Object[] restrictions
)

JScript

public function GetOleDbSchemaTable (
    schema : Guid, 
    restrictions : Object[]
) : DataTable

パラメータ

schema: 取得するスキーマテーブルを示す OleDbSchemaGuid 値の 1 つ。

restrictions: 制約値の Object 配列。制約値は、制約列の順に適用されます。つまり、先頭の制約値は先頭の制約列に適用され、2 番目の制約値は 2 番目の制約列に適用されます。

戻り値
要求したスキーマ情報を格納した DataTable。

例外

例外の種類	条件
OleDbException	指定された制約セットが無効です。
InvalidOperationException	OleDbConnection が閉じています。
ArgumentException	指定されたスキーマ行セットは、OLE DB プロバイダでサポートされていません。または schema パラメータに DbInfoLiterals の値が格納され、restrictions パラメータに 1 つ以上の制約が格納されています。

例外の種類

条件

OleDbException

指定された制約セットが無効です。

InvalidOperationException

OleDbConnection が閉じています。

ArgumentException

指定されたスキーマ行セットは、OLE DB プロバイダでサポートされていません。

または

schema パラメータに DbInfoLiterals の値が格納され、restrictions パラメータに 1 つ以上の制約が格納されています。

解説

スキーマテーブルは、schema パラメータで指定した OLE DB スキーマ行セットと同じ形式の DataTable として返されます。DataTable に返される行をフィルタ処理するには、restrictions パラメータを使用します。たとえば、テーブル名、型、所有者、スキーマの制約などを指定します。値を配列で渡す場合、値を含まない配列要素には、空の文字列または null を設定します。restrictions に空の配列を渡すと、すべての行 (各テーブルにつき 1 行) が既定の順序で返されます。配列内の値は、ソーステーブルおよび DataTable の列の順序に対応します。restrictions 配列内の各要素は、スキーマ行セット内の対応する列の内容と比較されます。たとえば、restrictions 配列の 1 番目の要素は、行セットの 1 列目と比較されます。制約要素が null ではない場合、制約値と完全一致するスキーマの行だけが結果の DataTable に追加されます。

OleDbConnection メソッドは、標準共通言語ランタイム変換規則を使用して、基になる OLE DB IDBSchemaRowset::GetRowset メソッドを呼び出します。詳細については、「COM のデータ型」を参照してください。

リテラルに関する情報は、DbInfoLiterals を使用して取得できます。これにより取得される情報は、OLE DB IDBInfo::GetLiteralInfo インターフェイスの呼び出し、または adSchemaDBInfoLiterals 定数を指定した ADO Connection.OpenSchema メソッドの呼び出しで得られる情報と同じです。

使用例

データベース内のテーブル一覧を返す例を次に示します。

Visual Basic

Public Function GetSchemaTable(ByVal
 connectionString As String) _
    As DataTable

    Using connection As New OleDbConnection(connectionString)
        connection.Open()

        Dim schemaTable As DataTable = _
            connection.GetOleDbSchemaTable(OleDbSchemaGuid.Tables, _
            New Object() {Nothing, Nothing,
 Nothing, "TABLE"})
        Return schemaTable
    End Using
End Function

static DataTable GetSchemaTable(string connectionString)
{
    using (OleDbConnection connection = new
 
               OleDbConnection(connectionString))
    {
        connection.Open();
        DataTable schemaTable = connection.GetOleDbSchemaTable(
            OleDbSchemaGuid.Tables,
            new object[] { null, null,
 null, "TABLE" });
        return schemaTable;
    }

using System;
using System.Data;
using System.Data.OleDb;

class Class1
{
    static void Main()
    {
        string x = "Provider=SQLOLEDB;Data Source=(local);Initial
 Catalog=AdventureWorks;"
            + "Integrated Security=SSPI";
        GetSchemaTable(x);
        Console.ReadLine();
    }

    static DataTable GetSchemaTable(string
 connectionString)
    {
        using (OleDbConnection connection = new
 
                   OleDbConnection(connectionString))
        {
            connection.Open();
            DataTable schemaTable = connection.GetOleDbSchemaTable(
                OleDbSchemaGuid.Tables,
                new object[] { null, null,
 null, "TABLE" });
            return schemaTable;
        }