fSchema

Sets the database

Sets the schema to be cached to the fCache object specified

Returns column information for the table specified

If only a table is specified, column info is in the following format:

array(
    (string) {column name} => array(
        'type'           => (string)  {data type},
        'placeholder'    => (string)  {fDatabase::escape() placeholder for this data type},
        'not_null'       => (boolean) {if value can't be null},
        'default'        => (mixed)   {the default value},
        'valid_values'   => (array)   {the valid values for a varchar field},
        'max_length'     => (integer) {the maximum length in a varchar field},
        'min_value'      => (numeric) {the minimum value for an integer/float field},
        'max_value'      => (numeric) {the maximum value for an integer/float field},
        'decimal_places' => (integer) {the number of decimal places for a decimal/numeric/money/smallmoney field},
        'auto_increment' => (boolean) {if the integer primary key column is a serial/autoincrement/auto_increment/indentity column},
        'comment'        => (string)  {the SQL comment/description for the column}
    ), ...
)

If a table and column are specified, column info is in the following format:

array(
    'type'           => (string)  {data type},
    'placeholder'    => (string)  {fDatabase::escape() placeholder for this data type},
    'not_null'       => (boolean) {if value can't be null},
    'default'        => (mixed)   {the default value-may contain special strings CURRENT_TIMESTAMP, CURRENT_TIME or CURRENT_DATE},
    'valid_values'   => (array)   {the valid values for a varchar field},
    'max_length'     => (integer) {the maximum length in a char/varchar field},
    'min_value'      => (fNumber) {the minimum value for an integer/float field},
    'max_value'      => (fNumber) {the maximum value for an integer/float field},
    'decimal_places' => (integer) {the number of decimal places for a decimal/numeric/money/smallmoney field},
    'auto_increment' => (boolean) {if the integer primary key column is a serial/autoincrement/auto_increment/indentity column},
    'comment'        => (string)  {the SQL comment/description for the column}
)

If a table, column and element are specified, returned value is the single element specified.

The 'type' element is homogenized to a value from the following list:

• 'varchar'
• 'char'
• 'text'
• 'integer'
• 'float'
• 'timestamp'
• 'date'
• 'time'
• 'boolean'
• 'blob'

Please note that MySQL reports boolean data types as tinyint(1), so all tinyint(1) columns will be listed as boolean. This can be fixed by calling:

$schema->setColumnInfoOverride(
    array(
        'type'        => 'integer',
        'placeholder' => '%i',
        'default'     => {default integer},
        'min_value'   => new fNumber(-128),
        'max_value'   => new fNumber(127)
    ),
    '{table name}',
    '{column name}'
);

The 'comment' element pulls from the database's column comment facility with the exception of MSSQL and SQLite.

For MSSQL, the comment is pulled from the MS_Description extended property, which can be added via the Description field in SQL Server Management Studio, or via the sp_addextendedproperty stored procedure.

For SQLite, the comment is extracted from any SQL comment that is placed at the end of the line on which the column is defined:

CREATE TABLE users (
    user_id INTEGER PRIMARY KEY AUTOINCREMENT,
    name VARCHAR(200) NOT NULL -- This is the full name
);

For the SQLite users table defined above, the name column will have the comment This is the full name.

Returns the databases on the current server

Returns a list of primary key, foreign key and unique key constraints for the table specified

The structure of the returned array is:

array(
     'primary' => array(
         {column name}, ...
     ),
     'unique'  => array(
         array(
             {column name}, ...
         ), ...
     ),
     'foreign' => array(
         array(
             'column'         => {column name},
             'foreign_table'  => {foreign table name},
             'foreign_column' => {foreign column name},
             'on_delete'      => {the ON DELETE action: 'no_action', 'restrict', 'cascade', 'set_null', or 'set_default'},
             'on_update'      => {the ON UPDATE action: 'no_action', 'restrict', 'cascade', 'set_null', or 'set_default'}
         ), ...
     )
)

Returns a list of one-to-one, many-to-one, one-to-many and many-to-many relationships for the table specified

The structure of the returned array is:

array(
    'one-to-one' => array(
        array(
            'table'          => (string) {the name of the table this relationship is for},
            'column'         => (string) {the column in the specified table},
            'related_table'  => (string) {the related table},
            'related_column' => (string) {the related column},
            'on_delete'      => (string) {the ON DELETE action: 'no_action', 'restrict', 'cascade', 'set_null', or 'set_default'},
            'on_update'      => (string) {the ON UPDATE action: 'no_action', 'restrict', 'cascade', 'set_null', or 'set_default'}
        ), ...
    ),
    'many-to-one' => array(
        array(
            'table'          => (string) {the name of the table this relationship is for},
            'column'         => (string) {the column in the specified table},
            'related_table'  => (string) {the related table},
            'related_column' => (string) {the related column}
        ), ...
    ),
    'one-to-many' => array(
        array(
            'table'          => (string) {the name of the table this relationship is for},
            'column'         => (string) {the column in the specified table},
            'related_table'  => (string) {the related table},
            'related_column' => (string) {the related column},
            'on_delete'      => (string) {the ON DELETE action: 'no_action', 'restrict', 'cascade', 'set_null', or 'set_default'},
            'on_update'      => (string) {the ON UPDATE action: 'no_action', 'restrict', 'cascade', 'set_null', or 'set_default'}
        ), ...
    ),
    'many-to-many' => array(
        array(
            'table'               => (string) {the name of the table this relationship is for},
            'column'              => (string) {the column in the specified table},
            'related_table'       => (string) {the related table},
            'related_column'      => (string) {the related column},
            'join_table'          => (string) {the table that joins the specified table to the related table},
            'join_column'         => (string) {the column in the join table that references 'column'},
            'join_related_column' => (string) {the column in the join table that references 'related_column'},
            'on_delete'           => (string) {the ON DELETE action: 'no_action', 'restrict', 'cascade', 'set_null', or 'set_default'},
            'on_update'           => (string) {the ON UPDATE action: 'no_action', 'restrict', 'cascade', 'set_null', or 'set_default'}
        ), ...
    )
)

Returns the tables in the current database

Allows overriding of column info

Performs an array merge with the column info detected from the database.

To erase a whole table, set the $column_info to NULL. To erase a column, set the $column_info for that column to NULL.

If the $column_info parameter is not NULL, it should be an associative array containing one or more of the following keys. Please see getColumnInfo() for a description of each.

• 'type'
• 'placeholder'
• 'not_null'
• 'default'
• 'valid_values'
• 'max_length'
• 'min_value'
• 'max_value'
• 'decimal_places'
• 'auto_increment'
• 'comment'

The following keys may be set to NULL:

• 'not_null'
• 'default'
• 'valid_values'
• 'max_length'
• 'min_value'
• 'max_value'
• 'decimal_places'
• 'comment'

The key 'auto_increment' should be a boolean.

The 'type' key should be one of:

• 'blob'
• 'boolean'
• 'char'
• 'date'
• 'float'
• 'integer'
• 'text'
• 'time'
• 'timestamp'
• 'varchar'

Allows overriding of key info. Replaces existing info, so be sure to provide full key info for type selected or all types.