void createIndexSql(
string
$table, string
$name,
$definition
)
|
|
Get the stucture of a field into an array
Parameters:
|
string |
$table: |
name of the table on which the index is to be created |
|
string |
$name: |
name of the index to be created |
|
array |
$definition: |
associative array that defines properties of the index to be created. Currently, only one property named FIELDS is supported. This property is also an associative with the names of the index fields as array indexes. Each entry of this array is set to another type of associative array that specifies properties of the index that are specific to each field. Currently, only the sorting property is supported. It should be used to define the sorting direction of the index. It may be set to either ascending or descending. Not all DBMS support index sorting direction configuration. The DBMS drivers of those that do not support it ignore this property. Use the function support() to determine whether the DBMS driver can manage indexes. Example array( 'fields' => array( 'user_name' => array( 'sorting' => 'ascending' ), 'last_login' => array() ) ) |
API Tags:
Information Tags:
Redefinition of:
- Doctrine_Export::createIndexSql()
- Get the stucture of a field into an array
boolean createSequence(
string
$seqName, [string
$start = 1], [
$options = array()]
)
|
|
create sequence
Parameters:
|
string |
$seqName: |
name of the sequence to be created |
|
string |
$start: |
start value of the sequence; default is 1 |
|
array |
$options: |
An associative array of table options: array( 'comment' => 'Foo', 'charset' => 'utf8', 'collate' => 'utf8_unicode_ci', ); |
API Tags:
Redefinition of:
- Doctrine_Export::createSequence()
- create sequence
void createTableSql(
string
$name,
$fields, [
$options = array()]
)
|
|
create a new table
Parameters:
|
string |
$name: |
Name of the database that should be created |
|
array |
$fields: |
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 ) ); |
|
array |
$options: |
An associative array of table options: |
API Tags:
Redefinition of:
- Doctrine_Export::createTableSql()
- create a new table
void dropDatabase(
string
$name
)
|
|
drop an existing database
Parameters:
|
string |
$name: |
name of the database that should be dropped |
API Tags:
Information Tags:
| Throws: | Doctrine_Export_Exception if something failed during the removal of the database file |
| Throws: | Doctrine_Export_Exception if the database file does not exist |
Redefinition of:
- Doctrine_Export::dropDatabase()
- drop an existing database (this method is implemented by the drivers)
string dropSequenceSql(
string
$sequenceName
)
|
|
drop existing sequence
Parameters:
|
string |
$sequenceName: |
name of the sequence to be dropped |
API Tags:
Redefinition of:
- Doctrine_Export::dropSequenceSql()
- dropSequenceSql drop existing sequence
string getAdvancedForeignKeyOptions(
$definition
)
|
|
getAdvancedForeignKeyOptions Return the FOREIGN KEY query section dealing with non-standard options as MATCH, INITIALLY DEFERRED, ON UPDATE, ...
Parameters:
|
array |
$definition: |
foreign key definition |
API Tags:
Redefinition of:
- Doctrine_Export::getAdvancedForeignKeyOptions()
- getAdvancedForeignKeyOptions Return the FOREIGN KEY query section dealing with non-standard options as MATCH, INITIALLY DEFERRED, ON UPDATE, ...
string getIndexFieldDeclarationList(
$fields
)
|
|
getIndexFieldDeclarationList Obtain DBMS specific SQL code portion needed to set an index declaration to be used in statements like CREATE TABLE.
Parameters:
API Tags:
Redefinition of:
- Doctrine_Export::getIndexFieldDeclarationList()
- getIndexFieldDeclarationList Obtain DBMS specific SQL code portion needed to set an index declaration to be used in statements like CREATE TABLE.