Управляемые классы SQLXML — объект SqlXmlCommand

Применимо к:база данных SQL ServerAzure SQL

Это конструктор для объекта SqlXmlCommand:

public SqlXmlCommand(string cnString)  

Где cnString — строка подключения ADO или OLEDB, которая идентифицирует сервер, базу данных и сведения об имени входа, Provider=SQLOLEDB; Server=(local); database=AdventureWorks; Integrated Security=SSPI"например .

В строке соединения параметр Provider должен иметь значение SQLOLEDB, а параметр Data Provider в строку поставщика не включается).

Рабочий пример см. в разделе Выполнение SQL-запросов (управляемые классы SQLXML).

Методы

ОбъектSqlXmlCommand поддерживает несколько методов, включая следующие методы для выполнения команды:

void ExecuteNonQuery()
Выполняет команду, но не возвращает никакого результата. Этот метод полезен для выполнения команд, которые не являются запросами (то есть команд, которые ничего не возвращают). Например, выполнение диаграммы обновления или дельты, которая изменяет записи, но ничего не возвращает.

Stream ExecuteStream()
Возвращает новый объект Stream. Этот метод полезен, если нужно вернуть результаты запроса в новом потоке. Рабочий пример см. в разделе Выполнение SQL-запросов (управляемые классы SQLXML).

public void ExecuteToStream(Stream outputStream)
Записывает результаты запроса в существующий поток. Этот метод полезен при наличии потока, к которому нужно добавить результаты (например, чтобы результаты запроса записывались в System.Web.HttpResponse.OutputStream). Рабочий пример см. в разделе Выполнение SQL-запросов (управляемые классы SQLXML).

XmlReader ExecuteXmlReader()
Возвращает объект XmlReader. Этот метод можно использовать для непосредственного управления данными в объекте XmlReader или подключения к цепной архитектуре System.Xml. Дополнительные сведения см. в документации microsoft платформа .NET Framework. Рабочий пример см. в статье Выполнение SQL-запросов с помощью метода ExecuteXMLReader.

ОбъектSqlXmlCommand также поддерживает следующие дополнительные методы:

SqlXmlParameter CreateParameter()
Создает объект SqlXmlParameter. Можно задать значения для параметров Name и Value этого объекта. Этот метод полезен для передачи параметров команды. Рабочий пример см. в разделе Выполнение SQL-запросов (управляемые классы SQLXML).

void ClearParameters()
Очищает параметры, созданные для данного командного объекта. Это удобно, если нужно выполнить несколько запросов, используя один и тот же командный объект.

Свойства

Объект SqlXmlCommand также поддерживает следующие свойства:

ClientSideXml
Если для этого свойства задать значение True, преобразование набора строк в XML будет происходить на клиенте, а не на сервере. Это свойство полезно, если нужно переместить вычислительную нагрузку на средний уровень архитектуры. Это свойство также позволяет упаковывать существующие хранимые процедуры в инструкции FOR XML для получения вывода в формате XML.

SchemaPath
Название схемы сопоставления вместе с путем к каталогу (например, C:\x\y\MySchema.xml). Это свойство полезно для задания схемы сопоставления в запросах XPath. Может быть указан абсолютный или относительный путь. Если путь относительный, для разрешения относительного пути используется базовый путь, указанный в разделе Базовый путь. Если базовый путь не указан, то относительный путь разрешается относительно текущего каталога. Рабочий пример см. в статье Доступ к функциям SQLXML в среде .NET.

XslPath
Имя XSL-файла, включая путь к каталогу. Может быть указан абсолютный или относительный путь. Если путь относительный, для разрешения относительного пути используется базовый путь, указанный в разделе Базовый путь. Если базовый путь не указан, то относительный путь разрешается относительно текущего каталога. Рабочий пример см. в разделе Применение преобразования XSL (управляемые классы SQLXML).

Базовый путь
Базовый путь (путь к каталогу). Это свойство полезно для разрешения относительного пути, указанного для XSL-файла (с помощью свойства XslPath), файла схемы сопоставления (с помощью свойства SchemaPath) или ссылки на внешнюю схему в XML-шаблоне (задается с помощью атрибута mapping-schema ).

OutputEncoding
Указывает кодировку потока, который возвращается при выполнении программы. С помощью этого свойства удобно задавать конкретную кодировку для возвращаемого потока. Примеры распространенных кодировок: UTF-8, ANSI и Unicode. По умолчанию используется UTF-8.

Пространства имен
Разрешает выполнение запросов XPath, использующих пространства имен. Дополнительные сведения о запросах XPath с пространствами имен см. в разделе Выполнение запросов XPath с пространствами имен (управляемые классы SQLXML). Рабочий пример см. в разделе Выполнение запросов XPath (управляемые классы SQLXML).

RootTag
Задает единственный корневой элемент для XML-документа, сформированного при выполнении команды. У допустимого XML-документа может быть только один тег на корневом уровне. Если выполненная команда формирует фрагмент XML (у которого нет единственного элемента верхнего уровня), можно задать корневой элемент для возвращаемого фрагмента XML. Рабочий пример см. в разделе Применение преобразования XSL (управляемые классы SQLXML).

CommandText
Текст команды. Это свойство используется для задания текста команды, которую нужно выполнить. Рабочий пример см. в разделе Выполнение SQL-запросов (управляемые классы SQLXML).

CommandStream
Командный поток. Это свойство служит для выполнения команды из файла (например, XML-шаблона). При использовании CommandStream поддерживаются только значения CommandType Template, UpdateGram и DiffGram . Рабочий пример см. в разделе Выполнение файлов шаблонов с помощью свойства CommandStream.

CommandType
Идентифицирует тип команды. Это свойство используется для задания типа команды, которую нужно выполнить. Значения в следующей таблице задают тип команды. Рабочий пример см. в статье Доступ к функциям SQLXML в среде .NET.

Значение Описание
SqlXmlCommandType.Sql Выполняет команду SQL (например, SELECT * FROM Employees FOR XML AUTO).
SqlXmlCommandType.XPath Выполняет команду XPath (например, Employees[@EmployeeID=1]).
SqlXmlCommandType.Template Выполняет шаблон XML.
SqlXmlCommandType.TemplateFile Выполняет файл шаблона, расположенный по указанному пути.
SqlXmlCommandType.UpdateGram Выполняет диаграмму обновления.
SqlXmlCommandType.Diffgram Выполняет дельту.

См. также:

Объект SqlXmlParameter (управляемые классы SQLXML)
Объект SqlXmlAdapter (управляемые классы SQLXML)