1. interface
  2. Stancl
  3. \
  4. Tenancy
  5. \
  6. Database
  7. \
  8. Contracts
  9. \
  10. StatefulTenantDatabaseManager

StatefulTenantDatabaseManager

interface StatefulTenantDatabaseManager implements TenantDatabaseManager (View source)

Tenant database manager with a persistent connection.

Methods

bool
createDatabase(TenantWithDatabase $tenant)

Create a database.

from  TenantDatabaseManager
bool
deleteDatabase(TenantWithDatabase $tenant)

Delete a database.

from  TenantDatabaseManager
bool
databaseExists(string $name)

Does a database exist?

from  TenantDatabaseManager
array
makeConnectionConfig(array $baseConfig, string $databaseName)

Construct a DB connection config array.

from  TenantDatabaseManager
Connection
database()

Get the DB connection used by the tenant database manager.

void
setConnection(string $connection)

Set the DB connection that should be used by the tenant database manager.

Details

in TenantDatabaseManager at line 10
bool createDatabase(TenantWithDatabase $tenant)

Create a database.

Parameters

TenantWithDatabase $tenant

Return Value

bool

in TenantDatabaseManager at line 13
bool deleteDatabase(TenantWithDatabase $tenant)

Delete a database.

Parameters

TenantWithDatabase $tenant

Return Value

bool

in TenantDatabaseManager at line 16
bool databaseExists(string $name)

Does a database exist?

Parameters

string $name

Return Value

bool

in TenantDatabaseManager at line 19
array makeConnectionConfig(array $baseConfig, string $databaseName)

Construct a DB connection config array.

Parameters

array $baseConfig
string $databaseName

Return Value

array

at line 16
Connection database()

Get the DB connection used by the tenant database manager.

Return Value

Connection

at line 23
void setConnection(string $connection)

Set the DB connection that should be used by the tenant database manager.

Parameters

string $connection

Return Value

void

Exceptions

NoConnectionSetException