ALTER_INDEX(7pg14)
β¨ ALTER INDEX β¨
okay so bestie, welcome to ALTER INDEX from the PostgreSQL 14.24 docs (manual page 7) β this is the page where we learn how to change the definition of an index. yes, the glow-up page. π
πΈ SYNOPSIS πΈ
like, here's the whole menu, exactly as written, no cap:
ALTER INDEX [ IF EXISTS ] name RENAME TO new_name
ALTER INDEX [ IF EXISTS ] name SET TABLESPACE tablespace_name
ALTER INDEX name ATTACH PARTITION index_name
ALTER INDEX name [ NO ] DEPENDS ON EXTENSION extension_name
ALTER INDEX [ IF EXISTS ] name SET ( storage_parameter [= value] [, ... ] )
ALTER INDEX [ IF EXISTS ] name RESET ( storage_parameter [, ... ] )
ALTER INDEX [ IF EXISTS ] name ALTER [ COLUMN ] column_number
SET STATISTICS integer
ALTER INDEX ALL IN TABLESPACE name [ OWNED BY role_name [, ... ] ]
SET TABLESPACE new_tablespace [ NOWAIT ]
π¦ DESCRIPTION π¦
So ALTER INDEX changes the definition of an existing index. There are several subforms (little flavors, if you will) described down below. Heads up: the lock level required may differ for each subform. An ACCESS EXCLUSIVE lock is held unless it's explicitly noted otherwise. And if you list multiple subcommands together, the lock you end up holding is the strictest one required by any of them. main character lock energy, honestly.
π RENAME
The RENAME form changes the name of the index. If the index is associated with a table constraint (and by that I mean UNIQUE, PRIMARY KEY, or EXCLUDE), the constraint gets renamed as well. There is no effect on the stored data. π
Renaming an index acquires a SHARE UPDATE EXCLUSIVE lock.
π SET TABLESPACE
This form changes the index's tablespace to the specified tablespace and moves the data file(s) associated with the index to the new tablespace. To change the tablespace of an index, you must own the index and have CREATE privilege on the new tablespace. Slay, but with permissions.
All indexes in the current database in a tablespace can be moved by using the ALL IN TABLESPACE form β which will lock all indexes to be moved and then move each one. This form also supports OWNED BY, which will only move indexes owned by the roles specified. If the NOWAIT option is specified, then the command will fail if it is unable to acquire all of the locks required immediately. π
Note that system catalogs will not be moved by this command β use ALTER DATABASE or explicit ALTER INDEX invocations instead if that's what you want. See also CREATE TABLESPACE.
π ATTACH PARTITION index_name
Causes the named index (possibly schema-qualified) to become attached to the altered index. The named index must be on a partition of the table containing the index being altered, and it must have an equivalent definition. An attached index cannot be dropped by itself, and will automatically be dropped if its parent index is dropped. it's giving "you can't sit with us unless you're matching." π«Ά
If the named index is already attached to the altered index, the command will attempt to validate the parent index if the parent is currently invalid.
π DEPENDS ON EXTENSION extension_name
π NO DEPENDS ON EXTENSION extension_name
This form marks the index as dependent on the extension β or no longer dependent on that extension if NO is specified. An index that's marked as dependent on an extension is automatically dropped when the extension is dropped. ride or die, literally.
π SET ( storage_parameter [= value] [, ... ] )
This form changes one or more index-method-specific storage parameters for the index. See CREATE INDEX for the details on the available parameters. Note that the index contents will not be modified immediately by this command β depending on the parameter, you might need to rebuild the index with REINDEX to get the desired effects.
π RESET ( storage_parameter [, ... ] )
This form resets one or more index-method-specific storage parameters to their defaults. As with SET, a REINDEX might be needed to update the index entirely.
π ALTER [ COLUMN ] column_number SET STATISTICS integer
This form sets the per-column statistics-gathering target for subsequent ANALYZE operations β though it can be used only on index columns that are defined as an expression. Since expressions lack a unique name, we refer to them using the ordinal number of the index column. The target can be set in the range 0 to 10000; alternatively, set it to -1 to revert to using the system default statistics target (default_statistics_target). For more information on the use of statistics by the PostgreSQL query planner, refer to Section 14.2. π
π PARAMETERS π
IF EXISTSβ do not throw an error if the index does not exist. A notice is issued in this case, bestie. πcolumn_numberβ the ordinal number refers to the ordinal (left-to-right) position of the index column.nameβ the name (possibly schema-qualified) of an existing index to alter.new_nameβ the new name for the index. the rebrand β¨tablespace_nameβ the tablespace to which the index will be moved.extension_nameβ the name of the extension that the index is to depend on.storage_parameterβ the name of an index-method-specific storage parameter.valueβ the new value for an index-method-specific storage parameter. This might be a number or a word depending on the parameter.
π NOTES π
These operations are also possible using ALTER TABLE. In fact, ALTER INDEX is just an alias for the forms of ALTER TABLE that apply to indexes. plot twist: it was ALTER TABLE all along.
There was formerly an ALTER INDEX OWNER variant, but this is now ignored (with a warning). An index cannot have an owner different from its table's owner. Changing the table's owner automatically changes the index as well. no solo ownership arcs here.
Changing any part of a system catalog index is not permitted. periodt. don't even try it. π«
π₯ EXAMPLES π₯
To rename an existing index:
ALTER INDEX distributors RENAME TO suppliers;
To move an index to a different tablespace:
ALTER INDEX distributors SET TABLESPACE fasttablespace;
To change an index's fill factor (assuming that the index method supports it):
ALTER INDEX distributors SET (fillfactor = 75);
REINDEX INDEX distributors;
Set the statistics-gathering target for an expression index:
CREATE INDEX coord_idx ON measured (x, y, (z + t));
ALTER INDEX coord_idx ALTER COLUMN 3 SET STATISTICS 1000;
β COMPATIBILITY β
ALTER INDEX is a PostgreSQL extension. it's OG, it's iconic, it's not standard SQL. π
π SEE ALSO π
CREATE INDEX(CREATE_INDEX(7))REINDEX(7)
and that's the page, bestie! π this little love letter lives in the PostgreSQL 14.24 docs, dated 2026, filed under ALTER INDEX(7). go forth and alter your indexes responsibly. mwah. πβ¨π¦
π¦ where this page comes from
- opensuse-leap 16.0: postgresql14 14.24-160000.1.1 Β· PostgreSQL
- opensuse-leap 16.0: postgresql14 14.24-160000.1.1 Β· PostgreSQL
- opensuse-leap 16.0: postgresql14 14.24-160000.1.1 Β· PostgreSQL
- opensuse-leap 16.0: postgresql14 14.24-160000.1.1 Β· PostgreSQL
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms