DatabaseSchema: ezcDbSchemaHandlerPgsql
[ ]
[ ]
[ ]
[ ]
[ ]
Class: ezcDbSchemaHandlerPgsql
|
Handler for PostgreSQL databases and SQL files. [
source]
Implemented Interfaces
Parents
ezcDbSchemaHandlerSql
|
--ezcDbSchemaHandlerPgsql
Method Summary
|
public void |
closeTransferDestination(
)
Tell destination handler that there is no more data to transfer. [destination] |
|
protected static void |
convertFromStandardType(
$type, &$length )
|
|
protected static void |
convertToStandardType(
$type, &$length )
|
|
protected array |
fetchSchema(
$db, $what )
Fetch schema from given database. |
|
protected static void |
fetchTableFields(
$db, $table )
Fetch fields definition for the given table. |
|
protected static void |
fetchTableIndexes(
$db, $table )
|
|
protected string |
generateAddFieldSql(
$tableName, $fieldName, $fieldSchema, [$params = array()] )
Generate SQL query for adding a table field. |
|
protected string |
generateAddIndexSql(
$tableName, $indexName, $indexSchema, [$params = array()], [$isEmbedded = false] )
Generate index creation SQL query. |
|
protected string |
generateAlterFieldSql(
$tableName, $fieldName, $fieldSchema, [$diffParams = array()] )
Generate SQL query for altering table field schema. |
|
protected static void |
generateCreateSequenceSql(
$seqName, $seqSchema )
|
|
protected array(string) |
generateCreateTableSql(
$tableName, $tableSchema, [$params = array()] )
Generate SQL queries for table creation. |
|
protected static void |
generateDataAsSQL(
$schema )
|
|
protected static void |
generateDataValueTextSQL(
$fieldDef, $value )
|
|
protected static void |
generateDefaultDef(
$table_name, $field_name, $def, $params )
|
|
protected string |
generateDropFieldSql(
$tableName, $fieldName, [$params = array()] )
Generate SQL query for dropping a table field. |
|
protected string |
generateDropIndexSql(
$tableName, $indexName, $indexSchema, [$params = array()] )
Generate drop index SQL query. |
|
protected string |
generateDropTableSql(
$tableName, [$params = array()] )
Generate table dropping SQL query. |
|
protected static void |
generateFieldSql(
$table_name, $field_name, $def, [$params = array()] )
|
|
protected static void |
generateNullDef(
$table_name, $field_name, $def, $params )
|
|
protected static array |
generateSchemaAsSQL(
$schema )
Dump specified schema as an array of SQL queries. |
|
protected static void |
generateUpdateSequencesSQL(
$schema )
|
|
public void |
getDbmsName(
)
|
|
public void |
getSchema(
$schema, $internalFormat, $what )
Return schema in one of internal formats without saving it to a file or database. |
|
public static array |
getSupportedFeatures(
)
|
|
public static void |
getSupportedInternalFormats(
)
Returns the list of internal formats supported by the handler. |
|
public static void |
getSupportedStorageTypes(
)
This handler supports saving/loading schema to/from DB and saving to SQL files. |
|
protected static void |
isTypeLengthSupported(
$pgType )
|
|
public void |
loadSchema(
$src, $storageType, $what )
Loads schema from a database. |
|
public void |
openTransferDestination(
$storage, $storageType )
Prepare destination handler for transfer [destination]. |
|
protected static void |
parseDefault(
&$fieldSchema, $default )
|
|
protected static void |
parseType(
$type_info, &$length_info )
|
|
protected static A |
primaryKeyIndexName(
$tableName, $indexName, $fields )
The name will consist of the table name and _pkey, since it is only allowed to have one primary key pre table that shouldn't be a problem. |
|
protected static void |
reservedKeywordList(
)
|
|
public void |
saveDelta(
$delta, $dst, $storageType )
Saves difference between schemas to an SQL file. |
|
public void |
saveRow(
$row )
Save given row. [destination] |
|
public void |
saveSchema(
$schema, $dst, $storageType, $what )
Saves schema to an SQL file or database. |
|
public void |
setTableBeingTransferred(
$tableName, [$tableFields = null] )
Start to transfer data of the next table. [destination] |
|
public void |
transfer(
$storage, $storageType, $dstHandler )
Actually transfer data [source]. |
Methods
closeTransferDestination
void closeTransferDestination(
)
Tell destination handler that there is no more data to transfer. [destination]
See also:
ezcDbSchemaHandlerDataTransfer.
convertFromStandardType
void convertFromStandardType(
$type,
&$length )
Parameters
| Name |
Type |
Description |
$type |
|
|
&$length |
|
|
convertToStandardType
void convertToStandardType(
$type,
&$length )
Parameters
| Name |
Type |
Description |
$type |
|
|
&$length |
|
|
fetchSchema
array fetchSchema(
$db,
$what )
Fetch schema from given database.
Parameters
| Name |
Type |
Description |
$db |
|
|
$what |
|
|
fetchTableFields
Fetch fields definition for the given table.
Parameters
| Name |
Type |
Description |
$db |
ezcDbHandler |
Database to use. |
$table |
string |
Table to fetch fields from. |
fetchTableIndexes
void fetchTableIndexes(
$db,
$table )
Parameters
| Name |
Type |
Description |
$db |
|
|
$table |
|
|
generateAddFieldSql
string generateAddFieldSql(
$tableName,
$fieldName,
$fieldSchema, [
$params = array()] )
Generate SQL query for adding a table field.
Parameters
| Name |
Type |
Description |
$tableName |
|
|
$fieldName |
|
|
$fieldSchema |
|
|
$params |
|
|
See also:
ezcDbSchemaHandlerSql::generateAddFieldSql().
generateAddIndexSql
string generateAddIndexSql(
$tableName,
$indexName,
$indexSchema, [
$params = array()], [
$isEmbedded = false] )
Generate index creation SQL query.
Parameters
| Name |
Type |
Description |
$tableName |
|
|
$indexName |
|
|
$indexSchema |
|
|
$params |
|
|
$isEmbedded |
|
|
See also:
ezcDbSchemaHandlerSql::generateAddIndexSql().
generateAlterFieldSql
string generateAlterFieldSql(
$tableName,
$fieldName,
$fieldSchema, [
$diffParams = array()] )
Generate SQL query for altering table field schema.
Parameters
| Name |
Type |
Description |
$tableName |
|
|
$fieldName |
|
|
$fieldSchema |
|
|
$diffParams |
|
|
See also:
ezcDbSchemaHandlerSql::generateAlterFieldSql().
generateCreateSequenceSql
void generateCreateSequenceSql(
$seqName,
$seqSchema )
Parameters
| Name |
Type |
Description |
$seqName |
|
|
$seqSchema |
|
|
generateCreateTableSql
array(string) generateCreateTableSql(
$tableName,
$tableSchema, [
$params = array()] )
Generate SQL queries for table creation.
Parameters
| Name |
Type |
Description |
$tableName |
|
|
$tableSchema |
|
|
$params |
|
|
See also:
ezcDbSchemaHandlerSql::generateCreateTableSql().
generateDataAsSQL
void generateDataAsSQL(
$schema )
Parameters
| Name |
Type |
Description |
$schema |
|
|
generateDataValueTextSQL
void generateDataValueTextSQL(
$fieldDef,
$value )
Parameters
| Name |
Type |
Description |
$fieldDef |
|
|
$value |
|
|
generateDefaultDef
void generateDefaultDef(
$table_name,
$field_name,
$def,
$params )
Parameters
| Name |
Type |
Description |
$table_name |
|
|
$field_name |
|
|
$def |
|
|
$params |
|
|
generateDropFieldSql
string generateDropFieldSql(
$tableName,
$fieldName, [
$params = array()] )
Generate SQL query for dropping a table field.
Parameters
| Name |
Type |
Description |
$tableName |
|
|
$fieldName |
|
|
$params |
|
|
See also:
ezcDbSchemaHandlerSql::generateDropFieldSql().
generateDropIndexSql
string generateDropIndexSql(
$tableName,
$indexName,
$indexSchema, [
$params = array()] )
Generate drop index SQL query.
Parameters
| Name |
Type |
Description |
$tableName |
|
|
$indexName |
|
|
$indexSchema |
|
|
$params |
|
|
See also:
ezcDbSchemaHandlerSql::generateDropIndexSql().
generateDropTableSql
string generateDropTableSql(
$tableName, [
$params = array()] )
Generate table dropping SQL query.
Parameters
| Name |
Type |
Description |
$tableName |
|
|
$params |
|
|
See also:
ezcDbSchemaHandlerSql::generateDropTableSql().
generateFieldSql
void generateFieldSql(
$table_name,
$field_name,
$def, [
$params = array()] )
Parameters
| Name |
Type |
Description |
$table_name |
|
|
$field_name |
|
|
$def |
|
|
$params |
|
|
generateNullDef
void generateNullDef(
$table_name,
$field_name,
$def,
$params )
Parameters
| Name |
Type |
Description |
$table_name |
|
|
$field_name |
|
|
$def |
|
|
$params |
|
|
generateSchemaAsSQL
array generateSchemaAsSQL(
$schema )
Dump specified schema as an array of SQL queries.
Parameters
| Name |
Type |
Description |
$schema |
|
|
Throws
| Class | Description |
|---|
ezcDbSchemaException::GENERIC_ERROR |
if there's no schema to generate SQL queries for. |
generateUpdateSequencesSQL
void generateUpdateSequencesSQL(
$schema )
Parameters
| Name |
Type |
Description |
$schema |
|
|
getDbmsName
void getDbmsName(
)
getSchema
void getSchema(
$schema,
$internalFormat,
$what )
Return schema in one of internal formats without saving it to a file or database.
Parameters
| Name |
Type |
Description |
$schema |
|
|
$internalFormat |
|
|
$what |
|
|
Throws
| Class | Description |
|---|
ezcDbSchemaException::UNKNOWN_INTERNAL_FORMAT |
if an unknown internal format specified |
ezcDbSchemaException::INVALID_ARGUMMENT |
if $what is specified incorrectly. |
See also:
ezcDbSchemaHandler::getSchema().
getSupportedFeatures
array getSupportedFeatures(
)
getSupportedInternalFormats
void getSupportedInternalFormats(
)
Returns the list of internal formats supported by the handler.
See also:
ezcDbSchemaHandler::getSupportedInternalFormats().
getSupportedStorageTypes
void getSupportedStorageTypes(
)
This handler supports saving/loading schema to/from DB and saving to SQL files.
isTypeLengthSupported
void isTypeLengthSupported(
$pgType )
Parameters
| Name |
Type |
Description |
$pgType |
|
|
loadSchema
void loadSchema(
$src,
$storageType,
$what )
Loads schema from a database.
Parameters
| Name |
Type |
Description |
$src |
|
|
$storageType |
|
|
$what |
|
|
openTransferDestination
void openTransferDestination(
$storage,
$storageType )
Prepare destination handler for transfer [destination].
Parameters
| Name |
Type |
Description |
$storage |
|
|
$storageType |
|
|
See also:
ezcDbSchemaHandlerDataTransfer.
parseDefault
void parseDefault(
&$fieldSchema,
$default )
Parameters
| Name |
Type |
Description |
&$fieldSchema |
|
|
$default |
|
|
parseType
void parseType(
$type_info,
&$length_info )
Parameters
| Name |
Type |
Description |
$type_info |
|
|
&$length_info |
|
|
primaryKeyIndexName
A primaryKeyIndexName(
$tableName,
$indexName,
$fields )
The name will consist of the table name and _pkey, since it is only allowed to have one primary key pre table that shouldn't be a problem.
Parameters
| Name |
Type |
Description |
$tableName |
|
|
$indexName |
|
|
$fields |
|
|
reservedKeywordList
void reservedKeywordList(
)
saveDelta
void saveDelta(
$delta,
$dst,
$storageType )
Saves difference between schemas to an SQL file.
Parameters
| Name |
Type |
Description |
$delta |
|
|
$dst |
|
|
$storageType |
|
|
saveRow
void saveRow(
$row )
Save given row. [destination]
Parameters
| Name |
Type |
Description |
$row |
|
|
See also:
ezcDbSchemaHandlerDataTransfer.
saveSchema
void saveSchema(
$schema,
$dst,
$storageType,
$what )
Saves schema to an SQL file or database.
Parameters
| Name |
Type |
Description |
$schema |
|
|
$dst |
|
|
$storageType |
|
|
$what |
|
|
setTableBeingTransferred
void setTableBeingTransferred(
$tableName, [
$tableFields = null] )
Start to transfer data of the next table. [destination]
Parameters
| Name |
Type |
Description |
$tableName |
|
|
$tableFields |
|
|
See also:
ezcDbSchemaHandlerDataTransfer.
transfer
void transfer(
$storage,
$storageType,
$dstHandler )
Actually transfer data [source].
Parameters
| Name |
Type |
Description |
$storage |
|
|
$storageType |
|
|
$dstHandler |
|
|
See also:
ezcDbSchemaHandlerDataTransfer.
Last updated: Thu, 01 Nov 2007
