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 записи можно передавать в SQL Server в качестве табличного параметра, назначив возвращаемое значение метода свойствуValue.

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Экземпляры обычно создаются один раз и повторно используются для создания многих SqlDataRecord объектов, которые передаются в SQL Server в качестве табличного параметра. Дополнительные сведения см. в разделеTable-Valued Параметры.

Конструкторы

Имя.	Описание
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)	Инициализирует новый экземпляр класса с указанным именем столбца SqlMetaData , типом, максимальной длиной, точностью, масштабом, идентификатором языкового стандарта, параметрами сравнения и определяемым пользователем типом (UDT). Эта форма конструктора поддерживает табличные параметры и позволяет указать, является ли столбец в табличном параметре уникальным, а также порядок сортировки столбца и порядковый номер столбца сортировки.
SqlMetaData(String, SqlDbType, Int64, Byte, Byte, Int64, SqlCompareOptions, Type)	Инициализирует новый экземпляр класса с указанным именем столбца SqlMetaData , типом, максимальной длиной, точностью, масштабом, идентификатором языкового стандарта, параметрами сравнения и определяемым пользователем типом (UDT).
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)	Инициализирует новый экземпляр класса с указанным именем столбцаSqlMetaData, типом, определяемым пользователем типом, SQL Server типом и сервером по умолчанию. Эта форма конструктора поддерживает табличные параметры и позволяет указать, является ли столбец в табличном параметре уникальным, а также порядок сортировки столбца и порядковый номер столбца сортировки.
SqlMetaData(String, SqlDbType, Type, String)	Инициализирует новый экземпляр класса с указанным именем столбцаSqlMetaData, определяемым пользователем типом (UDT) и типом SQL Server.
SqlMetaData(String, SqlDbType, Type)	Инициализирует новый экземпляр класса с указанным именем столбца SqlMetaData , типом и определяемым пользователем типом (UDT).
SqlMetaData(String, SqlDbType)	Инициализирует новый экземпляр класса с указанным именем столбца SqlMetaData и типом.

Свойства

Имя.	Описание
CompareOptions	Возвращает правила сравнения, используемые для столбца или параметра.
DbType	Возвращает тип данных столбца или параметра.
IsUniqueKey	Указывает, является ли столбец в параметре с табличным значением уникальным.
LocaleId	Возвращает идентификатор языкового стандарта столбца или параметра.
Max	Возвращает длину типов данных TEXT, NTEXT и IMAGE.
MaxLength	Возвращает максимальную длину столбца или параметра.
Name	Возвращает имя столбца или параметра.
Precision	Возвращает точность столбца или параметра.
Scale	Возвращает масштаб столбца или параметра.
SortOrder	Возвращает порядок сортировки столбца.
SortOrdinal	Возвращает порядковый номер столбца сортировки.
SqlDbType	Возвращает тип данных столбца или параметра.
Type	Возвращает тип среды CLR определяемого пользователем типа (UDT).
TypeName	Возвращает трехкомпонентное имя определяемого пользователем типа (UDT) или тип SQL Server, представленный экземпляром.
UseServerDefault	Сообщает, должен ли этот столбец использовать значение сервера по умолчанию.
XmlSchemaCollectionDatabase	Возвращает имя базы данных, в которой находится коллекция схем для этого экземпляра XML.
XmlSchemaCollectionName	Возвращает имя коллекции схем для этого экземпляра XML.
XmlSchemaCollectionOwningSchema	Возвращает реляционную схему, в которой находится коллекция схем для этого экземпляра XML.

Методы

Имя.	Описание
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 .