mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 09:25:06 +03:00
113 lines
3.6 KiB
Plaintext
113 lines
3.6 KiB
Plaintext
import Layout from '~/layouts/DefaultGuideLayout'
|
|
|
|
export const meta = {
|
|
id: 'pg_repack',
|
|
title: 'pg_repack: Physical storage optimization and maintenance',
|
|
description:
|
|
'A tool to remove bloat from tables and indexes and optimize physical data order and physical storage',
|
|
}
|
|
|
|
[pg_repack](https://github.com/reorg/pg_repack) is a PostgreSQL extension to remove bloat from tables and indexes, and optionally restore the physical order of clustered indexes. Unlike CLUSTER and VACUUM FULL it works online, without holding an exclusive lock on the processed tables during processing. pg_repack is efficient to boot, with performance comparable to using CLUSTER directly.
|
|
|
|
pg_repack provides the following methods to optimize physical storage:
|
|
|
|
- Online CLUSTER: ordering table data by cluster index in a non-blocking way
|
|
- Ordering table data by specified columns
|
|
- Online VACUUM FULL: packing rows only in a non-blocking way
|
|
- Rebuild or relocate only the indexes of a table
|
|
|
|
## Requirements
|
|
|
|
- Only superusers can use the utility.
|
|
- Target table must have a PRIMARY KEY, or a UNIQUE total index on a NOT NULL column.
|
|
- Performing a full-table repack requires free disk space about twice as large as the target table and its indexes.
|
|
|
|
## Usage
|
|
|
|
### Enable the extension
|
|
|
|
Get started with pg_repack by enabling the extension in the Supabase Dashboard.
|
|
|
|
<Tabs
|
|
scrollable
|
|
size="small"
|
|
type="underlined"
|
|
defaultActiveId="dashboard"
|
|
queryGroup="database-method"
|
|
>
|
|
<TabPanel id="dashboard" label="Dashboard">
|
|
|
|
1. Go to the [Database](https://supabase.com/dashboard/project/_/database/tables) page in the Dashboard.
|
|
2. Click on **Extensions** in the sidebar.
|
|
3. Search for "pg_repack" and enable the extension.
|
|
|
|
</TabPanel>
|
|
<TabPanel id="sql" label="SQL">
|
|
|
|
```sql
|
|
-- Example: enable the "pg_repack" extension
|
|
create extension pg_repack with schema extensions;
|
|
|
|
-- Example: disable the "pg_repack" extension
|
|
drop extension if exists pg_repack;
|
|
```
|
|
|
|
</TabPanel>
|
|
</Tabs>
|
|
|
|
### Syntax
|
|
|
|
```sh
|
|
pg_repack [OPTION]... [DBNAME]
|
|
```
|
|
|
|
## Examples
|
|
|
|
It's useful for performance to support tables data ordered on disk and physically remove deleted data that remain
|
|
otherwise.
|
|
|
|
Perform an online CLUSTER of all the clustered tables in the database `db`, and perform an online `VACUUM FULL` of all the non-clustered tables:
|
|
|
|
```sh
|
|
pg_repack db
|
|
```
|
|
|
|
Perform an online `VACUUM FULL` on the tables `table1` and `table2` in the database `db` (an eventual cluster index is ignored):
|
|
|
|
```sh
|
|
pg_repack --no-order --table table1 --table table2 db
|
|
```
|
|
|
|
Moving indexes to a tablespace on a faster volume increases performance of `SELECT` queries using these indexes
|
|
drastically. `INSERT`s and `UPDATE`s of a table with indexes on a fast volume are also faster. This is very useful
|
|
when the fast volume is small and can not accommodate all tables, as indexes are much smaller than tables.
|
|
|
|
Move all indexes of table `table1` to tablespace `tbs`:
|
|
|
|
```sh
|
|
pg_repack -d db --table table1 --only-indexes --tablespace tbs
|
|
```
|
|
|
|
Move the specified index `idx` to tablespace `tbs`:
|
|
|
|
```sh
|
|
pg_repack -d db --index idx --tablespace tbs
|
|
```
|
|
|
|
See the [official pg_repack documentation](https://reorg.github.io/pg_repack/) for the full list of options.
|
|
|
|
## Restrictions
|
|
|
|
- pg_repack cannot reorganize temp tables.
|
|
- pg_repack cannot cluster tables by GiST indexes.
|
|
- You cannot perform DDL commands of the target tables except VACUUM or ANALYZE while pg_repack is working.
|
|
pg_repack holds an ACCESS SHARE lock on the target table to enforce this restriction.
|
|
|
|
## Resources
|
|
|
|
- [Official pg_repack documentation](https://reorg.github.io/pg_repack/)
|
|
|
|
export const Page = ({ children }) => <Layout meta={meta} children={children} />
|
|
|
|
export default Page
|