Classes gerenciadas SQLXML – Objeto SqlXmlCommand

Aplica-se a: SQL Server Banco de Dados SQL do Azure

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, o Provider precisa ser SQLOLEDB e o Data Provider não 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 SqlXmlCommand 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. Este método será útil se você quiser executar um comando nonquery (ou seja, um comando que não retorna nada). Um exemplo é a execução de um diagrama de atualização ou um DiffGram que atualiza registros mas não retorna nada.

Fluxo ExecuteStream()
Retorna um novo objeto Stream. Este método será útil quando você quiser os resultados de consulta retornados em um novo fluxo. Para obter um exemplo de trabalho, consulte Executando consultas SQL (classes gerenciadas SQLXML).

public void ExecuteToStream(Stream outputStream)
Escreve os resultados da consulta para um fluxo existente. Esse método é útil quando você tem um fluxo ao qual precisa que os resultados sejam 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 SqlXmlCommand também dá suporte a estes métodos adicionais:

Parâmetro SqlXml: CreateParameter()
Cria um objeto SqlXmlParameter. Você pode definir valores para os parâmetros Name e Value desse objeto. Este 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()
Desmarca o(s) parâmetro(s) que foi(ram) criado(s) para um determinado objeto de comando. Este 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 definida como True, especifica que a conversão do conjunto de linhas em XML ocorrerá no cliente, e não no servidor. Esta propriedade será útil quando você quiser mover a carga de desempenho para a camada intermediária. A propriedade também permite envolver os procedimentos armazenados existentes com FOR XML para obter saída de XML.

Caminho do esquema
O nome do esquema de mapeamento juntamente com o caminho de diretório (por exemplo, C:\x\y\MySchema.xml). Esta propriedade será ú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 em 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 Acessando a funcionalidade SQLXML no ambiente .NET.

Caminho XslPath
O nome do arquivo XSL juntamente com o caminho de diretório. O caminho especificado pode ser absoluto ou relativo. Se o caminho for relativo, o caminho base especificado em 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 Aplicando uma transformação XSL (classes gerenciadas SQLXML).

Base Path
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 atributo mapping-schema ).

Codificação de saída
Especifica a codificação para o fluxo retornado quando o comando é executado. Esta propriedade será útil para solicitar uma codificação específica para o fluxo que é retornado. Algumas codificações geralmente 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 (SQLXML Managed Classes). Para obter um exemplo de trabalho, consulte Executando consultas XPath (classes gerenciadas SQLXML).

RootTag
Fornece o único elemento raiz para XML gerado pela execução do comando. Um documento XML válido exige 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 de retorno. Para obter um exemplo de trabalho, consulte Aplicando uma transformação XSL (classes gerenciadas SQLXML).

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

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

CommandType
Identifica o tipo de comando. Esta propriedade será usada para especificar o tipo de comando que você quer executar. Os valores da tabela a seguir determinam o tipo do comando. Para obter um exemplo de trabalho, consulte Acessando a funcionalidade SQLXML no ambiente .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 diagrama de atualização.
SqlXmlCommandType.Diffgram	Executa um DiffGram.

Confira também

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