SqlMetaData クラス

定義

名前空間:

Microsoft.Data.SqlClient.Server

アセンブリ:

Microsoft.Data.SqlClient.dll

パッケージ:

Microsoft.Data.SqlClient v7.1.0

SqlDataRecord オブジェクトによって使用される列のメタデータ情報を指定します。 このクラスは継承できません。

public ref class SqlMetaData sealed

public sealed class SqlMetaData

type SqlMetaData = class

Public NotInheritable Class SqlMetaData

継承

Object

SqlMetaData

例

次の例は、レコードの列メタデータを記述する複数の SqlMetaData オブジェクトの作成と、 SqlDataRecord レコードのストリームの生成を示しています。 これらのSqlDataRecord レコードは、メソッドの戻り値を Value プロパティに割り当てることで、テーブル値パラメーターとしてSQL Serverにストリーミングできます。

using System;
using System.Collections.Generic;
using System.Data;
using Microsoft.Data.SqlClient.Server;

public static IEnumerable<SqlDataRecord> ReturnNewRecords()
{
    // Variables.
    SqlMetaData column1Info;
    SqlMetaData column2Info;
    SqlMetaData column3Info;
    SqlDataRecord record;

    // Create the column metadata.
    column1Info = new SqlMetaData("Column1", SqlDbType.NVarChar, 12);
    column2Info = new SqlMetaData("Column2", SqlDbType.Int);
    column3Info = new SqlMetaData("Column3", SqlDbType.DateTime);

    // Create a new record with the column metadata.      
    record = new SqlDataRecord(new SqlMetaData[] { 
      column1Info,
      column2Info,
      column3Info });

    // Set the fields of the first record and stream it to SQL Server.
    record.SetString(0, "Hello World!");
    record.SetInt32(1, 42);
    record.SetDateTime(2, DateTime.Now);
    yield return record;

    // Set the fields of the second record and stream it to SQL Server.
    record.SetInt32(1, 0);
    yield return record;
}

注釈

SqlMetaData通常、インスタンスは 1 回ビルドされ、テーブル値パラメーターとしてSQL Serverにストリーミングされる多数のSqlDataRecord オブジェクトを構築するために再利用されます。 詳細については、「 Table-Valued パラメーター」を参照してください。

コンストラクター

Name	説明
SqlMetaData(String, SqlDbType, Boolean, Boolean, SortOrder, Int32)	指定した列名と既定のサーバーを使用して、 SqlMetaData クラスの新しいインスタンスを初期化します。 この形式のコンストラクターは、テーブル値パラメーター内で列が一意であるかどうか、列の並べ替え順序、および並べ替え列の序数を指定できるようにすることで、テーブル値パラメーターをサポートします。
SqlMetaData(String, SqlDbType, Byte, Byte, Boolean, Boolean, SortOrder, Int32)	指定した列名、型、有効桁数、スケール、およびサーバーの既定値を使用して、 SqlMetaData クラスの新しいインスタンスを初期化します。 この形式のコンストラクターは、テーブル値パラメーター内で列が一意であるかどうか、列の並べ替え順序、および並べ替え列の序数を指定できるようにすることで、テーブル値パラメーターをサポートします。
SqlMetaData(String, SqlDbType, Byte, Byte)	指定した列名、型、有効桁数、および小数点以下桁数を使用して、 SqlMetaData クラスの新しいインスタンスを初期化します。
SqlMetaData(String, SqlDbType, Int64, Boolean, Boolean, SortOrder, Int32)	指定した列名、型、最大長、およびサーバーの既定値を使用して、 SqlMetaData クラスの新しいインスタンスを初期化します。 この形式のコンストラクターは、テーブル値パラメーター内で列が一意であるかどうか、列の並べ替え順序、および並べ替え列の序数を指定できるようにすることで、テーブル値パラメーターをサポートします。
SqlMetaData(String, SqlDbType, Int64, Byte, Byte, Int64, SqlCompareOptions, Type, Boolean, Boolean, SortOrder, Int32)	指定した列名、型、最大長、有効桁数、小数点以下桁数、ロケール ID、比較オプション、およびユーザー定義型 (UDT) を使用して、 SqlMetaData クラスの新しいインスタンスを初期化します。 この形式のコンストラクターは、テーブル値パラメーター内で列が一意であるかどうか、列の並べ替え順序、および並べ替え列の序数を指定できるようにすることで、テーブル値パラメーターをサポートします。
SqlMetaData(String, SqlDbType, Int64, Byte, Byte, Int64, SqlCompareOptions, Type)	指定した列名、型、最大長、有効桁数、小数点以下桁数、ロケール ID、比較オプション、およびユーザー定義型 (UDT) を使用して、 SqlMetaData クラスの新しいインスタンスを初期化します。
SqlMetaData(String, SqlDbType, Int64, Int64, SqlCompareOptions, Boolean, Boolean, SortOrder, Int32)	指定した列名、型、最大長、ロケール、比較オプション、およびサーバーの既定値を使用して、 SqlMetaData クラスの新しいインスタンスを初期化します。 この形式のコンストラクターは、テーブル値パラメーター内で列が一意であるかどうか、列の並べ替え順序、および並べ替え列の序数を指定できるようにすることで、テーブル値パラメーターをサポートします。
SqlMetaData(String, SqlDbType, Int64, Int64, SqlCompareOptions)	指定した列名、型、最大長、ロケール、および比較オプションを使用して、 SqlMetaData クラスの新しいインスタンスを初期化します。
SqlMetaData(String, SqlDbType, Int64)	指定した列名、型、および最大長を使用して、 SqlMetaData クラスの新しいインスタンスを初期化します。
SqlMetaData(String, SqlDbType, String, String, String, Boolean, Boolean, SortOrder, Int32)	指定した列名、データベース名、所有スキーマ、オブジェクト名、および既定のサーバーを使用して、 SqlMetaData クラスの新しいインスタンスを初期化します。 この形式のコンストラクターは、テーブル値パラメーター内で列が一意であるかどうか、列の並べ替え順序、および並べ替え列の序数を指定できるようにすることで、テーブル値パラメーターをサポートします。
SqlMetaData(String, SqlDbType, String, String, String)	指定した列名、型、データベース名、所有スキーマ、およびオブジェクト名を使用して、 SqlMetaData クラスの新しいインスタンスを初期化します。
SqlMetaData(String, SqlDbType, Type, String, Boolean, Boolean, SortOrder, Int32)	指定した列名、型、ユーザー定義型、SQL Server型、およびサーバーの既定値を使用して、SqlMetaData クラスの新しいインスタンスを初期化します。 この形式のコンストラクターは、テーブル値パラメーター内で列が一意であるかどうか、列の並べ替え順序、および並べ替え列の序数を指定できるようにすることで、テーブル値パラメーターをサポートします。
SqlMetaData(String, SqlDbType, Type, String)	指定した列名、ユーザー定義型 (UDT)、およびSQL Server型を使用して、SqlMetaData クラスの新しいインスタンスを初期化します。
SqlMetaData(String, SqlDbType, Type)	指定した列名、型、およびユーザー定義型 (UDT) を使用して、 SqlMetaData クラスの新しいインスタンスを初期化します。
SqlMetaData(String, SqlDbType)	指定した列名と型を使用して、 SqlMetaData クラスの新しいインスタンスを初期化します。

プロパティ

Name	説明
CompareOptions	列またはパラメーターに使用される比較規則を取得します。
DbType	列またはパラメーターのデータ型を取得します。
IsUniqueKey	テーブル値パラメーターの列が一意かどうかを示します。
LocaleId	列またはパラメーターのロケール ID を取得します。
Max	TEXT、NTEXT、および IMAGE データ型の長さを取得します。
MaxLength	列またはパラメーターの最大長を取得します。
Name	列またはパラメーターの名前を取得します。
Precision	列またはパラメーターの有効桁数を取得します。
Scale	列またはパラメーターのスケールを取得します。
SortOrder	列の並べ替え順序を返します。
SortOrdinal	並べ替え列の序数を返します。
SqlDbType	列またはパラメーターのデータ型を取得します。
Type	ユーザー定義型 (UDT) の共通言語ランタイム (CLR) 型を取得します。
TypeName	ユーザー定義型 (UDT) またはインスタンスによって表されるSQL Server型の 3 部構成の名前を取得します。
UseServerDefault	この列が既定のサーバー値を使用する必要があるかどうかを報告します。
XmlSchemaCollectionDatabase	この XML インスタンスのスキーマ コレクションがあるデータベースの名前を取得します。
XmlSchemaCollectionName	この XML インスタンスのスキーマ コレクションの名前を取得します。
XmlSchemaCollectionOwningSchema	この XML インスタンスのスキーマ コレクションがある所有リレーショナル スキーマを取得します。

メソッド

Name	説明
Adjust(Boolean)	指定した Boolean 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(Byte)	指定した Byte 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(Byte[])	指定した Byte 値の配列をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(Char)	指定した Char 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(Char[])	指定した Char 値の配列をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(DateTime)	指定した DateTime 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(DateTimeOffset)	指定した DateTimeOffset 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(Decimal)	指定した Decimal 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(Double)	指定した Double 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(Guid)	指定した Guid 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(Int16)	指定した Int16 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(Int32)	指定した Int32 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(Int64)	指定した Int64 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(Object)	指定した Object 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(Single)	指定した Single 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(SqlBinary)	指定した SqlBinary 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(SqlBoolean)	指定した SqlBoolean 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(SqlByte)	指定した SqlByte 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(SqlBytes)	指定した SqlBytes 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(SqlChars)	指定した SqlChars 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(SqlDateTime)	指定した SqlDateTime 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(SqlDecimal)	指定した SqlDecimal 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(SqlDouble)	指定した SqlDouble 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(SqlGuid)	指定した SqlGuid 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(SqlInt16)	指定した SqlInt16 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(SqlInt32)	指定した SqlInt32 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(SqlInt64)	指定した SqlInt64 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(SqlMoney)	指定した SqlMoney 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(SqlSingle)	指定した SqlSingle 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(SqlString)	指定した SqlString 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(SqlXml)	指定した SqlXml 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(String)	指定した String 値をメタデータに対して検証し、必要に応じて値を調整します。
Adjust(TimeSpan)	指定した TimeSpan 値をメタデータに対して検証し、必要に応じて値を調整します。
InferFromValue(Object, String)	指定したオブジェクトからメタデータを推論し、 SqlMetaData インスタンスとして返します。