SqlMetaData Classe

Definição

Namespace:

Microsoft.Data.SqlClient.Server

Assembly:

Microsoft.Data.SqlClient.dll

Pacote:

Microsoft.Data.SqlClient v7.1.0

Especifica as informações de metadados de uma coluna usada por um SqlDataRecord objeto. Essa classe não pode ser herdada.

public ref class SqlMetaData sealed

public sealed class SqlMetaData

type SqlMetaData = class

Public NotInheritable Class SqlMetaData

Herança

Object

SqlMetaData

Exemplos

O exemplo a seguir mostra a criação de vários SqlMetaData objetos, que descrevem os metadados de coluna de um registro e a geração de um fluxo de SqlDataRecord registros. Esses SqlDataRecord registros podem ser transmitidos para SQL Server como um parâmetro com valor de tabela atribuindo o valor retornado do método à Value propriedade.

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

Comentários

SqlMetaDatanormalmente, as instâncias são criadas uma vez e reutilizados para construir muitos SqlDataRecord objetos que são transmitidos para SQL Server como um parâmetro com valor de tabela. Para obter mais informações, consulte Table-Valued Parâmetros.

Construtores

Nome	Description
SqlMetaData(String, SqlDbType, Boolean, Boolean, SortOrder, Int32)	Inicializa uma nova instância da SqlMetaData classe com o nome da coluna especificado e o servidor padrão. Essa forma do construtor dá suporte a parâmetros com valor de tabela, permitindo que você especifique se a coluna é exclusiva no parâmetro com valor de tabela, a ordem de classificação da coluna e o ordinal da coluna de classificação.
SqlMetaData(String, SqlDbType, Byte, Byte, Boolean, Boolean, SortOrder, Int32)	Inicializa uma nova instância da classe com o nome, o tipo, a precisão, a escala e o SqlMetaData servidor especificados. Essa forma do construtor dá suporte a parâmetros com valor de tabela, permitindo que você especifique se a coluna é exclusiva no parâmetro com valor de tabela, a ordem de classificação da coluna e o ordinal da coluna de classificação.
SqlMetaData(String, SqlDbType, Byte, Byte)	Inicializa uma nova instância da SqlMetaData classe com o nome da coluna, o tipo, a precisão e a escala especificados.
SqlMetaData(String, SqlDbType, Int64, Boolean, Boolean, SortOrder, Int32)	Inicializa uma nova instância da SqlMetaData classe com o nome da coluna, o tipo, o comprimento máximo e o padrão do servidor especificados. Essa forma do construtor dá suporte a parâmetros com valor de tabela, permitindo que você especifique se a coluna é exclusiva no parâmetro com valor de tabela, a ordem de classificação da coluna e o ordinal da coluna de classificação.
SqlMetaData(String, SqlDbType, Int64, Byte, Byte, Int64, SqlCompareOptions, Type, Boolean, Boolean, SortOrder, Int32)	Inicializa uma nova instância da SqlMetaData classe com o nome da coluna, o tipo, o tamanho máximo, a precisão, a escala, a ID da localidade, as opções de comparação e o tipo definido pelo usuário (UDT). Essa forma do construtor dá suporte a parâmetros com valor de tabela, permitindo que você especifique se a coluna é exclusiva no parâmetro com valor de tabela, a ordem de classificação da coluna e o ordinal da coluna de classificação.
SqlMetaData(String, SqlDbType, Int64, Byte, Byte, Int64, SqlCompareOptions, Type)	Inicializa uma nova instância da SqlMetaData classe com o nome da coluna, o tipo, o tamanho máximo, a precisão, a escala, a ID da localidade, as opções de comparação e o tipo definido pelo usuário (UDT).
SqlMetaData(String, SqlDbType, Int64, Int64, SqlCompareOptions, Boolean, Boolean, SortOrder, Int32)	Inicializa uma nova instância da SqlMetaData classe com o nome, o tipo, o comprimento máximo, a localidade, as opções de comparação e o padrão do servidor especificados. Essa forma do construtor dá suporte a parâmetros com valor de tabela, permitindo que você especifique se a coluna é exclusiva no parâmetro com valor de tabela, a ordem de classificação da coluna e o ordinal da coluna de classificação.
SqlMetaData(String, SqlDbType, Int64, Int64, SqlCompareOptions)	Inicializa uma nova instância da SqlMetaData classe com o nome, o tipo, o comprimento máximo, a localidade e as opções de comparação especificados.
SqlMetaData(String, SqlDbType, Int64)	Inicializa uma nova instância da SqlMetaData classe com o nome da coluna, o tipo e o comprimento máximo especificados.
SqlMetaData(String, SqlDbType, String, String, String, Boolean, Boolean, SortOrder, Int32)	Inicializa uma nova instância da classe com o nome da coluna, o nome do banco de dados, o esquema proprietário, o nome do objeto e o SqlMetaData servidor padrão especificados. Essa forma do construtor dá suporte a parâmetros com valor de tabela, permitindo que você especifique se a coluna é exclusiva no parâmetro com valor de tabela, a ordem de classificação da coluna e o ordinal da coluna de classificação.
SqlMetaData(String, SqlDbType, String, String, String)	Inicializa uma nova instância da SqlMetaData classe com o nome, o tipo, o nome do banco de dados, o esquema proprietário e o nome do objeto especificados.
SqlMetaData(String, SqlDbType, Type, String, Boolean, Boolean, SortOrder, Int32)	Inicializa uma nova instância da SqlMetaData classe com o nome da coluna, o tipo, o tipo definido pelo usuário, o tipo de SQL Server e o padrão do servidor especificados. Essa forma do construtor dá suporte a parâmetros com valor de tabela, permitindo que você especifique se a coluna é exclusiva no parâmetro com valor de tabela, a ordem de classificação da coluna e o ordinal da coluna de classificação.
SqlMetaData(String, SqlDbType, Type, String)	Inicializa uma nova instância da classe com o nome da SqlMetaData coluna especificado, o tipo definido pelo usuário (UDT) e SQL Server tipo.
SqlMetaData(String, SqlDbType, Type)	Inicializa uma nova instância da SqlMetaData classe com o nome, o tipo e o tipo de coluna especificados (UDT).
SqlMetaData(String, SqlDbType)	Inicializa uma nova instância da SqlMetaData classe com o nome e o tipo de coluna especificados.

Propriedades

Nome	Description
CompareOptions	Obtém as regras de comparação usadas para a coluna ou parâmetro.
DbType	Obtém o tipo de dados da coluna ou parâmetro.
IsUniqueKey	Indica se a coluna no parâmetro com valor de tabela é exclusiva.
LocaleId	Obtém a ID da localidade da coluna ou parâmetro.
Max	Obtém o comprimento dos tipos de dados TEXT, NTEXT e IMAGE.
MaxLength	Obtém o comprimento máximo da coluna ou parâmetro.
Name	Obtém o nome da coluna ou parâmetro.
Precision	Obtém a precisão da coluna ou parâmetro.
Scale	Obtém a escala da coluna ou parâmetro.
SortOrder	Retorna a ordem de classificação de uma coluna.
SortOrdinal	Retorna o ordinal da coluna de classificação.
SqlDbType	Obtém o tipo de dados da coluna ou parâmetro.
Type	Obtém o tipo CLR (Common Language Runtime) do tipo definido pelo usuário (UDT).
TypeName	Obtém o nome de três partes do tipo definido pelo usuário (UDT) ou o tipo de SQL Server representado pela instância.
UseServerDefault	Relata se essa coluna deve usar o valor do servidor padrão.
XmlSchemaCollectionDatabase	Obtém o nome do banco de dados em que a coleção de esquemas dessa instância XML está localizada.
XmlSchemaCollectionName	Obtém o nome da coleção de esquemas para esta instância XML.
XmlSchemaCollectionOwningSchema	Obtém o esquema relacional proprietário em que a coleção de esquemas dessa instância XML está localizada.

Métodos

Nome	Description
Adjust(Boolean)	Valida o valor especificado Boolean em relação aos metadados e ajusta o valor, se necessário.
Adjust(Byte)	Valida o valor especificado Byte em relação aos metadados e ajusta o valor, se necessário.
Adjust(Byte[])	Valida a matriz de Byte valores especificada em relação aos metadados e ajusta o valor, se necessário.
Adjust(Char)	Valida o valor especificado Char em relação aos metadados e ajusta o valor, se necessário.
Adjust(Char[])	Valida a matriz de Char valores especificada em relação aos metadados e ajusta o valor, se necessário.
Adjust(DateTime)	Valida o valor especificado DateTime em relação aos metadados e ajusta o valor, se necessário.
Adjust(DateTimeOffset)	Valida o valor especificado DateTimeOffset em relação aos metadados e ajusta o valor, se necessário.
Adjust(Decimal)	Valida o valor especificado Decimal em relação aos metadados e ajusta o valor, se necessário.
Adjust(Double)	Valida o valor especificado Double em relação aos metadados e ajusta o valor, se necessário.
Adjust(Guid)	Valida o valor especificado Guid em relação aos metadados e ajusta o valor, se necessário.
Adjust(Int16)	Valida o valor especificado Int16 em relação aos metadados e ajusta o valor, se necessário.
Adjust(Int32)	Valida o valor especificado Int32 em relação aos metadados e ajusta o valor, se necessário.
Adjust(Int64)	Valida o valor especificado Int64 em relação aos metadados e ajusta o valor, se necessário.
Adjust(Object)	Valida o valor especificado Object em relação aos metadados e ajusta o valor, se necessário.
Adjust(Single)	Valida o valor especificado Single em relação aos metadados e ajusta o valor, se necessário.
Adjust(SqlBinary)	Valida o valor especificado SqlBinary em relação aos metadados e ajusta o valor, se necessário.
Adjust(SqlBoolean)	Valida o valor especificado SqlBoolean em relação aos metadados e ajusta o valor, se necessário.
Adjust(SqlByte)	Valida o valor especificado SqlByte em relação aos metadados e ajusta o valor, se necessário.
Adjust(SqlBytes)	Valida o valor especificado SqlBytes em relação aos metadados e ajusta o valor, se necessário.
Adjust(SqlChars)	Valida o valor especificado SqlChars em relação aos metadados e ajusta o valor, se necessário.
Adjust(SqlDateTime)	Valida o valor especificado SqlDateTime em relação aos metadados e ajusta o valor, se necessário.
Adjust(SqlDecimal)	Valida o valor especificado SqlDecimal em relação aos metadados e ajusta o valor, se necessário.
Adjust(SqlDouble)	Valida o valor especificado SqlDouble em relação aos metadados e ajusta o valor, se necessário.
Adjust(SqlGuid)	Valida o valor especificado SqlGuid em relação aos metadados e ajusta o valor, se necessário.
Adjust(SqlInt16)	Valida o valor especificado SqlInt16 em relação aos metadados e ajusta o valor, se necessário.
Adjust(SqlInt32)	Valida o valor especificado SqlInt32 em relação aos metadados e ajusta o valor, se necessário.
Adjust(SqlInt64)	Valida o valor especificado SqlInt64 em relação aos metadados e ajusta o valor, se necessário.
Adjust(SqlMoney)	Valida o valor especificado SqlMoney em relação aos metadados e ajusta o valor, se necessário.
Adjust(SqlSingle)	Valida o valor especificado SqlSingle em relação aos metadados e ajusta o valor, se necessário.
Adjust(SqlString)	Valida o valor especificado SqlString em relação aos metadados e ajusta o valor, se necessário.
Adjust(SqlXml)	Valida o valor especificado SqlXml em relação aos metadados e ajusta o valor, se necessário.
Adjust(String)	Valida o valor especificado String em relação aos metadados e ajusta o valor, se necessário.
Adjust(TimeSpan)	Valida o valor especificado TimeSpan em relação aos metadados e ajusta o valor, se necessário.
InferFromValue(Object, String)	Infere os metadados do objeto especificado e o retorna como uma SqlMetaData instância.