Inheritence

Doctrine_Export_Mysql  < Doctrine_Export  < Doctrine_Connection_Module

Method Details

• $name	name of the table that is intended to be changed.
  $changes	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 f
  $check	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.

  (boolean) alterTableSql($name, $changes, $check = false)

  alter an existing table

  
  

• createDatabaseSql($name)

  
  

• $table	name of the table on which the index is to be created
  $name	name of the index to be created
  $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 i

  createIndexSql($table, $name, $definition)

  Get the stucture of a field into an array

  throws PDOException

  
  

• $sequenceName	name of the sequence to be created
  $start	start value of the sequence; default is 1
  $options	An associative array of table options: array( 'comment' => 'Foo', 'charset' => 'utf8', 'collate' => 'utf8_unicode_ci', 'type&ap

  (boolean) createSequence($sequenceName, $start = 1, $options = array())

  create sequence

  
  

• $name	Name of the database that should be created
  $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 associ
  $options	An associative array of table options: array( 'comment' => 'Foo', 'charset' => 'utf8', 'collate' => 'utf8_unicode_ci', 'type&ap

  createTableSql($name, $fields, $options = array())

  create a new table

  
  

• $name

  name of the database that should be dropped

  (string) dropDatabaseSql($name)

  drop an existing database

  
  

• $table	name of table that should be used in method
  $name	name of the foreign key to be dropped

  dropForeignKey($table, $name)

  drop existing foreign key

  
  

• $table	name of table that should be used in method
  $name	name of the index to be dropped

  dropIndexSql($table, $name)

  drop existing index

  
  

• $table

  name of table that should be dropped from the database

  dropTableSql($table)

  dropTable

  throws PDOException

  
  

• (string) getAdvancedForeignKeyOptions($definition)

  getAdvancedForeignKeyOptions Return the FOREIGN KEY query section dealing with non-standard options as MATCH, INITIALLY DEFERRED, ON UPDATE, ...

  
  

• $name	name the field to be declared.
  $field	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 val

  (string) getDeclaration($name, $field)

  Obtain DBMS specific SQL code portion needed to declare a generic type field to be used in statements like CREATE TABLE.

  Doctrine_Export_Mysql

  
  

• $field

  field definition array

  (string) getDefaultFieldDeclaration($field)

  getDefaultDeclaration Obtain DBMS specific SQL code portion needed to set a default value declaration to be used in statements like CREATE TABLE.

  Doctrine_Export_Mysql

  
  

• $definition	index definition
  $charset	name of the index

  (string) getIndexDeclaration($name, $definition, $charset)

  Obtain DBMS specific SQL code portion needed to set an index declaration to be used in statements like CREATE TABLE.

  Doctrine_Export_Mysql

  
  

• (string) getIndexFieldDeclarationList($fields)

  getIndexFieldDeclarationList Obtain DBMS specific SQL code portion needed to set an index declaration to be used in statements like CREATE TABLE.