Mocks DB

Mocks DB is a lightweight, mock MySQL server designed for testing and development. It accepts any standard MySQL connection and query, but instead of storing data, it generates realistic "junk" data on the fly based on your provided schema.

Perfect for performance testing, UI development, or any scenario where you need a database that acts like the real thing but populates itself.

Features

• MySQL Protocol Support: Connect with any standard MySQL client (CLI, Workbench, generic libraries).
• Dynamic Data Generation: Uses Faker to generate realistic data based on column types.
• Schema Awareness: define your table structures via standard CREATE TABLE statements.
• Configurable: Control row counts, limits, and random seeds.
• Zero Storage: No disk I/O for data, everything is generated in memory on demand.

Installation

pip install mocks-db

Usage

Run the server with a file:

mocks-db --schema schema.sql --port 3306

Or pass the schema directly as a string:

mocks-db --schema-content "CREATE TABLE users (id INT, name VARCHAR(255));" --port 3306

Connect with your favorite client:

mysql -h 127.0.0.1 -P 3306 -u root

Run queries:

SELECT * FROM users LIMIT 10;

Development

To develop and test locally without installing from a remote repository:

1. Clone the repo (if you haven't already).

2. Create a virtual environment:

   python3 -m venv venv
   source venv/bin/activate
   

3. Install dependencies and the package in editable mode:

   pip install -e .
   

4. Run the server:

   mocks-db --schema-content "CREATE TABLE test (id INT);"
   

   Or run efficiently via python module:

   python -m mocks_db.main --help
   

5. Install development dependencies and run tests:

   This project uses pyproject.toml for dependency management. You can install the package along with development dependencies (like pytest) using the [dev] extra:

   pip install -e ".[dev]"
   

   Or use the legacy requirements style:

   pip install -r requirements-dev.txt
   

   Then run tests:

   pytest
   

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT