9.8. Функции форматирования данных #
Функции форматирования в PostgreSQL предоставляют богатый набор инструментов для преобразования самых разных типов данных (дата/время, целое, числа с плавающей и фиксированной точкой) в форматированные строки и обратно. Все они перечислены в Таблице 9.26. Все эти функции следует одному соглашению: в первом аргументе передаётся значение, которое нужно отформатировать, а во втором — шаблон, определяющий формат ввода или вывода.
Таблица 9.26. Функции форматирования
Функция Описание Пример(ы) |
|---|
Преобразует время в строку согласно заданному формату.
|
Преобразует интервал в строку согласно заданному формату.
|
Преобразует число в строку согласно заданному формату; поддерживаются типы
|
Преобразует строку в дату согласно заданному формату.
|
Преобразует строку в число согласно заданному формату.
|
Преобразует строку в значение времени согласно заданному формату. (См. также
|
Подсказка
Функции to_timestamp и to_date предназначены для работы с входными форматами, которые нельзя преобразовать простым приведением. Для большинства стандартных форматов даты/времени работает простое приведение исходной строки к требуемому типу и использовать его гораздо легче. Так же и функцию to_number нет необходимости использовать для стандартных представлений чисел.
Шаблон вывода to_char может содержать ряд кодов, которые распознаются при форматировании и заменяются соответствующими данными в зависимости от заданного значения. Любой текст, который не является кодом, просто копируется в неизменном виде. Подобным образом в строке шаблона ввода (для других функций) шаблонные коды определяют, какие значения должны поступать из входной строки. Если в строке шаблона есть символы, не относящиеся к шаблонным кодам, соответствующие символы во входной строке просто пропускаются (вне зависимости от того, совпадают ли они с символами в строке шаблона).
Все коды форматирования даты и времени перечислены в Таблице 9.27.
Таблица 9.27. Коды форматирования даты/времени
| Код | Описание |
|---|---|
HH | час дня (01–12) |
HH12 | час дня (01–12) |
HH24 | час дня (00–23) |
MI | минута (00–59) |
SS | секунда (00–59) |
MS | миллисекунда (000–999) |
US | микросекунда (000000–999999) |
FF1 | десятая доля секунды (0–9) |
FF2 | сотая доля секунды (00–99) |
FF3 | миллисекунда (000–999) |
FF4 | десятитысячная доля секунды (0000–9999) |
FF5 | стотысячная доля секунды (00000–99999) |
FF6 | микросекунда (000000–999999) |
SSSS, SSSSS | секунды после полуночи (0–86399) |
AM, am, PM или pm | обозначение времени до/после полудня (без точек) |
A.M., a.m., P.M. или p.m. | обозначение времени до/после полудня (с точками) |
Y,YYY | год (4 или более цифр) с разделителем |
YYYY | год (4 или более цифр) |
YYY | последние 3 цифры года |
YY | последние 2 цифры года |
Y | последняя цифра года |
IYYY | недельный год по ISO 8601 (4 или более цифр) |
IYY | последние 3 цифры недельного года по ISO 8601 |
IY | последние 2 цифры недельного года по ISO 8601 |
I | последняя цифра недельного года по ISO 8601 |
BC, bc, AD или ad | обозначение эры (без точек) |
B.C., b.c., A.D. или a.d. | обозначение эры (с точками) |
MONTH | полное название месяца в верхнем регистре (дополненное пробелами до 9 символов) |
Month | полное название месяца с большой буквы (дополненное пробелами до 9 символов) |
month | полное название месяца в нижнем регистре (дополненное пробелами до 9 символов) |
MON | сокращённое название месяца в верхнем регистре (3 буквы в английском; в других языках длина может меняться) |
Mon | сокращённое название месяца с большой буквы (3 буквы в английском; в других языках длина может меняться) |
mon | сокращённое название месяца в нижнем регистре (3 буквы в английском; в других языках длина может меняться) |
MM | номер месяца (01–12) |
DAY | полное название дня недели в верхнем регистре (дополненное пробелами до 9 символов) |
Day | полное название дня недели с большой буквы (дополненное пробелами до 9 символов) |
day | полное название дня недели в нижнем регистре (дополненное пробелами до 9 символов) |
DY | сокращённое название дня недели в верхнем регистре (3 буквы в английском; в других языках может меняться) |
Dy | сокращённое название дня недели с большой буквы (3 буквы в английском; в других языках длина может меняться) |
dy | сокращённое название дня недели в нижнем регистре (3 буквы в английском; в других языках длина может меняться) |
DDD | номер дня в году (001–366) |
IDDD | номер дня в году по ISO 8601 (001–371; первый день года — понедельник первой недели по ISO) |
DD | день месяца (01–31) |
D | номер дня недели, считая с воскресенья (1) до субботы (7) |
ID | номер дня недели по ISO 8601, считая с понедельника (1) до воскресенья (7) |
W | неделя месяца (1–5) (первая неделя начинается в первый день месяца) |
WW | номер недели в году (1–53) (первая неделя начинается в первый день года) |
IW | номер недели в году по ISO 8601 (01–53; первый четверг года относится к неделе 1) |
CC | век (2 цифры) (двадцать первый век начался 2001-01-01) |
J | юлианская дата (целое число дней от 24 ноября 4714 г. до н. э. 00:00 по местному времени; см. Раздел B.7) |
Q | квартал |
RM | номер месяца римскими цифрами в верхнем регистре (I–XII; I=январь) |
rm | номер месяца римскими цифрами в нижнем регистре (i–xii; i=январь) |
TZ | сокращённое название часового пояса в верхнем регистре (поддерживается только в to_char) |
tz | сокращённое название часового пояса в нижнем регистре (поддерживается только в to_char) |
TZH | часы часового пояса |
TZM | минуты часового пояса |
OF | смещение часового пояса от UTC (поддерживается только в to_char) |
К любым кодам форматирования можно добавить модификаторы, изменяющие их поведение. Например, шаблон форматирования FMMonth включает код Month с модификатором FM. Модификаторы, предназначенные для форматирования даты/времени, перечислены в Таблице 9.28.
Таблица 9.28. Модификаторы кодов для форматирования даты/времени
| Модификатор | Описание | Пример |
|---|---|---|
Приставка FM | режим заполнения (подавляет ведущие нули и дополнение пробелами) | FMMonth |
Окончание TH | окончание порядкового числительного в верхнем регистре | DDTH, например 12TH |
Окончание th | окончание порядкового числительного в нижнем регистре | DDth, например 12th |
Приставка FX | глобальный параметр фиксированного формата (см. замечания) | FX Month DD Day |
Приставка TM | режим перевода (используются локализованные названия дней и месяцев, исходя из lc_time) | TMMonth |
Окончание SP | режим числа прописью (не реализован) | DDSP |
Замечания по использованию форматов даты/времени:
FMподавляет дополняющие пробелы и нули справа, которые в противном случае будут добавлены, чтобы результат имел фиксированную ширину. В PostgreSQL модификаторFMдействует только на следующий код, тогда как в OracleFMеё действие распространяется на все последующие коды, пока не будет отключено последующим модификаторомFM.TMподавляет замыкающие пробелы вне зависимости от указанияFM.Функции
to_timestampиto_dateигнорируют регистр букв во входной строке; поэтому, например, для шаблоновMON,Monиmonподойдут одни и те же строки. Если используется приставкаTM, смена регистра производится в соответствии с правилом сортировки, установленным для входной строки (см. Раздел 24.2).to_timestampиto_dateпропускают повторяющиеся пробелы в начале входной строки и вокруг значений даты и времени, если только не используется приставкаFX. Например,to_timestamp(' 2000 JUN', 'YYYY MON')иto_timestamp('2000 - JUN', 'YYYY-MON')будут работать, ноto_timestamp('2000 JUN', 'FXYYYY MON')выдаст ошибку, так какto_timestampожидает только один пробел. ПриставкаFXдолжна быть первой в шаблоне.Разделитель (пробел или отличный от цифры/буквы символ) в строке шаблона функций
to_timestampиto_dateсоответствует любому разделителю во входной строке или пропускается, если только не добавлена приставкаFX. Например,to_timestamp('2000JUN', 'YYYY///MON')иto_timestamp('2000/JUN', 'YYYY MON')будут работать, ноto_timestamp('2000//JUN', 'YYYY/MON')выдаст ошибку, так как количество разделителей во входной строке превышает количество разделителей в шаблоне.Если добавляется приставка
FX, разделитель в строке шаблона соответствует ровно одному символу во входной строке. Но заметьте, что символ во входной строке не обязательно должен совпадать с символом разделителя в шаблоне. Например,to_timestamp('2000/JUN', 'FXYYYY MON')будет работать, аto_timestamp('2000/JUN', 'FXYYYY MON')выдаст ошибку, потому что второй пробел в строке шаблона забирает буквуJиз входной строки.Коду шаблона
TZHможет соответствовать число со знаком. Без приставкиFXзнаки минуса могут быть неоднозначными и восприниматься как разделители. Эта неоднозначность разрешается следующим образом: если число разделителей передTZHв строке шаблона меньше числа разделителей перед знаком минуса во входной строке, знак минус воспринимается как относящийся кTZH. В противном случае знак минуса воспринимается как разделитель значений. Например, вto_timestamp('2000 -10', 'YYYY TZH')в полеTZHпопадает-10, а вto_timestamp('2000 -10', 'YYYY TZH')вTZHпопадает значение10.Шаблоны для
to_charмогут содержать обычный текст; он будет выведен в неизменном виде. Чтобы принудительно вывести текст буквально, даже если он содержит шаблонные коды, подстроку с ним можно заключить в кавычки. Например, в строке'"Hello Year "YYYY', кодYYYYбудет заменён годом, а букваYв словеYearостанется неизменной. В функцияхto_date,to_numberиto_timestampпри обработке подстрок в кавычках и буквального текста некоторой длины пропускается такое же число символов во входной строке; например, при обработке подстроки"XX"будут пропущены два символа (любые, не обязательноXX).Подсказка
До PostgreSQL 12 во входной строке можно было пропускать произвольный текст, используя в шаблоне символы, отличные от цифр и букв. Например, раньше работало
to_timestamp('2000y6m1d', 'yyyy-MM-DD'). Теперь для этой цели можно использовать только буквы. Например, шаблоныto_timestamp('2000y6m1d', 'yyyytMMtDDt')иto_timestamp('2000y6m1d', 'yyyy"y"MM"m"DD"d"')пропускаютy,mиd.Если вам нужно получить на выходе двойные кавычки, вы должны предварить их символом обратной косой черты, например:
'\"YYYY Month\"'. В остальном этот символ вне кавычек воспринимается как обычный. Внутри строки в кавычках он указывает, что следующий символ должен восприниматься буквально, каким бы он ни был (но это имеет смысл, только если следующий символ — кавычки или обратная косая черта).Если в функциях
to_timestampиto_dateформат года определяется менее, чем 4 цифрами, например, какYYY, и в переданном значении года тоже меньше 4 цифр, год пересчитывается в максимально близкий к году 2020, т. е.95воспринимается как 1995.Функции
to_timestampиto_dateвоспринимают отрицательные значения годов как относящиеся к годам до н. э. Если же указать отрицательное значение и добавить явный признакBC(до н. э.), год будет относиться к н. э. Нулевое значение года воспринимается как 1 год до н. э.В функциях
to_timestampиto_dateс преобразованиемYYYYсвязано ограничение, когда обрабатываемый год записывается более чем 4 цифрами. ПослеYYYYнеобходимо будет добавить нецифровой символ или соответствующий код, иначе год всегда будет восприниматься как 4 цифры. Например, вto_date('200001130', 'YYYYMMDD')(с годом 20000) год будет интерпретирован как состоящий из 4 цифр; чтобы исправить ситуацию, нужно добавить нецифровой разделитель после года, как вto_date('20000-1130', 'YYYY-MMDD'), или код как вto_date('20000Nov30', 'YYYYMonDD').Функции
to_timestampиto_dateпринимают полеCC(век), но игнорируют его, если в шаблоне есть полеYYY,YYYYилиY,YYY. ЕслиCCиспользуется сYYилиY, результатом будет год в данном столетии. Если присутствует только код столетия, без года, подразумевается первый год этого века.Функции
to_timestampиto_dateпринимают названия и номера дней недели (DAY,Dи связанные типы полей), но игнорируют их при вычислении результата. То же самое происходит с полями квартала (Q).Функциям
to_timestampиto_dateможно передать даты по недельному календарю ISO 8601 (отличающиеся от григорианских) одним из двух способов:Год, номер недели и дня недели: например,
to_date('2006-42-4', 'IYYY-IW-ID')возвращает дату2006-10-19. Если день недели опускается, он считается равным 1 (понедельнику).Год и день года: например,
to_date('2006-291', 'IYYY-IDDD')также возвращает2006-10-19.
Попытка ввести дату из смеси полей григорианского и недельного календаря ISO 8601 бессмысленна, поэтому это будет считаться ошибкой. В контексте ISO 8601 понятия «номер месяца» и «день месяца» не существуют, а в григорианском календаре нет понятия номера недели по ISO.
Внимание
Тогда как
to_dateне примет смесь полей григорианского и недельного календаря ISO,to_charспособна на это, так как форматы вродеYYYY-MM-DD (IYYY-IDDD)могут быть полезны. Но избегайте форматов типаIYYY-MM-DD; в противном случае с датами в начале года возможны сюрпризы. (За дополнительными сведениями обратитесь к Подразделу 9.9.1.)Функция
to_timestampвоспринимает поля миллисекунд (MS) или микросекунд (US) как дробную часть число секунд. Например,to_timestamp('12.3', 'SS.MS')— это не 3 миллисекунды, а 300, так как это значение воспринимается как 12 + 0.3 секунды. Это значит, что для форматаSS.MSвходные значения12.3,12.30и12.300задают одно и то же число миллисекунд. Чтобы получить три миллисекунды, время нужно записать в виде12.003, тогда оно будет воспринято как 12 + 0.003 = 12.003 сек.Ещё более сложный пример:
to_timestamp('15:12:02.020.001230', 'HH24:MI:SS.MS.US')будет преобразовано в 15 часов, 12 минут и 2 секунды + 20 миллисекунд + 1230 микросекунд = 2.021230 seconds.Нумерация дней недели в
to_char(..., 'ID')соответствует функцииextract(isodow from ...), но нумерацияto_char(..., 'D')не соответствует нумерации, принятой вextract(dow from ...).Функция
to_char(interval)обрабатывает форматыHHиHH12в рамках 12 часов, то есть 0 и 36 часов будут выводиться как12, тогда какHH24выводит число часов полностью, и для значенийintervalрезультат может превышать 23.
Коды форматирования числовых значений перечислены в Таблице 9.29.
Таблица 9.29. Коды форматирования чисел
| Код | Описание |
|---|---|
9 | позиция цифры (может отсутствовать, если цифра незначащая) |
0 | позиция цифры (присутствует всегда, даже если цифра незначащая) |
. (точка) | десятичная точка |
, (запятая) | разделитель групп (тысяч) |
PR | отрицательное значение в угловых скобках |
S | знак, добавляемый к числу (с учётом локали) |
L | символ денежной единицы (с учётом локали) |
D | разделитель целой и дробной части числа (с учётом локали) |
G | разделитель групп (с учётом локали) |
MI | знак минус в заданной позиции (если число < 0) |
PL | знак плюс в заданной позиции (если число > 0) |
SG | знак плюс или минус в заданной позиции |
RN | число римскими цифрами (в диапазоне от 1 до 3999) |
TH или th | окончание порядкового числительного |
V | сдвиг на заданное количество цифр (см. замечания) |
EEEE | экспоненциальная запись числа |
Замечания по использованию форматов чисел:
0обозначает позицию цифры, которая будет выводиться всегда, даже если это незначащий ноль слева или справа.9также обозначает позицию цифры, но если это незначащий ноль слева, он заменяется пробелом, а если справа и задан режим заполнения, он удаляется. (Для функцииto_number()эти два символа равнозначны.)Если в формате числа предусмотрено меньше знаков после запятой, чем в форматируемом числе, функция
to_char()округлит число до указанного количества знаков.Символы шаблона
S,L,DиGпредставляют знак, символ денежной единицы, десятичную точку и разделитель тысяч, как их определяет текущая локаль (см. lc_monetary и lc_numeric). Символы точка и запятая представляют те же символы, обозначающие десятичную точку и разделитель тысяч, но не зависят от локали.Если в шаблоне
to_char()отсутствует явное указание положения знака, для него резервируется одна позиция рядом с числом (слева от него). Если левее нескольких9помещёнS, знак также будет приписан слева к числу.Знак числа, полученный кодами
SG,PLилиMI, не присоединяется к числу; например,to_char(-12, 'MI9999')выдаёт'- 12', тогда какto_char(-12, 'S9999')—' -12'. (В OracleMIне может идти перед9, наоборот9нужно указать передMI.)THне преобразует значения меньше 0 и не поддерживает дробные числа.PL,SGиTH— расширения PostgreSQL.В
to_numberпри использовании шаблонных кодов, не обозначающих данные, таких какLиTH, пропускается соответствующее количество входных символов. При этом не имеет значения, совпадают ли они с символами шаблона, если только это не символы данных (то есть цифры, знак числа, десятичная точка или запятая). Например, для подстрокиTHбудут пропущены два символа, не представляющие данные.Vcto_charумножает вводимое значение на10^, гдеnn— число цифр, следующих заV.Vсto_numberподобным образом делит значение. Функцииto_charиto_numberне поддерживаютVс дробными числами (например,99.9V99не допускается).Код
EEEE(научная запись) не может сочетаться с любыми другими вариантами форматирования или модификаторами, за исключением цифр и десятичной точки, и должен располагаться в конце строки шаблона (например,9.99EEEE— допустимый шаблон).
Для изменения поведения кодов к ним могут быть применены определённые модификаторы. Например, FM99.99 обрабатывается как код 99.99 с модификатором FM. Все модификаторы для форматирования чисел перечислены в Таблице 9.30.
Таблица 9.30. Модификаторы шаблонов для форматирования чисел
| Модификатор | Описание | Пример |
|---|---|---|
Приставка FM | режим заполнения (подавляет завершающие нули и дополнение пробелами) | FM99.99 |
Окончание TH | окончание порядкового числительного в верхнем регистре | 999TH |
Окончание th | окончание порядкового числительного в нижнем регистре | 999th |
В Таблице 9.31 приведены некоторые примеры использования функции to_char.
Таблица 9.31. Примеры to_char
| Выражение | Результат |
|---|---|
to_char(current_timestamp, 'Day, DD HH12:MI:SS') | 'Tuesday , 06 05:39:18' |
to_char(current_timestamp, 'FMDay, FMDD HH12:MI:SS') | 'Tuesday, 6 05:39:18' |
to_char(-0.1, '99.99') | ' -.10' |
to_char(-0.1, 'FM9.99') | '-.1' |
to_char(-0.1, 'FM90.99') | '-0.1' |
to_char(0.1, '0.9') | ' 0.1' |
to_char(12, '9990999.9') | ' 0012.0' |
to_char(12, 'FM9990999.9') | '0012.' |
to_char(485, '999') | ' 485' |
to_char(-485, '999') | '-485' |
to_char(485, '9 9 9') | ' 4 8 5' |
to_char(1485, '9,999') | ' 1,485' |
to_char(1485, '9G999') | ' 1 485' |
to_char(148.5, '999.999') | ' 148.500' |
to_char(148.5, 'FM999.999') | '148.5' |
to_char(148.5, 'FM999.990') | '148.500' |
to_char(148.5, '999D999') | ' 148,500' |
to_char(3148.5, '9G999D999') | ' 3 148,500' |
to_char(-485, '999S') | '485-' |
to_char(-485, '999MI') | '485-' |
to_char(485, '999MI') | '485 ' |
to_char(485, 'FM999MI') | '485' |
to_char(485, 'PL999') | '+485' |
to_char(485, 'SG999') | '+485' |
to_char(-485, 'SG999') | '-485' |
to_char(-485, '9SG99') | '4-85' |
to_char(-485, '999PR') | '<485>' |
to_char(485, 'L999') | 'DM 485' |
to_char(485, 'RN') | ' CDLXXXV' |
to_char(485, 'FMRN') | 'CDLXXXV' |
to_char(5.2, 'FMRN') | 'V' |
to_char(482, '999th') | ' 482nd' |
to_char(485, '"Good number:"999') | 'Good number: 485' |
to_char(485.8, '"Pre:"999" Post:" .999') | 'Pre: 485 Post: .800' |
to_char(12, '99V999') | ' 12000' |
to_char(12.4, '99V999') | ' 12400' |
to_char(12.45, '99V9') | ' 125' |
to_char(0.0004859, '9.99EEEE') | ' 4.86e-04' |
9.8. Data Type Formatting Functions #
The PostgreSQL formatting functions provide a powerful set of tools for converting various data types (date/time, integer, floating point, numeric) to formatted strings and for converting from formatted strings to specific data types. Table 9.26 lists them. These functions all follow a common calling convention: the first argument is the value to be formatted and the second argument is a template that defines the output or input format.
Table 9.26. Formatting Functions
Function Description Example(s) |
|---|
Converts time stamp to string according to the given format.
|
Converts interval to string according to the given format.
|
Converts number to string according to the given format; available for
|
Converts string to date according to the given format.
|
Converts string to numeric according to the given format.
|
Converts string to time stamp according to the given format. (See also
|
Tip
to_timestamp and to_date exist to handle input formats that cannot be converted by simple casting. For most standard date/time formats, simply casting the source string to the required data type works, and is much easier. Similarly, to_number is unnecessary for standard numeric representations.
In a to_char output template string, there are certain patterns that are recognized and replaced with appropriately-formatted data based on the given value. Any text that is not a template pattern is simply copied verbatim. Similarly, in an input template string (for the other functions), template patterns identify the values to be supplied by the input data string. If there are characters in the template string that are not template patterns, the corresponding characters in the input data string are simply skipped over (whether or not they are equal to the template string characters).
Table 9.27 shows the template patterns available for formatting date and time values.
Table 9.27. Template Patterns for Date/Time Formatting
| Pattern | Description |
|---|---|
HH | hour of day (01–12) |
HH12 | hour of day (01–12) |
HH24 | hour of day (00–23) |
MI | minute (00–59) |
SS | second (00–59) |
MS | millisecond (000–999) |
US | microsecond (000000–999999) |
FF1 | tenth of second (0–9) |
FF2 | hundredth of second (00–99) |
FF3 | millisecond (000–999) |
FF4 | tenth of a millisecond (0000–9999) |
FF5 | hundredth of a millisecond (00000–99999) |
FF6 | microsecond (000000–999999) |
SSSS, SSSSS | seconds past midnight (0–86399) |
AM, am, PM or pm | meridiem indicator (without periods) |
A.M., a.m., P.M. or p.m. | meridiem indicator (with periods) |
Y,YYY | year (4 or more digits) with comma |
YYYY | year (4 or more digits) |
YYY | last 3 digits of year |
YY | last 2 digits of year |
Y | last digit of year |
IYYY | ISO 8601 week-numbering year (4 or more digits) |
IYY | last 3 digits of ISO 8601 week-numbering year |
IY | last 2 digits of ISO 8601 week-numbering year |
I | last digit of ISO 8601 week-numbering year |
BC, bc, AD or ad | era indicator (without periods) |
B.C., b.c., A.D. or a.d. | era indicator (with periods) |
MONTH | full upper case month name (blank-padded to 9 chars) |
Month | full capitalized month name (blank-padded to 9 chars) |
month | full lower case month name (blank-padded to 9 chars) |
MON | abbreviated upper case month name (3 chars in English, localized lengths vary) |
Mon | abbreviated capitalized month name (3 chars in English, localized lengths vary) |
mon | abbreviated lower case month name (3 chars in English, localized lengths vary) |
MM | month number (01–12) |
DAY | full upper case day name (blank-padded to 9 chars) |
Day | full capitalized day name (blank-padded to 9 chars) |
day | full lower case day name (blank-padded to 9 chars) |
DY | abbreviated upper case day name (3 chars in English, localized lengths vary) |
Dy | abbreviated capitalized day name (3 chars in English, localized lengths vary) |
dy | abbreviated lower case day name (3 chars in English, localized lengths vary) |
DDD | day of year (001–366) |
IDDD | day of ISO 8601 week-numbering year (001–371; day 1 of the year is Monday of the first ISO week) |
DD | day of month (01–31) |
D | day of the week, Sunday (1) to Saturday (7) |
ID | ISO 8601 day of the week, Monday (1) to Sunday (7) |
W | week of month (1–5) (the first week starts on the first day of the month) |
WW | week number of year (1–53) (the first week starts on the first day of the year) |
IW | week number of ISO 8601 week-numbering year (01–53; the first Thursday of the year is in week 1) |
CC | century (2 digits) (the twenty-first century starts on 2001-01-01) |
J | Julian Date (integer days since November 24, 4714 BC at local midnight; see Section B.7) |
Q | quarter |
RM | month in upper case Roman numerals (I–XII; I=January) |
rm | month in lower case Roman numerals (i–xii; i=January) |
TZ | upper case time-zone abbreviation (only supported in to_char) |
tz | lower case time-zone abbreviation (only supported in to_char) |
TZH | time-zone hours |
TZM | time-zone minutes |
OF | time-zone offset from UTC (only supported in to_char) |
Modifiers can be applied to any template pattern to alter its behavior. For example, FMMonth is the Month pattern with the FM modifier. Table 9.28 shows the modifier patterns for date/time formatting.
Table 9.28. Template Pattern Modifiers for Date/Time Formatting
| Modifier | Description | Example |
|---|---|---|
FM prefix | fill mode (suppress leading zeroes and padding blanks) | FMMonth |
TH suffix | upper case ordinal number suffix | DDTH, e.g., 12TH |
th suffix | lower case ordinal number suffix | DDth, e.g., 12th |
FX prefix | fixed format global option (see usage notes) | FX Month DD Day |
TM prefix | translation mode (use localized day and month names based on lc_time) | TMMonth |
SP suffix | spell mode (not implemented) | DDSP |
Usage notes for date/time formatting:
FMsuppresses leading zeroes and trailing blanks that would otherwise be added to make the output of a pattern be fixed-width. In PostgreSQL,FMmodifies only the next specification, while in OracleFMaffects all subsequent specifications, and repeatedFMmodifiers toggle fill mode on and off.TMsuppresses trailing blanks whether or notFMis specified.to_timestampandto_dateignore letter case in the input; so for exampleMON,Mon, andmonall accept the same strings. When using theTMmodifier, case-folding is done according to the rules of the function's input collation (see Section 24.2).to_timestampandto_dateskip multiple blank spaces at the beginning of the input string and around date and time values unless theFXoption is used. For example,to_timestamp(' 2000 JUN', 'YYYY MON')andto_timestamp('2000 - JUN', 'YYYY-MON')work, butto_timestamp('2000 JUN', 'FXYYYY MON')returns an error becauseto_timestampexpects only a single space.FXmust be specified as the first item in the template.A separator (a space or non-letter/non-digit character) in the template string of
to_timestampandto_datematches any single separator in the input string or is skipped, unless theFXoption is used. For example,to_timestamp('2000JUN', 'YYYY///MON')andto_timestamp('2000/JUN', 'YYYY MON')work, butto_timestamp('2000//JUN', 'YYYY/MON')returns an error because the number of separators in the input string exceeds the number of separators in the template.If
FXis specified, a separator in the template string matches exactly one character in the input string. But note that the input string character is not required to be the same as the separator from the template string. For example,to_timestamp('2000/JUN', 'FXYYYY MON')works, butto_timestamp('2000/JUN', 'FXYYYY MON')returns an error because the second space in the template string consumes the letterJfrom the input string.A
TZHtemplate pattern can match a signed number. Without theFXoption, minus signs may be ambiguous, and could be interpreted as a separator. This ambiguity is resolved as follows: If the number of separators beforeTZHin the template string is less than the number of separators before the minus sign in the input string, the minus sign is interpreted as part ofTZH. Otherwise, the minus sign is considered to be a separator between values. For example,to_timestamp('2000 -10', 'YYYY TZH')matches-10toTZH, butto_timestamp('2000 -10', 'YYYY TZH')matches10toTZH.Ordinary text is allowed in
to_chartemplates and will be output literally. You can put a substring in double quotes to force it to be interpreted as literal text even if it contains template patterns. For example, in'"Hello Year "YYYY', theYYYYwill be replaced by the year data, but the singleYinYearwill not be. Into_date,to_number, andto_timestamp, literal text and double-quoted strings result in skipping the number of characters contained in the string; for example"XX"skips two input characters (whether or not they areXX).Tip
Prior to PostgreSQL 12, it was possible to skip arbitrary text in the input string using non-letter or non-digit characters. For example,
to_timestamp('2000y6m1d', 'yyyy-MM-DD')used to work. Now you can only use letter characters for this purpose. For example,to_timestamp('2000y6m1d', 'yyyytMMtDDt')andto_timestamp('2000y6m1d', 'yyyy"y"MM"m"DD"d"')skipy,m, andd.If you want to have a double quote in the output you must precede it with a backslash, for example
'\"YYYY Month\"'. Backslashes are not otherwise special outside of double-quoted strings. Within a double-quoted string, a backslash causes the next character to be taken literally, whatever it is (but this has no special effect unless the next character is a double quote or another backslash).In
to_timestampandto_date, if the year format specification is less than four digits, e.g.,YYY, and the supplied year is less than four digits, the year will be adjusted to be nearest to the year 2020, e.g.,95becomes 1995.In
to_timestampandto_date, negative years are treated as signifying BC. If you write both a negative year and an explicitBCfield, you get AD again. An input of year zero is treated as 1 BC.In
to_timestampandto_date, theYYYYconversion has a restriction when processing years with more than 4 digits. You must use some non-digit character or template afterYYYY, otherwise the year is always interpreted as 4 digits. For example (with the year 20000):to_date('200001130', 'YYYYMMDD')will be interpreted as a 4-digit year; instead use a non-digit separator after the year, liketo_date('20000-1130', 'YYYY-MMDD')orto_date('20000Nov30', 'YYYYMonDD').In
to_timestampandto_date, theCC(century) field is accepted but ignored if there is aYYY,YYYYorY,YYYfield. IfCCis used withYYorYthen the result is computed as that year in the specified century. If the century is specified but the year is not, the first year of the century is assumed.In
to_timestampandto_date, weekday names or numbers (DAY,D, and related field types) are accepted but are ignored for purposes of computing the result. The same is true for quarter (Q) fields.In
to_timestampandto_date, an ISO 8601 week-numbering date (as distinct from a Gregorian date) can be specified in one of two ways:Year, week number, and weekday: for example
to_date('2006-42-4', 'IYYY-IW-ID')returns the date2006-10-19. If you omit the weekday it is assumed to be 1 (Monday).Year and day of year: for example
to_date('2006-291', 'IYYY-IDDD')also returns2006-10-19.
Attempting to enter a date using a mixture of ISO 8601 week-numbering fields and Gregorian date fields is nonsensical, and will cause an error. In the context of an ISO 8601 week-numbering year, the concept of a “month” or “day of month” has no meaning. In the context of a Gregorian year, the ISO week has no meaning.
Caution
While
to_datewill reject a mixture of Gregorian and ISO week-numbering date fields,to_charwill not, since output format specifications likeYYYY-MM-DD (IYYY-IDDD)can be useful. But avoid writing something likeIYYY-MM-DD; that would yield surprising results near the start of the year. (See Section 9.9.1 for more information.)In
to_timestamp, millisecond (MS) or microsecond (US) fields are used as the seconds digits after the decimal point. For exampleto_timestamp('12.3', 'SS.MS')is not 3 milliseconds, but 300, because the conversion treats it as 12 + 0.3 seconds. So, for the formatSS.MS, the input values12.3,12.30, and12.300specify the same number of milliseconds. To get three milliseconds, one must write12.003, which the conversion treats as 12 + 0.003 = 12.003 seconds.Here is a more complex example:
to_timestamp('15:12:02.020.001230', 'HH24:MI:SS.MS.US')is 15 hours, 12 minutes, and 2 seconds + 20 milliseconds + 1230 microseconds = 2.021230 seconds.to_char(..., 'ID')'s day of the week numbering matches theextract(isodow from ...)function, butto_char(..., 'D')'s does not matchextract(dow from ...)'s day numbering.to_char(interval)formatsHHandHH12as shown on a 12-hour clock, for example zero hours and 36 hours both output as12, whileHH24outputs the full hour value, which can exceed 23 in anintervalvalue.
Table 9.29 shows the template patterns available for formatting numeric values.
Table 9.29. Template Patterns for Numeric Formatting
| Pattern | Description |
|---|---|
9 | digit position (can be dropped if insignificant) |
0 | digit position (will not be dropped, even if insignificant) |
. (period) | decimal point |
, (comma) | group (thousands) separator |
PR | negative value in angle brackets |
S | sign anchored to number (uses locale) |
L | currency symbol (uses locale) |
D | decimal point (uses locale) |
G | group separator (uses locale) |
MI | minus sign in specified position (if number < 0) |
PL | plus sign in specified position (if number > 0) |
SG | plus/minus sign in specified position |
RN | Roman numeral (input between 1 and 3999) |
TH or th | ordinal number suffix |
V | shift specified number of digits (see notes) |
EEEE | exponent for scientific notation |
Usage notes for numeric formatting:
0specifies a digit position that will always be printed, even if it contains a leading/trailing zero.9also specifies a digit position, but if it is a leading zero then it will be replaced by a space, while if it is a trailing zero and fill mode is specified then it will be deleted. (Forto_number(), these two pattern characters are equivalent.)If the format provides fewer fractional digits than the number being formatted,
to_char()will round the number to the specified number of fractional digits.The pattern characters
S,L,D, andGrepresent the sign, currency symbol, decimal point, and thousands separator characters defined by the current locale (see lc_monetary and lc_numeric). The pattern characters period and comma represent those exact characters, with the meanings of decimal point and thousands separator, regardless of locale.If no explicit provision is made for a sign in
to_char()'s pattern, one column will be reserved for the sign, and it will be anchored to (appear just left of) the number. IfSappears just left of some9's, it will likewise be anchored to the number.A sign formatted using
SG,PL, orMIis not anchored to the number; for example,to_char(-12, 'MI9999')produces'- 12'butto_char(-12, 'S9999')produces' -12'. (The Oracle implementation does not allow the use ofMIbefore9, but rather requires that9precedeMI.)THdoes not convert values less than zero and does not convert fractional numbers.PL,SG, andTHare PostgreSQL extensions.In
to_number, if non-data template patterns such asLorTHare used, the corresponding number of input characters are skipped, whether or not they match the template pattern, unless they are data characters (that is, digits, sign, decimal point, or comma). For example,THwould skip two non-data characters.Vwithto_charmultiplies the input values by10^, wherennis the number of digits followingV.Vwithto_numberdivides in a similar manner.to_charandto_numberdo not support the use ofVcombined with a decimal point (e.g.,99.9V99is not allowed).EEEE(scientific notation) cannot be used in combination with any of the other formatting patterns or modifiers other than digit and decimal point patterns, and must be at the end of the format string (e.g.,9.99EEEEis a valid pattern).
Certain modifiers can be applied to any template pattern to alter its behavior. For example, FM99.99 is the 99.99 pattern with the FM modifier. Table 9.30 shows the modifier patterns for numeric formatting.
Table 9.30. Template Pattern Modifiers for Numeric Formatting
| Modifier | Description | Example |
|---|---|---|
FM prefix | fill mode (suppress trailing zeroes and padding blanks) | FM99.99 |
TH suffix | upper case ordinal number suffix | 999TH |
th suffix | lower case ordinal number suffix | 999th |
Table 9.31 shows some examples of the use of the to_char function.
Table 9.31. to_char Examples
| Expression | Result |
|---|---|
to_char(current_timestamp, 'Day, DD HH12:MI:SS') | 'Tuesday , 06 05:39:18' |
to_char(current_timestamp, 'FMDay, FMDD HH12:MI:SS') | 'Tuesday, 6 05:39:18' |
to_char(-0.1, '99.99') | ' -.10' |
to_char(-0.1, 'FM9.99') | '-.1' |
to_char(-0.1, 'FM90.99') | '-0.1' |
to_char(0.1, '0.9') | ' 0.1' |
to_char(12, '9990999.9') | ' 0012.0' |
to_char(12, 'FM9990999.9') | '0012.' |
to_char(485, '999') | ' 485' |
to_char(-485, '999') | '-485' |
to_char(485, '9 9 9') | ' 4 8 5' |
to_char(1485, '9,999') | ' 1,485' |
to_char(1485, '9G999') | ' 1 485' |
to_char(148.5, '999.999') | ' 148.500' |
to_char(148.5, 'FM999.999') | '148.5' |
to_char(148.5, 'FM999.990') | '148.500' |
to_char(148.5, '999D999') | ' 148,500' |
to_char(3148.5, '9G999D999') | ' 3 148,500' |
to_char(-485, '999S') | '485-' |
to_char(-485, '999MI') | '485-' |
to_char(485, '999MI') | '485 ' |
to_char(485, 'FM999MI') | '485' |
to_char(485, 'PL999') | '+485' |
to_char(485, 'SG999') | '+485' |
to_char(-485, 'SG999') | '-485' |
to_char(-485, '9SG99') | '4-85' |
to_char(-485, '999PR') | '<485>' |
to_char(485, 'L999') | 'DM 485' |
to_char(485, 'RN') | ' CDLXXXV' |
to_char(485, 'FMRN') | 'CDLXXXV' |
to_char(5.2, 'FMRN') | 'V' |
to_char(482, '999th') | ' 482nd' |
to_char(485, '"Good number:"999') | 'Good number: 485' |
to_char(485.8, '"Pre:"999" Post:" .999') | 'Pre: 485 Post: .800' |
to_char(12, '99V999') | ' 12000' |
to_char(12.4, '99V999') | ' 12400' |
to_char(12.45, '99V9') | ' 125' |
to_char(0.0004859, '9.99EEEE') | ' 4.86e-04' |