class DBSchemaManager

Represents and handles all schema management for a database

Config options

check_and_repair_on_build bool

Methods

static 
showTableNameWarning($table, $class) deprecated

No description

setDatabase(Database $database)

Injector injection point for database controller

quiet(bool $quiet = true)

Enable supression of database messages.

query(string $sql, int $errorLevel = E_USER_ERROR)

Execute the given SQL 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.

boolean
isSchemaUpdating()

Returns true if we are during a schema update.

boolean
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

requireTable(string $table, array $fieldSchema = null, array $indexSchema = null, boolean $hasAutoIncPK = true, array $options = array(), 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|boolean $spec)

Generate the given index in the database, modifying whatever already exists as necessary.

boolean
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

string
IdColumn(boolean $asDbValue = false, boolean $hasAutoIncPK = true)

This returns the data type for the id column which is the primary key for each table

boolean
checkAndRepairTable(string $tableName)

Checks a table's integrity and repairs it if necessary.

fixTableCase(string $tableName)

Ensure the given table has the correct case

array
enumValuesForField(string $tableName, string $fieldName)

Returns the values of the given enum field

dbDataType($type)

No description

array
databaseList()

Retrieves the list of all databases the user has access to

boolean
databaseExists(string $name)

Determine if the database with the specified name exists

boolean
createDatabase(string $name)

Create a database with the specified name

dropDatabase(string $name)

Drops a database with the specified name

alterIndex(string $tableName, string $indexName, array $indexSpec)

Alter an index on a table.

array[array]
indexList(string $table)

Return the list of indexes in a table.

array
tableList()

Returns a list of all tables in the database.

string
createTable(string $table, array $fields = null, array $indexes = null, array $options = null, array $advancedOptions = null)

Create a new table.

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.

renameTable(string $oldTableName, string $newTableName)

Rename a table.

createField(string $table, string $field, string $spec)

Create a new field on a table.

renameField(string $tableName, string $oldName, string $newName)

Change the database column name of the given field.

array
fieldList(string $table)

Get a list of all the fields for the given table.

boolean
clearCachedFieldlist(string $tableName = null)

This allows the cached values for a table's field list to be erased.

string
boolean(array $values)

Returns data type for 'boolean' column

string
date(array $values)

Returns data type for 'date' column

string
decimal(array $values)

Returns data type for 'decimal' column

string
enum(array $values)

Returns data type for 'set' column

string
set(array $values)

Returns data type for 'set' column

string
float(array $values)

Returns data type for 'float' column

string
int(array $values)

Returns data type for 'int' column

string
datetime(array $values)

Returns data type for 'datetime' column

string
text(array $values)

Returns data type for 'text' column

string
time(array $values)

Returns data type for 'time' column

string
varchar(array $values)

Returns data type for 'varchar' column

year($values)

No description

Details

at line 63
static showTableNameWarning($table, $class) deprecated

deprecated 4.0.0:5.0.0

Parameters

$table
$class

at line 73
setDatabase(Database $database)

Injector injection point for database controller

Parameters

Database $database

at line 105
quiet(bool $quiet = true)

Enable supression of database messages.

Parameters

bool $quiet

at line 119
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.

Parameters

string $sql The SQL query to execute
int $errorLevel The level of error reporting to enable for the query

Return Value

Query

at line 133
Query preparedQuery(string $sql, array $parameters, int $errorLevel = E_USER_ERROR)

Execute the given SQL parameterised query with the specified arguments

Parameters

string $sql The SQL query to execute. The ? character will denote parameters.
array $parameters An ordered list of arguments.
int $errorLevel The level of error reporting to enable for the query

Return Value

Query

at line 143
schemaUpdate(callable $callback)

Initiates a schema update within a single callback

Parameters

callable $callback

at line 205
cancelSchemaUpdate()

Cancels the schema updates requested during (but not after) schemaUpdate() call.

at line 216
boolean isSchemaUpdating()

Returns true if we are during a schema update.

Return Value

boolean

at line 226
boolean doesSchemaNeedUpdating()

Returns true if schema modifications were requested during (but not after) schemaUpdate() call.

Return Value

boolean

at line 240
transCreateTable(string $table, array $options = null, array $advanced_options = null)

Instruct the schema manager to record a table creation to later execute

Parameters

string $table Name of the table
array $options Create table options (ENGINE, etc.)
array $advanced_options Advanced table creation options

at line 258
transAlterTable(string $table, array $options, array $advanced_options)

Instruct the schema manager to record a table alteration to later execute

Parameters

string $table Name of the table
array $options Create table options (ENGINE, etc.)
array $advanced_options Advanced table creation options

at line 272
transCreateField(string $table, string $field, string $schema)

Instruct the schema manager to record a field to be later created

Parameters

string $table Name of the table to hold this field
string $field Name of the field to create
string $schema Field specification as a string

at line 285
transCreateIndex(string $table, string $index, array $schema)

Instruct the schema manager to record an index to be later created

Parameters

string $table Name of the table to hold this index
string $index Name of the index to create
array $schema Already parsed index specification

at line 298
transAlterField(string $table, string $field, string $schema)

Instruct the schema manager to record a field to be later updated

Parameters

string $table Name of the table to hold this field
string $field Name of the field to update
string $schema Field specification as a string

at line 311
transAlterIndex(string $table, string $index, array $schema)

Instruct the schema manager to record an index to be later updated

Parameters

string $table Name of the table to hold this index
string $index Name of the index to update
array $schema Already parsed index specification

at line 354
requireTable(string $table, array $fieldSchema = null, array $indexSchema = null, boolean $hasAutoIncPK = true, array $options = array(), array|bool $extensions = false)

Generate the following table in the database, modifying whatever already exists as necessary.

Parameters

string $table The name of the table
array $fieldSchema A list of the fields to create, in the same form as DataObject::$db
array $indexSchema A list of indexes to create. See {@link requireIndex()} The values of the array can be one of: - true: Create a single column index on the field named the same as the index. - array('fields' => array('A','B','C'), 'type' => 'index/unique/fulltext'): This gives you full control over the index.
boolean $hasAutoIncPK A flag indicating that the primary key on this table is an autoincrement type
array $options Create table options (ENGINE, etc.)
array|bool $extensions List of extensions

at line 456
dontRequireTable(string $table)

If the given table exists, move it out of the way by renaming it to obsolete(tablename).

Parameters

string $table The table name.

at line 489
requireIndex(string $table, string $index, string|array|boolean $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. - array('type' => 'index|unique|fulltext', 'value' => 'FieldA, FieldB'): This gives you full control over the index.

Parameters

string $table The table name.
string $index The index name.
string|array|boolean $spec The specification of the index in any loose format. See requireTable() for more information.

at line 628
abstract boolean hasTable(string $tableName)

Returns true if the given table is exists in the current database

Parameters

string $tableName Name of table to check

Return Value

boolean Flag indicating existence of table

at line 637
bool hasField(string $tableName, string $fieldName)

Return true if the table exists and already has a the field specified

Parameters

string $tableName
  • The table to check
string $fieldName
  • The field to check

Return Value

bool
  • True if the table exists and the field exists on the table

at line 656
requireField(string $table, string $field, array|string $spec)

Generate the given field on the table, modifying whatever already exists as necessary.

Parameters

string $table The table name.
string $field The field name.
array|string $spec The field specification. If passed in array syntax, the specific database driver takes care of the ALTER TABLE syntax. If passed as a string, its assumed to be prepared as a direct SQL framgment ready for insertion into ALTER TABLE. In this case you'll need to take care of database abstraction in your DBField subclass.

at line 762
dontRequireField(string $table, string $fieldName)

If the given field exists, move it out of the way by renaming it to obsolete(fieldname).

Parameters

string $table
string $fieldName

at line 786
alterationMessage(string $message, string $type = "")

Show a message about database alteration

Parameters

string $message to display
string $type one of [created|changed|repaired|obsolete|deleted|error]

at line 849
abstract string IdColumn(boolean $asDbValue = false, boolean $hasAutoIncPK = true)

This returns the data type for the id column which is the primary key for each table

Parameters

boolean $asDbValue
boolean $hasAutoIncPK

Return Value

string

at line 857
abstract boolean checkAndRepairTable(string $tableName)

Checks a table's integrity and repairs it if necessary.

Parameters

string $tableName The name of the table.

Return Value

boolean Return true if the table has integrity after the method is complete.

at line 865
fixTableCase(string $tableName)

Ensure the given table has the correct case

Parameters

string $tableName Name of table in desired case

at line 897
abstract array enumValuesForField(string $tableName, string $fieldName)

Returns the values of the given enum field

Parameters

string $tableName Name of table to check
string $fieldName name of enum field to check

Return Value

array List of enum values

at line 908
abstract dbDataType($type)

Parameters

$type

at line 915
abstract array databaseList()

Retrieves the list of all databases the user has access to

Return Value

array List of database names

at line 923
abstract boolean databaseExists(string $name)

Determine if the database with the specified name exists

Parameters

string $name Name of the database to check for

Return Value

boolean Flag indicating whether this database exists

at line 931
abstract boolean createDatabase(string $name)

Create a database with the specified name

Parameters

string $name Name of the database to create

Return Value

boolean True if successful

at line 938
abstract dropDatabase(string $name)

Drops a database with the specified name

Parameters

string $name Name of the database to drop

at line 948
abstract alterIndex(string $tableName, string $indexName, array $indexSpec)

Alter an index on a table.

Parameters

string $tableName The name of the table.
string $indexName The name of the index.
array $indexSpec The specification of the index, see Database::requireIndex() for more details.

at line 971
abstract array[array] indexList(string $table)

Return the list of indexes in a table.

Parameters

string $table The table name.

Return Value

array[array] List of current indexes in the table, each in standard array form. The key for this array should be predictable using the indexKey method

at line 980
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.

Return Value

array

at line 995
abstract string createTable(string $table, array $fields = null, array $indexes = null, array $options = null, array $advancedOptions = null)

Create a new table.

Parameters

string $table The name of the table
array $fields A map of field names to field types
array $indexes A map of indexes
array $options An map of additional options. The available keys are as follows: - 'MSSQLDatabase'/'MySQLDatabase'/'PostgreSQLDatabase' - database-specific options such as "engine" for MySQL. - 'temporary' - If true, then a temporary table will be created
array $advancedOptions Advanced creation options

Return Value

string The table name generated. This may be different from the table name, for example with temporary tables.

at line 1014
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.

Parameters

string $table The name of the table to alter
array $newFields New fields, a map of field name => field schema
array $newIndexes New indexes, a map of index name => index type
array $alteredFields Updated fields, a map of field name => field schema
array $alteredIndexes Updated indexes, a map of index name => index type
array $alteredOptions
array $advancedOptions

at line 1030
abstract renameTable(string $oldTableName, string $newTableName)

Rename a table.

Parameters

string $oldTableName The old table name.
string $newTableName The new table name.

at line 1039
abstract createField(string $table, string $field, string $spec)

Create a new field on a table.

Parameters

string $table Name of the table.
string $field Name of the field to add.
string $spec The field specification, eg 'INTEGER NOT NULL'

at line 1048
abstract renameField(string $tableName, string $oldName, string $newName)

Change the database column name of the given field.

Parameters

string $tableName The name of the tbale the field is in.
string $oldName The name of the field to change.
string $newName The new name of the field

at line 1057
abstract array fieldList(string $table)

Get a list of all the fields for the given table.

Returns a map of field name => field spec.

Parameters

string $table The table name.

Return Value

array

at line 1067
boolean 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.

Parameters

string $tableName

Return Value

boolean

at line 1079
abstract string boolean(array $values)

Returns data type for 'boolean' column

Parameters

array $values Contains a tokenised list of info about this data type

Return Value

string

at line 1087
abstract string date(array $values)

Returns data type for 'date' column

Parameters

array $values Contains a tokenised list of info about this data type

Return Value

string

at line 1095
abstract string decimal(array $values)

Returns data type for 'decimal' column

Parameters

array $values Contains a tokenised list of info about this data type

Return Value

string

at line 1103
abstract string enum(array $values)

Returns data type for 'set' column

Parameters

array $values Contains a tokenised list of info about this data type

Return Value

string

at line 1111
abstract string set(array $values)

Returns data type for 'set' column

Parameters

array $values Contains a tokenised list of info about this data type

Return Value

string

at line 1119
abstract string float(array $values)

Returns data type for 'float' column

Parameters

array $values Contains a tokenised list of info about this data type

Return Value

string

at line 1127
abstract string int(array $values)

Returns data type for 'int' column

Parameters

array $values Contains a tokenised list of info about this data type

Return Value

string

at line 1135
abstract string datetime(array $values)

Returns data type for 'datetime' column

Parameters

array $values Contains a tokenised list of info about this data type

Return Value

string

at line 1143
abstract string text(array $values)

Returns data type for 'text' column

Parameters

array $values Contains a tokenised list of info about this data type

Return Value

string

at line 1151
abstract string time(array $values)

Returns data type for 'time' column

Parameters

array $values Contains a tokenised list of info about this data type

Return Value

string

at line 1159
abstract string varchar(array $values)

Returns data type for 'varchar' column

Parameters

array $values Contains a tokenised list of info about this data type

Return Value

string

at line 1167
abstract year($values)

Parameters

$values