CREATE INDEX
CREATE INDEX — создать индекс
Синтаксис
CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ]имя
] ON [ ONLY ]имя_таблицы
[ USINGметод
] ( {имя_столбца
| (выражение
) } [ COLLATEправило_сортировки
] [класс_операторов
[ (параметр_класса_оп
=значение
[, ... ] ) ] ] [ ASC | DESC ] [ NULLS { FIRST | LAST } ] [, ...] ) [ INCLUDE (имя_столбца
[, ...] ) ] [ NULLS [ NOT ] DISTINCT ] [ WITH (параметр_хранения
[=значение
] [, ... ] ) ] [ TABLESPACEтабл_пространство
] [ WHEREпредикат
]
Описание
CREATE INDEX
создаёт индексы по указанному столбцу(ам) заданного отношения, которым может быть таблица или материализованное представление. Индексы применяются в первую очередь для оптимизации производительности базы данных (хотя при неправильном использовании возможен и противоположный эффект).
Ключевое поле для индекса задаётся как имя столбца или выражение, заключённое в скобки. Если метод индекса поддерживает составные индексы, допускается указание нескольких полей.
Поле индекса может быть выражением, вычисляемым из значений одного или нескольких столбцов в строке таблицы. Это может быть полезно для получения быстрого доступа к данным по некоторому преобразованию исходных значений. Например, индекс, построенный по выражению upper(col)
, позволит использовать поиск по индексу в предложении WHERE upper(col) = 'JIM'
.
Postgres Pro предоставляет следующие методы индексов: B-дерево, хеш, GiST, SP-GiST, GIN, RUM и BRIN. Пользователи могут определить и собственные методы индексов, но это довольно сложная задача.
Если в команде присутствует предложение WHERE
, она создаёт частичный индекс. Такой индекс содержит записи только для части таблицы, обычно более полезной для индексации, чем остальная таблица. Например, если таблица содержит информацию об оплаченных и неоплаченных счетах, при этом последних сравнительно немного, но именно эта часть таблицы наиболее востребована, то увеличить быстродействие можно, создав индекс только по этой части. Ещё одно возможное применение WHERE
— добавив UNIQUE
, обеспечить уникальность в подмножестве таблицы. Подробнее это рассматривается в Разделе 11.8.
Выражение в предложении WHERE
может ссылаться только на столбцы нижележащей таблицы, но не обязательно ограничиваться теми, по которым строится индекс. В настоящее время в WHERE
также нельзя использовать подзапросы и агрегатные выражения. Это же ограничение распространяется и на выражения в полях индексов.
Все функции и операторы, используемые в определении индекса, должны быть «постоянными», то есть, их результаты должны зависеть только от аргументов, но не от внешних факторов (например, содержимого другой таблицы или текущего времени). Это ограничение обеспечивает определённость поведения индекса. Чтобы использовать в выражении индекса или в предложении WHERE
собственную функцию, не забудьте пометить её при создании как постоянную (IMMUTABLE).
Параметры
UNIQUE
Указывает, что система должна контролировать повторяющиеся значения в таблице при создании индекса (если в таблице уже есть данные) и при каждом добавлении данных. Попытки вставить или изменить данные, при которых будет нарушена уникальность индекса, будут завершаться ошибкой.
Когда уникальные индексы применяются к секционированным таблицам, действуют дополнительные ограничения; см. CREATE TABLE.
CONCURRENTLY
С этим указанием Postgres Pro построит индекс, не устанавливая никаких блокировок, которые бы предотвращали добавление, изменение или удаление записей в таблице, тогда как по умолчанию операция построения индекса блокирует запись (но не чтение) данных в таблице до своего завершения. С созданием индекса в этом режиме связан ряд особенностей, о которых следует знать, — см. Неблокирующее построение индексов.
Для временных таблиц
CREATE INDEX
всегда выполняется более простым, неблокирующим способом, так как они не могут использоваться никакими другими сеансами.IF NOT EXISTS
Не считать ошибкой, если индекс с таким именем уже существует. В этом случае будет выдано замечание. Заметьте, что нет никакой гарантии, что существующий индекс как-то соотносится с тем, который мог бы быть создан. Имя индекса является обязательным, когда указывается
IF NOT EXISTS
.INCLUDE
Необязательное предложение
INCLUDE
позволяет указать список столбцов, которые войдут в индекс как неключевые столбцы. Неключевой столбец не может использоваться в условии поиска для сканирования по индексу, и он не учитывается при анализе ограничения уникальности или исключения, устанавливаемого индексом. Однако при сканировании только индекса содержимое неключевых столбцов может быть получено без обращения к целевой таблице, так как оно находится непосредственно в элементе индекса. Таким образом, в результате добавления неключевых столбцов сканирование только индекса может использоваться в тех запросах, где иначе оно было бы неприменимо.Добавляя в индекс неключевые столбцы, особенно большого размера, есть смысл проявлять консерватизм. Если кортеж в индексе превышает максимально допустимый размер для данного типа индексов, вставить данные в таблицу не удастся. В неключевых столбцах дублируются данные из основной таблицы, что приводит к раздуванию индекса и может повлечь замедление запросов. Кроме того, если неключевой столбец содержится в индексе B-дерево, в таком индексе не будет работать исключение дубликатов.
Для столбцов, перечисленных в
INCLUDE
, не нужны соответствующие классы операторов; это предложение может содержать столбцы, для типов данных которых не определены классы операторов для заданного метода доступа.Выражения в неключевых столбцах не поддерживаются, так как их нельзя будет использовать при сканировании только индекса.
В настоящее время эту возможность поддерживают методы доступа индексов B-дерево, GiST и SP-GiST. В таких индексах значения столбцов, указанных в предложении
INCLUDE
, включаются в кортежи на уровне листьев, которые соответствуют кортежам кучи, но не включаются в элементы верхних уровней, используемые для навигации в дереве.имя
Имя создаваемого индекса. Указание схемы при этом не допускается; индекс всегда относится к той же схеме, что и родительская таблица. Имя индекса должно отличаться от имени любого другого отношения (таблицы, последовательности, индекса, представления, материализованного представления или сторонней таблицы) в этой схеме. Если имя опущено, Postgres Pro формирует подходящее имя по имени родительской таблицы и именам индексируемых столбцов.
ONLY
Указывает, что индексы не должны рекурсивно создаваться в секциях секционированной таблицы. По умолчанию создание выполняется рекурсивно.
имя_таблицы
Имя индексируемой таблицы (возможно, дополненное схемой).
метод
Имя применяемого метода индекса. Возможные варианты:
btree
,hash
,gist
,spgist
,gin
,brin
или установленный пользователем метод, например bloom. По умолчанию подразумевается методbtree
.имя_столбца
Имя столбца таблицы.
выражение
Выражение с одним или несколькими столбцами таблицы. Обычно выражение должно записываться в скобках, как показано в синтаксисе команды. Однако скобки можно опустить, если выражение записано в виде вызова функции.
правило_сортировки
Имя правила сортировки, применяемого для индекса. По умолчанию используется правило сортировки, заданное для индексируемого столбца, либо полученное для результата выражения индекса. Индексы с нестандартными правилами сортировки могут быть полезны для запросов, включающих выражения с такими правилами.
класс_операторов
Имя класса операторов. Подробнее об этом ниже.
параметр_класса_оп
Имя параметра класса операторов. Подробнее об этом ниже.
ASC
Указывает порядок сортировки по возрастанию (подразумевается по умолчанию).
DESC
Указывает порядок сортировки по убыванию.
NULLS FIRST
Указывает, что значения NULL после сортировки оказываются перед остальными. Это поведение по умолчанию с порядком сортировки
DESC
.NULLS LAST
Указывает, что значения NULL после сортировки оказываются после остальных. Это поведение по умолчанию с порядком сортировки
ASC
.NULLS DISTINCT
NULLS NOT DISTINCT
Определяет, должны ли значения NULL считаться различными (не равными) для уникального индекса. По умолчанию они считаются различными, поэтому уникальный индекс может содержать в столбце несколько значений NULL.
параметр_хранения
Имя специфичного для индекса параметра хранения. За подробностями обратитесь к разделу Параметры хранения индекса ниже.
табл_пространство
Табличное пространство, в котором будет создан индекс. Если не определено, выбирается default_tablespace, либо temp_tablespaces, при создании индекса временной таблицы.
предикат
Выражение ограничения для частичного индекса.
Параметры хранения индекса #
Необязательное предложение WITH
определяет параметры хранения для индекса. У каждого метода индекса есть свой набор допустимых параметров хранения. Следующий параметр принимают методы B-дерево, хеш, GiST и SP-GiST:
fillfactor
(integer
) #Фактор заполнения для индекса определяет в процентном отношении, насколько плотно метод индекса будет заполнять страницы индекса. Для B-деревьев концевые страницы заполняются до этого процента при начальном построении индекса и позже, при расширении индекса вправо (добавлении новых наибольших значений ключа). Если страницы впоследствии оказываются заполненными полностью, они будут разделены, что приводит к фрагментации структуры индекса на диске. Для B-деревьев по умолчанию используется фактор заполнения 90, но его можно поменять на любое целое число от 10 до 100.
Для индексов-B-деревьев в таблицах, где ожидается множество добавлений и/или изменений записей, имеет смысл выбрать меньшие значения фактора заполнения в момент выполнения
CREATE INDEX
(до массовой загрузки данных в таблицы). Значения в диапазоне 50 – 90 могут сгладить всплески разделений страниц на начальном этапе жизни индекса-B-дерева (при подобном снижении фактора заполнения может даже уменьшиться абсолютное количество разделений страниц, хотя это во многом зависит от нагрузки). Процедура восходящего удаления индексных кортежей, описанная в Подразделе 64.4.2, рассчитывает на наличие некоторого «дополнительного» места на страницах, где будут сохраняться «дополнительные» версии кортежей, и следовательно, может зависеть от фактора заполнения (хотя обычно его влияние второстепенно).В других особых случаях может быть полезно увеличить фактор заполнения до 100 перед выполнением
CREATE INDEX
, чтобы максимально эффективно использовать хранилище. Этот вариант следует рассматривать, только если вы абсолютно уверены, что таблица будет статичной (то есть в ней никогда не будут изменяться или добавляться данные). В противном случае фактор заполнения, равный 100, скорее повредит производительности — даже единичные изменения или добавления вызовут резкий скачок активности разделения страниц.Другие индексные методы используют фактор заполнения по-своему, но примерно в том же ключе; значение по умолчанию для разных методов разное.
Индексы B-дерево дополнительно принимают этот параметр:
deduplicate_items
(boolean
) #Этот параметр управляет механизмом исключения дубликатов, описанным в Подразделе 64.4.3. Он принимает логическое значение
ON
илиOFF
, соответственно включающее или отключающее это оптимизацию. (Другие возможные написанияON
иOFF
перечислены в Разделе 18.1.) Значение по умолчанию —ON
.Примечание
После выключения параметра
deduplicate_items
командойALTER INDEX
при добавлении в будущем новых элементов дубликаты исключаться не будут, но представление существующих кортежей не поменяется на стандартное.
Индексы GiST дополнительно принимают этот параметр:
buffering
(enum
) #Определяет, будет ли при построении индекса использоваться буферизация, описанная в Подразделе 65.4.1. Со значением
OFF
она отключена, сON
— включена, а сAUTO
— отключена вначале, но может затем включиться на ходу, как только размер индекса достигнет значения effective_cache_size. Значение по умолчанию —AUTO
. Заметьте, что если возможно построить индекс с сортировкой, именно этот метод будет использоваться при любом значении, кромеbuffering=ON
.
Индексы GIN принимают другие параметры:
fastupdate
(boolean
) #Этот параметр управляет механизмом быстрого обновления, описанным в Подразделе 67.4.1. Он имеет логическое значение:
ON
включает быстрое обновление,OFF
отключает его. Значение по умолчанию —ON
.Примечание
Выключение
fastupdate
вALTER INDEX
предотвращает помещение добавляемых в дальнейшем строк в список записей, ожидающих индексации, но записи, добавленные в этот список ранее, в нём остаются. Чтобы очистить очередь операций, надо затем выполнитьVACUUM
для этой таблицы или вызвать функциюgin_clean_pending_list
.
gin_pending_list_limit
(integer
) #Пользовательский параметр gin_pending_list_limit. Его значение задаётся в килобайтах.
Индексы RUM принимают другие параметры:
attach
(text
) #Этот параметр задаёт имя столбца, который нужно присоединить в качестве дополнительной информации.
to
(text
) #Этот параметр задаёт имя столбца, по которому добавляется упорядочивание.
order_by_attach
(boolean
) #Этот параметр задаёт упорядочение по
attach
иitempointer
вместо упорядочения только поitempointer
.
Индексы BRIN принимают другие параметры:
pages_per_range
(integer
) #Определяет, сколько блоков таблицы образуют зону блоков для каждой записи в индексе BRIN (за подробностями обратитесь к Разделу 68.1). Значение по умолчанию —
128
.autosummarize
(boolean
) #Определяет, будет ли поставлен в очередь расчёт сводного значения для предыдущей зоны страниц, когда происходит добавление в следующую. За подробностями обратитесь к Подразделу 68.1.1. По умолчанию
off
.
Неблокирующее построение индексов #
Создание индекса может мешать обычной работе с базой данных. Обычно Postgres Pro блокирует запись в индексируемую таблицу и выполняет всю операцию построения индекса за одно сканирование таблицы. Другие транзакции могут продолжать читать таблицу, но при попытке вставить, изменить или удалить строки в таблице они будут заблокированы до завершения построения индекса. Это может оказать нежелательное влияние на работу производственной базы данных. Индексация очень больших таблиц может занимать много часов, и даже для маленьких таблиц построение индекса может заблокировать записывающие процессы на время, неприемлемое для производственной системы.
Postgres Pro поддерживает построение индексов без блокировки записи. Этот метод выбирается указанием CONCURRENTLY
команды CREATE INDEX
. Когда он используется, Postgres Pro должен выполнить два сканирования таблицы, а кроме того, должен дождаться завершения всех существующих транзакций, которые потенциально могут модифицировать и использовать этот индекс. Таким образом, эта процедура требует проделать в сумме больше действий и выполняется значительно дольше, чем обычное построение индекса. Однако благодаря тому, что этот метод позволяет продолжать обычную работу с базой во время построения индекса, он оказывается полезным в производственной среде. Хотя разумеется, дополнительная нагрузка на процессор и подсистему ввода/вывода, создаваемая при построении индекса, может привести к замедлению других операций.
При неблокирующем построении индекса он как «нерабочий» добавляется в системный каталог в одной транзакции, а затем в двух других транзакциях выполняются ещё два сканирования таблицы. Перед каждым сканированием таблицы процедура построения индекса должна ждать завершения текущих транзакций, модифицировавших эту таблицу. После второго сканирования также необходимо дожидаться завершения всех транзакций, получивших снимок (см. Главу 13) перед вторым сканированием, включая транзакции, задействованные на любом этапе неблокирующего построения индексов для других таблиц (это касается частичных индексов и индексов, построенных не просто по столбцам). Наконец индекс может быть помечен как «рабочий» и готовый к использованию, после чего команда CREATE INDEX
завершается. Однако даже тогда индекс может быть не готов немедленно к применению в запросах: в худшем случае он не будет использоваться, пока существуют транзакции, начатые до начала построения индекса.
Если при сканировании таблицы возникает проблема, например взаимоблокировка или нарушение уникальности в уникальном индексе, команда CREATE INDEX
завершится ошибкой, но оставит после себя «нерабочий» индекс. Этот индекс будет игнорироваться при чтении данных, так как он может быть неполным; однако с ним могут быть связаны дополнительные операции при изменениях. В psql встроенная команда \d
помечает такой индекс как INVALID
:
postgres=# \d tab Table "public.tab" Column | Type | Collation | Nullable | Default --------+---------+-----------+----------+--------- col | integer | | | Indexes: "idx" btree (col) INVALID
Рекомендуемый в таких случаях способ исправления ситуации — удалить индекс и затем попытаться снова выполнить CREATE INDEX CONCURRENTLY
. (Кроме того, можно перестроить его с помощью команды REINDEX INDEX CONCURRENTLY
.)
Ещё одна сложность, с которой можно столкнуться при неблокирующем построении уникального индекса, заключается в том, что ограничение уникальности уже влияет на другие транзакции, когда второе сканирование таблицы только начинается. Это значит, что нарушения ограничения могут проявляться в других запросах до того, как индекс становится доступным для использования и даже тогда, когда создать индекс в итоге не удаётся. Кроме того, если при втором сканировании происходит ошибка, «нерабочий» индекс оставляет в силе своё ограничение уникальности и дальше.
Метод неблокирующего построения поддерживает также индексы выражений и частичные индексы. Ошибки, произошедшие при вычислении этих выражений, могут привести к такому же поведению, как в вышеописанных случаях с нарушением ограничений уникальности.
Обычное построение индекса допускает одновременное построение других индексов для таблицы обычным методом, но неблокирующее построение для конкретной таблицы в один момент времени допускается только одно. Однако в любом случае никакие другие изменения схемы таблицы в это время не разрешаются. Другое отличие состоит в том, что в блоке транзакции может быть выполнена обычная команда CREATE INDEX
, но не CREATE INDEX CONCURRENTLY
.
Метод неблокирующего построения для индексов секционированных таблиц в настоящее время не поддерживается. Однако вы можете сократить время, на которое будет заблокирована секционированная таблица, построив в неблокирующем режиме индекс для каждой секции в отдельности и затем создав секционированный индекс в обычном режиме. В этом случае построение секционированного индекса будет заключаться только в изменении метаданных.
Примечания
Информацию о том, когда могут применяться, и когда не применяются индексы, и в каких конкретных ситуациях они могут быть полезны, можно найти в Главе 11.
В настоящее время индексы с несколькими ключевыми столбцами поддерживаются только методами B-дерево, GiST, GIN и BRIN. Возможность построения индекса по нескольким ключевым столбцам не зависит от поддержки включения в индекс неключевых столбцов (INCLUDE
). Индексы могут содержать до 32 столбцов, в том числе неключевых. (Этот предел можно изменить, пересобрав Postgres Pro.) Уникальные индексы поддерживает только метод B-дерево.
Для каждого столбца индекса можно задать класс операторов и дополнительные параметры класса. Данный класс определяет, какие операторы будут использоваться индексом для этого столбца. Например, индекс-B-дерево по четырёхбайтовым целым будет использовать класс int4_ops
; этот класс операторов включает функции сравнения для таких значений. На практике обычно достаточно использовать класс операторов по умолчанию для типа данных столбца. Существование классов операторов объясняется в первую очередь тем, что для некоторых типов данных можно предложить более одного осмысленного порядка сортировки. Например, может возникнуть желание отсортировать комплексные числа как по абсолютному значению, так и по вещественной части. Это можно сделать, определив два класса операторов для типа данных и выбрав подходящий класс при создании индекса. За дополнительными сведениями о классах операторов обратитесь к Разделу 11.10 и Разделу 37.16.
Когда команда CREATE INDEX
вызывается для секционированной таблицы, по умолчанию её действие распространятся рекурсивно на все секции, с тем чтобы в них оказались соответствующие индексы. Сначала каждая секция проверяется на наличие равнозначного индекса, и, если таковой находится, он присоединяется как индекс секции к создаваемому, который таким образом становится родительским индексом. Если нужного индекса не оказывается, новый индекс автоматически создаётся и присоединяется к основному; имя индекса для каждой секции выбирается так же, как и при выполнении этой команды без имени индекса. С указанием ONLY
рекурсия не производится и индекс помечается как нерабочий. (Команда ALTER INDEX ... ATTACH PARTITION
пометит его как рабочий, когда он будет представлен во всех секциях). Однако заметьте, что в любой секции, создаваемой в будущем командой CREATE TABLE ... PARTITION OF
, соответствующий индекс появится автоматически, вне зависимости от данного указания.
Для методов индекса, поддерживающих сканирование по порядку (в настоящее время это поддерживает только B-дерево), можно изменить порядок сортировки индекса, добавив необязательные предложения ASC
, DESC
, NULLS FIRST
или NULLS LAST
. Так как упорядоченный индекс можно сканировать вперёд или назад, обычно не имеет смысла создавать индекс по убыванию (DESC
) для одного столбца — этот порядок сортировки можно получить и с обычным индексом. Эти параметры имеют смысл при создании составных индексов так, что они будут соответствовать порядку сортировки, указанному в запросе со смешанным порядком, например SELECT ... ORDER BY x ASC, y DESC
. Параметры NULLS
полезны, когда требуется реализовать поведение «NULL внизу», изменив стандартное «NULL вверху», в запросах, зависящих от индексов, чтобы избежать дополнительной сортировки.
Система регулярно собирает статистику по всем столбцам таблицы. Новые индексы, построенные без применения выражений, могут эффективно использовать эту статистику сразу. Однако для создаваемых индексов по выражениям требуется выполнить ANALYZE
или подождать, пока фоновый процесс автоочистки не проанализирует таблицу и не посчитает статистику для этих индексов.
Для большинства методов индексов скорость создания индекса зависит от значения maintenance_work_mem. Чем больше это значение, тем меньше времени требуется для создания индекса (если только заданное значение не превышает объём действительно доступной памяти, что влечёт за собой использование подкачки).
Postgres Pro может строить индексы, задействуя несколько процессоров для ускорения обработки строк таблицы. Это называется параллельным построением индексов. Для методов индексов, поддерживающих построение в параллельном режиме (в настоящее время это только B-дерево), параметр maintenance_work_mem
задаёт максимальный объём памяти, который может быть выделен для одной операции построения индекса в целом, независимо от того, сколько рабочих процессов будет запущено. Целесообразность использования параллельных процессов и их оптимальное количество обычно автоматически определяется моделью стоимости.
Параллельное построение индексов может выиграть от увеличения maintenance_work_mem
там, где для аналогичного последовательного построения индекса выигрыша не будет или он будет минимальным. Заметьте, что значение maintenance_work_mem
может влиять на число запрашиваемых рабочих процессов, так как параллельным исполнителям должно быть выделено не менее 32MB
из общего бюджета maintenance_work_mem
. Кроме того, 32MB
должно остаться для ведущего процесса. Увеличение max_parallel_maintenance_workers позволит создать больше исполнителей, что приведёт к уменьшению времени создания индекса, если только создание индекса уже не упирается в скорость ввода/вывода. Разумеется, для этого должно быть достаточно процессорных ресурсов, которые иначе бы простаивали.
Если в ALTER TABLE
задаётся значение parallel_workers
, именно оно определяет, сколько параллельных исполнителей будет запрашивать команда CREATE INDEX
для данной таблицы. При этом полностью игнорируется модель стоимости и maintenance_work_mem
не влияет на определение количества параллельных исполнителей. Если параметру parallel_workers
в ALTER TABLE
присваивается 0, параллельное построение индексов для этой таблицы полностью отключается.
Подсказка
После изменения параметра parallel_workers
в ходе оптимизации построения индексов имеет смысл сбросить его. Это предотвратит нежелательные изменения планов запросов, так как parallel_workers
влияет на все параллельные сканирования таблицы.
Хотя CREATE INDEX
с указанием CONCURRENTLY
поддерживает параллельное построение без особых ограничений, фактически в параллельном режиме выполняется только первое сканирование таблицы.
Для удаления индекса применяется DROP INDEX
.
Как и любая длительная транзакция, операция CREATE INDEX
с таблицей может повлиять на возможность удаления кортежей параллельной операцией VACUUM
с какой-либо другой таблицей.
В предыдущих выпусках Postgres Pro также поддерживался метод индекса R-дерево. Сейчас он отсутствует, так как он не даёт значительных преимуществ по сравнению с GiST. Указание USING rtree
команда CREATE INDEX
будет интерпретировать как USING gist
, для упрощения перевода старых баз на GiST.
Каждый процесс, выполняющий операцию CREATE INDEX
, будет выдавать информацию о ходе её выполнения, отображаемую в представлении pg_stat_progress_create_index
. За подробностями обратитесь к Подразделу 26.4.4.
Примеры
Создание уникального индекса-B-дерева по столбцу title
в таблице films
:
CREATE UNIQUE INDEX title_idx ON films (title);
Создание уникального индекса-B-дерева по столбцу title
с неключевыми столбцами director
и rating
в таблице films
:
CREATE UNIQUE INDEX title_idx ON films (title) INCLUDE (director, rating);
Создание индекса B-дерево без исключения дубликатов:
CREATE INDEX title_idx ON films (title) WITH (deduplicate_items = off);
Создание индекса по выражению lower(title)
, позволяющего эффективно выполнять регистронезависимый поиск:
CREATE INDEX ON films ((lower(title)));
(В этом примере мы решили опустить имя индекса, чтобы имя выбрала система, например films_lower_idx
.)
Создание индекса с нестандартным правилом сортировки:
CREATE INDEX title_idx_german ON films (title COLLATE "de_DE");
Создание индекса с нестандартным порядком значений NULL:
CREATE INDEX title_idx_nulls_low ON films (title NULLS FIRST);
Создание индекса с нестандартным фактором заполнения:
CREATE UNIQUE INDEX title_idx ON films (title) WITH (fillfactor = 70);
Создание индекса GIN с отключённым механизмом быстрого обновления:
CREATE INDEX gin_idx ON documents_table USING GIN (locations) WITH (fastupdate = off);
Создание индекса по столбцу code
в таблице films
и размещение его в табличном пространстве indexspace
:
CREATE INDEX code_idx ON films (code) TABLESPACE indexspace;
Создание индекса GiST по координатам точек, позволяющего эффективно использовать операторы box с результатом функции преобразования:
CREATE INDEX pointloc ON points USING gist (box(location,location)); SELECT * FROM points WHERE box(location,location) && '(0,0),(1,1)'::box;
Создание индекса без блокировки записи в таблицу:
CREATE INDEX CONCURRENTLY sales_quantity_index ON sales_table (quantity);
Совместимость
CREATE INDEX
является языковым расширением Postgres Pro. Средства обеспечения индексов в стандарте SQL не описаны.
См. также
ALTER INDEX, DROP INDEX, REINDEX, Подраздел 26.4.4CREATE INDEX
CREATE INDEX — define a new index
Synopsis
CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ]name
] ON [ ONLY ]table_name
[ USINGmethod
] ( {column_name
| (expression
) } [ COLLATEcollation
] [opclass
[ (opclass_parameter
=value
[, ... ] ) ] ] [ ASC | DESC ] [ NULLS { FIRST | LAST } ] [, ...] ) [ INCLUDE (column_name
[, ...] ) ] [ NULLS [ NOT ] DISTINCT ] [ WITH (storage_parameter
[=value
] [, ... ] ) ] [ TABLESPACEtablespace_name
] [ WHEREpredicate
]
Description
CREATE INDEX
constructs an index on the specified column(s) of the specified relation, which can be a table or a materialized view. Indexes are primarily used to enhance database performance (though inappropriate use can result in slower performance).
The key field(s) for the index are specified as column names, or alternatively as expressions written in parentheses. Multiple fields can be specified if the index method supports multicolumn indexes.
An index field can be an expression computed from the values of one or more columns of the table row. This feature can be used to obtain fast access to data based on some transformation of the basic data. For example, an index computed on upper(col)
would allow the clause WHERE upper(col) = 'JIM'
to use an index.
Postgres Pro provides the index methods B-tree, hash, GiST, SP-GiST, GIN, RUM, and BRIN. Users can also define their own index methods, but that is fairly complicated.
When the WHERE
clause is present, a partial index is created. A partial index is an index that contains entries for only a portion of a table, usually a portion that is more useful for indexing than the rest of the table. For example, if you have a table that contains both billed and unbilled orders where the unbilled orders take up a small fraction of the total table and yet that is an often used section, you can improve performance by creating an index on just that portion. Another possible application is to use WHERE
with UNIQUE
to enforce uniqueness over a subset of a table. See Section 11.8 for more discussion.
The expression used in the WHERE
clause can refer only to columns of the underlying table, but it can use all columns, not just the ones being indexed. Presently, subqueries and aggregate expressions are also forbidden in WHERE
. The same restrictions apply to index fields that are expressions.
All functions and operators used in an index definition must be “immutable”, that is, their results must depend only on their arguments and never on any outside influence (such as the contents of another table or the current time). This restriction ensures that the behavior of the index is well-defined. To use a user-defined function in an index expression or WHERE
clause, remember to mark the function immutable when you create it.
Parameters
UNIQUE
Causes the system to check for duplicate values in the table when the index is created (if data already exist) and each time data is added. Attempts to insert or update data which would result in duplicate entries will generate an error.
Additional restrictions apply when unique indexes are applied to partitioned tables; see CREATE TABLE.
CONCURRENTLY
When this option is used, Postgres Pro will build the index without taking any locks that prevent concurrent inserts, updates, or deletes on the table; whereas a standard index build locks out writes (but not reads) on the table until it's done. There are several caveats to be aware of when using this option — see Building Indexes Concurrently below.
For temporary tables,
CREATE INDEX
is always non-concurrent, as no other session can access them, and non-concurrent index creation is cheaper.IF NOT EXISTS
Do not throw an error if a relation with the same name already exists. A notice is issued in this case. Note that there is no guarantee that the existing index is anything like the one that would have been created. Index name is required when
IF NOT EXISTS
is specified.INCLUDE
The optional
INCLUDE
clause specifies a list of columns which will be included in the index as non-key columns. A non-key column cannot be used in an index scan search qualification, and it is disregarded for purposes of any uniqueness or exclusion constraint enforced by the index. However, an index-only scan can return the contents of non-key columns without having to visit the index's table, since they are available directly from the index entry. Thus, addition of non-key columns allows index-only scans to be used for queries that otherwise could not use them.It's wise to be conservative about adding non-key columns to an index, especially wide columns. If an index tuple exceeds the maximum size allowed for the index type, data insertion will fail. In any case, non-key columns duplicate data from the index's table and bloat the size of the index, thus potentially slowing searches. Furthermore, B-tree deduplication is never used with indexes that have a non-key column.
Columns listed in the
INCLUDE
clause don't need appropriate operator classes; the clause can include columns whose data types don't have operator classes defined for a given access method.Expressions are not supported as included columns since they cannot be used in index-only scans.
Currently, the B-tree, GiST and SP-GiST index access methods support this feature. In these indexes, the values of columns listed in the
INCLUDE
clause are included in leaf tuples which correspond to heap tuples, but are not included in upper-level index entries used for tree navigation.name
The name of the index to be created. No schema name can be included here; the index is always created in the same schema as its parent table. The name of the index must be distinct from the name of any other relation (table, sequence, index, view, materialized view, or foreign table) in that schema. If the name is omitted, Postgres Pro chooses a suitable name based on the parent table's name and the indexed column name(s).
ONLY
Indicates not to recurse creating indexes on partitions, if the table is partitioned. The default is to recurse.
table_name
The name (possibly schema-qualified) of the table to be indexed.
method
The name of the index method to be used. Choices are
btree
,hash
,gist
,spgist
,gin
,brin
, or user-installed access methods like bloom. The default method isbtree
.column_name
The name of a column of the table.
expression
An expression based on one or more columns of the table. The expression usually must be written with surrounding parentheses, as shown in the syntax. However, the parentheses can be omitted if the expression has the form of a function call.
collation
The name of the collation to use for the index. By default, the index uses the collation declared for the column to be indexed or the result collation of the expression to be indexed. Indexes with non-default collations can be useful for queries that involve expressions using non-default collations.
opclass
The name of an operator class. See below for details.
opclass_parameter
The name of an operator class parameter. See below for details.
ASC
Specifies ascending sort order (which is the default).
DESC
Specifies descending sort order.
NULLS FIRST
Specifies that nulls sort before non-nulls. This is the default when
DESC
is specified.NULLS LAST
Specifies that nulls sort after non-nulls. This is the default when
DESC
is not specified.NULLS DISTINCT
NULLS NOT DISTINCT
Specifies whether for a unique index, null values should be considered distinct (not equal). The default is that they are distinct, so that a unique index could contain multiple null values in a column.
storage_parameter
The name of an index-method-specific storage parameter. See Index Storage Parameters below for details.
tablespace_name
The tablespace in which to create the index. If not specified, default_tablespace is consulted, or temp_tablespaces for indexes on temporary tables.
predicate
The constraint expression for a partial index.
Index Storage Parameters #
The optional WITH
clause specifies storage parameters for the index. Each index method has its own set of allowed storage parameters. The B-tree, hash, GiST and SP-GiST index methods all accept this parameter:
fillfactor
(integer
) #The fillfactor for an index is a percentage that determines how full the index method will try to pack index pages. For B-trees, leaf pages are filled to this percentage during initial index builds, and also when extending the index at the right (adding new largest key values). If pages subsequently become completely full, they will be split, leading to fragmentation of the on-disk index structure. B-trees use a default fillfactor of 90, but any integer value from 10 to 100 can be selected.
B-tree indexes on tables where many inserts and/or updates are anticipated can benefit from lower fillfactor settings at
CREATE INDEX
time (following bulk loading into the table). Values in the range of 50 - 90 can usefully “smooth out” the rate of page splits during the early life of the B-tree index (lowering fillfactor like this may even lower the absolute number of page splits, though this effect is highly workload dependent). The B-tree bottom-up index deletion technique described in Section 64.4.2 is dependent on having some “extra” space on pages to store “extra” tuple versions, and so can be affected by fillfactor (though the effect is usually not significant).In other specific cases it might be useful to increase fillfactor to 100 at
CREATE INDEX
time as a way of maximizing space utilization. You should only consider this when you are completely sure that the table is static (i.e. that it will never be affected by either inserts or updates). A fillfactor setting of 100 otherwise risks harming performance: even a few updates or inserts will cause a sudden flood of page splits.The other index methods use fillfactor in different but roughly analogous ways; the default fillfactor varies between methods.
B-tree indexes additionally accept this parameter:
deduplicate_items
(boolean
) #Controls usage of the B-tree deduplication technique described in Section 64.4.3. Set to
ON
orOFF
to enable or disable the optimization. (Alternative spellings ofON
andOFF
are allowed as described in Section 18.1.) The default isON
.Note
Turning
deduplicate_items
off viaALTER INDEX
prevents future insertions from triggering deduplication, but does not in itself make existing posting list tuples use the standard tuple representation.
GiST indexes additionally accept this parameter:
buffering
(enum
) #Determines whether the buffered build technique described in Section 65.4.1 is used to build the index. With
OFF
buffering is disabled, withON
it is enabled, and withAUTO
it is initially disabled, but is turned on on-the-fly once the index size reaches effective_cache_size. The default isAUTO
. Note that if sorted build is possible, it will be used instead of buffered build unlessbuffering=ON
is specified.
GIN indexes accept different parameters:
fastupdate
(boolean
) #This setting controls usage of the fast update technique described in Section 67.4.1. It is a Boolean parameter:
ON
enables fast update,OFF
disables it. The default isON
.Note
Turning
fastupdate
off viaALTER INDEX
prevents future insertions from going into the list of pending index entries, but does not in itself flush previous entries. You might want toVACUUM
the table or callgin_clean_pending_list
function afterward to ensure the pending list is emptied.
gin_pending_list_limit
(integer
) #Custom gin_pending_list_limit parameter. This value is specified in kilobytes.
RUM indexes accept different parameters:
attach
(text
) #This setting specifies the name of the column to attach as additional information.
to
(text
) #This setting specifies the name of the column to add ordering by.
order_by_attach
(boolean
) #This setting controls whether to use the (
attach
,itempointer
) order instead of justitempointer
.
BRIN indexes accept different parameters:
pages_per_range
(integer
) #Defines the number of table blocks that make up one block range for each entry of a BRIN index (see Section 68.1 for more details). The default is
128
.autosummarize
(boolean
) #Defines whether a summarization run is queued for the previous page range whenever an insertion is detected on the next one. See Section 68.1.1 for more details. The default is
off
.
Building Indexes Concurrently #
Creating an index can interfere with regular operation of a database. Normally Postgres Pro locks the table to be indexed against writes and performs the entire index build with a single scan of the table. Other transactions can still read the table, but if they try to insert, update, or delete rows in the table they will block until the index build is finished. This could have a severe effect if the system is a live production database. Very large tables can take many hours to be indexed, and even for smaller tables, an index build can lock out writers for periods that are unacceptably long for a production system.
Postgres Pro supports building indexes without locking out writes. This method is invoked by specifying the CONCURRENTLY
option of CREATE INDEX
. When this option is used, Postgres Pro must perform two scans of the table, and in addition it must wait for all existing transactions that could potentially modify or use the index to terminate. Thus this method requires more total work than a standard index build and takes significantly longer to complete. However, since it allows normal operations to continue while the index is built, this method is useful for adding new indexes in a production environment. Of course, the extra CPU and I/O load imposed by the index creation might slow other operations.
In a concurrent index build, the index is actually entered as an “invalid” index into the system catalogs in one transaction, then two table scans occur in two more transactions. Before each table scan, the index build must wait for existing transactions that have modified the table to terminate. After the second scan, the index build must wait for any transactions that have a snapshot (see Chapter 13) predating the second scan to terminate, including transactions used by any phase of concurrent index builds on other tables, if the indexes involved are partial or have columns that are not simple column references. Then finally the index can be marked “valid” and ready for use, and the CREATE INDEX
command terminates. Even then, however, the index may not be immediately usable for queries: in the worst case, it cannot be used as long as transactions exist that predate the start of the index build.
If a problem arises while scanning the table, such as a deadlock or a uniqueness violation in a unique index, the CREATE INDEX
command will fail but leave behind an “invalid” index. This index will be ignored for querying purposes because it might be incomplete; however it will still consume update overhead. The psql \d
command will report such an index as INVALID
:
postgres=# \d tab Table "public.tab" Column | Type | Collation | Nullable | Default --------+---------+-----------+----------+--------- col | integer | | | Indexes: "idx" btree (col) INVALID
The recommended recovery method in such cases is to drop the index and try again to perform CREATE INDEX CONCURRENTLY
. (Another possibility is to rebuild the index with REINDEX INDEX CONCURRENTLY
).
Another caveat when building a unique index concurrently is that the uniqueness constraint is already being enforced against other transactions when the second table scan begins. This means that constraint violations could be reported in other queries prior to the index becoming available for use, or even in cases where the index build eventually fails. Also, if a failure does occur in the second scan, the “invalid” index continues to enforce its uniqueness constraint afterwards.
Concurrent builds of expression indexes and partial indexes are supported. Errors occurring in the evaluation of these expressions could cause behavior similar to that described above for unique constraint violations.
Regular index builds permit other regular index builds on the same table to occur simultaneously, but only one concurrent index build can occur on a table at a time. In either case, schema modification of the table is not allowed while the index is being built. Another difference is that a regular CREATE INDEX
command can be performed within a transaction block, but CREATE INDEX CONCURRENTLY
cannot.
Concurrent builds for indexes on partitioned tables are currently not supported. However, you may concurrently build the index on each partition individually and then finally create the partitioned index non-concurrently in order to reduce the time where writes to the partitioned table will be locked out. In this case, building the partitioned index is a metadata only operation.
Notes
See Chapter 11 for information about when indexes can be used, when they are not used, and in which particular situations they can be useful.
Currently, only the B-tree, GiST, GIN, and BRIN index methods support multiple-key-column indexes. Whether there can be multiple key columns is independent of whether INCLUDE
columns can be added to the index. Indexes can have up to 32 columns, including INCLUDE
columns. (This limit can be altered when building Postgres Pro.) Only B-tree currently supports unique indexes.
An operator class with optional parameters can be specified for each column of an index. The operator class identifies the operators to be used by the index for that column. For example, a B-tree index on four-byte integers would use the int4_ops
class; this operator class includes comparison functions for four-byte integers. In practice the default operator class for the column's data type is usually sufficient. The main point of having operator classes is that for some data types, there could be more than one meaningful ordering. For example, we might want to sort a complex-number data type either by absolute value or by real part. We could do this by defining two operator classes for the data type and then selecting the proper class when creating an index. More information about operator classes is in Section 11.10 and in Section 37.16.
When CREATE INDEX
is invoked on a partitioned table, the default behavior is to recurse to all partitions to ensure they all have matching indexes. Each partition is first checked to determine whether an equivalent index already exists, and if so, that index will become attached as a partition index to the index being created, which will become its parent index. If no matching index exists, a new index will be created and automatically attached; the name of the new index in each partition will be determined as if no index name had been specified in the command. If the ONLY
option is specified, no recursion is done, and the index is marked invalid. (ALTER INDEX ... ATTACH PARTITION
marks the index valid, once all partitions acquire matching indexes.) Note, however, that any partition that is created in the future using CREATE TABLE ... PARTITION OF
will automatically have a matching index, regardless of whether ONLY
is specified.
For index methods that support ordered scans (currently, only B-tree), the optional clauses ASC
, DESC
, NULLS FIRST
, and/or NULLS LAST
can be specified to modify the sort ordering of the index. Since an ordered index can be scanned either forward or backward, it is not normally useful to create a single-column DESC
index — that sort ordering is already available with a regular index. The value of these options is that multicolumn indexes can be created that match the sort ordering requested by a mixed-ordering query, such as SELECT ... ORDER BY x ASC, y DESC
. The NULLS
options are useful if you need to support “nulls sort low” behavior, rather than the default “nulls sort high”, in queries that depend on indexes to avoid sorting steps.
The system regularly collects statistics on all of a table's columns. Newly-created non-expression indexes can immediately use these statistics to determine an index's usefulness. For new expression indexes, it is necessary to run ANALYZE
or wait for the autovacuum daemon to analyze the table to generate statistics for these indexes.
For most index methods, the speed of creating an index is dependent on the setting of maintenance_work_mem. Larger values will reduce the time needed for index creation, so long as you don't make it larger than the amount of memory really available, which would drive the machine into swapping.
Postgres Pro can build indexes while leveraging multiple CPUs in order to process the table rows faster. This feature is known as parallel index build. For index methods that support building indexes in parallel (currently, only B-tree), maintenance_work_mem
specifies the maximum amount of memory that can be used by each index build operation as a whole, regardless of how many worker processes were started. Generally, a cost model automatically determines how many worker processes should be requested, if any.
Parallel index builds may benefit from increasing maintenance_work_mem
where an equivalent serial index build will see little or no benefit. Note that maintenance_work_mem
may influence the number of worker processes requested, since parallel workers must have at least a 32MB
share of the total maintenance_work_mem
budget. There must also be a remaining 32MB
share for the leader process. Increasing max_parallel_maintenance_workers may allow more workers to be used, which will reduce the time needed for index creation, so long as the index build is not already I/O bound. Of course, there should also be sufficient CPU capacity that would otherwise lie idle.
Setting a value for parallel_workers
via ALTER TABLE
directly controls how many parallel worker processes will be requested by a CREATE INDEX
against the table. This bypasses the cost model completely, and prevents maintenance_work_mem
from affecting how many parallel workers are requested. Setting parallel_workers
to 0 via ALTER TABLE
will disable parallel index builds on the table in all cases.
Tip
You might want to reset parallel_workers
after setting it as part of tuning an index build. This avoids inadvertent changes to query plans, since parallel_workers
affects all parallel table scans.
While CREATE INDEX
with the CONCURRENTLY
option supports parallel builds without special restrictions, only the first table scan is actually performed in parallel.
Use DROP INDEX
to remove an index.
Like any long-running transaction, CREATE INDEX
on a table can affect which tuples can be removed by concurrent VACUUM
on any other table.
Prior releases of Postgres Pro also had an R-tree index method. This method has been removed because it had no significant advantages over the GiST method. If USING rtree
is specified, CREATE INDEX
will interpret it as USING gist
, to simplify conversion of old databases to GiST.
Each backend running CREATE INDEX
will report its progress in the pg_stat_progress_create_index
view. See Section 26.4.4 for details.
Examples
To create a unique B-tree index on the column title
in the table films
:
CREATE UNIQUE INDEX title_idx ON films (title);
To create a unique B-tree index on the column title
with included columns director
and rating
in the table films
:
CREATE UNIQUE INDEX title_idx ON films (title) INCLUDE (director, rating);
To create a B-Tree index with deduplication disabled:
CREATE INDEX title_idx ON films (title) WITH (deduplicate_items = off);
To create an index on the expression lower(title)
, allowing efficient case-insensitive searches:
CREATE INDEX ON films ((lower(title)));
(In this example we have chosen to omit the index name, so the system will choose a name, typically films_lower_idx
.)
To create an index with non-default collation:
CREATE INDEX title_idx_german ON films (title COLLATE "de_DE");
To create an index with non-default sort ordering of nulls:
CREATE INDEX title_idx_nulls_low ON films (title NULLS FIRST);
To create an index with non-default fill factor:
CREATE UNIQUE INDEX title_idx ON films (title) WITH (fillfactor = 70);
To create a GIN index with fast updates disabled:
CREATE INDEX gin_idx ON documents_table USING GIN (locations) WITH (fastupdate = off);
To create an index on the column code
in the table films
and have the index reside in the tablespace indexspace
:
CREATE INDEX code_idx ON films (code) TABLESPACE indexspace;
To create a GiST index on a point attribute so that we can efficiently use box operators on the result of the conversion function:
CREATE INDEX pointloc ON points USING gist (box(location,location)); SELECT * FROM points WHERE box(location,location) && '(0,0),(1,1)'::box;
To create an index without locking out writes to the table:
CREATE INDEX CONCURRENTLY sales_quantity_index ON sales_table (quantity);
Compatibility
CREATE INDEX
is a Postgres Pro language extension. There are no provisions for indexes in the SQL standard.