https://github.com/hirefrank/pg-to-sqlite

https://github.com/hirefrank/pg-to-sqlite

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/hirefrank/pg-to-sqlite
• Owner: hirefrank
• License: mit
• Created: 2024-04-20T10:57:27.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-09-07T14:24:50.000Z (3 months ago)
• Last Synced: 2024-09-08T13:59:19.250Z (3 months ago)
• Language: Shell
• Size: 40 KB
• Stars: 17
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-turso - PostgreSQL to SQLite3 DB Conversion

README

        
# PostgreSQL to SQLite3 DB Conversion

This Bash script allows you to migrate data from a PostgreSQL database into a SQLite3 database file. It creates a PostgreSQL dump file (if it doesn't already exist and a PostgreSQL connection string is provided), converts the dump file into SQLite3-compatible SQL statements, and imports the data into a new or recreated SQLite3 database file.

## Prerequisites

Before running the script, ensure that the following tools are installed on your system:

- `pg_dump` (PostgreSQL client utility)

- `sed` (Stream Editor for filtering and transforming text)

- `sqlite3` (SQLite3 command-line tool)

## Usage

`./migrate.sh  [postgres_connection_string] [--reset]`

- ``: The path to the SQLite database file.

- `[postgres_connection_string]`: Optional. The PostgreSQL connection string. If not provided, the script will look for an existing PostgreSQL dump file.

- `[--reset]`: Optional. If provided, the script will reset the environment by cleaning up existing files and recreating the SQLite database.

_Ensure that the `schema.sql` file, which defines the SQLite database schema, is present in the same directory as the `migrate.sh` script before running the migration._

## Script Behavior

1. If the `--reset` flag is provided, the script will remove any existing PostgreSQL dump file and SQLite3 database file, and then create a new SQLite3 database file.

2. If the PostgreSQL dump file doesn't exist and the PostgreSQL connection string is provided, the script will create a new dump file using `pg_dump`. The dump file name is derived from the SQLite database file name with the extension `.dump`.

3. The script converts the PostgreSQL dump file into SQLite3-compatible SQL statements using `sed`.

4. It wraps the SQL statements with `BEGIN TRANSACTION` and `COMMIT` statements.

5. The script recreates the SQLite3 database file if it already exists, or creates a new one if it doesn't exist.

6. It creates the schema in the SQLite3 database using the provided SQLite3 schema file (`./schema.sql`).

7. It disables foreign key checks temporarily for the import process.

8. It imports the converted SQL statements into the SQLite3 database.

9. It re-enables foreign key checks after the import is complete.

10. It cleans up the temporary SQL file.

## Notes

- The script excludes the `__drizzle_migrations` table from the PostgreSQL dump. You can modify the `EXCLUDE_TABLES` array in the script to include or exclude different tables.

- If the PostgreSQL connection string is not provided, the script will skip creating the PostgreSQL dump file.

- If the `--reset` flag is provided, the script will remove any existing PostgreSQL dump file and SQLite3 database file before starting, and then create a new SQLite3 database file.

- The script displays the total execution time at the end.

- All output and error messages are logged to the `migrate_postgres_to_sqlite3.log` file.

## Unattended Execution

To run the script unattended or in the background, you can use `nohup` or `&`:

```bash

nohup ./migrate.sh  &> /dev/null &

```

## License

This project is licensed under the [MIT License](LICENSE).