F.58. rum
F.58.1. Введение
Модуль rum предоставляет метод доступа RUM для работы с индексами. Он основан на коде методов доступа GIN.
Индексы GIN позволяют выполнять быстрый полнотекстовый поиск, используя типы tsvector и tsquery. Однако могут возникнуть некоторые проблемы с производительностью из-за того, что информация о позициях лексем и другая дополнительная информация не сохраняются.
Индекс RUM решает эти проблемы, сохраняя дополнительную информацию в дереве идентификаторов и обладает следующими преимуществами перед GIN:
Ускорение ранжирования. Для ранжирования необходима информация о позициях лексем. После сканирования индекса
RUMнет необходимости в сканировании собственно данных, так как индекс сохраняет позиции лексем.Ускорение поиска фраз. Это преимущество связано с предыдущим, так как для поиска фраз также необходима информация о позициях лексем.
Ускорение упорядочивания по меткам времени. Вместе с лексемами индекс
RUMсохраняет дополнительную информацию, поэтому не требуется сканирование собственно данных.Возможность производить поиск «сначала в глубину», а значит сразу выдавать первые результаты.
Недостаток RUM состоит в том, что он строится и изменяется медленнее, чем GIN, потому что RUM хранит помимо ключей дополнительную информацию и использует унифицированные записи WAL.
F.58.2. Установка
rum — это обычное расширение Postgres Pro Enterprise без каких-либо особых предварительных требований.
Процедура установки выглядит следующим образом:
$ psql имя_бд -c "CREATE EXTENSION rum"
F.58.3. Общие операторы
Реализованные в модуле rum операторы перечислены в Таблице F.40:
Таблица F.40. Операторы rum
| Оператор | Возвращает | Описание |
|---|---|---|
tsvector <=> tsquery | float4 | Возвращает расстояние между значениями tsvector и tsquery. |
timestamp <=> timestamp | float8 | Возвращает расстояние между двумя значениями timestamp. |
timestamp <=| timestamp | float8 | Возвращает расстояние только для возрастающих значений timestamp. |
timestamp |=> timestamp | float8 | Возвращает расстояние только для убывающих значений timestamp. |
Примечание
rum вводит собственную функцию ранжирования, которая выполняется внутри оператора <=> и вычисляет оценку (инвертированное расстояние), используя заданный метод реализации. Она представляет собой сочетание функций ts_rank и ts_rank_cd (за подробностями обратитесь к Разделу 9.13). В то время, как ts_rank не поддерживает логические операции, а ts_rank_cd плохо работает с запросами OR, доступная в rum функция ранжирования лишена этих недостатков.
F.58.4. Классы операторов
Расширение rum предоставляет следующие классы операторов:
rum_tsvector_opsСохраняет лексемы
tsvectorс информацией о позициях. Поддерживает упорядочивание с оператором<=>и поиск по префиксу.rum_tsvector_hash_opsСохраняет хеш лексем
tsvectorс информацией о позициях. Поддерживает упорядочивание с оператором<=>, но не поддерживает поиск по префиксу.rum_tsvector_addon_opsСохраняет лексемы
tsvectorс дополнительными данными любых типов, которые принимаетRUM.rum_tsvector_hash_addon_opsСохраняет лексемы
tsvectorс дополнительными данными любых типов, которые принимаетRUM. Не поддерживает поиск по префиксу.rum_tsquery_opsСохраняет ветви дерева запроса в дополнительной информации.
rum_anyarray_opsСохраняет элементы массива
anyarrayи длину массива. Поддерживает упорядочивание с оператором <=>.Индексируемые операторы:
&& @> <@ = %rum_anyarray_addon_opsСохраняет элементы
anyarrayс дополнительными данными любых типов, которые принимаетRUM.rum_type_opsСохраняет лексемы соответствующего типа с информацией о позициях. В качестве
типав имени класса должно подставляться одно из следующих имён типов:int2,int4,int8,float4,float8,money,oid,timestamp,timestamptz,time,timetz,date,interval,macaddr,inet,cidr,text,varchar,char,bytea,bit,varbit,numeric.Класс операторов
поддерживает упорядочивание с операторамитип_rum_ops<=>,<=|и|=>. Его можно использовать совместно с классами операторовrum_tsvector_addon_ops,rum_tsvector_hash_addon_opsиrum_anyarray_addon_ops.Поддержка индексируемых операторов зависит от типа данных:
Операторы
< <= = >= > <=> <=| |=>поддерживаются для типовint2,int4,int8,float4,float8,money,oid,timestamp,timestamptz.Операторы
< <= = >= >поддерживаются для типовtime,timetz,date,interval,macaddr,inet,cidr,text,varchar,char,bytea,bit,varbit,numeric.
Примечание
Следующие классы операторов теперь считаются устаревшими: rum_tsvector_timestamp_ops, rum_tsvector_timestamptz_ops, rum_tsvector_hash_timestamp_ops, rum_tsvector_hash_timestamptz_ops.
F.58.5. Примеры
F.58.5.1. Пример с rum_tsvector_ops
Предположим, что у нас есть таблица:
CREATE TABLE test_rum(t text, a tsvector);
CREATE TRIGGER tsvectorupdate
BEFORE UPDATE OR INSERT ON test_rum
FOR EACH ROW EXECUTE PROCEDURE tsvector_update_trigger('a', 'pg_catalog.english', 't');
INSERT INTO test_rum(t) VALUES ('The situation is most beautiful');
INSERT INTO test_rum(t) VALUES ('It is a beautiful');
INSERT INTO test_rum(t) VALUES ('It looks like a beautiful place');Затем мы можем создать новый индекс:
CREATE INDEX rumidx ON test_rum USING rum (a rum_tsvector_ops);
И выполнять следующие запросы:
SELECT t, a <=> to_tsquery('english', 'beautiful | place') AS rank
FROM test_rum
WHERE a @@ to_tsquery('english', 'beautiful | place')
ORDER BY a <=> to_tsquery('english', 'beautiful | place');
t | rank
---------------------------------+-----------
The situation is most beautiful | 0.0303964
It is a beautiful | 0.0303964
It looks like a beautiful place | 0.0607927
(3 rows)
SELECT t, a <=> to_tsquery('english', 'place | situation') AS rank
FROM test_rum
WHERE a @@ to_tsquery('english', 'place | situation')
ORDER BY a <=> to_tsquery('english', 'place | situation');
t | rank
---------------------------------+-----------
The situation is most beautiful | 0.0303964
It looks like a beautiful place | 0.0303964
(2 rows)F.58.5.2. Пример с rum_tsvector_addon_ops
Предположим, что у нас есть таблица:
CREATE TABLE tsts (id int, t tsvector, d timestamp);
\copy tsts from 'rum/data/tsts.data'
CREATE INDEX tsts_idx ON tsts USING rum (t rum_tsvector_addon_ops, d)
WITH (attach = 'd', to = 't');С ним мы можем выполнять подобные запросы:
EXPLAIN (costs off)
SELECT id, d, d <=> '2016-05-16 14:21:25' FROM tsts WHERE t @@ 'wr&qh' ORDER BY d <=> '2016-05-16 14:21:25' LIMIT 5;
QUERY PLAN
-----------------------------------------------------------------------------------
Limit
-> Index Scan using tsts_idx on tsts
Index Cond: (t @@ '''wr'' & ''qh'''::tsquery)
Order By: (d <=> 'Mon May 16 14:21:25 2016'::timestamp without time zone)
(4 rows)
SELECT id, d, d <=> '2016-05-16 14:21:25' FROM tsts WHERE t @@ 'wr&qh' ORDER BY d <=> '2016-05-16 14:21:25' LIMIT 5;
id | d | ?column?
-----+---------------------------------+---------------
355 | Mon May 16 14:21:22.326724 2016 | 2.673276
354 | Mon May 16 13:21:22.326724 2016 | 3602.673276
371 | Tue May 17 06:21:22.326724 2016 | 57597.326724
406 | Wed May 18 17:21:22.326724 2016 | 183597.326724
415 | Thu May 19 02:21:22.326724 2016 | 215997.326724
(5 rows)F.58.5.3. Пример с rum_tsquery_ops
Предположим, что у нас таблица:
CREATE TABLE query (q tsquery, tag text);
INSERT INTO query VALUES ('supernova & star', 'sn'),
('black', 'color'),
('big & bang & black & hole', 'bang'),
('spiral & galaxy', 'shape'),
('black & hole', 'color');
CREATE INDEX query_idx ON query USING rum(q);Мы можем выполнить следующий быстрый запрос:
SELECT * FROM query
WHERE to_tsvector('black holes never exists before we think about them') @@ q;
q | tag
------------------+-------
'black' | color
'black' & 'hole' | color
(2 rows)F.58.5.4. Пример с rum_anyarray_ops
Предположим, что у нас есть таблица:
CREATE TABLE test_array (i int2[]);
INSERT INTO test_array VALUES ('{}'), ('{0}'), ('{1,2,3,4}'), ('{1,2,3}'), ('{1,2}'), ('{1}');
CREATE INDEX idx_array ON test_array USING rum (i rum_anyarray_ops);Теперь мы можем выполнить следующий запрос, используя сканирование индекса:
SET enable_seqscan TO off;
EXPLAIN (COSTS OFF) SELECT * FROM test_array WHERE i && '{1}' ORDER BY i <=> '{1}' ASC;
QUERY PLAN
------------------------------------------
Index Scan using idx_array on test_array
Index Cond: (i && '{1}'::smallint[])
Order By: (i <=> '{1}'::smallint[])
(3 rows)
SELECT * FROM test_array WHERE i && '{1}' ORDER BY i <=> '{1}' ASC;
i
-----------
{1}
{1,2}
{1,2,3}
{1,2,3,4}
(4 rows)F.58.6. Авторы
Александр Коротков
Олег Бартунов
Фёдор Сигаев
F.58. rum
F.58.1. Introduction
The rum module provides access method to work with the RUM indexes. It is based on the GIN access method code.
GIN index allows you to perform fast full-text search using tsvector and tsquery types. However, full-text search with GIN index has some performance issues because positional and other additional information is not stored.
RUM solves these issues by storing additional information in a posting tree. As compared to GIN, RUM index has the following benefits:
Faster ranking. Ranking requires positional information. And after the index scan we do not need an additional heap scan to retrieve lexeme positions because
RUMindex stores them.Faster phrase search. This improvement is related to the previous one as phrase search also needs positional information.
Faster ordering by timestamp.
RUMindex stores additional information together with lexemes, so it is not necessary to perform a heap scan.A possibility to perform depth-first search and therefore return first results immediately.
The drawback of RUM is that it has slower build and insert time as compared to GIN because RUM stores additional information together with keys and uses generic WAL records.
F.58.2. Installation
rum is a Postgres Pro Enterprise extension and it has no special prerequisites.
Install extension as follows:
$ psql dbname -c "CREATE EXTENSION rum"
F.58.3. Common Operators
The operators provided by the rum module are shown in Table F.40:
Table F.40. rum Operators
| Operator | Returns | Description |
|---|---|---|
tsvector <=> tsquery | float4 | Returns distance between tsvector and tsquery values. |
timestamp <=> timestamp | float8 | Returns distance between two timestamp values. |
timestamp <=| timestamp | float8 | Returns distance only for ascending timestamp values. |
timestamp |=> timestamp | float8 | Returns distance only for descending timestamp values. |
Note
rum introduces its own ranking function that is executed inside the <=> operator. It calculates the score (inverted distance) using the specified normalization method. This function is a combination of ts_rank and ts_rank_cd (see Section 9.13 for details). While ts_rank does not support logical operators and ts_rank_cd works poorly with OR queries, the rum-specific ranking function overcomes these drawbacks.
F.58.4. Operator Classes
The rum extension provides the following operator classes:
rum_tsvector_opsStores
tsvectorlexemes with positional information. Supports ordering by<=>operator and prefix search.rum_tsvector_hash_opsStores hash of
tsvectorlexemes with positional information. Supports ordering by<=>operator, but does not support prefix search.rum_tsvector_addon_opsStores
tsvectorlexemes with additional data of any type supported byRUM.rum_tsvector_hash_addon_opsStores
tsvectorlexemes with additional data of any type supported byRUM. Does not support prefix search.rum_tsquery_opsStores branches of query tree in additional information.
rum_anyarray_opsStores
anyarrayelements with length of the array. Supports ordering by <=> operator.Indexable operators:
&& @> <@ = %rum_anyarray_addon_opsStores
anyarrayelements with additional data of any type supported byRUM.rum_type_opsStores lexemes of the corresponding type with positional information. The
typeplaceholder in the class name must be substituted by one of the following type names:int2,int4,int8,float4,float8,money,oid,timestamp,timestamptz,time,timetz,date,interval,macaddr,inet,cidr,text,varchar,char,bytea,bit,varbit,numeric.rum_supports ordering bytype_ops<=>,<=|, and|=>operators. This operator class can be used together withrum_tsvector_addon_ops,rum_tsvector_hash_addon_ops, andrum_anyarray_addon_opsoperator classes.Supported indexable operators depend on the data type:
< <= = >= > <=> <=| |=>are supported forint2,int4,int8,float4,float8,money,oid,timestamp,timestamptz.< <= = >= >are supported fortime,timetz,date,interval,macaddr,inet,cidr,text,varchar,char,bytea,bit,varbit,numeric.
Note
The following operator classes are now deprecated: rum_tsvector_timestamp_ops, rum_tsvector_timestamptz_ops, rum_tsvector_hash_timestamp_ops, rum_tsvector_hash_timestamptz_ops.
F.58.5. Examples
F.58.5.1. rum_tsvector_ops Example
Let's assume we have the following table:
CREATE TABLE test_rum(t text, a tsvector);
CREATE TRIGGER tsvectorupdate
BEFORE UPDATE OR INSERT ON test_rum
FOR EACH ROW EXECUTE PROCEDURE tsvector_update_trigger('a', 'pg_catalog.english', 't');
INSERT INTO test_rum(t) VALUES ('The situation is most beautiful');
INSERT INTO test_rum(t) VALUES ('It is a beautiful');
INSERT INTO test_rum(t) VALUES ('It looks like a beautiful place');
Then we can create a new index:
CREATE INDEX rumidx ON test_rum USING rum (a rum_tsvector_ops);
And we can execute the following queries:
SELECT t, a <=> to_tsquery('english', 'beautiful | place') AS rank
FROM test_rum
WHERE a @@ to_tsquery('english', 'beautiful | place')
ORDER BY a <=> to_tsquery('english', 'beautiful | place');
t | rank
---------------------------------+-----------
The situation is most beautiful | 0.0303964
It is a beautiful | 0.0303964
It looks like a beautiful place | 0.0607927
(3 rows)
SELECT t, a <=> to_tsquery('english', 'place | situation') AS rank
FROM test_rum
WHERE a @@ to_tsquery('english', 'place | situation')
ORDER BY a <=> to_tsquery('english', 'place | situation');
t | rank
---------------------------------+-----------
The situation is most beautiful | 0.0303964
It looks like a beautiful place | 0.0303964
(2 rows)
F.58.5.2. rum_tsvector_addon_ops Example
Let's assume we have the following table:
CREATE TABLE tsts (id int, t tsvector, d timestamp);
\copy tsts from 'rum/data/tsts.data'
CREATE INDEX tsts_idx ON tsts USING rum (t rum_tsvector_addon_ops, d)
WITH (attach = 'd', to = 't');
Now we can execute the following queries:
EXPLAIN (costs off)
SELECT id, d, d <=> '2016-05-16 14:21:25' FROM tsts WHERE t @@ 'wr&qh' ORDER BY d <=> '2016-05-16 14:21:25' LIMIT 5;
QUERY PLAN
-----------------------------------------------------------------------------------
Limit
-> Index Scan using tsts_idx on tsts
Index Cond: (t @@ '''wr'' & ''qh'''::tsquery)
Order By: (d <=> 'Mon May 16 14:21:25 2016'::timestamp without time zone)
(4 rows)
SELECT id, d, d <=> '2016-05-16 14:21:25' FROM tsts WHERE t @@ 'wr&qh' ORDER BY d <=> '2016-05-16 14:21:25' LIMIT 5;
id | d | ?column?
-----+---------------------------------+---------------
355 | Mon May 16 14:21:22.326724 2016 | 2.673276
354 | Mon May 16 13:21:22.326724 2016 | 3602.673276
371 | Tue May 17 06:21:22.326724 2016 | 57597.326724
406 | Wed May 18 17:21:22.326724 2016 | 183597.326724
415 | Thu May 19 02:21:22.326724 2016 | 215997.326724
(5 rows)
F.58.5.3. rum_tsquery_ops Example
Suppose we have the table:
CREATE TABLE query (q tsquery, tag text);
INSERT INTO query VALUES ('supernova & star', 'sn'),
('black', 'color'),
('big & bang & black & hole', 'bang'),
('spiral & galaxy', 'shape'),
('black & hole', 'color');
CREATE INDEX query_idx ON query USING rum(q);
We can execute the following fast query:
SELECT * FROM query
WHERE to_tsvector('black holes never exists before we think about them') @@ q;
q | tag
------------------+-------
'black' | color
'black' & 'hole' | color
(2 rows)
F.58.5.4. rum_anyarray_ops Example
Let's assume we have the following table:
CREATE TABLE test_array (i int2[]);
INSERT INTO test_array VALUES ('{}'), ('{0}'), ('{1,2,3,4}'), ('{1,2,3}'), ('{1,2}'), ('{1}');
CREATE INDEX idx_array ON test_array USING rum (i rum_anyarray_ops);
Now we can execute the following query using index scan:
SET enable_seqscan TO off;
EXPLAIN (COSTS OFF) SELECT * FROM test_array WHERE i && '{1}' ORDER BY i <=> '{1}' ASC;
QUERY PLAN
------------------------------------------
Index Scan using idx_array on test_array
Index Cond: (i && '{1}'::smallint[])
Order By: (i <=> '{1}'::smallint[])
(3 rows)
SELECT * FROM test_array WHERE i && '{1}' ORDER BY i <=> '{1}' ASC;
i
-----------
{1}
{1,2}
{1,2,3}
{1,2,3,4}
(4 rows)
F.58.6. Authors
Alexander Korotkov
Oleg Bartunov
Teodor Sigaev