SqlMetaData Klasse

Definition

Namespace:

Microsoft.Data.SqlClient.Server

Assembly:

Microsoft.Data.SqlClient.dll

Paket:

Microsoft.Data.SqlClient v7.1.0

Gibt die Metadateninformationen einer Spalte an, die von einem SqlDataRecord Objekt verwendet wird. Diese Klasse kann nicht vererbt werden.

public ref class SqlMetaData sealed

public sealed class SqlMetaData

type SqlMetaData = class

Public NotInheritable Class SqlMetaData

Vererbung

Object

SqlMetaData

Beispiele

Das folgende Beispiel zeigt die Erstellung mehrerer SqlMetaData Objekte, die die Spaltenmetadaten eines Datensatzes und die Generierung eines Datensatzdatenstroms SqlDataRecord beschreiben. Diese SqlDataRecord Datensätze können an SQL Server als Tabellenwertparameter gestreamt werden, indem der Eigenschaft der Rückgabewert der Value Methode zugewiesen wird.

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

Hinweise

SqlMetaDataInstanzen werden in der Regel einmal erstellt und wiederverwendet, um viele SqlDataRecord Objekte zu erstellen, die als Tabellenwertparameter in SQL Server gestreamt werden. Weitere Informationen finden Sie unter Table-Valued Parameter.

Konstruktoren

Name	Beschreibung
SqlMetaData(String, SqlDbType, Boolean, Boolean, SortOrder, Int32)	Initialisiert eine neue Instanz der SqlMetaData Klasse mit dem angegebenen Spaltennamen und dem Standardserver. Diese Form des Konstruktors unterstützt Tabellenwertparameter: Sie können angeben, ob die Spalte im Tabellenwertparameter eindeutig ist, und Sie können die Sortierreihenfolge für die Spalte sowie die Ordnungszahl der Sortierspalte festlegen.
SqlMetaData(String, SqlDbType, Byte, Byte, Boolean, Boolean, SortOrder, Int32)	Initialisiert eine neue Instanz der SqlMetaData Klasse mit dem angegebenen Spaltennamen, Typ, Genauigkeit, Skalierung und Serverstandard. Diese Form des Konstruktors unterstützt Tabellenwertparameter: Sie können angeben, ob die Spalte im Tabellenwertparameter eindeutig ist, und Sie können die Sortierreihenfolge für die Spalte sowie die Ordnungszahl der Sortierspalte festlegen.
SqlMetaData(String, SqlDbType, Byte, Byte)	Initialisiert eine neue Instanz der SqlMetaData Klasse mit dem angegebenen Spaltennamen, Typ, Genauigkeit und Skalierung.
SqlMetaData(String, SqlDbType, Int64, Boolean, Boolean, SortOrder, Int32)	Initialisiert eine neue Instanz der SqlMetaData Klasse mit dem angegebenen Spaltennamen, Typ, maximaler Länge und Serverstandard. Diese Form des Konstruktors unterstützt Tabellenwertparameter: Sie können angeben, ob die Spalte im Tabellenwertparameter eindeutig ist, und Sie können die Sortierreihenfolge für die Spalte sowie die Ordnungszahl der Sortierspalte festlegen.
SqlMetaData(String, SqlDbType, Int64, Byte, Byte, Int64, SqlCompareOptions, Type, Boolean, Boolean, SortOrder, Int32)	Initialisiert eine neue Instanz der SqlMetaData Klasse mit dem angegebenen Spaltennamen, Typ, maximaler Länge, Genauigkeit, Skalierung, Gebietsschema-ID, Vergleichen von Optionen und benutzerdefiniertem Typ (UDT). Diese Form des Konstruktors unterstützt Tabellenwertparameter: Sie können angeben, ob die Spalte im Tabellenwertparameter eindeutig ist, und Sie können die Sortierreihenfolge für die Spalte sowie die Ordnungszahl der Sortierspalte festlegen.
SqlMetaData(String, SqlDbType, Int64, Byte, Byte, Int64, SqlCompareOptions, Type)	Initialisiert eine neue Instanz der SqlMetaData Klasse mit dem angegebenen Spaltennamen, Typ, maximaler Länge, Genauigkeit, Skalierung, Gebietsschema-ID, Vergleichen von Optionen und benutzerdefiniertem Typ (UDT).
SqlMetaData(String, SqlDbType, Int64, Int64, SqlCompareOptions, Boolean, Boolean, SortOrder, Int32)	Initialisiert eine neue Instanz der SqlMetaData Klasse mit dem angegebenen Spaltennamen, Typ, maximale Länge, Gebietsschema, Vergleichsoptionen und Serverstandard. Diese Form des Konstruktors unterstützt Tabellenwertparameter: Sie können angeben, ob die Spalte im Tabellenwertparameter eindeutig ist, und Sie können die Sortierreihenfolge für die Spalte sowie die Ordnungszahl der Sortierspalte festlegen.
SqlMetaData(String, SqlDbType, Int64, Int64, SqlCompareOptions)	Initialisiert eine neue Instanz der SqlMetaData Klasse mit dem angegebenen Spaltennamen, Typ, maximale Länge, Gebietsschema und Vergleichsoptionen.
SqlMetaData(String, SqlDbType, Int64)	Initialisiert eine neue Instanz der SqlMetaData Klasse mit dem angegebenen Spaltennamen, Typ und maximaler Länge.
SqlMetaData(String, SqlDbType, String, String, String, Boolean, Boolean, SortOrder, Int32)	Initialisiert eine neue Instanz der SqlMetaData Klasse mit dem angegebenen Spaltennamen, dem Datenbanknamen, dem Besitzerschema, dem Objektnamen und dem Standardserver. Diese Form des Konstruktors unterstützt Tabellenwertparameter: Sie können angeben, ob die Spalte im Tabellenwertparameter eindeutig ist, und Sie können die Sortierreihenfolge für die Spalte sowie die Ordnungszahl der Sortierspalte festlegen.
SqlMetaData(String, SqlDbType, String, String, String)	Initialisiert eine neue Instanz der SqlMetaData Klasse mit dem angegebenen Spaltennamen, Typ, Datenbankname, Besitzerschema und Objektnamen.
SqlMetaData(String, SqlDbType, Type, String, Boolean, Boolean, SortOrder, Int32)	Initialisiert eine neue Instanz der SqlMetaData Klasse mit dem angegebenen Spaltennamen, Typ, benutzerdefiniertem Typ, SQL Server Typ und Serverstandard. Diese Form des Konstruktors unterstützt Tabellenwertparameter: Sie können angeben, ob die Spalte im Tabellenwertparameter eindeutig ist, und Sie können die Sortierreihenfolge für die Spalte sowie die Ordnungszahl der Sortierspalte festlegen.
SqlMetaData(String, SqlDbType, Type, String)	Initialisiert eine neue Instanz der SqlMetaData Klasse mit dem angegebenen Spaltennamen, benutzerdefiniertem Typ (UDT) und SQL Server Typ.
SqlMetaData(String, SqlDbType, Type)	Initialisiert eine neue Instanz der SqlMetaData Klasse mit dem angegebenen Spaltennamen, Typ und benutzerdefiniertem Typ (UDT).
SqlMetaData(String, SqlDbType)	Initialisiert eine neue Instanz der SqlMetaData Klasse mit dem angegebenen Spaltennamen und -typ.

Eigenschaften

Name	Beschreibung
CompareOptions	Ruft die Vergleichsregeln ab, die für die Spalte oder den Parameter verwendet werden.
DbType	Ruft den Datentyp der Spalte oder des Parameters ab.
IsUniqueKey	Gibt an, ob die Spalte im Parameter mit Tabellenwert eindeutig ist.
LocaleId	Ruft die Gebietsschema-ID der Spalte oder des Parameters ab.
Max	Ruft die Länge der Datentypen TEXT, NTEXT und IMAGE ab.
MaxLength	Ruft die maximale Länge der Spalte oder des Parameters ab.
Name	Ruft den Namen der Spalte oder des Parameters ab.
Precision	Ruft die Genauigkeit der Spalte oder des Parameters ab.
Scale	Ruft die Skalierung der Spalte oder des Parameters ab.
SortOrder	Gibt die Sortierreihenfolge für eine Spalte zurück.
SortOrdinal	Gibt die Ordnungszahl der Sortierspalte zurück.
SqlDbType	Ruft den Datentyp der Spalte oder des Parameters ab.
Type	Ruft den Common Language Runtime (CLR)-Typ des benutzerdefinierten Typs (UDT) ab.
TypeName	Ruft den dreiteiligen Namen des benutzerdefinierten Typs (UDT) oder den durch die Instanz dargestellten SQL Server Typ ab.
UseServerDefault	Gibt an, ob diese Spalte den Standardwert des Servers verwenden soll.
XmlSchemaCollectionDatabase	Ruft den Namen der Datenbank ab, in der sich die Schemaauflistung für diese XML-Instanz befindet.
XmlSchemaCollectionName	Ruft den Namen der Schemaauflistung für diese XML-Instanz ab.
XmlSchemaCollectionOwningSchema	Ruft das eigene relationale Schema ab, in dem sich die Schemaauflistung für diese XML-Instanz befindet.

Methoden

Name	Beschreibung
Adjust(Boolean)	Überprüft den angegebenen Boolean Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(Byte)	Überprüft den angegebenen Byte Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(Byte[])	Überprüft das angegebene Array von Werten anhand der Byte Metadaten und passt den Wert bei Bedarf an.
Adjust(Char)	Überprüft den angegebenen Char Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(Char[])	Überprüft das angegebene Array von Werten anhand der Char Metadaten und passt den Wert bei Bedarf an.
Adjust(DateTime)	Überprüft den angegebenen DateTime Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(DateTimeOffset)	Überprüft den angegebenen DateTimeOffset Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(Decimal)	Überprüft den angegebenen Decimal Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(Double)	Überprüft den angegebenen Double Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(Guid)	Überprüft den angegebenen Guid Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(Int16)	Überprüft den angegebenen Int16 Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(Int32)	Überprüft den angegebenen Int32 Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(Int64)	Überprüft den angegebenen Int64 Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(Object)	Überprüft den angegebenen Object Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(Single)	Überprüft den angegebenen Single Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(SqlBinary)	Überprüft den angegebenen SqlBinary Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(SqlBoolean)	Überprüft den angegebenen SqlBoolean Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(SqlByte)	Überprüft den angegebenen SqlByte Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(SqlBytes)	Überprüft den angegebenen SqlBytes Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(SqlChars)	Überprüft den angegebenen SqlChars Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(SqlDateTime)	Überprüft den angegebenen SqlDateTime Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(SqlDecimal)	Überprüft den angegebenen SqlDecimal Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(SqlDouble)	Überprüft den angegebenen SqlDouble Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(SqlGuid)	Überprüft den angegebenen SqlGuid Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(SqlInt16)	Überprüft den angegebenen SqlInt16 Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(SqlInt32)	Überprüft den angegebenen SqlInt32 Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(SqlInt64)	Überprüft den angegebenen SqlInt64 Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(SqlMoney)	Überprüft den angegebenen SqlMoney Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(SqlSingle)	Überprüft den angegebenen SqlSingle Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(SqlString)	Überprüft den angegebenen SqlString Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(SqlXml)	Überprüft den angegebenen SqlXml Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(String)	Überprüft den angegebenen String Wert anhand der Metadaten und passt den Wert bei Bedarf an.
Adjust(TimeSpan)	Überprüft den angegebenen TimeSpan Wert anhand der Metadaten und passt den Wert bei Bedarf an.
InferFromValue(Object, String)	Leitet die Metadaten aus dem angegebenen Objekt ab und gibt sie als SqlMetaData Instanz zurück.