README

In configuration, setup the following structure

Connections

Set up named connections. Generally, use "default" as the connection name to allow any ConnectionManager::getConnection() call to work.

Settings are compatible with Doctrine's ConnectionManager, allowing you to use the same configuration for both.

[
    'database' => [
        'connections' => [
            'default|connectionName' => [ // Doctrine connection manager compatible
                'dbname'   => 'your_database_name',
                'user'     => 'your_username',
                'password' => 'your_password',
                'host'     => '127.0.0.1', // Optional
                'port'     => 3306, // Optional
                'driver'   => 'pdo_mysql'
            ]
        ]
    ]
]

Supported drivers include:

Global Table Prefix

Defining a global table prefix allows you to set a prefix that will be applied to all tables unless overridden by specific table settings.

[
    'database' => [
        'globalTablePrefix' => 'prefix_'
    ]
]

Table Settings

Simple table aliases can be set up as follows:

[
    'database' => [
        'tables' => [
            'tableAlias' => 'tableName'
        ]
    ]
]

Or more fine grain control can be achieved by specifying the table name, read and write connections, and whether to use the global prefix:

[
    'database' => [
        'tables' => [
            'tableAlias' => [
                'table' => 'tableName',
                'readConnection' => 'readConnectionName',
                'writeConnection' => 'writeConnectionName',
                'useGlobalPrefix' => true|false
            ] 
        ]
    ]
]