Compartilhar via


Objeto SqlXmlCommand (classes gerenciadas SQLXML)

Este é o construtor do objeto SqlXmlCommand:

public SqlXmlCommand(string cnString)  

Onde cnString está a cadeia de conexão ADO ou OLEDB que identifica o servidor, o banco de dados e as informações de logon, por exemplo, Provider=SQLOLEDB; Server=(local); database=AdventureWorks; Integrated Security=SSPI".

Na cadeia de conexão, deve Provider ser SQLOLEDB e não Data Provider deve ser incluído na cadeia de caracteres do provedor).

Para obter um exemplo de trabalho, consulte Executando consultas SQL (classes gerenciadas SQLXML).

Métodos

O objeto TheSqlXmlCommand dá suporte a vários métodos, incluindo os seguintes métodos para executar um comando:

void ExecuteNonQuery()
Executa o comando, mas não retorna nada. Esse método será útil se você quiser executar um comando nãoquery (ou seja, um comando que não retorna nada). Um exemplo é executar um updategram ou um DiffGram que atualiza registros, mas não retorna nada.

Stream ExecuteStream()
Retorna um novo objeto Stream. Esse método é útil quando você deseja que os resultados da consulta sejam retornados para você em um novo fluxo. Para obter um exemplo de trabalho, consulte Executando consultas SQL (classes gerenciadas SQLXML).

public void ExecuteToStream(Stream outputStream)
Grava os resultados da consulta em um fluxo existente. Esse método é útil quando você tem um fluxo ao qual você precisa dos resultados acrescentados (por exemplo, para que os resultados da consulta sejam gravados no System.Web.HttpResponse.OutputStream). Para obter um exemplo de trabalho, consulte Executando consultas SQL (classes gerenciadas SQLXML).

XmlReader ExecuteXmlReader()
Retorna um objeto XmlReader. Você pode usar esse método para manipular dados no objeto XmlReader diretamente ou conectar a arquitetura encadeável de System.Xml. Para obter mais informações, consulte a documentação do Microsoft .NET Framework. Para obter um exemplo de trabalho, consulte Executando consultas SQL usando o método ExecuteXMLReader.

O objeto TheSqlXmlCommand também dá suporte a estes métodos adicionais:

SqlXmlParameter CreateParameter()
Cria um objeto SqlXmlParameter. Você pode definir valores para os parâmetros Nome e Valor desse objeto. Esse método será útil se você quiser passar parâmetros para um comando. Para obter um exemplo de trabalho, consulte Executando consultas SQL (classes gerenciadas SQLXML).

void ClearParameters()
Limpa parâmetros que foram criados para um determinado objeto de comando. Esse método será útil se você quiser executar várias consultas no mesmo objeto de comando.

Propriedades

O objeto SqlXmlCommand também dá suporte a estas propriedades:

ClientSideXml
Quando definido como True, especifica que a conversão do conjunto de linhas em XML deve ocorrer no cliente em vez de no servidor. Essa propriedade é útil quando você deseja mover a carga de desempenho para a camada intermediária. A propriedade também permite encapsular os procedimentos armazenados existentes com FOR XML para obter a saída XML.

SchemaPath
O nome do esquema de mapeamento junto com o caminho do diretório (por exemplo, C:\x\y\MySchema.xml). Essa propriedade é útil para especificar um esquema de mapeamento para consultas XPath. O caminho especificado pode ser absoluto ou relativo. Se o caminho for relativo, o caminho base especificado no Caminho Base será usado para resolver o caminho relativo. Se nenhum caminho base for especificado, o caminho relativo será relativo ao diretório atual. Para obter um exemplo de trabalho, consulte Como acessar a funcionalidade SQLXML no ambiente do .NET.

XslPath
O nome do arquivo XSL junto com o caminho do diretório. O caminho especificado pode ser absoluto ou relativo. Se o caminho for relativo, o caminho base especificado no Caminho Base será usado para resolver o caminho relativo. Se nenhum caminho base for especificado, o caminho relativo será relativo ao diretório atual. Para obter um exemplo de trabalho, consulte Aplicar uma transformação XSL (classes gerenciadas SQLXML).

Caminho base
O caminho base (um caminho de diretório). Essa propriedade é útil para resolver um caminho relativo especificado para um arquivo XSL (usando a propriedade XslPath), um arquivo de esquema de mapeamento (usando a propriedade SchemaPath) ou uma referência de esquema externo em um modelo XML (especificado usando o mapping-schema atributo).

OutputEncoding
Especifica a codificação do fluxo retornado quando o comando é executado. Essa propriedade é útil para solicitar uma codificação específica para o fluxo retornado. Algumas codificações comumente usadas são UTF-8, ANSI e Unicode. UTF-8 é a codificação padrão.

Namespaces
Habilita a execução de consultas XPath que usam namespaces. Para obter mais informações sobre consultas XPath com namespaces, consulte Executando consultas XPath com namespaces (classes gerenciadas SQLXML). Para obter um exemplo de trabalho, consulte Executando consultas XPath (classes gerenciadas SQLXML).

RootTag
Fornece o elemento raiz único para XML gerado pela execução de comando. Um documento XML válido requer uma única marca de nível raiz. Se o comando executado gerar um fragmento XML (sem um único elemento de nível superior), você poderá especificar um elemento raiz para o XML que retorna. Para obter um exemplo de trabalho, consulte Aplicar uma transformação XSL (classes gerenciadas SQLXML).

CommandText
O texto do comando. Essa propriedade é usada para especificar o texto do comando que você deseja executar. Para obter um exemplo de trabalho, consulte Executando consultas SQL (classes gerenciadas SQLXML).

CommandStream
O fluxo de comando. Essa propriedade será útil se você quiser executar um comando de um arquivo (por exemplo, um modelo XML). Quando você estiver usando CommandStream, há suporte apenas para valores "Template","UpdateGram" e "DiffGram"CommandType . Para obter um exemplo de trabalho, consulte Executando arquivos de modelo usando a propriedade CommandStream.

TipoComando
Identifica o tipo de comando. Essa propriedade é usada para especificar o tipo de comando que você deseja executar. Os valores na tabela a seguir determinam o tipo do comando. Para obter um exemplo de trabalho, consulte Como acessar a funcionalidade SQLXML no ambiente do .NET.

Valor Descrição
SqlXmlCommandType.Sql Executa um comando SQL (por exemplo, SELECT * FROM Employees FOR XML AUTO).
SqlXmlCommandType.XPath Executa um comando XPath (por exemplo, Employees[@EmployeeID=1]).
SqlXmlCommandType.Template Executa um modelo XML.
SqlXmlCommandType.TemplateFile Executa um arquivo de modelo no caminho especificado.
SqlXmlCommandType.UpdateGram Executa um programa de atualização.
SqlXmlCommandType.Diffgram Executa um DiffGram.

Consulte Também

Objeto SqlXmlParameter (classes gerenciadas SQLXML)
Objeto SqlXmlAdapter (classes gerenciadas SQLXML)