CLI Reference
postgresql-partition-manager
Simplified PostgreSQL partitioning management
Usage:
Flags:
| Flag | Shorthand | Default | Description |
|---|---|---|---|
| --config | -c | "" | config file (default is $HOME/postgresql-partition-manager.yaml) |
| --connection-url | -u | "" | Database connection string |
| --debug | -d | false | Enable debug mode |
| --lock-timeout | 100 | Set lock_timeout (ms) | |
| --log-format | -l | json | Log format (text or json) |
| --statement-timeout | 3000 | Set statement_timeout (ms) |
postgresql-partition-manager run
Perform partition operations
Usage:
Inherited Flags:
| Flag | Shorthand | Default | Description |
|---|---|---|---|
| --config | -c | "" | config file (default is $HOME/postgresql-partition-manager.yaml) |
| --connection-url | -u | "" | Database connection string |
| --debug | -d | false | Enable debug mode |
| --lock-timeout | 100 | Set lock_timeout (ms) | |
| --log-format | -l | json | Log format (text or json) |
| --statement-timeout | 3000 | Set statement_timeout (ms) |
postgresql-partition-manager run all
Perform partitions provisioning, cleanup, and check
Usage:
Inherited Flags:
| Flag | Shorthand | Default | Description |
|---|---|---|---|
| --config | -c | "" | config file (default is $HOME/postgresql-partition-manager.yaml) |
| --connection-url | -u | "" | Database connection string |
| --debug | -d | false | Enable debug mode |
| --lock-timeout | 100 | Set lock_timeout (ms) | |
| --log-format | -l | json | Log format (text or json) |
| --statement-timeout | 3000 | Set statement_timeout (ms) |
postgresql-partition-manager run check
Check existing partitions
Usage:
Inherited Flags:
| Flag | Shorthand | Default | Description |
|---|---|---|---|
| --config | -c | "" | config file (default is $HOME/postgresql-partition-manager.yaml) |
| --connection-url | -u | "" | Database connection string |
| --debug | -d | false | Enable debug mode |
| --lock-timeout | 100 | Set lock_timeout (ms) | |
| --log-format | -l | json | Log format (text or json) |
| --statement-timeout | 3000 | Set statement_timeout (ms) |
postgresql-partition-manager run cleanup
Remove outdated partitions
Usage:
Inherited Flags:
| Flag | Shorthand | Default | Description |
|---|---|---|---|
| --config | -c | "" | config file (default is $HOME/postgresql-partition-manager.yaml) |
| --connection-url | -u | "" | Database connection string |
| --debug | -d | false | Enable debug mode |
| --lock-timeout | 100 | Set lock_timeout (ms) | |
| --log-format | -l | json | Log format (text or json) |
| --statement-timeout | 3000 | Set statement_timeout (ms) |
postgresql-partition-manager run provisioning
Create and attach new partitions
Usage:
Inherited Flags:
| Flag | Shorthand | Default | Description |
|---|---|---|---|
| --config | -c | "" | config file (default is $HOME/postgresql-partition-manager.yaml) |
| --connection-url | -u | "" | Database connection string |
| --debug | -d | false | Enable debug mode |
| --lock-timeout | 100 | Set lock_timeout (ms) | |
| --log-format | -l | json | Log format (text or json) |
| --statement-timeout | 3000 | Set statement_timeout (ms) |
postgresql-partition-manager validate
Check configuration file and exit with an error if configuration is invalid
Usage:
Inherited Flags:
| Flag | Shorthand | Default | Description |
|---|---|---|---|
| --config | -c | "" | config file (default is $HOME/postgresql-partition-manager.yaml) |
| --connection-url | -u | "" | Database connection string |
| --debug | -d | false | Enable debug mode |
| --lock-timeout | 100 | Set lock_timeout (ms) | |
| --log-format | -l | json | Log format (text or json) |
| --statement-timeout | 3000 | Set statement_timeout (ms) |