PgsqlImporter
Extends DatabaseImporterPDO PostgreSQL Database Importer.
since |
1.5.0 |
---|---|
package |
Joomla Framework |
Methods
__construct
Constructor.
__construct() : mixed
Sets up the default options for the importer.
since |
1.0 |
---|
Response
mixed
asXml
Set the output option for the importer to XML format.
asXml() : $this
since |
1.0 |
---|
Response
$this
check
Checks if all data and options are in order prior to importer.
check() : $this
since |
1.0 |
---|---|
throws |
|
Response
$this
from
Specifies the data source to import.
from(\SimpleXMLElement|string from) : $this
since |
1.0 |
---|
Arguments
- from
\SimpleXMLElement|string
The data source to import, either as a SimpleXMLElement object or XML string.
Response
$this
getAddColumnSql
Get the SQL syntax to add a column.
getAddColumnSql(string table, \SimpleXMLElement field) : string
since |
1.0 |
---|
Arguments
- table
string
The table name.- field
\SimpleXMLElement
The XML field definition.
Response
string
getAddIndexSql
Get the SQL syntax to add an index.
getAddIndexSql(\SimpleXMLElement field) : string
since |
1.0 |
---|
Arguments
- field
\SimpleXMLElement
The XML index definition.
Response
string
getAddSequenceSql
Get the syntax to add a sequence.
getAddSequenceSql(\SimpleXMLElement field) : string
since |
1.0 |
---|
Arguments
- field
\SimpleXMLElement
The XML definition for the sequence.
Response
string
getAddUniqueSql
Get the SQL syntax to add a unique constraint for a table key.
getAddUniqueSql(string table, array key) : string
since |
2.0.0 |
---|
Arguments
- table
string
The table name.- key
array
The key.
Response
string
getAlterColumnSql
Get the SQL syntax for a single column that would be included in a table create statement.
getAlterColumnSql(string table, \SimpleXMLElement field) : string
since |
1.0 |
---|
Arguments
- table
string
The name of the database table to alter.- field
\SimpleXMLElement
The XML field definition.
Response
string
getAlterTableSql
Get alters for table if there is a difference.
getAlterTableSql(\SimpleXMLElement structure) : array
since |
2.0.0 |
---|
Arguments
- structure
\SimpleXMLElement
The XML structure of the table.
Response
array
getChangeColumnSql
Get the syntax to alter a column.
getChangeColumnSql(string table, \SimpleXMLElement field) : string
since |
1.0 |
---|
Arguments
- table
string
The name of the database table to alter.- field
\SimpleXMLElement
The XML definition for the field.
Response
string
getChangeSequenceSql
Get the syntax to alter a sequence.
getChangeSequenceSql(\SimpleXMLElement field) : string
since |
1.0 |
---|
Arguments
- field
\SimpleXMLElement
The XML definition for the sequence.
Response
string
getColumnSql
Get the SQL syntax for a single column that would be included in a table create statement.
getColumnSql(\SimpleXMLElement field) : string
since |
1.0 |
---|
Arguments
- field
\SimpleXMLElement
The XML field definition.
Response
string
getDropColumnSql
Get the SQL syntax to drop a column.
getDropColumnSql(string table, string name) : string
since |
1.0 |
---|
Arguments
- table
string
The table name.- name
string
The name of the field to drop.
Response
string
getDropIndexSql
Get the SQL syntax to drop an index.
getDropIndexSql(string name) : string
since |
1.0 |
---|
Arguments
- name
string
The name of the key to drop.
Response
string
getDropPrimaryKeySql
Get the SQL syntax to drop a key.
getDropPrimaryKeySql(string table, string name) : string
since |
1.0 |
---|
Arguments
- table
string
The table name.- name
string
The constraint name.
Response
string
getDropSequenceSql
Get the SQL syntax to drop a sequence.
getDropSequenceSql(string name) : string
since |
1.0 |
---|
Arguments
- name
string
The name of the sequence to drop.
Response
string
getKeyLookup
Get the details list of keys for a table.
getKeyLookup(array keys) : array
since |
1.0 |
---|
Arguments
- keys
array
An array of objects that comprise the keys for the table.
Response
array
The lookup array. array({key name} => array(object, ...))
getRealTableName
Get the real name of the table, converting the prefix wildcard string if present.
getRealTableName(string table) : string
since |
1.0 |
---|
Arguments
- table
string
The name of the table.
Response
string
The real name of the table.
getSeqLookup
Get the details list of sequences for a table.
getSeqLookup(array sequences) : array
since |
1.0 |
---|
Arguments
- sequences
array
An array of objects that comprise the sequences for the table.
Response
array
The lookup array. array({key name} => array(object, ...))
getSetvalSequenceSql
Get the syntax to setval a sequence.
getSetvalSequenceSql(\SimpleXMLElement field) : string
since |
2.0.0 |
---|
Arguments
- field
\SimpleXMLElement
The XML definition for the sequence.
Response
string
importData
Import the data from the source into the existing tables.
importData() : void
note |
Currently only supports XML format. |
---|---|
since |
2.0.0 |
throws |
|
mergeStructure
Merges the incoming structure definition with the existing structure.
mergeStructure() : void
note |
Currently only supports XML format. |
---|---|
since |
1.0 |
throws |
|
setDbo
Sets the database connector to use for exporting structure and/or data.
setDbo(\Joomla\Database\DatabaseInterface db) : $this
since |
1.0 |
---|
Arguments
- db
\Joomla\Database\DatabaseInterface
The database connector.
Response
$this
withStructure
Sets an internal option to merge the structure based on the input data.
withStructure(bool setting = true) : $this
since |
1.0 |
---|
Arguments
- setting
bool
True to import the structure, false to not.
Response
$this
xmlToCreate
Get the SQL syntax to add a table.
xmlToCreate(\SimpleXMLElement table) : string
since |
2.0.0 |
---|---|
throws |
|
Arguments
- table
\SimpleXMLElement
The table information.
Response
string
Properties
cache
An array of cached data.
since |
1.0 |
---|
Type(s)
array
db
The database connector to use for exporting structure and/or data.
since |
1.0 |
---|
Type(s)
\Joomla\Database\DatabaseInterface
from
The input source.
since |
1.0 |
---|
Type(s)
mixed
asFormat
The type of input format.
since |
1.0 |
---|
Type(s)
string
options
An array of options for the exporter.
since |
1.0 |
---|
Type(s)
\stdClass