Joomla! API

Download
Demo

JDatabaseImporterPostgresql

Extends \JDatabaseImporter

PostgreSQL import driver.

since

12.1
package

Joomla.Platform

Methods

__construct

Constructor.

__construct()
inherited

Sets up the default options for the exporter.

since

13.1

asXml

Set the output option for the exporter to XML format.

asXml() : \JDatabaseImporter
inherited
since

13.1

Response

\JDatabaseImporterMethod supports chaining.

check

Checks if all data and options are in order prior to exporting.

check() : \JDatabaseImporter
inherited abstract
since

13.1
throws

\Exceptionif an error is encountered.

Response

\JDatabaseImporterMethod supports chaining.

from

Specifies the data source to import.

from(mixed $from) : \JDatabaseImporter
inherited
since

13.1

Arguments

$from

mixedThe data source to import.

Response

\JDatabaseImporterMethod supports chaining.

getAddColumnSql

Get the SQL syntax to add a column.

getAddColumnSql(string $table, \SimpleXMLElement $field) : string
since

12.1

Arguments

$table

stringThe table name.

$field

\SimpleXMLElementThe XML field definition.

Response

string

getAddIndexSql

Get the SQL syntax to add an index.

getAddIndexSql(\SimpleXMLElement $field) : string
since

12.1

Arguments

$field

\SimpleXMLElementThe XML index definition.

Response

string

getAddSequenceSql

Get the syntax to add a sequence.

getAddSequenceSql(\SimpleXMLElement $field) : string
since

12.1

Arguments

$field

\SimpleXMLElementThe XML definition for the sequence.

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

12.1

Arguments

$table

stringThe name of the database table to alter.

$field

\SimpleXMLElementThe XML field definition.

Response

string

getAlterTableSql

Get alters for table if there is a difference.

getAlterTableSql(\SimpleXMLElement $structure) : array
since

12.1

Arguments

$structure

\SimpleXMLElementThe XML structure of the table.

Response

array

getChangeColumnSql

Get the syntax to alter a column.

getChangeColumnSql(string $table, \SimpleXMLElement $field) : string
since

12.1

Arguments

$table

stringThe name of the database table to alter.

$field

\SimpleXMLElementThe XML definition for the field.

Response

string

getChangeSequenceSql

Get the syntax to alter a sequence.

getChangeSequenceSql(\SimpleXMLElement $field) : string
since

12.1

Arguments

$field

\SimpleXMLElementThe 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

12.1

Arguments

$field

\SimpleXMLElementThe XML field definition.

Response

string

getDropColumnSql

Get the SQL syntax to drop a column.

getDropColumnSql(string $table, string $name) : string
inherited
since

13.1

Arguments

$table

stringThe table name.

$name

stringThe name of the field to drop.

Response

string

getDropIndexSql

Get the SQL syntax to drop an index.

getDropIndexSql(string $name) : string
since

12.1

Arguments

$name

stringThe name of the key to drop.

Response

string

getDropPrimaryKeySql

Get the SQL syntax to drop a key.

getDropPrimaryKeySql(string $table, string $name) : string
since

12.1

Arguments

$table

stringThe table name.

$name

stringThe constraint name.

Response

string

getDropSequenceSql

Get the SQL syntax to drop a sequence.

getDropSequenceSql(string $name) : string
since

12.1

Arguments

$name

stringThe name of the sequence to drop.

Response

string

getIdxLookup

Get the details list of keys for a table.

getIdxLookup(array $keys) : array
since

12.1
throws

\Exception

Arguments

$keys

arrayAn array of objects that comprise the keys for the table.

Response

arrayThe 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
inherited
since

13.1

Arguments

$table

stringThe name of the table.

Response

stringThe real name of the table.

getSeqLookup

Get the details list of sequences for a table.

getSeqLookup(array $sequences) : array
since

12.1
throws

\Exception

Arguments

$sequences

arrayAn array of objects that comprise the sequences for the table.

Response

arrayThe lookup array. array({key name} => array(object, ...))

mergeStructure

Merges the incoming structure definition with the existing structure.

mergeStructure() : void
inherited
note

Currently only supports XML format.
since

13.1
throws

\RuntimeExceptionon error.

setDbo

Sets the database connector to use for exporting structure and/or data.

setDbo(\JDatabaseDriver $db) : \JDatabaseImporter
inherited
since

13.1

Arguments

$db

\JDatabaseDriverThe database connector.

Response

\JDatabaseImporterMethod supports chaining.

withStructure

Sets an internal option to merge the structure based on the input data.

withStructure(boolean $setting = true) : \JDatabaseImporter
inherited
since

13.1

Arguments

$setting

booleanTrue to export the structure, false to not.

Response

\JDatabaseImporterMethod supports chaining.

Properties

cache

An array of cached data.

inherited

Type(s)

array

db

The database connector to use for exporting structure and/or data.

inherited

Type(s)

\JDatabaseDriver

from

The input source.

inherited

Type(s)

mixed

asFormat

The type of input format (XML).

inherited

Type(s)

string

options

An array of options for the exporter.

inherited

Type(s)

object