> For the complete documentation index, see [llms.txt](https://wfsys.gitbook.io/wt-knowledge-base/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wfsys.gitbook.io/wt-knowledge-base/customization-server/custom-templates/custom-sql_query.md).
# SqlQuery
Кастомный SqlQuery полезен в тех случаях, когда необходима предварительная обработка данных, которую проще реализовать на C#, и не нужно передавать клиенту лишние данные, используемые в обработке.
Для создания кастомных SqlQuery достаточно подключения основной библиотеки WorkflowEngine.dll.
### Описание запроса
Пример синтаксиса кастомного запроса
```xml
SELECT
null AS "Field0",
null AS "Field1",
null AS "Field2"
LIMIT 0;
SELECT
city.city_id AS "CityId",
city.title AS "Title",
city.archive AS "Archive"
FROM
template.city
ORDER BY city.title;
```
В тэге `` можно указать запрос, который будет описывать поля ответа, доступные на форме, и не будет содержать записей. Такая договоренность позволяет понять структуру ответа без необходимости открывать исходный код элемента.
Тэг `` является вспомогательным для получения данных, которые необходимо предварительно обработать. Таких тэгов может быть несколько - все зависит от задачи.
### Обращение к запросу
Обращение к кастомному SqlQuery на форме ничем не отличается от обращения к платформенным SqlQuery:
```xml
```
Так же указываем поля таблицы, которую сервер возвращает клиентской части.
### Исходный код
{% code title="CustomSqlQuery.cs" %}
```csharp
using System;
using System.Data;
using System.Collections.Generic;
using System.Threading.Tasks;
using Microsoft.Extensions.DependencyInjection;
using Common;
namespace WorkflowEngine
{
public class CustomSqlQuery : AbstractSqlQuery
{
private const string TEXT_ELEMENT = "Text";
private const string MY_SQL_QUERY = "MySqlQuery";
private string _mySqlQueryText;
private readonly ISqlQueryHelper _sqlQueryHelper;
public CustomSqlQuery(IServiceProvider serviceProvider) : base(serviceProvider)
{
// Объект для замены переменных в тексте запроса
_sqlQueryHelper = serviceProvider.GetService();
}
public override void Init(System.Xml.XmlNode node)
{
// В методе базового класса разбирается тэг , значение которого можно получить через переменную sqlQueryText
base.Init(node);
// Получаем значение из тэга , вложенного в тэг
_mySqlQueryText = XmlParser.GetRequiredElementValue(
node, $"{MY_SQL_QUERY}/{TEXT_ELEMENT}", Name, this);
}
public async override Task Execute(IDatabaseConnection connection, Dictionary parameters)
{
// Выполнение текста запроса из sqlQueryText, предварительно заменив переменный в тексте на значения параметров
var result = await connection.ExecuteQueryAsync(GetQueryText(parameters)).ConfigureAwait(false);
// Выполнение текста дополнительного запрос, предварительно заменив переменный в тексте на значения параметров
var myTable = await connection.ExecuteQueryAsync(_sqlQueryHelper.GetQueryText(_mySqlQueryText, parameters));
// Здесь будет код по обработке данных из запросов и формированию итоговой таблицы
/*
foreach (DataRow dataRow in myTable.Rows) {
var newRow = result.NewRow();
newRow["Field0"] = ...;
newRow["Field1"] = ...;
newRow["Field2"] = ...;
result.Rows.Add(newRow);
}
*/
return result;
}
}
}
```
{% endcode %}
В конструкторе CustomSqlQuery используется метод GetService объекта типа ServiceProvider для получения объекта типа ISqlQueryHelper, который помогает построить текст запроса, заменив в нем переменные в круглых скобках `{}` на нужные значения:
```csharp
_sqlQueryHelper = serviceProvider.GetService();
```
В методе Init описывается парсинг xml-кода, для получение данных из серверного xml-файла. Статический метод [GetRequiredElementValue](https://wfsys.gitbook.io/workflow-engine-doc/xmlparser/methods/get_required_element_value#get_required_element_value) класса [XmlParser](https://wfsys.gitbook.io/workflow-engine-doc/xmlparser) используется для получения значения обязательного тэга, путь до которого указывается в параметре string path. В качестве результата метод вернет строку. Если элемент отсутствует, будет возвращено исключение типа InvalidXmlException. Если необходимо получить значение необязательного элемента, то следует использовать метод [GetElementValue](https://wfsys.gitbook.io/workflow-engine-doc/xmlparser/methods/get_element_value). Этот метод в случае отсутствия элемента будет возвращать значение по умолчанию, переданное в параметрах метода.
В методе Execute описывается логика кастомного запроса, прописываются команды на выполнение запросов к базе данных и формируется объект типа DataTable, который будет отправляться в качестве ответа на клиентскую часть.
Для выполнения SQL-запросов используется метод ExecuteQueryAsync у объекта типа IDatabaseConnection, результатом которого будет объект типа DataTable.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://wfsys.gitbook.io/wt-knowledge-base/customization-server/custom-templates/custom-sql_query.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.