Table

Creating a Table

database.create_table(self, 
    name: str, 
    columns: list, 
    prim_key: str,
    foreign_keys: Optional[dict] = None,
    cache_enabled: Optional[bool] = False,
    max_cache_len: Optional[int] = 125

Columns

Requires List of min 2 item tuples, max 3

('column_name', int|str|float|bytes, 'modifiers')

• column_name - str - database column name exclusions apply
• types: str, int, float, byte, bool, None # JSON dumpable dicts fall under str types
• modifiers: NOT NULL, UNIQUE, AUTO_INCREMENT

AUTOINCREMENT  (sqlite|postgres)
AUTO_INCREMENT (mysql)

Example - Basic

await db.create_table(
    'keystore',
    [
        ('key', str, 'UNIQUE NOT NULL'),
        ('value', str)
    ],
    'key',
    cache_enabled=True
)

Example - Foreign w/ Key

await db.create_table(
    'employees', 
    [    
        ('id', int, 'UNIQUE'),
        ('name', str),
        ('position_id', int)
    ], 
    'id', # Primary Key
    foreign_keys={
        'position_id': {
            'table': 'positions', 
            'ref': 'id',
            'mods': 'ON UPDATE CASCADE ON DELETE CASCADE'
        }
    },
    cache_enabled=True,
    cache_length=256
)

Migrations

Changes to existing table schemas via db.create_table() will trigger a table migration which takes place automatically in 3 phases