Class MySqlPlatform

the column to use

the column to use

the column to use

the column to use

the column to use

literal string or column name

literal string or column name

literal string or column name

literal string or column name

literal string or column name

literal string

literal string to find

an sql string literal or column name/alias

the value that should be matched against

the expression that should be compared to null

the expression that should be compared to null

the value to compare to

the lower value to compare with

the higher value to compare with

name of the database that should be dropped

The name of table to drop.

name of table that should be used in method

name of the index to be dropped

Name of the database that should be created

Associative array that contains the definition of each field of the new table The indexes of the array entries are the names of the fields of the table an the array entry values are associative arrays like those that are meant to be passed with the field definitions to get[Type]Declaration() functions. array( 'id' => array( 'type' => 'integer', 'unsigned' => 1 'notnull' => 1 'default' => 0 ), 'name' => array( 'type' => 'text', 'length' => 12 ), 'password' => array( 'type' => 'text', 'length' => 12 ) );

An associative array of table options: array( 'comment' => 'Foo', 'charset' => 'utf8', 'collate' => 'utf8_unicode_ci', 'type' => 'innodb', );

name of the table on which the constraint is to be created

name of the constraint to be created

associative array that defines properties of the constraint to be created. Currently, only one property named FIELDS is supported. This property is also an associative with the names of the constraint fields as array constraints. Each entry of this array is set to another type of associative array that specifies properties of the constraint that are specific to each field.

                            Example
                               array(
                                   'fields' => array(
                                       'user_name' => array(),
                                       'last_login' => array()
                                   )
                               )

name of the table on which the index is to be created

name of the index to be created

associative array that defines properties of the index to be created.

identifier name to be quoted

name of the table on which the foreign key is to be created

associative array that defines properties of the foreign key to be created.

The name of the table that is intended to be changed.

Associative array that contains the details of each type of change that is intended to be performed. The types of changes that are currently supported are defined as follows:

                        name

                           New name for the table.

                       add

                           Associative array with the names of fields to be added as
                            indexes of the array. The value of each entry of the array
                            should be set to another associative array with the properties
                            of the fields to be added. The properties of the fields should
                            be the same as defined by the Metabase parser.

                       remove

                           Associative array with the names of fields to be removed as indexes
                            of the array. Currently the values assigned to each entry are ignored.
                            An empty array should be used for future compatibility.

                       rename

                           Associative array with the names of fields to be renamed as indexes
                            of the array. The value of each entry of the array should be set to
                            another associative array with the entry named name with the new
                            field name and the entry named Declaration that is expected to contain
                            the portion of the field declaration already in DBMS specific SQL code
                            as it is used in the CREATE TABLE statement.

                       change

                           Associative array with the names of the fields to be changed as indexes
                            of the array. Keep in mind that if it is intended to change either the
                            name of a field and any other properties, the change array entries
                            should have the new names of the fields as array indexes.

                           The value of each entry of the array should be set to another associative
                            array with the properties of the fields to that are meant to be changed as
                            array entries. These entries should be assigned to the new values of the
                            respective properties. The properties of the fields should be the same
                            as defined by the Metabase parser.

                       Example
                           array(
                               'name' => 'userlist',
                               'add' => array(
                                   'quota' => array(
                                       'type' => 'integer',
                                       'unsigned' => 1
                                   )
                               ),
                               'remove' => array(
                                   'file_limit' => array(),
                                   'time_limit' => array()
                               ),
                               'change' => array(
                                   'name' => array(
                                       'length' => '20',
                                       'definition' => array(
                                           'type' => 'text',
                                           'length' => 20,
                                       ),
                                   )
                               ),
                               'rename' => array(
                                   'sex' => array(
                                       'name' => 'gender',
                                       'definition' => array(
                                           'type' => 'text',
                                           'length' => 1,
                                           'default' => 'M',
                                       ),
                                   )
                               )
                           )

indicates whether the function should just check if the DBMS driver can perform the requested table alterations if the value is true or actually perform them otherwise.

a multidimensional associative array. The first dimension determines the field name, while the second dimension is keyed with the name of the properties of the field being declared as array indexes. Currently, the types of supported field properties are as follows:

 length
     Integer value that determines the maximum length of the text
     field. If this argument is missing the field should be
     declared to have the longest length allowed by the DBMS.

 default
     Text value to be used as default for this field.

 notnull
     Boolean flag that indicates whether this field is constrained
     to not be set to null.
 charset
     Text value with the default CHARACTER SET for this field.
 collation
     Text value with the default COLLATION for this field.
 unique
     unique constraint

name the field to be declared.

associative array with the name of the properties of the field being declared as array indexes. Currently, the types of supported field properties are as follows:

 length
     Integer value that determines the maximum length of the text
     field. If this argument is missing the field should be
     declared to have the longest length allowed by the DBMS.

 default
     Text value to be used as default for this field.

 notnull
     Boolean flag that indicates whether this field is constrained
     to not be set to null.
 charset
     Text value with the default CHARACTER SET for this field.
 collation
     Text value with the default COLLATION for this field.
 unique
     unique constraint
 check
     column check constraint

associative array with the name of the properties of the field being declared as array indexes. Currently, the types of supported field properties are as follows:

                  unsigned
                   Boolean flag that indicates whether the field
                   should be declared as unsigned integer if
                   possible.

                  default
                   Integer value to be used as default for this
                   field.

                  notnull
                   Boolean flag that indicates whether this field is
                   constrained to not be set to null.

field definition array

check definition

name of the index

index definition

by PHPBoost

an associative array with the following structure: name optional constraint name

     local                   the local field(s)

     foreign                 the foreign reference field(s)

     foreignTable            the name of the foreign table

     onDelete                referential delete action

     onUpdate                referential update action

     deferred                deferred constraint checking

The onDelete and onUpdate keys accept the following values:

CASCADE: Delete or update the row from the parent table and automatically delete or update the matching rows in the child table. Both ON DELETE CASCADE and ON UPDATE CASCADE are supported. Between two tables, you should not define several ON UPDATE CASCADE clauses that act on the same column in the parent table or in the child table.

SET NULL: Delete or update the row from the parent table and set the foreign key column or columns in the child table to NULL. This is valid only if the foreign key columns do not have the NOT NULL qualifier specified. Both ON DELETE SET NULL and ON UPDATE SET NULL clauses are supported.

NO ACTION: In standard SQL, NO ACTION means no action in the sense that an attempt to delete or update a primary key value is not allowed to proceed if there is a related foreign key value in the referenced table.

RESTRICT: Rejects the delete or update operation for the parent table. NO ACTION and RESTRICT are the same as omitting the ON DELETE or ON UPDATE clause.

SET DEFAULT

foreign key definition

foreign key referential action

name of the charset

name of the collation

even keys are strings, odd are patterns (% and _)

optional pattern operator (LIKE, ILIKE and maybe others in the future)

optional field name that is being matched against (might be required when emulating ILIKE)

The SQL string to write to / append to.

name of the database that should be created

name of the charset

We need to get the specific format for each dbms and override this function for each platform

array $field

The column name for which to get the correct character casing.

name of the collation