Alpha.Community

В разделе Документация вы найдете все для уверенного старта и работы с Альфа платформой: от пошаговых инструкций по установке и конфигурированию до подробного описания работы компонентов и подсистем. Для поиска необходимых тем и вопросов в документации, воспользуйтесь поиском и фильтрацией результатов.

Функции

ExecuteDirectly

Выполняет SQL-запрос напрямую, без создания выражения Create() и без подготовки Prepare(). Запрос создаётся, выполняется и удаляется автоматически сразу после завершения.

Синтаксис

uint4 ExecuteDirectly(string text)

Параметры

text string Текст SQL-запроса.

Возвращаемое значение

request_id uint4 Идентификатор запроса, который можно использовать для отслеживания выполнения через событие OnRequestStatusChanged.

Примеры

Выполнить однократный запрос.

// Однократный запрос
SqlSourceQuery_1.ExecuteDirectly("SELECT * FROM users WHERE age > 18");

Create

Создает SQL-выражение для последующего использования. Этот метод используется, когда нужно выполнить один и тот же запрос несколько раз с разными параметрами. Созданное выражение необходимо подготовить с помощью метода Prepare() перед выполнением.

Синтаксис

uint4 Create(string text)

Параметры

text string Текст SQL-запроса. Используйте символ ? для параметров, которые будут заданы позже через BindParameter()

Возвращаемое значение

statement_id uint4 Идентификатор созданного выражения, который используется в методах Prepare(), BindParameter(), Execute() и Remove()

Примеры

Создать параметризованный запрос для повторного получения пользователя по ID.

// Создаем выражение с параметром (знак ?)
statementId: var = SqlSourceQuery_1.Create("SELECT * FROM users WHERE id = ?");
// Теперь это выражение можно подготовить и выполнить
SqlSourceQuery_1.Prepare(statementId);

Prepare

Подготавливает выражение, созданное с помощью метода Create(), к выполнению. Подготовка выполняется асинхронно. После завершения подготовки можно устанавливать параметры через BindParameter() и выполнять запрос через Execute().

Синтаксис

uint4 Prepare(uint4 statementId)

Параметры

statementId uint4 Идентификатор выражения, полученный из метода Create()

Возвращаемое значение

request_id uint4 Идентификатор запроса для отслеживания статуса подготовки через событие OnRequestStatusChanged. Возвращает 0, если выражение с указанным statementId не найдено

Примеры

Подготовить ранее созданное выражение для дальнейшего выполнения.

// Создаем выражение
statementId: var = SqlSourceQuery_1.Create("SELECT * FROM products WHERE price < ?");
// Подготавливаем выражение
requestId: var = SqlSourceQuery_1.Prepare(statementId);
// Статус подготовки можно отследить в событии OnRequestStatusChanged
// После успешной подготовки можно привязывать параметры и выполнять запрос

BindParameter

Устанавливает значение параметра для выражения, созданного с помощью Create() и подготовленного с помощью Prepare(). Параметры нумеруются с 0 и соответствуют символам ? в тексте SQL-запроса.

После вызова Execute() все привязки параметров автоматически удаляются, поэтому для повторного выполнения того же запроса нужно заново задать все параметры через BindParameter().

Синтаксис

bool BindParameter(uint4 statementId, uint4 parameterIndex, variant parameterValue)

Параметры

statementId uint4 Идентификатор выражения, полученный из метода Create()
parameterIndex uint4 Индекс параметра (начинается с 0). Соответствует порядковому номеру символа ? в SQL-запросе
parameterValue variant Значение параметра.

Возвращаемое значение

true Параметр установлен.
false Параметр не установлен.

Примеры

Установить значение параметра ID перед выполнением параметризованного запроса.

SqlSourceQuery_1.BindParameter(statementId, 0, 125);

Execute

Выполняет выражение, созданное с помощью Create(), подготовленное с помощью Prepare() и с привязанными параметрами через BindParameter() (если запрос содержит параметры). После выполнения компонент содержит актуальный результирующий набор данных, который можно отобразить в таблице.

После выполнения все привязки параметров удаляются.

Синтаксис

uint4 Execute(uint4 statementId)

Параметры

statementId uint4 Идентификатор выражения, полученный из метода Create()

Возвращаемое значение

request_id uint4 Идентификатор запроса для отслеживания статуса выполнения через событие OnRequestStatusChanged. Возвращает 0, если выражение с указанным statementId не найдено

Примеры

Выполнить параметризованный запрос после установки параметров.

SqlSourceQuery_1.Execute(statementId);

Remove

Удаляет выражение, созданное с помощью метода Create(). После удаления выражения его идентификатор становится недействительным, и все связанные с ним ресурсы освобождаются. Рекомендуется удалять выражения после завершения работы с ними для экономии памяти.

Синтаксис

bool Remove(uint4 statementId)

Параметры

statementId uint4 Идентификатор выражения, полученный из метода Create()

Возвращаемое значение

true Выражение было успешно удалено
false Выражение с указанным statementId не существовало

Примеры

Удалить выражение после завершения работы с ним.

SqlSourceQuery_1.Remove(statementId);

RemoveAll

Удаляет все выражения, созданные с помощью метода Create(). Полезно для очистки всех ресурсов при завершении работы с базой данных или при переходе на другой экран приложения.

Синтаксис

uint4 RemoveAll()

Возвращаемое значение

uint4 Количество удалённых выражений.