1. class
  2. Stancl
  3. \
  4. Tenancy
  5. \
  6. Database
  7. \
  8. TenantDatabaseManagers
  9. \
  10. PostgreSQLSchemaManager

PostgreSQLSchemaManager

class PostgreSQLSchemaManager extends TenantDatabaseManager (View source)

Properties

protected string $connection

The database connection to the server.

 from  TenantDatabaseManager

Methods

Connection
database()

Get the DB connection used by the tenant database manager.

from  TenantDatabaseManager
void
setConnection(string $connection)

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

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

Construct a DB connection config array.

bool
createDatabase(TenantWithDatabase $tenant)

Create a database.

bool
deleteDatabase(TenantWithDatabase $tenant)

Delete a database.

bool
databaseExists(string $name)

Does a database exist?

Details

in TenantDatabaseManager at line 17
Connection database()

Get the DB connection used by the tenant database manager.

Return Value

Connection

in TenantDatabaseManager at line 26
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

at line 26
array makeConnectionConfig(array $baseConfig, string $databaseName)

Construct a DB connection config array.

Parameters

array $baseConfig
string $databaseName

Return Value

array

at line 11
bool createDatabase(TenantWithDatabase $tenant)

Create a database.

Parameters

TenantWithDatabase $tenant

Return Value

bool

at line 16
bool deleteDatabase(TenantWithDatabase $tenant)

Delete a database.

Parameters

TenantWithDatabase $tenant

Return Value

bool

at line 21
bool databaseExists(string $name)

Does a database exist?

Parameters

string $name

Return Value

bool