VACUUM(7)
π VACUUM(7) β the PostgreSQL 17.11 documentation glow-up, part 1 β¨
Okay bestie, welcome to VACUUM(7) β yes, that's the PostgreSQL 17.11 documentation, and no, we are not skipping a single line. This is the whole thing, rewritten with the energy it deserves. Buckle up. π
πΈ NAME πΈ
VACUUM β garbage-collect and optionally analyze a database. That's the whole vibe: clean up the mess and, if you want, take a little look at the data while you're at it. π§Ήβ¨
π¦ SYNOPSIS π¦
VACUUM [ ( option [, ...] ) ] [ table_and_columns [, ...] ]
where option can be one of:
FULL [ boolean ]
FREEZE [ boolean ]
VERBOSE [ boolean ]
ANALYZE [ boolean ]
DISABLE_PAGE_SKIPPING [ boolean ]
SKIP_LOCKED [ boolean ]
INDEX_CLEANUP { AUTO | ON | OFF }
PROCESS_MAIN [ boolean ]
PROCESS_TOAST [ boolean ]
TRUNCATE [ boolean ]
PARALLEL integer
SKIP_DATABASE_STATS [ boolean ]
ONLY_DATABASE_STATS [ boolean ]
BUFFER_USAGE_LIMIT size
and table_and_columns is:
table_name [ ( column_name [, ...] ) ]
That's the whole shape of it. Options go in parentheses, then table-and-columns, and there are a lot of options β but we'll get to those later. This part is the concept check, and it's giving "lecture but make it cute." π
π DESCRIPTION π
Okay so here's the tea: VACUUM reclaims storage occupied by dead tuples. In normal PostgreSQL operation, tuples that are deleted or obsoleted by an update are not physically removed from their table β they literally just sit there, haunting the place, until a VACUUM is done. That's why you have to run VACUUM periodically, especially on tables that get updated a lot. No cap, those are the ones that need it most. ππ§Ή
Without a table_and_columns list, VACUUM processes every table and materialized view in the current database that the current user has permission to vacuum. With a list, it processes only those table(s). Simple as that, bestie. π«Ά
VACUUM ANALYZE performs a VACUUM and then an ANALYZE for each selected table. It's a handy combination form for routine maintenance scripts β like a two-for-one situation, and honestly? Obsessed. See ANALYZE(7) for more details about its processing. π
Plain VACUUM (without FULL) simply reclaims space and makes it available for re-use. This form of the command can operate in parallel with normal reading and writing of the table, since an exclusive lock is not obtained. Iconic behavior, truly. However, extra space is not returned to the operating system (in most cases); it's just kept available for re-use within the same table. It also allows us to leverage multiple CPUs in order to process indexes. This feature is known as parallel vacuum. π To disable this feature, one can use the PARALLEL option and specify parallel workers as zero. Zero. None. Bye. π
VACUUM FULL rewrites the entire contents of the table into a new disk file with no extra space, allowing unused space to be returned to the operating system. Sounds slay, right? But it is much slower and requires an ACCESS EXCLUSIVE lock on each table while it is being processed. So likeβ¦ plan accordingly, bestie, because that lock is not here to make friends. ππ
Part 1 is done, but we are not done β more parts are coming, so don't go anywhere. πΈβ¨
β¨ PARAMETERS β¨
FULLβ okay so this picks the βfullβ vacuum, which can reclaim more space, but it takes much longer and exclusively locks the table. It also needs extra disk space, because it writes a new copy of the table and doesnβt release the old copy until the operation is complete. Usually you only want this when a significant amount of space needs to be reclaimed from inside the table. πFREEZEβ selects aggressive βfreezingβ of tuples. SpecifyingFREEZEis equivalent to doingVACUUMwith thevacuum_freeze_min_ageandvacuum_freeze_table_ageparameters set to zero. Aggressive freezing is always performed when the table is rewritten, so this option is redundant whenFULLis specified. β¨VERBOSEβ prints a detailed vacuum activity report for each table. Basically the group chat updates, but for your vacuum. π«ΆANALYZEβ updates the statistics used by the planner to determine the most efficient way to execute a query. Planner glow-up, no cap. πDISABLE_PAGE_SKIPPINGβ normally,VACUUMskips pages based on the visibility map. Pages where all tuples are known to be frozen can always be skipped, and those where all tuples are known to be visible to all transactions may be skipped except when performing an aggressive vacuum. Furthermore, except when performing an aggressive vacuum, some pages may be skipped in order to avoid waiting for other sessions to finish using them. This option disables all page-skipping behavior, and itβs intended to be used only when the contents of the visibility map are suspect, which should happen only if there is a hardware or software issue causing database corruption. π¨SKIP_LOCKEDβ saysVACUUMshould not wait for any conflicting locks to be released when beginning work on a relation: if a relation cannot be locked immediately without waiting, the relation is skipped. Note that even with this option,VACUUMmay still block when opening the relationβs indexes. Additionally,VACUUM ANALYZEmay still block when acquiring sample rows from partitions, table inheritance children, and some types of foreign tables. Also, whileVACUUMordinarily processes all partitions of specified partitioned tables, this option will causeVACUUMto skip all partitions if there is a conflicting lock on the partitioned table. πINDEX_CLEANUPβ normally,VACUUMskips index vacuuming when there are very few dead tuples in the table. The cost of processing all of the tableβs indexes is expected to greatly exceed the benefit of removing dead index tuples when this happens. This option can be used to forceVACUUMto process indexes when there are more than zero dead tuples. The default isAUTO, which allowsVACUUMto skip index vacuuming when appropriate. IfINDEX_CLEANUPis set toON,VACUUMwill conservatively remove all dead tuples from indexes. This may be useful for backwards compatibility with earlier releases of PostgreSQL where this was the standard behavior.
INDEX_CLEANUP can also be set to OFF to force VACUUM to always skip index vacuuming, even when there are many dead tuples in the table. This may be useful when it is necessary to make VACUUM run as quickly as possible to avoid imminent transaction ID wraparound (see Section 24.1.5). However, the wraparound failsafe mechanism controlled by vacuum_failsafe_age will generally trigger automatically to avoid transaction ID wraparound failure, and should be preferred. If index cleanup is not performed regularly, performance may suffer, because as the table is modified indexes will accumulate dead tuples and the table itself will accumulate dead line pointers that cannot be removed until index cleanup is completed.
This option has no effect for tables that have no index and is ignored if the FULL option is used. It also has no effect on the transaction ID wraparound failsafe mechanism. When triggered it will skip index vacuuming, even when INDEX_CLEANUP is set to ON. π
PROCESS_MAINβ specifies thatVACUUMshould attempt to process the main relation. This is usually the desired behavior and is the default. Setting this option to false may be useful when it is only necessary to vacuum a relationβs correspondingTOASTtable. π§PROCESS_TOASTβ specifies thatVACUUMshould attempt to process the correspondingTOASTtable for each relation, if one exists. This is usually the desired behavior and is the default. Setting this option to false may be useful when it is only necessary to vacuum the main relation. This option is required when theFULLoption is used. πTRUNCATEβ specifies thatVACUUMshould attempt to truncate off any empty pages at the end of the table and allow the disk space for the truncated pages to be returned to the operating system. This is normally the desired behavior and is the default unless thevacuum_truncateoption has been set to false for the table to be vacuumed. Setting this option to false may be useful to avoidACCESS EXCLUSIVElock on the table that the truncation requires. This option is ignored if theFULLoption is used. πPARALLELβ perform index vacuum and index cleanup phases ofVACUUMin parallel usingintegerbackground workers (for the details of each vacuum phase, please refer toTable 27.46). The number of workers used to perform the operation is equal to the number of indexes on the relation that support parallel vacuum, which is limited by the number of workers specified with thePARALLELoption if any, which is further limited bymax_parallel_maintenance_workers. An index can participate in parallel vacuum if and only if the size of the index is more thanmin_parallel_index_scan_size. Please note that it is not guaranteed that the number of parallel workers specified inintegerwill be used during execution. It is possible for a vacuum to run with fewer workers than specified, or even with no workers at all. Only one worker can be used per index. So parallel workers are launched only when there are at least 2 indexes in the table. Workers for vacuum are launched before the start of each phase and exit at the end of the phase. These behaviors might change in a future release. This option canβt be used with theFULLoption. β‘SKIP_DATABASE_STATSβ specifies thatVACUUMshould skip updating the database-wide statistics about oldest unfrozen XIDs. NormallyVACUUMwill update these statistics once at the end of the command. However, this can take awhile in a database with a very large number of tables, and it will accomplish nothing unless the table that had contained the oldest unfrozen XID was among those vacuumed. Moreover, if multipleVACUUMcommands are issued in parallel, only one of them can update the database-wide statistics at a time. Therefore, if an application intends to issue a series of manyVACUUMcommands, it can be helpful to set this option in all but the last such command; or set it in all the commands and separately issueVACUUM (ONLY_DATABASE_STATS)afterwards. πONLY_DATABASE_STATSβ specifies thatVACUUMshould do nothing except update the database-wide statistics about oldest unfrozen XIDs. When this option is specified, thetable_and_columnslist must be empty, and no other option may be enabled exceptVERBOSE. πBUFFER_USAGE_LIMITβ specifies the Buffer Access Strategy ring buffer size forVACUUM. This size is used to calculate the number of shared buffers which will be reused as part of this strategy.0disables use of a Buffer Access Strategy. IfANALYZEis also specified, theBUFFER_USAGE_LIMITvalue is used for both the vacuum and analyze stages. This option canβt be used with theFULLoption except ifANALYZEis also specified. When this option is not specified,VACUUMuses the value fromvacuum_buffer_usage_limit. Higher settings can allowVACUUMto run more quickly, but having too large a setting may cause too many other useful pages to be evicted from shared buffers. The minimum value is128 kBand the maximum value is16 GB. π₯booleanβ specifies whether the selected option should be turned on or off. You can writeTRUE,ON, or1to enable the option, andFALSE,OFF, or0to disable it. The boolean value can also be omitted, in which caseTRUEis assumed. β¨integerβ specifies a non-negative integer value passed to the selected option. π’sizeβ specifies an amount of memory in kilobytes. Sizes may also be specified as a string containing the numerical size followed by any one of the following memory units:B(bytes),kB(kilobytes),MB(megabytes),GB(gigabytes), orTB(terabytes). πΎtable_nameβ the name (optionally schema-qualified) of a specific table or materialized view to vacuum. If the specified table is a partitioned table, all of its leaf partitions are vacuumed. ποΈcolumn_nameβ the name of a specific column to analyze. Defaults to all columns. If a column list is specified,ANALYZEmust also be specified. π―
π OUTPUTS π
When VERBOSE is specified, VACUUM emits progress messages to indicate which table is currently being processed. Various statistics about the tables are printed as well. So yes, bestie, you get the live commentary. π
π NOTES π
okay so before you go vacuuming everything in sight, there are a few lil' rules, bestie. listen up π
- To vacuum a table, one must ordinarily have the
MAINTAINprivilege on the table. but listen β database owners are allowed to vacuum all tables in their databases, except shared catalogs. andVACUUMwill skip over any tables that the calling user does not have permission to vacuum. it's not gonna fight you about it, it just quietly moves on π - While
VACUUMis running, thesearch_pathis temporarily changed topg_catalog,pg_temp. just so you know β¨ VACUUMcannot be executed inside a transaction block. no cap, it just can't π«- for tables with GIN indexes,
VACUUM(in any form) also completes any pending index insertions, by moving pending index entries to the appropriate places in the main GIN index structure. see Section 64.4.4.1 for details π - we highkey recommend that all databases be vacuumed regularly in order to remove dead rows. PostgreSQL includes an "autovacuum" facility which can automate routine vacuum maintenance β it's literally the main character that does the chores for you π§ for more information about automatic and manual vacuuming, see Section 24.1.
- the
FULLoption is not recommended for routine use, but might be useful in special cases. an example is when you have deleted or updated most of the rows in a table and would like the table to physically shrink to occupy less disk space and allow faster table scans.VACUUM FULLwill usually shrink the table more than a plainVACUUMwould. it's giving deep-clean-your-room energy, not daily-tidy energy π - the
PARALLELoption is used only for vacuum purposes. if this option is specified with theANALYZEoption, it does not affectANALYZE. so don't expect it to do anything extra there, fr fr π VACUUMcauses a substantial increase in I/O traffic, which might cause poor performance for other active sessions π therefore, it is sometimes advisable to use the cost-based vacuum delay feature. for parallel vacuum, each worker sleeps in proportion to the work done by that worker. see Section 19.4.4 for details. think of it as everyone taking a lil' nap proportional to their shift πΈ- each backend running
VACUUMwithout theFULLoption will report its progress in thepg_stat_progress_vacuumview. backends runningVACUUM FULLwill instead report their progress in thepg_stat_progress_clusterview. see Section 27.4.5 and Section 27.4.2 for details. progress bar realness πβ¨
β¨ EXAMPLES β¨
okay so the moment you've been waiting for β to clean a single table onek, analyze it for the optimizer and print a detailed vacuum activity report:
VACUUM (VERBOSE, ANALYZE) onek;
that's it. that's the whole vibe. go off π
π¦ COMPATIBILITY π¦
bestie. there is no VACUUM statement in the SQL standard. it's a PostgreSQL original, iykyk π«Ά
the following syntax was used before PostgreSQL version 9.0 and is still supported:
VACUUM [ FULL ] [ FREEZE ] [ VERBOSE ] [ ANALYZE ] [ table_and_columns [, ...] ]
β οΈ note that in this syntax, the options must be specified in exactly the order shown. do not freestyle it, bestie β the order is the whole point π
π SEE ALSO π
vacuumdb(1)- Section 19.4.4
- Section 24.1.6
- Section 27.4.5
- Section 27.4.2
and that's the whole page, bestie!! π this lil' masterpiece is from PostgreSQL 17.11, dated 2026, and it's the VACUUM(7) page β go forth and vacuum responsibly, mwah πβ¨π¦
π¦ where this page comes from
- opensuse-leap 16.0: postgresql17 17.11-160000.1.1 Β· PostgreSQL
- opensuse-leap 16.0: postgresql17 17.11-160000.1.1 Β· PostgreSQL
- opensuse-leap 16.0: postgresql17 17.11-160000.1.1 Β· PostgreSQL
- opensuse-leap 16.0: postgresql17 17.11-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