Docs For Class atkMysqlDDL

Inherited Properties	Inherited Methods
Inherited From atkDDL atkDDL::$m_db atkDDL::$m_fields atkDDL::$m_idxnameFormat atkDDL::$m_indexes atkDDL::$m_primarykey atkDDL::$m_remove_field atkDDL::$m_table	Inherited From atkDDL atkDDL::atkDDL() Default constructor atkDDL::addField() Add a field to the table definition. atkDDL::addFields() Add multiple fields at once using the given metadata. atkDDL::buildAlter() Build one or more ALTER TABLE queries and return them as an array of strings. atkDDL::buildConstraints() Convert all constraints to a string that can be used in a CREATE TABLE statement. atkDDL::buildCreate() Build a CREATE TABLE query and return it as a string. atkDDL::buildDrop() Build a DROP TABLE query and return it as a string. atkDDL::buildField() Generate a string for a field, to be used inside a CREATE TABLE statement. atkDDL::buildFields() Convert all fields to a string that can be used in a CREATE or ALTER TABLE statement. atkDDL::buildPrimaryKey() Generate a string that defines the primary key, for use inside the CREATE TABLE statement. atkDDL::buildView() Build CREATE VIEW query atkDDL::calculateDecimalFieldSize() Calculate the correct field size for decimal fields We should add the decimals to the size, since size is specified including the decimals. atkDDL::create() Static factory method for creating a new atkDDL instance. This static method will determine the database type (mysql, oci, etc) and instantiate the correct DDL class. atkDDL::createIndex() Create an index atkDDL::dropField() Drop a field from the table definition. atkDDL::dropIndex() Drop an existing index atkDDL::dropSequence() Drop sequence atkDDL::dropView() Build DROP VIEW query atkDDL::executeAlter() Build and execute ALTER TABLE queries. atkDDL::executeCreate() Build and execute the CREATE TABLE query. atkDDL::executeCreateView() Build and execute CREATE VIEW query atkDDL::executeDrop() Build and execute the DROP TABLE query. atkDDL::executeDropView() Build and execute DROP VIEW query atkDDL::getGenericType() Convert an database specific type to an ATK generic datatype. atkDDL::getIndexName() Get Indexname atkDDL::getType() Convert an ATK generic datatype to a database specific type. atkDDL::loadMetaData() Set all table data at once using the given table meta data, retrieved using the metadata function of the db instance. atkDDL::needsQuotes() Method to determine whether quotes are needed around the values for a given generic datatype. atkDDL::needsSize() Method to determine whether a given generic field type needs to have a size defined. atkDDL::renameSequence() Rename sequence atkDDL::renameTable() Rename table name atkDDL::setTable() Set the name of the table. atkDDL::_buildConstraintsArray() Convert all constraints to an array that can be used in a CREATE or ALTER TABLE statement. atkDDL::_buildFieldsArray() Convert all fields to string that can be used in a CREATE or ALTER TABLE statement. Fields will be returned in an array. (INTERNAL USE ONLY)

Inherited Properties

Inherited Methods

Inherited From atkDDL

atkDDL::$m_db

atkDDL::$m_fields

atkDDL::$m_idxnameFormat

atkDDL::$m_indexes

atkDDL::$m_primarykey

atkDDL::$m_remove_field

atkDDL::$m_table

Inherited From atkDDL

atkDDL::atkDDL()

Default constructor

atkDDL::addField()

Add a field to the table definition.

atkDDL::addFields()

Add multiple fields at once using the given metadata.

atkDDL::buildAlter()

Build one or more ALTER TABLE queries and return them as an array of strings.

atkDDL::buildConstraints()

Convert all constraints to a string that can be used in a CREATE TABLE statement.

atkDDL::buildCreate()

Build a CREATE TABLE query and return it as a string.

atkDDL::buildDrop()

Build a DROP TABLE query and return it as a string.

atkDDL::buildField()

Generate a string for a field, to be used inside a CREATE TABLE statement.

atkDDL::buildFields()

Convert all fields to a string that can be used in a CREATE or ALTER TABLE statement.

atkDDL::buildPrimaryKey()

Generate a string that defines the primary key, for use inside the CREATE TABLE statement.

atkDDL::buildView()

Build CREATE VIEW query

atkDDL::calculateDecimalFieldSize()

Calculate the correct field size for decimal fields We should add the decimals to the size, since size is specified including the decimals.

atkDDL::create()

Static factory method for creating a new atkDDL instance. This static method will determine the database type (mysql, oci, etc) and instantiate the correct DDL class.

atkDDL::createIndex()

Create an index

atkDDL::dropField()

Drop a field from the table definition.

atkDDL::dropIndex()

Drop an existing index

atkDDL::dropSequence()

Drop sequence

atkDDL::dropView()

Build DROP VIEW query

atkDDL::executeAlter()

Build and execute ALTER TABLE queries.

atkDDL::executeCreate()

Build and execute the CREATE TABLE query.

atkDDL::executeCreateView()

Build and execute CREATE VIEW query

atkDDL::executeDrop()

Build and execute the DROP TABLE query.

atkDDL::executeDropView()

Build and execute DROP VIEW query

atkDDL::getGenericType()

Convert an database specific type to an ATK generic datatype.

atkDDL::getIndexName()

Get Indexname

atkDDL::getType()

Convert an ATK generic datatype to a database specific type.

atkDDL::loadMetaData()

Set all table data at once using the given table meta data, retrieved using the metadata function of the db instance.

atkDDL::needsQuotes()

Method to determine whether quotes are needed around the values for a given generic datatype.

atkDDL::needsSize()

Method to determine whether a given generic field type needs to have a size defined.

atkDDL::renameSequence()

Rename sequence

atkDDL::renameTable()

Rename table name

atkDDL::setTable()

Set the name of the table.

atkDDL::_buildConstraintsArray()

Convert all constraints to an array that can be used in a CREATE or ALTER TABLE statement.

atkDDL::_buildFieldsArray()

Convert all fields to string that can be used in a CREATE or ALTER TABLE statement. Fields will be returned in an array. (INTERNAL USE ONLY)

[ Top ]

Property Summary

mixed

$m_table_type

[ Top ]

Method Summary

atkMysqlDDL	atkMysqlDDL()	Constructor
The	buildCreate()	Build a CREATE TABLE query and return it as a string.
void	buildField()	Generate a string for a field, to be used inside a CREATE TABLE statement.
boolean	dropSequence()	Drop sequence
void	getGenericType()	Convert an database specific type to an ATK generic datatype.
void	getType()	Convert an ATK generic datatype to a database specific type.
void	loadMetaData()	Set all table data at once using the given table meta data, retrieved using the metadata function of the db instance.
boolean	renameSequence()	Rename sequence
boolean	renameTable()	Rename table name
void	setTableType()	Sets the table type (for databases that support different table types).

[ Top ]

Properties

mixed $m_table_type = NULL [line 31]

[ Top ]

Methods

Constructor atkMysqlDDL [line 38]

atkMysqlDDL atkMysqlDDL(
)

Constructor

[ Top ]

buildCreate [line 166]

The buildCreate(
)

Build a CREATE TABLE query and return it as a string.

API Tags:

Return:

CREATE TABLE query.

Redefinition of:

atkDDL::buildCreate(): Build a CREATE TABLE query and return it as a string.

[ Top ]

buildField [line 123]

void buildField(
string
$name, string
$generictype, [int
$size = 0], [int
$flags = 0], [mixed
$default = NULL] 
)

Generate a string for a field, to be used inside a CREATE TABLE statement.

This function tries to be generic, so it will work in the largest number of databases. Databases that won't work with this syntax, should override this method in the database specific ddl class.

Parameters:

string	$name:	The name of the field
string	$generictype:	The datatype of the field (should be one of the generic types supported by ATK).
int	$size:	The size of the field (if appropriate)
int	$flags:	The DDL_ flags for this field.
mixed	$default:	The default value to be used when inserting new rows.

Redefinition of:

atkDDL::buildField(): Generate a string for a field, to be used inside a CREATE TABLE statement.

[ Top ]

dropSequence [line 190]

boolean dropSequence(
string
$name 
)

Drop sequence

Parameters:

string

$name:

Sequence name

Redefinition of:

atkDDL::dropSequence(): Drop sequence

[ Top ]

getGenericType [line 79]

void getGenericType(
string
$type 
)

Convert an database specific type to an ATK generic datatype.

Parameters:

string

$type:

The database specific datatype to convert.

Redefinition of:

atkDDL::getGenericType(): Convert an database specific type to an ATK generic datatype.

Redefined in descendants as:

atkMysqliDDL::getGenericType() : Convert an database specific type to an ATK generic datatype.

[ Top ]

getType [line 47]

void getType(
string
$generictype 
)

Convert an ATK generic datatype to a database specific type.

Parameters:

string

$generictype:

The datatype to convert.

Redefinition of:

atkDDL::getType(): Convert an ATK generic datatype to a database specific type.

[ Top ]

loadMetaData [line 144]

void loadMetaData(
array
$tablemeta 
)

Set all table data at once using the given table meta data, retrieved using the metadata function of the db instance.

Parameters:

array

$tablemeta:

table meta data array

Redefinition of:

atkDDL::loadMetaData(): Set all table data at once using the given table meta data, retrieved using the metadata function of the db instance.

[ Top ]

renameSequence [line 203]

boolean renameSequence(
string
$name, string
$new_name 
)

Rename sequence

Parameters:

string	$name:	Sequence name
string	$new_name:	New sequence name

Redefinition of:

atkDDL::renameSequence(): Rename sequence

[ Top ]

renameTable [line 218]

boolean renameTable(
string
$name, string
$new_name 
)

Rename table name

Parameters:

string	$name:	Table name
string	$new_name:	New table name

Redefinition of:

atkDDL::renameTable(): Rename table name

[ Top ]

setTableType [line 156]

void setTableType(
string
$type 
)

Sets the table type (for databases that support different table types).

Parameters:

string

$type:

[ Top ]