INSERT
INSERT — добавить строки в таблицу
Синтаксис
[ WITH [ RECURSIVE ]запрос_WITH
[, ...] ] INSERT INTOимя_таблицы
[ ASпсевдоним
] [ (имя_столбца
[, ...] ) ] { DEFAULT VALUES | VALUES ( {выражение
| DEFAULT } [, ...] ) [, ...] |запрос
} [ ON CONFLICT [объект_конфликта
]действие_при_конфликте
] [ RETURNING * |выражение_результата
[ [ AS ]имя_результата
] [, ...] ] Здесь допускаетсяобъект_конфликта
: ( {имя_столбца_индекса
| (выражение_индекса
) } [ COLLATEправило_сортировки
] [класс_операторов
] [, ...] ) [ WHEREпредикат_индекса
] ON CONSTRAINTимя_ограничения
идействие_при_конфликте
может быть следующим: DO NOTHING DO UPDATE SET {имя_столбца
= {выражение
| DEFAULT } | (имя_столбца
[, ...] ) = ( {выражение
| DEFAULT } [, ...] ) | (имя_столбца
[, ...] ) = (вложенный_SELECT
) } [, ...] [ WHEREусловие
]
Описание
INSERT
добавляет строки в таблицу. Эта команда может добавить одну или несколько строк, сформированных выражениями значений, либо ноль или более строк, выданных дополнительным запросом.
Имена целевых столбцов могут перечисляться в любом порядке. Если список с именами столбцов отсутствует, по умолчанию целевыми столбцами становятся все столбцы заданной таблицы; либо первые N
из них, если только N
столбцов поступает от предложения VALUES
или запроса
. Значения, получаемые от предложения VALUES
или запроса
, связываются с явно или неявно определённым списком столбцов слева направо.
Все столбцы, не представленные в явном или неявном списке столбцов, получат значения по умолчанию, если для них заданы эти значения, либо NULL в противном случае.
Если выражение для любого столбца выдаёт другой тип данных, система попытается автоматически привести его к нужному.
Предложение ON CONFLICT
позволяет задать действие, заменяющее возникновение ошибки при нарушении ограничения уникальности или ограничения-исключения. (См. описание Предложение ON CONFLICT
ниже.)
С необязательным предложением RETURNING
команда INSERT
вычислит и возвратит значения для каждой фактически добавленной строки (или изменённой, если применялось предложение ON CONFLICT DO UPDATE
). В основном это полезно для получения значений, присвоенных по умолчанию, например, последовательного номера записи. Однако в этом предложении можно задать любое выражение со столбцами таблицы. Список RETURNING
имеет тот же синтаксис, что и список результатов SELECT
. В результате будут возвращены те строки, которые были успешно вставлены или изменены. Например, если строка была заблокирована, но не изменена, из-за того, что условие
в предложении ON CONFLICT DO UPDATE ... WHERE
не удовлетворено, эта строка возвращена не будет.
Чтобы добавлять строки в таблицу, необходимо иметь право INSERT
для неё. Если присутствует предложение ON CONFLICT DO UPDATE
, также требуется иметь право UPDATE
для этой таблицы.
Если указывается список столбцов, достаточно иметь право INSERT
только для перечисленных столбцов. Аналогично, с предложением ON CONFLICT DO UPDATE
достаточно иметь право UPDATE
только для столбцов, которые будут изменены. Однако предложение ON CONFLICT DO UPDATE
также требует наличия права SELECT
для всех столбцов, значения которых считываются в выражениях ON CONFLICT DO UPDATE
или в условии
.
Для применения предложения RETURNING
требуется право SELECT
для всех столбцов, перечисленных в RETURNING
. Если для добавления строк применяется запрос
, для всех таблиц или столбцов, задействованных в этом запросе, разумеется, необходимо иметь право SELECT
.
Параметры
Добавление
В этом разделе рассматриваются параметры, применяемые только при добавлении новых строк. Параметры, применяемые исключительно с предложением ON CONFLICT
, описываются отдельно.
запрос_WITH
Предложение
WITH
позволяет задать один или несколько подзапросов, на которые затем можно ссылаться по имени в запросеINSERT
. Подробнее об этом см. Раздел 7.8 и SELECT.Заданный
запрос
(операторSELECT
) также может содержать предложениеWITH
. В этом случае взапросе
можно обращаться к обоимзапросам_WITH
, но второй будет иметь приоритет, так как он вложен ближе.имя_таблицы
Имя существующей таблицы (возможно, дополненное схемой).
псевдоним
Альтернативное имя, заменяющее
имя_таблицы
. Когда указывается это имя, оно полностью скрывает реальное имя таблицы. Это особенно полезно, когда в предложенииON CONFLICT DO UPDATE
фигурирует таблица с именем excluded, так как это имя дано и специальной таблице, представляющей строки, предназначенные для добавления.имя_столбца
Имя столбца в таблице
имя_таблицы
. Это имя столбца при необходимости может быть дополнено именем вложенного поля или индексом в массиве. (Когда данные вставляются только в некоторые поля столбца составного типа, в другие поля записывается NULL.) Обращаясь к столбцу в предложенииON CONFLICT DO UPDATE
, включать имя таблицы в ссылку на целевой столбец не нужно. Например, записьINSERT INTO table_name ... ON CONFLICT DO UPDATE SET table_name.col = 1
некорректна (это согласуется с общим поведением командыUPDATE
).DEFAULT VALUES
Все столбцы получат значения по умолчанию.
выражение
Выражение или значение, которое будет присвоено соответствующему столбцу.
DEFAULT
Соответствующий столбец получит значение по умолчанию.
запрос
Запрос (оператор
SELECT
), который выдаст строки для добавления в таблицу. Его синтаксис описан в справке оператора SELECT.выражение_результата
Выражение, которое будет вычисляться и возвращаться командой
INSERT
после добавления или изменения каждой строки. В этом выражении можно использовать имена любых столбцов таблицыимя_таблицы
. Чтобы получить все столбцы, достаточно написать*
.имя_результата
Имя, назначаемое возвращаемому столбцу.
Предложение ON CONFLICT
Необязательное предложение ON CONFLICT
задаёт действие, заменяющее возникновение ошибки при нарушении ограничения уникальности или ограничения-исключения. Для каждой отдельной строки, предложенной для добавления, добавление либо выполняется успешно, либо, если нарушается решающее ограничение или индекс, задаваемые как объект_конфликта
, выполняется альтернативное действие_конфликта
. Вариант ON CONFLICT DO NOTHING
в качестве альтернативного действия просто отменяет добавление строки. Вариант ON CONFLICT DO UPDATE
изменяет существующую строку, вызвавшую конфликт со строкой, предложенной для добавления.
Задаваемый объект_конфликта
может выбирать уникальный индекс. Определение объекта, позволяющее выбрать индекс, включает один или несколько столбцов (их определяет имя_столбца_индекса
) и/или выражение_индекса
и необязательный предикат_индекса
. Все уникальные индексы в таблице имя_таблицы
, которые, без учёта порядка столбцов, содержат в точности столбцы/выражения, определяющие объект_конфликта
, выбираются как решающие индексы. Если указывается предикат_индекса
, он должен, в качестве дополнительного требования выбора, удовлетворять индексам. Заметьте, что это означает, что не частичный уникальный индекс (уникальный индекс без предиката) будет выбран (и будет использоваться в ON CONFLICT
), если такой индекс удовлетворяет всем остальным критериям. Если попытка выбрать индекс оказывается неудачной, выдаётся ошибка.
ON CONFLICT DO UPDATE
гарантирует атомарный результат команды INSERT
или UPDATE
; при отсутствии внешних ошибок гарантируется один из двух этих исходов, даже при большой параллельной активности. Эта операция также известна как UPSERT — «UPDATE или INSERT».
объект_конфликта
Определяет, для какого именно конфликта в
ON CONFLICT
будет предпринято альтернативное действие, устанавливая решающие индексы. Это указание позволяет осуществить выбор уникального индекса или явно задаёт имя ограничения. ДляON CONFLICT DO NOTHING
объект_конфликта
может не указываться; в этом случае игнорироваться будут все конфликты с любыми ограничениями (и уникальными индексами). ДляON CONFLICT DO UPDATE
объект_конфликта
должен указываться.действие_при_конфликте
Параметр
действие_при_конфликте
задаёт альтернативное действие в случае конфликта. Это может быть либоDO NOTHING
(не делать ничего), либо предложениеDO UPDATE
(произвести изменение), в котором указываются точные детали операцииUPDATE
, выполняемой в случае конфликта. ПредложенияSET
иWHERE
вON CONFLICT DO UPDATE
могут обращаться к существующей строке по имени таблицы (или псевдониму) или к строкам, предлагаемым для добавления, используя специальную таблицуexcluded
. Для чтения столбцовexcluded
необходимо иметь правоSELECT
для соответствующих столбцов в целевой таблице.Заметьте, что эффект действий всех триггеров уровня строк
BEFORE INSERT
отражается в значенияхexcluded
, так как в результате этих действий строка может быть исключена из множества добавляемых.имя_столбца_индекса
Имя столбца в таблице
имя_таблицы
. Используется для выбора решающих индексов. Задаётся в форматеCREATE INDEX
. Чтобы запрос выполнился, для столбцаимя_столбца_индекса
требуется правоSELECT
.выражение_индекса
Подобно указанию
имя_столбца_индекса
, но применяется для выбора индекса по выражениям со столбцами таблицыимя_таблицы
, фигурирующим в определениях индексов (не по простым столбцам). Задаётся в форматеCREATE INDEX
. Для всех столбцов, к которым обращаетсявыражение_индекса
, необходимо иметь правоSELECT
.правило_сортировки
Когда задаётся, устанавливает, что соответствующие
имя_столбца_индекса
иливыражение_индекса
должны использовать определённый порядок сортировки, чтобы этот индекс мог быть выбран. Обычно это указание опускается, так как от правил сортировки чаще всего не зависит, произойдёт ли нарушение ограничений или нет. Задаётся в форматеCREATE INDEX
.класс_операторов
Когда задаётся, устанавливает, что соответствующие
имя_столбца_индекса
иливыражение_индекса
должны использовать определённый класс, чтобы индекс мог быть выбран. Обычно это указание опускается, потому что семантика равенства часто всё равно одна и та же в разных классах операторов типа, или потому что достаточно рассчитывать на то, что заданные уникальные индексы имеют адекватное определение равенства. Задаётся в форматеCREATE INDEX
.предикат_индекса
Используется для выбора частичных уникальных индексов. Выбраны могут быть любые индексы, удовлетворяющие предикату (при этом они могут не быть собственно частичными индексами). Задаётся в формате
CREATE INDEX
. Для всех столбцов, задействованных впредикате_индекса
, требуется правоSELECT
.имя_ограничения
Явно задаёт решающее ограничение по имени, что заменяет неявный выбор ограничения или индекса.
условие
Выражение, выдающее значение типа
boolean
. Изменены будут только те строки, для которых это выражение выдастtrue
, хотя при выборе действияON CONFLICT DO UPDATE
заблокируются все строки. Заметьте, чтоусловие
вычисляется в конце, после того как конфликт был признан претендующим на выполнение изменения.
Заметьте, что ограничения-исключения не могут быть решающими в ON CONFLICT DO UPDATE
. Во всех случаях в качестве решающих поддерживаются только неоткладываемые (NOT DEFERRABLE
) ограничения и уникальные индексы.
Команда INSERT
с предложением ON CONFLICT DO UPDATE
является «детерминированной». Это означает, что этой команде не разрешено воздействовать на любую существующую строку больше одного раза; в случае такой ситуации возникнет ошибка нарушения мощности множества. Строки, предлагаемые для добавления, не должны дублироваться с точки зрения атрибутов, ограничиваемых решающим индексом или ограничением.
Подсказка
Часто предпочтительнее использовать неявный выбор уникального индекса вместо непосредственного указания ограничения в виде ON CONFLICT ON CONSTRAINT
имя_ограничения
. Выбор продолжит корректно работать, когда нижележащий индекс будет заменён другим более или менее равнозначным индексом методом наложения, например, с использованием CREATE UNIQUE INDEX ... CONCURRENTLY
и последующим удалением заменяемого индекса.
Выводимая информация
В случае успешного завершения INSERT
возвращает метку команды в виде
INSERToid
число
Здесь число
представляет количество добавленных или изменённых строк. Если число
равняется одному, а целевая таблица содержит oid, то в качестве oid
выводится OID, назначенный добавленной строке. Эта одна строка должна быть добавлена, но не изменена. В противном случае в качестве oid
выводится ноль.
Если команда INSERT
содержит предложение RETURNING
, её результат будет похож на результат оператора SELECT
(с теми же столбцами и значениями, что содержатся в списке RETURNING
), полученный для строк, добавленных или изменённых этой командой.
Примеры
Добавление одной строки в таблицу films
:
INSERT INTO films VALUES ('UA502', 'Bananas', 105, '1971-07-13', 'Comedy', '82 minutes');
В этом примере столбец len
опускается и, таким образом, получает значение по умолчанию:
INSERT INTO films (code, title, did, date_prod, kind) VALUES ('T_601', 'Yojimbo', 106, '1961-06-16', 'Drama');
В этом примере для столбца с датой задаётся указание DEFAULT
, а не явное значение:
INSERT INTO films VALUES ('UA502', 'Bananas', 105, DEFAULT, 'Comedy', '82 minutes'); INSERT INTO films (code, title, did, date_prod, kind) VALUES ('T_601', 'Yojimbo', 106, DEFAULT, 'Drama');
Добавление строки, полностью состоящей из значений по умолчанию:
INSERT INTO films DEFAULT VALUES;
Добавление нескольких строк с использованием многострочного синтаксиса VALUES
:
INSERT INTO films (code, title, did, date_prod, kind) VALUES ('B6717', 'Tampopo', 110, '1985-02-10', 'Comedy'), ('HG120', 'The Dinner Game', 140, DEFAULT, 'Comedy');
В этом примере в таблицу films
вставляются некоторые строки из таблицы tmp_films
, имеющей ту же структуру столбцов, что и films
:
INSERT INTO films SELECT * FROM tmp_films WHERE date_prod < '2004-05-07';
Этот пример демонстрирует добавление данных в столбцы с типом массива:
-- Создание пустого поля 3x3 для игры в крестики-нолики INSERT INTO tictactoe (game, board[1:3][1:3]) VALUES (1, '{{" "," "," "},{" "," "," "},{" "," "," "}}'); -- Указания индексов в предыдущей команда могут быть опущены INSERT INTO tictactoe (game, board) VALUES (2, '{{X," "," "},{" ",O," "},{" ",X," "}}');
Добавление одной строки в таблицу distributors
и получение последовательного номера, сгенерированного благодаря указанию DEFAULT
:
INSERT INTO distributors (did, dname) VALUES (DEFAULT, 'XYZ Widgets') RETURNING did;
Увеличение счётчика продаж для продавца, занимающегося компанией Acme Corporation, и сохранение всей изменённой строки вместе с текущим временем в таблице журнала:
WITH upd AS ( UPDATE employees SET sales_count = sales_count + 1 WHERE id = (SELECT sales_person FROM accounts WHERE name = 'Acme Corporation') RETURNING * ) INSERT INTO employees_log SELECT *, current_timestamp FROM upd;
Добавить дистрибьюторов или изменить существующие данные должным образом. Предполагается, что в таблице определён уникальный индекс, ограничивающий значения в столбце did
. Заметьте, что для обращения к значениям, изначально предлагаемым для добавления, используется специальная таблица excluded
:
INSERT INTO distributors (did, dname) VALUES (5, 'Gizmo Transglobal'), (6, 'Associated Computing, Inc') ON CONFLICT (did) DO UPDATE SET dname = EXCLUDED.dname;
Добавить дистрибьютора или не делать ничего для строк, предложенных для добавления, если уже есть существующая исключающая строка (строка, содержащая конфликтующие значения в столбце или столбцах после срабатывания триггеров перед добавлением строки). В данном примере предполагается, что определён уникальный индекс, ограничивающий значения в столбце did
:
INSERT INTO distributors (did, dname) VALUES (7, 'Redline GmbH') ON CONFLICT (did) DO NOTHING;
Добавить дистрибьюторов или изменить существующие данные должным образом. В данном примере предполагается, что в таблице определён уникальный индекс, ограничивающий значения в столбце did
. Предложение WHERE
позволяет ограничить набор фактически изменяемых строк (однако любая существующая строка, не подлежащая изменению, всё же будет заблокирована):
-- Не менять данные существующих дистрибьюторов в зависимости от почтового индекса INSERT INTO distributors AS d (did, dname) VALUES (8, 'Anvil Distribution') ON CONFLICT (did) DO UPDATE SET dname = EXCLUDED.dname || ' (formerly ' || d.dname || ')' WHERE d.zipcode <> '21201'; -- Указать имя ограничения непосредственно в операторе (связанный индекс -- применяется для принятия решения о выполнении действия DO NOTHING) INSERT INTO distributors (did, dname) VALUES (9, 'Antwerp Design') ON CONFLICT ON CONSTRAINT distributors_pkey DO NOTHING;
Добавить дистрибьютора, если возможно; в противном случае не делать ничего (DO NOTHING
). В данном примере предполагается, что в таблице определён уникальный индекс, ограничивающий значения в столбце did
по подмножеству строк, в котором логический столбец is_active
содержит true
:
-- Этот оператор может выбрать частичный уникальный индекс по "did" -- с предикатом "WHERE is_active", а может и просто использовать -- обычное ограничение уникальности по столбцу "did" INSERT INTO distributors (did, dname) VALUES (10, 'Conrad International') ON CONFLICT (did) WHERE is_active DO NOTHING;
Совместимость
INSERT
соответствует стандарту SQL, но предложение RETURNING
относится к расширениям Postgres Pro, как и возможность применять WITH
с INSERT
и возможность задавать альтернативное действие с ON CONFLICT
. Кроме того, ситуация, когда список столбцов опущен, но не все столбцы получают значения из предложения VALUES
или запроса
, стандартом не допускается.
Возможные ограничения предложения запрос
описаны в справке SELECT.
F.29. ltree
This module implements a data type ltree
for representing labels of data stored in a hierarchical tree-like structure. Extensive facilities for searching through label trees are provided.
F.29.1. Definitions
A label is a sequence of alphanumeric characters and underscores (for example, in C locale the characters A-Za-z0-9_
are allowed). Labels must be less than 256 characters long.
Examples: 42
, Personal_Services
A label path is a sequence of zero or more labels separated by dots, for example L1.L2.L3
, representing a path from the root of a hierarchical tree to a particular node. The length of a label path cannot exceed 65535 labels.
Example: Top.Countries.Europe.Russia
The ltree
module provides several data types:
ltree
stores a label path.lquery
represents a regular-expression-like pattern for matchingltree
values. A simple word matches that label within a path. A star symbol (*
) matches zero or more labels. For example:foo Match the exact label path
foo
*.foo.* Match any label path containing the labelfoo
*.foo Match any label path whose last label isfoo
Star symbols can also be quantified to restrict how many labels they can match:
*{
n
} Match exactlyn
labels *{n
,} Match at leastn
labels *{n
,m
} Match at leastn
but not more thanm
labels *{,m
} Match at mostm
labels — same as *{0,m
}There are several modifiers that can be put at the end of a non-star label in
lquery
to make it match more than just the exact match:@ Match case-insensitively, for example
a@
matchesA
* Match any label with this prefix, for examplefoo*
matchesfoobar
% Match initial underscore-separated wordsThe behavior of
%
is a bit complicated. It tries to match words rather than the entire label. For examplefoo_bar%
matchesfoo_bar_baz
but notfoo_barbaz
. If combined with*
, prefix matching applies to each word separately, for examplefoo_bar%*
matchesfoo1_bar2_baz
but notfoo1_br2_baz
.Also, you can write several possibly-modified labels separated with
|
(OR) to match any of those labels, and you can put!
(NOT) at the start to match any label that doesn't match any of the alternatives.Here's an annotated example of
lquery
:Top.*{0,2}.sport*@.!football|tennis.Russ*|Spain a. b. c. d. e.
This query will match any label path that:
begins with the label
Top
and next has zero to two labels before
a label beginning with the case-insensitive prefix
sport
then a label not matching
football
nortennis
and then ends with a label beginning with
Russ
or exactly matchingSpain
.
ltxtquery
represents a full-text-search-like pattern for matchingltree
values. Anltxtquery
value contains words, possibly with the modifiers@
,*
,%
at the end; the modifiers have the same meanings as inlquery
. Words can be combined with&
(AND),|
(OR),!
(NOT), and parentheses. The key difference fromlquery
is thatltxtquery
matches words without regard to their position in the label path.Here's an example
ltxtquery
:Europe & Russia*@ & !Transportation
This will match paths that contain the label
Europe
and any label beginning withRussia
(case-insensitive), but not paths containing the labelTransportation
. The location of these words within the path is not important. Also, when%
is used, the word can be matched to any underscore-separated word within a label, regardless of position.
Note: ltxtquery
allows whitespace between symbols, but ltree
and lquery
do not.
F.29.2. Operators and Functions
Type ltree
has the usual comparison operators =
, <>
, <
, >
, <=
, >=
. Comparison sorts in the order of a tree traversal, with the children of a node sorted by label text. In addition, the specialized operators shown in Table F.19 are available.
Table F.19. ltree
Operators
Operator | Returns | Description |
---|---|---|
ltree @> ltree | boolean | is left argument an ancestor of right (or equal)? |
ltree <@ ltree | boolean | is left argument a descendant of right (or equal)? |
ltree ~ lquery | boolean | does ltree match lquery ? |
lquery ~ ltree | boolean | does ltree match lquery ? |
ltree ? lquery[] | boolean | does ltree match any lquery in array? |
lquery[] ? ltree | boolean | does ltree match any lquery in array? |
ltree @ ltxtquery | boolean | does ltree match ltxtquery ? |
ltxtquery @ ltree | boolean | does ltree match ltxtquery ? |
ltree || ltree | ltree | concatenate ltree paths |
ltree || text | ltree | convert text to ltree and concatenate |
text || ltree | ltree | convert text to ltree and concatenate |
ltree[] @> ltree | boolean | does array contain an ancestor of ltree ? |
ltree <@ ltree[] | boolean | does array contain an ancestor of ltree ? |
ltree[] <@ ltree | boolean | does array contain a descendant of ltree ? |
ltree @> ltree[] | boolean | does array contain a descendant of ltree ? |
ltree[] ~ lquery | boolean | does array contain any path matching lquery ? |
lquery ~ ltree[] | boolean | does array contain any path matching lquery ? |
ltree[] ? lquery[] | boolean | does ltree array contain any path matching any lquery ? |
lquery[] ? ltree[] | boolean | does ltree array contain any path matching any lquery ? |
ltree[] @ ltxtquery | boolean | does array contain any path matching ltxtquery ? |
ltxtquery @ ltree[] | boolean | does array contain any path matching ltxtquery ? |
ltree[] ?@> ltree | ltree | first array entry that is an ancestor of ltree ; NULL if none |
ltree[] ?<@ ltree | ltree | first array entry that is a descendant of ltree ; NULL if none |
ltree[] ?~ lquery | ltree | first array entry that matches lquery ; NULL if none |
ltree[] ?@ ltxtquery | ltree | first array entry that matches ltxtquery ; NULL if none |
The operators <@
, @>
, @
and ~
have analogues ^<@
, ^@>
, ^@
, ^~
, which are the same except they do not use indexes. These are useful only for testing purposes.
The available functions are shown in Table F.20.
Table F.20. ltree
Functions
F.29.3. Indexes
ltree
supports several types of indexes that can speed up the indicated operators:
B-tree index over
ltree
:<
,<=
,=
,>=
,>
GiST index over
ltree
:<
,<=
,=
,>=
,>
,@>
,<@
,@
,~
,?
Example of creating such an index:
CREATE INDEX path_gist_idx ON test USING GIST (path);
GiST index over
ltree[]
:ltree[] <@ ltree
,ltree @> ltree[]
,@
,~
,?
Example of creating such an index:
CREATE INDEX path_gist_idx ON test USING GIST (array_path);
Note: This index type is lossy.
F.29.4. Example
This example uses the following data (also available in file contrib/ltree/ltreetest.sql
in the source distribution):
CREATE TABLE test (path ltree); INSERT INTO test VALUES ('Top'); INSERT INTO test VALUES ('Top.Science'); INSERT INTO test VALUES ('Top.Science.Astronomy'); INSERT INTO test VALUES ('Top.Science.Astronomy.Astrophysics'); INSERT INTO test VALUES ('Top.Science.Astronomy.Cosmology'); INSERT INTO test VALUES ('Top.Hobbies'); INSERT INTO test VALUES ('Top.Hobbies.Amateurs_Astronomy'); INSERT INTO test VALUES ('Top.Collections'); INSERT INTO test VALUES ('Top.Collections.Pictures'); INSERT INTO test VALUES ('Top.Collections.Pictures.Astronomy'); INSERT INTO test VALUES ('Top.Collections.Pictures.Astronomy.Stars'); INSERT INTO test VALUES ('Top.Collections.Pictures.Astronomy.Galaxies'); INSERT INTO test VALUES ('Top.Collections.Pictures.Astronomy.Astronauts'); CREATE INDEX path_gist_idx ON test USING GIST (path); CREATE INDEX path_idx ON test USING BTREE (path);
Now, we have a table test
populated with data describing the hierarchy shown below:
Top / | \ Science Hobbies Collections / | \ Astronomy Amateurs_Astronomy Pictures / \ | Astrophysics Cosmology Astronomy / | \ Galaxies Stars Astronauts
We can do inheritance:
ltreetest=> SELECT path FROM test WHERE path <@ 'Top.Science'; path ------------------------------------ Top.Science Top.Science.Astronomy Top.Science.Astronomy.Astrophysics Top.Science.Astronomy.Cosmology (4 rows)
Here are some examples of path matching:
ltreetest=> SELECT path FROM test WHERE path ~ '*.Astronomy.*'; path ----------------------------------------------- Top.Science.Astronomy Top.Science.Astronomy.Astrophysics Top.Science.Astronomy.Cosmology Top.Collections.Pictures.Astronomy Top.Collections.Pictures.Astronomy.Stars Top.Collections.Pictures.Astronomy.Galaxies Top.Collections.Pictures.Astronomy.Astronauts (7 rows) ltreetest=> SELECT path FROM test WHERE path ~ '*.!pictures@.*.Astronomy.*'; path ------------------------------------ Top.Science.Astronomy Top.Science.Astronomy.Astrophysics Top.Science.Astronomy.Cosmology (3 rows)
Here are some examples of full text search:
ltreetest=> SELECT path FROM test WHERE path @ 'Astro*% & !pictures@'; path ------------------------------------ Top.Science.Astronomy Top.Science.Astronomy.Astrophysics Top.Science.Astronomy.Cosmology Top.Hobbies.Amateurs_Astronomy (4 rows) ltreetest=> SELECT path FROM test WHERE path @ 'Astro* & !pictures@'; path ------------------------------------ Top.Science.Astronomy Top.Science.Astronomy.Astrophysics Top.Science.Astronomy.Cosmology (3 rows)
Path construction using functions:
ltreetest=> SELECT subpath(path,0,2)||'Space'||subpath(path,2) FROM test WHERE path <@ 'Top.Science.Astronomy'; ?column? ------------------------------------------ Top.Science.Space.Astronomy Top.Science.Space.Astronomy.Astrophysics Top.Science.Space.Astronomy.Cosmology (3 rows)
We could simplify this by creating a SQL function that inserts a label at a specified position in a path:
CREATE FUNCTION ins_label(ltree, int, text) RETURNS ltree AS 'select subpath($1,0,$2) || $3 || subpath($1,$2);' LANGUAGE SQL IMMUTABLE; ltreetest=> SELECT ins_label(path,2,'Space') FROM test WHERE path <@ 'Top.Science.Astronomy'; ins_label ------------------------------------------ Top.Science.Space.Astronomy Top.Science.Space.Astronomy.Astrophysics Top.Science.Space.Astronomy.Cosmology (3 rows)
F.29.5. Transforms
Additional extensions are available that implement transforms for the ltree
type for PL/Python. The extensions are called ltree_plpythonu
, ltree_plpython2u
, and ltree_plpython3u
(see Section 44.1 for the PL/Python naming convention). If you install these transforms and specify them when creating a function, ltree
values are mapped to Python lists. (The reverse is currently not supported, however.)
Caution
It is strongly recommended that the transform extensions be installed in the same schema as ltree
. Otherwise there are installation-time security hazards if a transform extension's schema contains objects defined by a hostile user.
F.29.6. Authors
All work was done by Teodor Sigaev (<teodor@stack.net>
) and Oleg Bartunov (<oleg@sai.msu.su>
). See http://www.sai.msu.su/~megera/postgres/gist/ for additional information. Authors would like to thank Eugeny Rodichev for helpful discussions. Comments and bug reports are welcome.