Clases administradas de SQLXML: objeto SqlXmlCommand

Se aplica a: SQL Server Azure SQL Database

Este es el constructor del objeto SqlXmlCommand:

public SqlXmlCommand(string cnString)  

Donde cnString es el cadena de conexión de ADO o OLEDB que identifica el servidor, la base de datos y la información de inicio de sesión, por ejemplo, Provider=SQLOLEDB; Server=(local); database=AdventureWorks; Integrated Security=SSPI".

En la cadena de conexión, Provider debe ser SQLOLEDB y Data Provider no debería incluirse en la cadena del proveedor.

Para obtener un ejemplo de trabajo, consulte Ejecución de consultas SQL (clases administradas de SQLXML).

Métodos

El objetoSqlXmlCommand admite varios métodos, incluidos los métodos siguientes para ejecutar un comando:

void ExecuteNonQuery()
Ejecuta el comando pero no devuelve nada. Este método resulta de gran utilidad si desea ejecutar un comando nonquery (es decir, un comando que no devuelve nada). Un ejemplo sería ejecutar un diagrama de actualización (updategram) o diferencia (DiffGram) que actualiza registros pero que no devuelve nada.

Stream ExecuteStream()
Devuelve un nuevo objeto Stream. Este método resulta de gran utilidad cuando desea que los resultados de la consulta se devuelvan en un nuevo flujo. Para obtener un ejemplo de trabajo, consulte Ejecución de consultas SQL (clases administradas de SQLXML).

public void ExecuteToStream(Stream outputStream)
Escribe los resultados de la consulta en un flujo existente. Este método es útil cuando tiene una secuencia a la que necesita los resultados anexados (por ejemplo, para que los resultados de la consulta se escriban en System.Web.HttpResponse.OutputStream). Para obtener un ejemplo de trabajo, consulte Ejecución de consultas SQL (clases administradas de SQLXML).

XmlReader ExecuteXmlReader()
Devuelve un objeto XmlReader. Puede usar este método para manipular datos en el objeto XmlReader directamente o conectar la arquitectura encadenable de System.Xml. Para obtener más información, consulte la documentación de Microsoft .NET Framework. Para obtener un ejemplo de trabajo, vea Ejecución de consultas SQL mediante el método ExecuteXMLReader.

El objetoSqlXmlCommand también admite estos métodos adicionales:

SqlXmlParameter CreateParameter()
Crea un objeto SqlXmlParameter. Puede establecer valores para los parámetros Name y Value de este objeto. Este método resulta de gran utilidad si desea pasar parámetros a un comando. Para obtener un ejemplo de trabajo, consulte Ejecución de consultas SQL (clases administradas de SQLXML).

void ClearParameters()
Borra los parámetros creados para un objeto de comando determinado. Este método resulta de gran utilidad si desea ejecutar varias consultas en el mismo objeto de comando.

Propiedades

El objeto SqlXmlCommand también admite estas propiedades:

ClientSideXml
Cuando se establece en True, especifica que la conversión del conjunto de filas a XML debe realizarse en el cliente en lugar de realizarse en el servidor. Esta propiedad resulta de gran utilidad si desea mover la carga de rendimiento al nivel intermedio. La propiedad también permite ajustar los procedimientos almacenados existentes con FOR XML para obtener la salida XML.

SchemaPath
Nombre del esquema de asignación junto con la ruta de acceso al directorio (por ejemplo, C:\x\y\MySchema.xml). Esta propiedad resulta muy útil para especificar un esquema de asignación para las consultas XPath. La ruta de acceso especificada puede ser absoluta o relativa. Si la ruta de acceso es relativa, la ruta de acceso base especificada en Ruta de acceso base se usa para resolver la ruta de acceso relativa. Si no se especifica ninguna ruta de acceso base, la ruta de acceso relativa es relativa al directorio actual. Para obtener un ejemplo de trabajo, consulte Acceso a la funcionalidad de SQLXML en el entorno de .NET.

XslPath
Nombre del archivo XSL junto con la ruta de acceso al directorio. La ruta de acceso especificada puede ser absoluta o relativa. Si la ruta de acceso es relativa, la ruta de acceso base especificada en Ruta de acceso base se usa para resolver la ruta de acceso relativa. Si no se especifica ninguna ruta de acceso base, la ruta de acceso relativa es relativa al directorio actual. Para obtener un ejemplo de trabajo, consulte Aplicación de una transformación XSL (clases administradas de SQLXML) .

Ruta de acceso base
Ruta de acceso base (ruta de acceso a un directorio). Esta propiedad es útil para resolver una ruta de acceso relativa especificada para un archivo XSL (mediante la propiedad XslPath), un archivo de esquema de asignación (mediante la propiedad SchemaPath) o una referencia de esquema externo en una plantilla XML (especificada mediante el atributo mapping-schema ).

OutputEncoding
Especifica la codificación del flujo que se devuelve cuando se ejecuta el comando. Esta propiedad es útil para solicitar una codificación concreta para el flujo que se devuelve. Entre algunas de las codificaciones que más se usan se incluyen UTF-8, ANSI y Unicode. La codificación predeterminada es UTF-8.

Espacios de nombres
Habilita la ejecución de consultas XPath que usan espacios de nombres. Para obtener más información sobre las consultas XPath con espacios de nombres, vea Ejecución de consultas XPath con espacios de nombres (clases administradas de SQLXML). Para obtener un ejemplo de trabajo, consulte Ejecución de consultas XPath (clases administradas de SQLXML) .

RootTag
Proporciona el elemento raíz único para XML generado por la ejecución del comando. Un documento XML válido requiere una etiqueta de nivel raíz única. Si el comando ejecutado genera un fragmento XML (sin un elemento de nivel superior único) puede especificar un elemento raíz para el XML que se devuelve. Para obtener un ejemplo de trabajo, consulte Aplicación de una transformación XSL (clases administradas de SQLXML) .

CommandText
Texto del comando. Esta propiedad se usa para especificar el texto del comando que se desea ejecutar. Para obtener un ejemplo de trabajo, consulte Ejecución de consultas SQL (clases administradas de SQLXML).

CommandStream
Secuencia de comandos. Esta propiedad resulta útil si desea ejecutar un comando desde un archivo (por ejemplo, una plantilla XML). Cuando se usa CommandStream, solo se admiten los valores "Template", "UpdateGram" y "DiffGram"CommandType. Para obtener un ejemplo de trabajo, vea Ejecución de archivos de plantilla mediante la propiedad CommandStream.

CommandType
Identifica el tipo de comando. Esta propiedad se usa para especificar el tipo de comando que se desea ejecutar. Los valores de la tabla siguiente determinan el tipo del comando. Para obtener un ejemplo de trabajo, consulte Acceso a la funcionalidad de SQLXML en el entorno de .NET.

Valor	Descripción
SqlXmlCommandType.Sql	Ejecuta un comando SQL (por ejemplo, SELECT * FROM Employees FOR XML AUTO).
SqlXmlCommandType.XPath	Ejecuta un comando XPath (por ejemplo, Employees[@EmployeeID=1]).
SqlXmlCommandType.Template	Ejecuta una plantilla XML.
SqlXmlCommandType.TemplateFile	Ejecuta un archivo de plantilla en la ruta de acceso especificada.
SqlXmlCommandType.UpdateGram	Ejecuta un diagrama de actualización (updategram).
SqlXmlCommandType.Diffgram	Ejecuta un diagrama de diferencia (DiffGram).

Consulte también

Objeto SqlXmlParameter (clases administradas de SQLXML)
Objeto SqlXmlAdapter (clases administradas SQLXML)