A Python library for managing containerized databases through Docker. This library provides a simple interface for creating, configuring, and managing database containers for development and testing environments, from within python.
The following features are supported:
- Easy setup and management of database containers
- Automated container lifecycle management
- Standardized configuration interfaces
- Connection management and health checking
- Volume persistence capabilities
- Initialization script support
The following features are implemented but not tested:
- Enable/Disable error if already created
- startdb
- restartdb
- init scripts to examples
The following databases are supported:
- MongoDB
- Microsoft SQL Server
- PostgreSQL
- MySQL
These databases might be added in the future:
- Cassandra
pip install py-dockerdb- Python 3.7+
- Docker installed and running
- Database-specific Python drivers:
pymongofor MongoDBpyodbcfor Microsoft SQL Serverpsycopg2for PostgreSQLmysql-connector-pythonfor MySQL
Check out the following usage examples:
from docker_db.mongodb import MongoDBConfig, MongoDB
# Create configuration
config = MongoDBConfig(
user="testuser",
password="testpass",
database="testdb",
root_username="admin",
root_password="adminpass",
container_name="test-mongodb"
)
# Create and start MongoDB container
db = MongoDB(config)
db.create_db()
# Connect to database
client = db.connection
# Use the database...
# Stop the container when done
db.stop_db()
# Completely remove the container
db.delete_db()from docker_db.postgres import PostgresConfig, PostgresDB
# Create configuration
config = PostgresConfig(
user="testuser",
password="testpass",
database="testdb",
container_name="test-postgres"
)
# Create and start PostgreSQL container
db = PostgresDB(config)
db.create_db()
# Connect to the database
conn = db.connection
# Create a cursor and execute a query
cursor = conn.cursor()
cursor.execute("SELECT version();")
version = cursor.fetchone()
print(f"PostgreSQL version: {version[0]}")
# Clean up
cursor.close()
db.stop_db()All database managers support initialization scripts that can be executed when the container is created:
from pathlib import Path
from docker_db.mongodb import MongoDBConfig, MongoDB
config = MongoDBConfig(
user="testuser",
password="testpass",
database="testdb",
root_username="admin",
root_password="adminpass",
container_name="test-mongodb",
init_script=Path("./path/to/init_script.js")
)You can specify custom volume paths to persist data between container restarts:
from pathlib import Path
from docker_db.mssql import MSSQLConfig, MSSQLDB
config = MSSQLConfig(
user="testuser",
password="testpass",
database="testdb",
sa_password="StrongPassword123!",
container_name="test-mssql",
volume_path=Path("./data/mssql")
)This project is licensed under the MIT License - see the LICENSE file for details.