SqlMetaData Clase

Definición

Espacio de nombres:

Microsoft.Data.SqlClient.Server

Ensamblado:

Microsoft.Data.SqlClient.dll

Paquete:

Microsoft.Data.SqlClient v7.1.0

Especifica la información de metadatos de una columna utilizada por un SqlDataRecord objeto . Esta clase no puede heredarse.

public ref class SqlMetaData sealed

public sealed class SqlMetaData

type SqlMetaData = class

Public NotInheritable Class SqlMetaData

Herencia

Object

SqlMetaData

Ejemplos

En el ejemplo siguiente se muestra la creación de varios SqlMetaData objetos, que describen los metadatos de columna de un registro y la generación de una secuencia de SqlDataRecord registros. Estos SqlDataRecord registros se pueden transmitir a SQL Server como parámetro con valores de tabla asignando el valor devuelto del método a la Value propiedad .

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

Comentarios

SqlMetaDataNormalmente, las instancias se compilan una vez y se reutilizan para construir muchos SqlDataRecord objetos que se transmiten a SQL Server como parámetro con valores de tabla. Para obtener más información, consulte Table-Valued Parámetros.

Constructores

Nombre	Description
SqlMetaData(String, SqlDbType, Boolean, Boolean, SortOrder, Int32)	Inicializa una nueva instancia de la SqlMetaData clase con el nombre de columna especificado y el servidor predeterminado. Esta forma del constructor admite parámetros con valores de tabla, lo que le permite especificar si la columna es única en el parámetro con valores de tabla, el criterio de ordenación de la columna y el ordinal de la columna de ordenación.
SqlMetaData(String, SqlDbType, Byte, Byte, Boolean, Boolean, SortOrder, Int32)	Inicializa una nueva instancia de la SqlMetaData clase con el nombre de columna, el tipo, la precisión, la escala y el servidor predeterminados especificados. Esta forma del constructor admite parámetros con valores de tabla, lo que le permite especificar si la columna es única en el parámetro con valores de tabla, el criterio de ordenación de la columna y el ordinal de la columna de ordenación.
SqlMetaData(String, SqlDbType, Byte, Byte)	Inicializa una nueva instancia de la SqlMetaData clase con el nombre de columna, el tipo, la precisión y la escala especificados.
SqlMetaData(String, SqlDbType, Int64, Boolean, Boolean, SortOrder, Int32)	Inicializa una nueva instancia de la SqlMetaData clase con el nombre de columna, el tipo, la longitud máxima y el valor predeterminado del servidor especificados. Esta forma del constructor admite parámetros con valores de tabla, lo que le permite especificar si la columna es única en el parámetro con valores de tabla, el criterio de ordenación de la columna y el ordinal de la columna de ordenación.
SqlMetaData(String, SqlDbType, Int64, Byte, Byte, Int64, SqlCompareOptions, Type, Boolean, Boolean, SortOrder, Int32)	Inicializa una nueva instancia de la SqlMetaData clase con el nombre de columna, el tipo, la longitud máxima, la precisión, la escala, el identificador de configuración regional, las opciones de comparación y el tipo definido por el usuario (UDT). Esta forma del constructor admite parámetros con valores de tabla, lo que le permite especificar si la columna es única en el parámetro con valores de tabla, el criterio de ordenación de la columna y el ordinal de la columna de ordenación.
SqlMetaData(String, SqlDbType, Int64, Byte, Byte, Int64, SqlCompareOptions, Type)	Inicializa una nueva instancia de la SqlMetaData clase con el nombre de columna, el tipo, la longitud máxima, la precisión, la escala, el identificador de configuración regional, las opciones de comparación y el tipo definido por el usuario (UDT).
SqlMetaData(String, SqlDbType, Int64, Int64, SqlCompareOptions, Boolean, Boolean, SortOrder, Int32)	Inicializa una nueva instancia de la SqlMetaData clase con el nombre de columna, el tipo, la longitud máxima, la configuración regional, las opciones de comparación y el valor predeterminado del servidor. Esta forma del constructor admite parámetros con valores de tabla, lo que le permite especificar si la columna es única en el parámetro con valores de tabla, el criterio de ordenación de la columna y el ordinal de la columna de ordenación.
SqlMetaData(String, SqlDbType, Int64, Int64, SqlCompareOptions)	Inicializa una nueva instancia de la SqlMetaData clase con el nombre de columna, el tipo, la longitud máxima, la configuración regional y las opciones de comparación especificadas.
SqlMetaData(String, SqlDbType, Int64)	Inicializa una nueva instancia de la SqlMetaData clase con el nombre de columna, el tipo y la longitud máxima especificados.
SqlMetaData(String, SqlDbType, String, String, String, Boolean, Boolean, SortOrder, Int32)	Inicializa una nueva instancia de la SqlMetaData clase con el nombre de columna, el nombre de la base de datos, el esquema propietario, el nombre de objeto y el servidor predeterminado. Esta forma del constructor admite parámetros con valores de tabla, lo que le permite especificar si la columna es única en el parámetro con valores de tabla, el criterio de ordenación de la columna y el ordinal de la columna de ordenación.
SqlMetaData(String, SqlDbType, String, String, String)	Inicializa una nueva instancia de la SqlMetaData clase con el nombre de columna, el tipo, el nombre de la base de datos, el esquema propietario y el nombre de objeto especificados.
SqlMetaData(String, SqlDbType, Type, String, Boolean, Boolean, SortOrder, Int32)	Inicializa una nueva instancia de la SqlMetaData clase con el nombre de columna, el tipo, el tipo definido por el usuario, el tipo SQL Server y el servidor predeterminado. Esta forma del constructor admite parámetros con valores de tabla, lo que le permite especificar si la columna es única en el parámetro con valores de tabla, el criterio de ordenación de la columna y el ordinal de la columna de ordenación.
SqlMetaData(String, SqlDbType, Type, String)	Inicializa una nueva instancia de la SqlMetaData clase con el nombre de columna especificado, el tipo definido por el usuario (UDT) y SQL Server tipo.
SqlMetaData(String, SqlDbType, Type)	Inicializa una nueva instancia de la SqlMetaData clase con el nombre de columna, el tipo y el tipo definido por el usuario especificados (UDT).
SqlMetaData(String, SqlDbType)	Inicializa una nueva instancia de la SqlMetaData clase con el nombre y el tipo de columna especificados.

Propiedades

Nombre	Description
CompareOptions	Obtiene las reglas de comparación usadas para la columna o el parámetro .
DbType	Obtiene el tipo de datos de la columna o parámetro.
IsUniqueKey	Indica si la columna del parámetro con valores de tabla es única.
LocaleId	Obtiene el identificador de configuración regional de la columna o el parámetro .
Max	Obtiene la longitud de los tipos de datos TEXT, NTEXT e IMAGE.
MaxLength	Obtiene la longitud máxima de la columna o el parámetro.
Name	Obtiene el nombre de la columna o parámetro.
Precision	Obtiene la precisión de la columna o parámetro.
Scale	Obtiene la escala de la columna o el parámetro.
SortOrder	Devuelve el criterio de ordenación de una columna.
SortOrdinal	Devuelve el ordinal de la columna de ordenación.
SqlDbType	Obtiene el tipo de datos de la columna o parámetro.
Type	Obtiene el tipo de Common Language Runtime (CLR) de tipo definido por el usuario (UDT).
TypeName	Obtiene el nombre de tres partes del tipo definido por el usuario (UDT) o el tipo SQL Server representado por la instancia.
UseServerDefault	Informa de si esta columna debe usar el valor predeterminado del servidor.
XmlSchemaCollectionDatabase	Obtiene el nombre de la base de datos donde se encuentra la colección de esquemas para esta instancia XML.
XmlSchemaCollectionName	Obtiene el nombre de la colección de esquemas para esta instancia XML.
XmlSchemaCollectionOwningSchema	Obtiene el esquema relacional propietario donde se encuentra la colección de esquemas para esta instancia XML.

Métodos

Nombre	Description
Adjust(Boolean)	Valida el valor especificado Boolean en los metadatos y ajusta el valor si es necesario.
Adjust(Byte)	Valida el valor especificado Byte en los metadatos y ajusta el valor si es necesario.
Adjust(Byte[])	Valida la matriz Byte de valores especificada en los metadatos y ajusta el valor si es necesario.
Adjust(Char)	Valida el valor especificado Char en los metadatos y ajusta el valor si es necesario.
Adjust(Char[])	Valida la matriz Char de valores especificada en los metadatos y ajusta el valor si es necesario.
Adjust(DateTime)	Valida el valor especificado DateTime en los metadatos y ajusta el valor si es necesario.
Adjust(DateTimeOffset)	Valida el valor especificado DateTimeOffset en los metadatos y ajusta el valor si es necesario.
Adjust(Decimal)	Valida el valor especificado Decimal en los metadatos y ajusta el valor si es necesario.
Adjust(Double)	Valida el valor especificado Double en los metadatos y ajusta el valor si es necesario.
Adjust(Guid)	Valida el valor especificado Guid en los metadatos y ajusta el valor si es necesario.
Adjust(Int16)	Valida el valor especificado Int16 en los metadatos y ajusta el valor si es necesario.
Adjust(Int32)	Valida el valor especificado Int32 en los metadatos y ajusta el valor si es necesario.
Adjust(Int64)	Valida el valor especificado Int64 en los metadatos y ajusta el valor si es necesario.
Adjust(Object)	Valida el valor especificado Object en los metadatos y ajusta el valor si es necesario.
Adjust(Single)	Valida el valor especificado Single en los metadatos y ajusta el valor si es necesario.
Adjust(SqlBinary)	Valida el valor especificado SqlBinary en los metadatos y ajusta el valor si es necesario.
Adjust(SqlBoolean)	Valida el valor especificado SqlBoolean en los metadatos y ajusta el valor si es necesario.
Adjust(SqlByte)	Valida el valor especificado SqlByte en los metadatos y ajusta el valor si es necesario.
Adjust(SqlBytes)	Valida el valor especificado SqlBytes en los metadatos y ajusta el valor si es necesario.
Adjust(SqlChars)	Valida el valor especificado SqlChars en los metadatos y ajusta el valor si es necesario.
Adjust(SqlDateTime)	Valida el valor especificado SqlDateTime en los metadatos y ajusta el valor si es necesario.
Adjust(SqlDecimal)	Valida el valor especificado SqlDecimal en los metadatos y ajusta el valor si es necesario.
Adjust(SqlDouble)	Valida el valor especificado SqlDouble en los metadatos y ajusta el valor si es necesario.
Adjust(SqlGuid)	Valida el valor especificado SqlGuid en los metadatos y ajusta el valor si es necesario.
Adjust(SqlInt16)	Valida el valor especificado SqlInt16 en los metadatos y ajusta el valor si es necesario.
Adjust(SqlInt32)	Valida el valor especificado SqlInt32 en los metadatos y ajusta el valor si es necesario.
Adjust(SqlInt64)	Valida el valor especificado SqlInt64 en los metadatos y ajusta el valor si es necesario.
Adjust(SqlMoney)	Valida el valor especificado SqlMoney en los metadatos y ajusta el valor si es necesario.
Adjust(SqlSingle)	Valida el valor especificado SqlSingle en los metadatos y ajusta el valor si es necesario.
Adjust(SqlString)	Valida el valor especificado SqlString en los metadatos y ajusta el valor si es necesario.
Adjust(SqlXml)	Valida el valor especificado SqlXml en los metadatos y ajusta el valor si es necesario.
Adjust(String)	Valida el valor especificado String en los metadatos y ajusta el valor si es necesario.
Adjust(TimeSpan)	Valida el valor especificado TimeSpan en los metadatos y ajusta el valor si es necesario.
InferFromValue(Object, String)	Deduce los metadatos del objeto especificado y los devuelve como una SqlMetaData instancia.