BE-SQL — различия между версиями

Версия 14:59, 22 марта 2016

BE-SQL — диалект SQL, который поддерживается BeanExplorer SQL Parser. Поддерживаются только запросы SELECT. Больше всего он похож на PostgreSQL, но некоторые конструкции из других диалектов тоже поддерживаются. Он также должен понимать различные BE-специфичные теги вроде <if>, <unless> и т. д. В данный момент находится в разработке: не все реальные запросы из проектов успешно разбираются BE-SQL.

Соответствие FreeMarker-конструкций и BE-SQL конструкций:

• chr(...) — CHR() или CHAR()
• concat(...) — CONCAT() или ||
• coalesce(...) — COALESCE() или IFNULL()
• round(...) — ROUND()
• length(...) — LENGTH() или LEN()
• lpad(...) — LPAD()
• replace(...) — REPLACE()
• substring(...) — SUBSTR() или SUBSTRING()
• if(...) — IF() (может транслироваться в предложение CASE WHEN ...)
•  ?dateFormat — FORMAT_DATE()
•  ?dateTimeFormat — FORMAT_DATETIME()
•  ?dateFormatRus — FORMAT_DATE_RUS()
•  ?asInt — CAST(x AS BIGINT), TO_NUMBER(x)
•  ?asVarChar — CAST(x AS CHAR), CAST(x AS VARCHAR), TO_CHAR(x)
•  ?asDate — CAST(x AS DATE), TO_DATE(x)
•  ?asPK — CAST(x AS KEY), TO_KEY(x)
•  ?lower — LOWER()
•  ?upper — UPPER()
•  ?monthStart — DATE_TRUNC('MONTH', x)
•  ?yearStart — DATE_TRUNC('YEAR', x)
•  ?year — YEAR(), EXTRACT(YEAR FROM x)
•  ?month — MONTH(), EXTRACT(MONTH FROM x)
•  ?day — DAY(), EXTRACT(DAY FROM x)
•  ?indexOf — INSTR(string, subString) или POSITION(subString IN string)
•  ?str — просто пишите в 'одинарных кавычках', экранируйте одинарную кавычку с помощью '\'
•  ?quote — просто пишите в "двойных кавычках" или в `обратных кавычках`, оба варианта должны сработать и транслироваться при необходимости
• currentDateTime — CURRENT_TIMESTAMP или NOW()
• currentDate — CURRENT_DATE
• addMonths(date,mon) — ADD_MONTHS(date, mon)
• addDays(date, days) — ADD_DAYS(date, days)
• addMillis(date, ms) — ADD_MILLIS(date, ms)
• fromFakeTable — FROM DUAL или можно не писать FROM вообще

Для ограничения количества записей можно просто писать SELECT ... LIMIT 1: это транслируется в соответствующий диалект SQL.

Список всех поддерживаемых SQL-функций

В скобках указываются синонимы

CONCAT, COALESCE (IFNULL), COUNT, SUM, MAX, MIN, SUBSTR (SUBSTRING), LENGTH (LEN), UPPER, LOWER, CHR (CHAR), TO_CHAR, TO_NUMBER, TO_DATE, TO_KEY,
REPLACE, RTRIM, LTRIM, LPAD, ROUND, TRUNC (TRUNCATE), INSTR (STRPOS), IF, NOW, FORMAT_DATE (=TO_CHAR(x, 'YYYY-MM-DD')), YEAR, MONTH, DAY, 
FORMAT_DATETIME (=TO_CHAR(x, 'YYYY-MM-DD HH24:MI:SS')), FORMAT_DATE_RUS (=TO_CHAR(x, 'DD.MM.YYYY')), FORMAT_DATE_RUS_SHORT (=TO_CHAR(x, 'DD.MM.YY')), 
DATE_TRUNC, POSITION, DATE_ADD, ADD_MONTHS, ADD_DAYS, ADD_MILLIS, LAST_DAY, TIMESTAMPDIFF, YEARDIFF, MONTHDIFF, DAYDIFF, HOURDIFF, MINUTEDIFF, SECONDDIFF.

Функции для работы с датами и временем

Форматирование даты

Для форматирования даты в строку можно использовать TO_CHAR(дата, <строка_формата>) или DATE_FORMAT(дата, <строка_формата>). Строка формата должна быть одной из предопределённых констант из списка, иначе будет ошибка:

• 'YYYY-MM-DD' или '%Y-%m-%d' (также можно использовать функцию FORMAT_DATE())
• 'YYYY-MM-DD HH24:MI:SS' или '%Y-%m-%d %H:%i:%S' (также можно использовать функцию FORMAT_DATETIME())
• 'DD.MM.YYYY' или '%d.%m.%Y' (также можно использовать функцию FORMAT_DATE_RUS())
• 'DD.MM.YY' или '%d.%m.%y' (также можно использовать функцию FORMAT_DATE_RUS_SHORT())
• 'YYYY' или '%Y'
• 'MM' или '%m'
• 'DD' или '%d'

SELECT NOW(), FORMAT_DATE(NOW());

NOW                     FORMAT_DATE
----------------------- -----------
2016-03-04 11:12:38.360 2016-03-04

SELECT NOW(), FORMAT_DATETIME(NOW());

NOW                     FORMAT_DATETIME
----------------------- -------------------
2016-03-04 11:12:38.360 2016-03-04 11:12:38

SELECT NOW(), FORMAT_DATE_RUS(NOW());

NOW                     FORMAT_DATE_RUS
----------------------- ---------------
2016-03-04 11:12:38.360 04.03.2016

SELECT NOW(), FORMAT_DATE_RUS_SHORT(NOW());

NOW                     FORMAT_DATE_RUS_SHORT
----------------------- ---------------------
2016-03-04 11:12:38.360 04.03.16

SELECT TO_CHAR(NOW(), 'YYYY');
-> 2016

Для получения числа, месяца или года заданной даты в виде числа используются функции DAY(дата), MONTH(дата) или YEAR(дата) соответственно:

SELECT YEAR(CURRENT_DATE);
-> 2016

Аналогично можно использовать EXTRACT(YEAR FROM CURRENT_DATE).

Разница между датами

Для получения разницы между датами в годах, месяцах, днях, часах, минутах или секундах используются следующие функции:

• YEARDIFF(startDate, endDate) или EXTRACT(YEAR FROM AGE(endDate, startDate))
• MONTHDIFF(startDate, endDate) или EXTRACT(MONTH FROM AGE(endDate, startDate)) + 12 * EXTRACT(YEAR FROM AGE(endDate, startDate))
• DAYDIFF(startDate, endDate) или EXTRACT(DAY FROM(endDate - startDate))
• HOURDIFF(startDate, endDate) или FLOOR(EXTRACT(EPOCH FROM(endDate - startDate)) / 3600)
• MINUTEDIFF(startDate, endDate) или FLOOR(EXTRACT(EPOCH FROM(endDate - startDate)) / 60)
• SECONDDIFF(startDate, endDate) или EXTRACT(EPOCH FROM(endDate - startDate))

SELECT EXTRACT(YEAR FROM AGE('2015-05-01', '2013-02-01'));
-> 2

SELECT YEARDIFF('2013-02-01', '2015-05-01');
-> 2

SELECT MONTHDIFF('2013-02-01', '2015-05-01');
-> 27

Также можно использовать функцию TIMESTAMPDIFF(<интервал>, startDate, endDate), где в качестве интервала должно быть YEAR, MONTH, DAY, HOUR, MINUTE или SECOND.

SELECT TIMESTAMPDIFF(DAY, '2016-01-01', '2017-01-01');
-> 366

SELECT TIMESTAMPDIFF(SECOND, '2016-01-01', '2016-01-02' );
-> 86400

Добавление интервала к дате

Для добавления к дате месяцев, дней или миллисекунд используются функции ADD_MONTHS(дата, количество), ADD_DAYS(дата, количество), ADD_MILLIS(дата, количество) соответственно:

SELECT CURRENT_DATE, ADD_MONTHS(CURRENT_DATE, 2);

CURRENT_DATE ADD_MONTHS
------------ ----------
2016-03-04   2016-05-04

SELECT CURRENT_DATE, ADD_DAYS(CURRENT_DATE, 7);

CURRENT_DATE ADD_DAYS
------------ ----------
2016-03-04   2016-03-11

SELECT NOW(), ADD_MILLIS(NOW(), 3000);

NOW                     ADD_MILLIS
----------------------- ----------------------- 
2016-03-04 11:12:38.360 2016-03-04 11:12:41.360

Последний день месяца

Для получения последнего дня месяца используется функция LAST_DAY(дата):

SELECT CURRENT_DATE, LAST_DAY(CURRENT_DATE) "Last", LAST_DAY(CURRENT_DATE) - CURRENT_DATE "Days Left";

CURRENT_DATE Last       Days Left
------------ ---------- ---------
2016-03-04   2016-03-31        27

Список всех поддерживаемых операций

+, -, *, /, >, <, >=, <=, = (или ==), != (или <>), || (конкатенация строк), OR, AND (или &&), NOT (или !), LIKE, FLOOR.

Что точно не работает пока

Использование этих возможностей скорее всего приведёт к ошибке валидации. В некоторых случаях к некорректному переформатированию в другом движке.

• BE-теги <if>/<unless> в JOIN/ORDER BY/GROUP BY и других нетривиальных местах
• genericRef, joinGenericRef

Создание макросов

Предусмотрена возможность создания собственных макросов. Определение макроса начинается с MACRO. За ним идет имя макроса и список аргументов в скобках, который может состоять из обязательных и следующих за ними аргументов с заданным по умолчанию значением. В случае отсутствия аргументов скобки нужно оставить пустыми. Далее следуют выражения, которые будут подставляться при вызове макроса, в их числе могут быть другие макросы, подстановки параметров, условные выражения. Заканчивается определение ключевым словом END.

MACRO MY_MACRO(arg1, arg2='000000')
CONCAT(SUBSTR(arg1, 1, 5 ), arg2)
END

Вызываются макросы как обычные функции:

SELECT MY_MACRO(code) FROM table t;

Такой запрос будет преобразован в SELECT CONCAT(SUBSTR(code, 1, 5 ), '000000') FROM table t.