DBSchemaManager
abstract class DBSchemaManager (View source)
Represents and handles all schema management for a database
Properties
| protected | Database | $database | Instance of the database controller this schema belongs to |
|
| protected | bool | $supressOutput | If this is false, then information about database operations will be displayed, eg creation of tables. |
|
| protected static | array<string,string> | $table_name_warnings | ||
| protected | array | $tableList | The table list, generated by the tableList() function. |
|
| protected | bool | $schemaIsUpdating | Keeps track whether we are currently updating the schema. |
|
| protected | array | $schemaUpdateTransaction | Large array structure that represents a schema update transaction |
Methods
Execute the given SQL parameterised query with the specified arguments
Cancels the schema updates requested during (but not after) schemaUpdate() call.
Returns true if schema modifications were requested during (but not after) schemaUpdate() call.
Instruct the schema manager to record a table creation to later execute
Instruct the schema manager to record a table alteration to later execute
Instruct the schema manager to record a field to be later created
Instruct the schema manager to record an index to be later created
Instruct the schema manager to record a field to be later updated
Instruct the schema manager to record an index to be later updated
Handler for the other transXXX methods - mark the given table as being altered if it doesn't already exist
Generate the following table in the database, modifying whatever already exists as necessary.
If the given table exists, move it out of the way by renaming it to obsolete(tablename).
Generate the given index in the database, modifying whatever already exists as necessary.
Splits a spec string safely, considering quoted columns, whitespace, and cleaning brackets
Builds a properly quoted column list from an array
Given an index specification in the form of a string ensure that each column name is property quoted, stripping brackets and modifiers.
Given an index spec determines the index type
This takes the index spec which has been provided by a class (ie static $indexes = blah blah) and turns it into a proper string.
Returns true if the given table is exists in the current database
Return true if the table exists and already has a the field specified
Generate the given field on the table, modifying whatever already exists as necessary.
If the given field exists, move it out of the way by renaming it to obsolete(fieldname).
Show a message about database alteration
This returns the data type for the id column which is the primary key for each table
Checks a table's integrity and repairs it if necessary.
Returns the values of the given enum field
Alter an index on a table.
Determines the key that should be used to identify this index when retrieved from DBSchemaManager->indexList.
Create a new table.
Alter a table's schema.
Change the database column name of the given field.
This allows the cached values for a table's field list to be erased.
Details
static
showTableNameWarning(string $table, string $class)
No description
setDatabase(Database $database)
Injector injection point for database controller
quiet(bool $quiet = true)
Enable suppression of database messages.
Query
query(string $sql, int $errorLevel = E_USER_ERROR)
Execute the given SQL query.
This abstract function must be defined by subclasses as part of the actual implementation. It should return a subclass of SS_Query as the result.
Query
preparedQuery(string $sql, array $parameters, int $errorLevel = E_USER_ERROR)
Execute the given SQL parameterised query with the specified arguments
schemaUpdate(callable $callback)
Initiates a schema update within a single callback
cancelSchemaUpdate()
Cancels the schema updates requested during (but not after) schemaUpdate() call.
bool
isSchemaUpdating()
Returns true if we are during a schema update.
bool
doesSchemaNeedUpdating()
Returns true if schema modifications were requested during (but not after) schemaUpdate() call.
transCreateTable(string $table, array $options = null, array $advanced_options = null)
Instruct the schema manager to record a table creation to later execute
transAlterTable(string $table, array $options, array $advanced_options)
Instruct the schema manager to record a table alteration to later execute
transCreateField(string $table, string $field, string $schema)
Instruct the schema manager to record a field to be later created
transCreateIndex(string $table, string $index, array $schema)
Instruct the schema manager to record an index to be later created
transAlterField(string $table, string $field, string $schema)
Instruct the schema manager to record a field to be later updated
transAlterIndex(string $table, string $index, array $schema)
Instruct the schema manager to record an index to be later updated
protected
transInitTable(string $table)
Handler for the other transXXX methods - mark the given table as being altered if it doesn't already exist
requireTable(string $table, array $fieldSchema = null, array $indexSchema = null, bool $hasAutoIncPK = true, array $options = [], array|bool $extensions = false)
Generate the following table in the database, modifying whatever already exists as necessary.
dontRequireTable(string $table)
If the given table exists, move it out of the way by renaming it to obsolete(tablename).
requireIndex(string $table, string $index, string|array|bool $spec)
Generate the given index in the database, modifying whatever already exists as necessary.
The keys of the array are the names of the index. The values of the array can be one of:
- true: Create a single column index on the field named the same as the index.
- ['type' => 'index|unique|fulltext', 'value' => 'FieldA, FieldB']: This gives you full control over the index.
protected array
explodeColumnString(string $spec)
Splits a spec string safely, considering quoted columns, whitespace, and cleaning brackets
protected string
implodeColumnList(array $columns)
Builds a properly quoted column list from an array
protected string
quoteColumnSpecString(string $spec)
Given an index specification in the form of a string ensure that each column name is property quoted, stripping brackets and modifiers.
This index may also be in the form of a "CREATE INDEX..." sql fragment
protected string
determineIndexType(array|string $spec)
Given an index spec determines the index type
protected string
convertIndexSpec(string|array $indexSpec)
This takes the index spec which has been provided by a class (ie static $indexes = blah blah) and turns it into a proper string.
Some indexes may be arrays, such as fulltext and unique indexes, and this allows database-specific arrays to be created. See requireTable() for details on the index format.
abstract bool
hasTable(string $tableName)
Returns true if the given table is exists in the current database
bool
hasField(string $tableName, string $fieldName)
Return true if the table exists and already has a the field specified
requireField(string $table, string $field, array|string $spec)
Generate the given field on the table, modifying whatever already exists as necessary.
dontRequireField(string $table, string $fieldName)
If the given field exists, move it out of the way by renaming it to obsolete(fieldname).
alterationMessage(string $message, string $type = "")
Show a message about database alteration
abstract string
IdColumn(bool $asDbValue = false, bool $hasAutoIncPK = true)
This returns the data type for the id column which is the primary key for each table
abstract bool
checkAndRepairTable(string $tableName)
Checks a table's integrity and repairs it if necessary.
fixTableCase(string $tableName)
Ensure the given table has the correct case
abstract array
enumValuesForField(string $tableName, string $fieldName)
Returns the values of the given enum field
abstract
dbDataType($type)
No description
abstract array
databaseList()
Retrieves the list of all databases the user has access to
abstract bool
databaseExists(string $name)
Determine if the database with the specified name exists
abstract bool
createDatabase(string $name)
Create a database with the specified name
abstract
dropDatabase(string $name)
Drops a database with the specified name
abstract
alterIndex(string $tableName, string $indexName, array $indexSpec)
Alter an index on a table.
abstract protected string
indexKey(string $table, string $index, array $spec)
Determines the key that should be used to identify this index when retrieved from DBSchemaManager->indexList.
In some connectors this is the database-visible name, in others the usercode-visible name.
abstract array[]
indexList(string $table)
Return the list of indexes in a table.
abstract array
tableList()
Returns a list of all tables in the database.
Keys are table names in lower case, values are table names in case that database expects.
abstract string
createTable(string $table, array $fields = null, array $indexes = null, array $options = null, array $advancedOptions = null)
Create a new table.
abstract
alterTable(string $table, array $newFields = null, array $newIndexes = null, array $alteredFields = null, array $alteredIndexes = null, array $alteredOptions = null, array $advancedOptions = null)
Alter a table's schema.
abstract
renameTable(string $oldTableName, string $newTableName)
Rename a table.
abstract
createField(string $table, string $field, string $spec)
Create a new field on a table.
abstract
renameField(string $tableName, string $oldName, string $newName)
Change the database column name of the given field.
abstract array
fieldList(string $table)
Get a list of all the fields for the given table.
Returns a map of field name => field spec.
bool
clearCachedFieldlist(string $tableName = null)
This allows the cached values for a table's field list to be erased.
If $tablename is empty, then the whole cache is erased.
abstract string
boolean(array $values)
Returns data type for 'boolean' column
abstract string
date(array $values)
Returns data type for 'date' column
abstract string
decimal(array $values)
Returns data type for 'decimal' column
abstract string
enum(array $values)
Returns data type for 'set' column
abstract string
set(array $values)
Returns data type for 'set' column
abstract string
float(array $values)
Returns data type for 'float' column
abstract string
int(array $values)
Returns data type for 'int' column
abstract string
datetime(array $values)
Returns data type for 'datetime' column
abstract string
text(array $values)
Returns data type for 'text' column
abstract string
time(array $values)
Returns data type for 'time' column
abstract string
varchar(array $values)
Returns data type for 'varchar' column
abstract
year($values)
No description