https://github.com/vendrinc/pg_parcel
Extract horizontal slices of PostgreSQL schemas
https://github.com/vendrinc/pg_parcel
postgresql
Last synced: over 1 year ago
JSON representation
Extract horizontal slices of PostgreSQL schemas
- Host: GitHub
- URL: https://github.com/vendrinc/pg_parcel
- Owner: vendrinc
- License: apache-2.0
- Created: 2022-03-01T20:27:05.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-02T03:13:54.000Z (over 1 year ago)
- Last Synced: 2025-01-20T13:32:00.071Z (over 1 year ago)
- Topics: postgresql
- Language: Rust
- Homepage:
- Size: 8.73 MB
- Stars: 12
- Watchers: 26
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# pg_parcel
[](https://github.com/vendrinc/pg_parcel/actions/workflows/build.yml)
[](https://github.com/vendrinc/pg_parcel/actions/workflows/release.yml)
A very minimal subset of `pg_dump --data-only` with multi-tenancy in mind. A solution to: https://postgrespro.com/list/thread-id/1715772
Most options are specified via config file.
```toml
column_name = "customer_id"
schema_name = "public"
database_url = "postgres://localhost:15432/postgres"
features = ["currency", "audit"]
skip_tables = [
"_backup$",
"^obsolete_"
# ... more regular expressions
]
[overrides]
# We only want the one customer identified by --id on the command line
customers = """
select * from customers where id in :ids
"""
# The `user_files` table doesn't have a customer_id column, so we need to join.
user_files = """
select user_files.*
from users_files
join users on users.id = user_files.user_id
where users.customer_id in :ids
"""
daily_exchange_rates = """
select * from daily_exchange_rates
where 'currency' = any (current_setting('pg_parcel.features')::text[])
"""
audit_log = """
select * from audit_log
where customer_id in :ids and
(
ARRAY['audit'] && (current_setting('pg_parcel.features')::text[])
or created_at >= NOW() - INTERVAL '30 days'
or updated_at >= NOW() - INTERVAL '30 days'
);
"""
```
| Session Variable | Contains |
| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pg_parcel.ids` | The list of all values passed with `--id` |
| `pg_parcel.features` | The list of features defined in the `pg_parcel.toml` file, minus any features turned off with `--no-feature`. If `--features` is set, they take precedence over the config file, but `--no-features` is final. |
| `pg_partial.feature.`_`myfeature`_ | Same rules as `pg_parcel.features`, but one variable per setting. The value is just `true` Override queries can still use `IN :ids` but session variables are now preferred. |
## Demo
## Releases
We publish binaries for both Linux x86_64 (any distro, using [musl](https://musl.libc.org/)) and macOS Universal (both Intel and Apple Silicon in a single binary).
To create a new release, update `Cargo.toml` and create a tag like `v1.2.3` (SemVer, prefixed with `v`).
## License
Licensed under either of
- Apache License, Version 2.0
([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license
([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.