Database Support in Panther

Panther natively supports two databases: MongoDB and PantherDB. However, you can also define your own custom database connections and queries.

---

Configuration Structure

Define your database configuration in the following format:

DATABASE = {
    'engine': {
        'class': 'address of engine',
        'arg1': 'value1',
        # ... additional arguments ...
    },
    'query': 'address of query class',  # Optional
}

Notes

• Built-in supported engines:
• panther.db.connections.PantherDBConnection
• panther.db.connections.MongoDBConnection
• All values in engine (except class) are passed to the __init__ method of the specified class.
• The query key is optional for the default supported engines, but you can customize it if needed.

---

PantherDB

Example configuration for PantherDB:

DATABASE = {
    'engine': {
        'class': 'panther.db.connections.PantherDBConnection',
        'path': BASE_DIR / 'database.pdb',  # Optional
        'encryption': True  # Optional, default is False
    }
}

Notes

• path is optional; you can customize the directory and filename of your database.
• encryption is optional and defaults to False.
• The cryptography package is required if you set encryption to True.

---

MongoDB

Example configuration for MongoDB:

DATABASE = {
    'engine': {
        'class': 'panther.db.connections.MongoDBConnection',
        'host': 'mongodb://127.0.0.1:27017/database_name'
    }
}

Notes

• The parameters for the engine are the same as those for pymongo.MongoClient. See the PyMongo documentation for details.

---

How Does It Work?

• Panther creates a database connection based on the DATABASE configuration you define in your configs.
• You can access this connection through your models, or directly via:

  from panther.db.connections import db