SqlMetaData Classe

Définition

Espace de noms:

Microsoft.Data.SqlClient.Server

Assembly:

Microsoft.Data.SqlClient.dll

Package:

Microsoft.Data.SqlClient v7.1.0

Spécifie les informations de métadonnées d’une colonne utilisée par un SqlDataRecord objet. Cette classe ne peut pas être héritée.

public ref class SqlMetaData sealed

public sealed class SqlMetaData

type SqlMetaData = class

Public NotInheritable Class SqlMetaData

Héritage

Object

SqlMetaData

Exemples

L’exemple suivant montre la création de plusieurs SqlMetaData objets, qui décrivent les métadonnées de colonne d’un enregistrement et la génération d’un flux d’enregistrements SqlDataRecord . Ces SqlDataRecord enregistrements peuvent être diffusés en continu vers SQL Server en tant que paramètre table en affectant la valeur de retour de la méthode à la Value propriété.

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;
}

Remarques

SqlMetaDatales instances sont généralement générées une fois et réutilisées pour construire de nombreux SqlDataRecord objets qui sont diffusés en continu vers SQL Server en tant que paramètre table. Pour plus d’informations, consultez Table-Valued Paramètres.

Constructeurs

Nom	Description
SqlMetaData(String, SqlDbType, Boolean, Boolean, SortOrder, Int32)	Initialise une nouvelle instance de la SqlMetaData classe avec le nom de colonne spécifié et le serveur par défaut. Cette forme du constructeur prend en charge les paramètres table en offrant la possibilité de spécifier si la colonne est unique dans le paramètre table, l’ordre de tri de la colonne et l’ordinal de la colonne de tri.
SqlMetaData(String, SqlDbType, Byte, Byte, Boolean, Boolean, SortOrder, Int32)	Initialise une nouvelle instance de la classe avec le nom de colonne, le type, la précision, l’échelle SqlMetaData et la valeur par défaut du serveur spécifiés. Cette forme du constructeur prend en charge les paramètres table en offrant la possibilité de spécifier si la colonne est unique dans le paramètre table, l’ordre de tri de la colonne et l’ordinal de la colonne de tri.
SqlMetaData(String, SqlDbType, Byte, Byte)	Initialise une nouvelle instance de la SqlMetaData classe avec le nom de colonne, le type, la précision et l’échelle spécifiés.
SqlMetaData(String, SqlDbType, Int64, Boolean, Boolean, SortOrder, Int32)	Initialise une nouvelle instance de la SqlMetaData classe avec le nom de colonne, le type, la longueur maximale et la valeur par défaut du serveur spécifiés. Cette forme du constructeur prend en charge les paramètres table en offrant la possibilité de spécifier si la colonne est unique dans le paramètre table, l’ordre de tri de la colonne et l’ordinal de la colonne de tri.
SqlMetaData(String, SqlDbType, Int64, Byte, Byte, Int64, SqlCompareOptions, Type, Boolean, Boolean, SortOrder, Int32)	Initialise une nouvelle instance de la classe avec le nom de colonne, le type, la longueur maximale, la précision, l’échelle SqlMetaData , l’ID de paramètres régionaux, les options de comparaison et le type défini par l’utilisateur (UDT). Cette forme du constructeur prend en charge les paramètres table en offrant la possibilité de spécifier si la colonne est unique dans le paramètre table, l’ordre de tri de la colonne et l’ordinal de la colonne de tri.
SqlMetaData(String, SqlDbType, Int64, Byte, Byte, Int64, SqlCompareOptions, Type)	Initialise une nouvelle instance de la classe avec le nom de colonne, le type, la longueur maximale, la précision, l’échelle SqlMetaData , l’ID de paramètres régionaux, les options de comparaison et le type défini par l’utilisateur (UDT).
SqlMetaData(String, SqlDbType, Int64, Int64, SqlCompareOptions, Boolean, Boolean, SortOrder, Int32)	Initialise une nouvelle instance de la SqlMetaData classe avec le nom de colonne, le type, la longueur maximale, les paramètres régionaux, les options de comparaison et la valeur par défaut du serveur spécifiés. Cette forme du constructeur prend en charge les paramètres table en offrant la possibilité de spécifier si la colonne est unique dans le paramètre table, l’ordre de tri de la colonne et l’ordinal de la colonne de tri.
SqlMetaData(String, SqlDbType, Int64, Int64, SqlCompareOptions)	Initialise une nouvelle instance de la SqlMetaData classe avec le nom de colonne, le type, la longueur maximale, les paramètres régionaux et les options de comparaison spécifiés.
SqlMetaData(String, SqlDbType, Int64)	Initialise une nouvelle instance de la SqlMetaData classe avec le nom de colonne, le type et la longueur maximale spécifiés.
SqlMetaData(String, SqlDbType, String, String, String, Boolean, Boolean, SortOrder, Int32)	Initialise une nouvelle instance de la SqlMetaData classe avec le nom de colonne, le nom de la base de données, le schéma propriétaire, le nom de l’objet et le serveur par défaut spécifiés. Cette forme du constructeur prend en charge les paramètres table en offrant la possibilité de spécifier si la colonne est unique dans le paramètre table, l’ordre de tri de la colonne et l’ordinal de la colonne de tri.
SqlMetaData(String, SqlDbType, String, String, String)	Initialise une nouvelle instance de la SqlMetaData classe avec le nom de colonne, le type, le nom de la base de données, le schéma propriétaire et le nom d’objet spécifiés.
SqlMetaData(String, SqlDbType, Type, String, Boolean, Boolean, SortOrder, Int32)	Initialise une nouvelle instance de la SqlMetaData classe avec le nom de colonne, le type, le type défini par l’utilisateur, le type SQL Server et le serveur par défaut. Cette forme du constructeur prend en charge les paramètres table en offrant la possibilité de spécifier si la colonne est unique dans le paramètre table, l’ordre de tri de la colonne et l’ordinal de la colonne de tri.
SqlMetaData(String, SqlDbType, Type, String)	Initialise une nouvelle instance de la SqlMetaData classe avec le nom de colonne spécifié, le type défini par l’utilisateur (UDT) et SQL Server type.
SqlMetaData(String, SqlDbType, Type)	Initialise une nouvelle instance de la classe avec le nom, le type et le type défini par l’utilisateur SqlMetaData spécifiés.
SqlMetaData(String, SqlDbType)	Initialise une nouvelle instance de la SqlMetaData classe avec le nom et le type de colonne spécifiés.

Propriétés

Nom	Description
CompareOptions	Obtient les règles de comparaison utilisées pour la colonne ou le paramètre.
DbType	Obtient le type de données de la colonne ou du paramètre.
IsUniqueKey	Indique si la colonne du paramètre table est unique.
LocaleId	Obtient l’ID de paramètres régionaux de la colonne ou du paramètre.
Max	Obtient la longueur des types de données TEXT, NTEXT et IMAGE.
MaxLength	Obtient la longueur maximale de la colonne ou du paramètre.
Name	Obtient le nom de la colonne ou du paramètre.
Precision	Obtient la précision de la colonne ou du paramètre.
Scale	Obtient l’échelle de la colonne ou du paramètre.
SortOrder	Retourne l’ordre de tri d’une colonne.
SortOrdinal	Retourne l’ordinal de la colonne de tri.
SqlDbType	Obtient le type de données de la colonne ou du paramètre.
Type	Obtient le type CLR (Common Language Runtime) de type défini par l’utilisateur (UDT).
TypeName	Obtient le nom en trois parties du type défini par l’utilisateur (UDT) ou le type de SQL Server représenté par l’instance.
UseServerDefault	Indique si cette colonne doit utiliser la valeur du serveur par défaut.
XmlSchemaCollectionDatabase	Obtient le nom de la base de données où se trouve la collection de schémas pour cette instance XML.
XmlSchemaCollectionName	Obtient le nom de la collection de schémas pour cette instance XML.
XmlSchemaCollectionOwningSchema	Obtient le schéma relationnel propriétaire où se trouve la collection de schémas pour cette instance XML.

Méthodes

Nom	Description
Adjust(Boolean)	Valide la valeur spécifiée Boolean par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(Byte)	Valide la valeur spécifiée Byte par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(Byte[])	Valide le tableau de Byte valeurs spécifié par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(Char)	Valide la valeur spécifiée Char par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(Char[])	Valide le tableau de Char valeurs spécifié par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(DateTime)	Valide la valeur spécifiée DateTime par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(DateTimeOffset)	Valide la valeur spécifiée DateTimeOffset par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(Decimal)	Valide la valeur spécifiée Decimal par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(Double)	Valide la valeur spécifiée Double par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(Guid)	Valide la valeur spécifiée Guid par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(Int16)	Valide la valeur spécifiée Int16 par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(Int32)	Valide la valeur spécifiée Int32 par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(Int64)	Valide la valeur spécifiée Int64 par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(Object)	Valide la valeur spécifiée Object par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(Single)	Valide la valeur spécifiée Single par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(SqlBinary)	Valide la valeur spécifiée SqlBinary par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(SqlBoolean)	Valide la valeur spécifiée SqlBoolean par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(SqlByte)	Valide la valeur spécifiée SqlByte par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(SqlBytes)	Valide la valeur spécifiée SqlBytes par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(SqlChars)	Valide la valeur spécifiée SqlChars par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(SqlDateTime)	Valide la valeur spécifiée SqlDateTime par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(SqlDecimal)	Valide la valeur spécifiée SqlDecimal par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(SqlDouble)	Valide la valeur spécifiée SqlDouble par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(SqlGuid)	Valide la valeur spécifiée SqlGuid par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(SqlInt16)	Valide la valeur spécifiée SqlInt16 par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(SqlInt32)	Valide la valeur spécifiée SqlInt32 par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(SqlInt64)	Valide la valeur spécifiée SqlInt64 par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(SqlMoney)	Valide la valeur spécifiée SqlMoney par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(SqlSingle)	Valide la valeur spécifiée SqlSingle par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(SqlString)	Valide la valeur spécifiée SqlString par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(SqlXml)	Valide la valeur spécifiée SqlXml par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(String)	Valide la valeur spécifiée String par rapport aux métadonnées et ajuste la valeur si nécessaire.
Adjust(TimeSpan)	Valide la valeur spécifiée TimeSpan par rapport aux métadonnées et ajuste la valeur si nécessaire.
InferFromValue(Object, String)	Déduit les métadonnées de l’objet spécifié et la retourne en tant qu’instance SqlMetaData .