https://github.com/mateuszsokola/partman-wizard

📊 A CLI tool to partition PostgreSQL tables and manage data migration efficiently.
https://github.com/mateuszsokola/partman-wizard

cli data-migration database-management database-migrations nodejs partition-table partitioning partman postgres postgres-extension postgresql sql table-partitioning

Last synced: 2 days ago
JSON representation

📊 A CLI tool to partition PostgreSQL tables and manage data migration efficiently.

• Host: GitHub
• URL: https://github.com/mateuszsokola/partman-wizard
• Owner: mateuszsokola
• License: mit
• Created: 2024-08-24T10:31:59.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-08-27T16:52:02.000Z (about 1 month ago)
• Last Synced: 2024-09-21T11:04:07.480Z (7 days ago)
• Topics: cli, data-migration, database-management, database-migrations, nodejs, partition-table, partitioning, partman, postgres, postgres-extension, postgresql, sql, table-partitioning
• Language: JavaScript
• Homepage:
• Size: 359 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Partman Wizard

**Partman Wizard** is a CLI tool designed to help you partition PostgreSQL tables using the `pg_partman` extension. This tool guides you through the process of setting up table partitions and migrating data efficiently.

If you need PostgreSQL-as-a-Service with support for the `pg_partman` extension, consider [Neon](https://neon.tech/). PS. They have a FREE-TIER 💸

## What this bad boy can do?

- Create and configure partitions based on existing tables in PostgreSQL

- Migrate data from source tables to partitioned ones

It works like magic ✨

## Watch on YT

[![How To Use Partman Wizard](./yt.png)](https://youtu.be/t4qqf-Z0CKc)

## Usage

To use the Partman Wizard, you need to have Node.js 18+ installed. You can then run the tool directly using `npx`:

```bash

npx partman-wizard

```

Follow the configuration steps and enjoy your partitioned tables.

## Configure partition maintenance

To keep your partitions up-to-date, set up a cron job to run maintenance tasks. Due to the complexity of cloud deployments and PostgreSQL itself, this wizard cannot set it up for you.

Make sure to run the following SQL query at least once per day. It's common to schedule it to run at midnight (or one minute after):

```sql

SELECT partman.run_maintenance();

```

# Feedback & Contributions

If you find this tool useful, consider giving it a star on [GitHub](https://github.com/mateuszsokola/partman-wizard). For bug reports or contributions, please visit the [GitHub repository](https://github.com/mateuszsokola/partman-wizard).

# License

This project is licensed under the MIT License. See the [LICENSE](https://github.com/mateuszsokola/partman-wizard/blob/main/LICENSE) file for details.



Enjoy using Partman Wizard! 😊