schemasync v0.0.1

schemasync

Maintain your database schema history and migrations without ORM overhead.

schemasync is a lightweight command-line tool for managing database migrations and schema versioning. It focuses on simplicity and avoids the complexities of ORMs, making it perfect for developers who prefer direct control over their SQL migrations.

Features

• Create timestamped migration files.
• Run migrations (up or down) in sequence.
• Lightweight and ORM-independent.
• Support for .env configuration and MySQL databases (via mysql2).

Installation

Install schemasync globally via npm:

npm install -g schemasync


# schemasync Usage Guide

## 1. Create a Migration File
Run the following command to generate a new migration file:

```bash
schemasync-create <migration_name>

Example:

schemasync-create add_users_table

Output: A new file is created in the migrations/ folder with the format: YYYYMMDD_HHMMSS_add_users_table.js.

2. Run Migrations (Up)

Execute all pending migrations to apply schema changes:

schemasync-up

Note: The tool applies migration files in chronological order.

3. Rollback Migrations (Down)

Revert the most recently applied migration:

schemasync-down

Configuration

schemasync uses environment variables for database connection configuration. Add a .env file in your project root with the following content:

DB_HOST=localhost
DB_PORT=3306
DB_USER=root
DB_PASSWORD=password
DB_NAME=my_database

File Structure

A typical project using schemasync will have the following structure:

project/
│
├── migrations/                # Migration files
├── .env                       # Database configuration
├── package.json

Migration File Example

Each migration file should export up and down functions that return SQL query strings for schema updates and rollbacks.

Example:

module.exports = {
  up: () => `
    CREATE TABLE users (
      id INT AUTO_INCREMENT PRIMARY KEY,
      name VARCHAR(255) NOT NULL,
      email VARCHAR(255) UNIQUE NOT NULL,
      created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
    );
  `,
  down: () => `
    DROP TABLE users;
  `
};

Requirements

• Node.js v14+
• MySQL database

License

This project is licensed under the MIT License.

Author

Created by Kaif Master.

Contributing

We welcome contributions! If you'd like to improve this package or fix any issues, feel free to fork the repository, make your changes, and submit a pull request.

GitHub Repository: https://github.com/MasterKaif/SchemaSync

Steps to Contribute:

1. Fork the repository.
2. Create a new branch: git checkout -b my-new-feature.
3. Make your changes and commit them: git commit -m 'Add some feature'.
4. Push to the branch: git push origin my-new-feature.
5. Submit a pull request.

Thank you for your interest in contributing!