Модуль: Sql

Модуль Sql служит для задач, связанных с выполнением SQL-запросов и получением данных из них

Khorn - Модуль Sql

Methods

inner api.Sql.firstRow(query, field, dataType) → *
inner api.Sql.getRows(query) → Array.<Object>
inner api.Sql.mapRows(query, options) → Array.<Object>
inner api.Sql.mapRowsCallback(value, index) → *

Methods description

inner firstRow(query, field, dataType) → *

Выполнить запрос, и вернуть значение определенного поля в этой строке

Parameters:
Name Type Argument Default Description
query String Текст SQL-запроса
field Number | String optional  0 Номер поля или его имя
dataType String optional  Тип поля
Return:
* - Значение поля или -1, если запрос вернул 0 строк
Since:
  • build 3
Author:
  • Юрий Шибанов <y.shibanov@systtech.ru>
Throws:
Выкидывает ошибку, если в качестве текста запроса передана не строка

inner getRows(query) → Array.<Object>

Выполнить запрос и вернуть строки в виде массива объектов, имена полей которых являются именами столбцов

Parameters:
Name Type Description
query String Текст SQL-запроса
Return:
Array.<Object> - Массив строк в виде объектов
Since:
  • build 3
Author:
  • Юрий Шибанов <y.shibanov@systtech.ru>
Throws:
Выкидывает ошибку, если в качестве текста запроса передана не строка

inner mapRows(query, options) → Array.<Object>

Выполнить запрос, сформировать массив объектов согласно переданным опциям и вернуть его

Parameters:
Name Type Description
query String Текст SQL-запроса
options Array.<Object> Опции
Properties
Name Type Argument Description
fieldName String Имя поля
dataType String optional  Тип данных, хранимых в поле
callback mapRowsCallback optional  Callback, в который передаются выбранные значения
Return:
Array.<Object> - Массив строк в виде объектов
Since:
  • build 3
Author:
  • Илья Гребенкин <i.grebenkin@systtech.ru>
Throws:
Выкидывает ошибку, если в качестве текста запроса передана не строка, в качестве опций передан не объект или выполнение запроса завершилось с ошибкой

inner mapRowsCallback(value, index) → *

Callback для метода mapRows

Parameters:
Name Type Description
value * Значение поля, в необходимом формате
index Number Номер строки
Return:
* - Новое значение поля