1. class
  2. Dibi
  3. \
  4. Drivers
  5. \
  6. PostgreDriver

PostgreDriver

class PostgreDriver implements Driver, ResultDriver, Reflector

The driver for PostgreSQL database.

Driver options:

  • host, hostaddr, port, dbname, user, password, connect_timeout, options, sslmode, service => see PostgreSQL API
  • string => or use connection string
  • schema => the schema search path
  • charset => character encoding to set (default is utf8)
  • persistent (bool) => try to find a persistent link?
  • resource (resource) => existing connection resource

Methods

__construct()

No description

void
connect(array $config)

Connects to a database.

void
disconnect()

Disconnects from a database.

bool
ping()

Pings database.

ResultDriver|null
query($sql)

Executes the SQL query.

static DriverException
createException($message, $code = null, $sql = null)

No description

int|false
getAffectedRows()

Gets the number of affected rows by the last INSERT, UPDATE or DELETE query.

int|false
getInsertId($sequence)

Retrieves the ID generated for an AUTO_INCREMENT column by the previous INSERT query.

void
begin($savepoint = null)

Begins a transaction (if supported).

void
commit($savepoint = null)

Commits statements in a transaction.

void
rollback($savepoint = null)

Rollback changes in a transaction.

bool
inTransaction()

Is in transaction?

mixed
getResource()

Returns the connection resource.

Reflector
getReflector()

Returns the connection reflector.

ResultDriver
createResultDriver($resource)

Result set driver factory.

string
escapeText($value)

Encodes data for use in a SQL statement.

string
escapeBinary($value)

No description

string
escapeIdentifier($value)

No description

string
escapeBool($value)

No description

string
escapeDate($value)

No description

string
escapeDateTime($value)

No description

string
escapeLike($value, $pos)

Encodes string for use in a LIKE statement.

string
unescapeBinary($value)

Decodes data from result set.

escape($value, $type) deprecated

No description

void
applyLimit($sql, $limit, $offset)

Injects LIMIT/OFFSET to the SQL query.

void
__destruct()

Automatically frees the resources allocated for this result set.

int
getRowCount()

Returns the number of rows in a result set.

array
fetch($assoc)

Fetches the row at current position and moves the internal cursor to the next position.

bool
seek($row)

Moves cursor position without fetching row.

void
free()

Frees the resources allocated for this result set.

array
getResultColumns()

Returns metadata for all columns in a result set.

mixed
getResultResource()

Returns the result set resource.

array
getTables()

Returns list of tables.

array
getColumns($table)

Returns metadata for all columns in a table.

array
getIndexes($table)

Returns metadata for all indexes in a table.

array
getForeignKeys($table)

Returns metadata for all foreign keys in a table.

Details

at line 44
__construct()

No description

Exceptions

NotSupportedException

at line 57
void connect(array $config)

Connects to a database.

Parameters

array $config

Return Value

void

Exceptions

Exception

at line 111
void disconnect()

Disconnects from a database.

Return Value

void

at line 121
bool ping()

Pings database.

Return Value

bool

at line 133
ResultDriver|null query($sql)

Executes the SQL query.

Parameters

$sql

Return Value

ResultDriver|null

Exceptions

DriverException

at line 154
static DriverException createException($message, $code = null, $sql = null)

No description

Parameters

$message
$code
$sql

Return Value

DriverException

at line 183
int|false getAffectedRows()

Gets the number of affected rows by the last INSERT, UPDATE or DELETE query.

Return Value

int|false

number of rows or false on error

at line 193
int|false getInsertId($sequence)

Retrieves the ID generated for an AUTO_INCREMENT column by the previous INSERT query.

Parameters

$sequence

Return Value

int|false

int on success or false on failure

at line 217
void begin($savepoint = null)

Begins a transaction (if supported).

Parameters

$savepoint

Return Value

void

Exceptions

DriverException

at line 229
void commit($savepoint = null)

Commits statements in a transaction.

Parameters

$savepoint

Return Value

void

Exceptions

DriverException

at line 241
void rollback($savepoint = null)

Rollback changes in a transaction.

Parameters

$savepoint

Return Value

void

Exceptions

DriverException

at line 251
bool inTransaction()

Is in transaction?

Return Value

bool

at line 261
mixed getResource()

Returns the connection resource.

Return Value

mixed

at line 271
Reflector getReflector()

Returns the connection reflector.

Return Value

Reflector

at line 282
ResultDriver createResultDriver($resource)

Result set driver factory.

Parameters

$resource

Return Value

ResultDriver

at line 298
string escapeText($value)

Encodes data for use in a SQL statement.

Parameters

$value

Return Value

string

encoded value

at line 311
string escapeBinary($value)

No description

Parameters

$value

Return Value

string

at line 324
string escapeIdentifier($value)

No description

Parameters

$value

Return Value

string

at line 335
string escapeBool($value)

No description

Parameters

$value

Return Value

string

at line 345
string escapeDate($value)

No description

Parameters

$value

Return Value

string

at line 358
string escapeDateTime($value)

No description

Parameters

$value

Return Value

string

at line 373
string escapeLike($value, $pos)

Encodes string for use in a LIKE statement.

Parameters

$value
$pos

Return Value

string

at line 387
string unescapeBinary($value)

Decodes data from result set.

Parameters

$value

Return Value

string

at line 394
escape($value, $type) deprecated

deprecated

No description

Parameters

$value
$type

at line 408
void applyLimit($sql, $limit, $offset)

Injects LIMIT/OFFSET to the SQL query.

Parameters

$sql
$limit
$offset

Return Value

void

at line 429
void __destruct()

Automatically frees the resources allocated for this result set.

Return Value

void

at line 441
int getRowCount()

Returns the number of rows in a result set.

Return Value

int

at line 452
array fetch($assoc)

Fetches the row at current position and moves the internal cursor to the next position.

Parameters

$assoc

Return Value

array

array on success, nonarray if no next record

at line 463
bool seek($row)

Moves cursor position without fetching row.

Parameters

$row

Return Value

bool

true on success, false if unable to seek to specified record

at line 473
void free()

Frees the resources allocated for this result set.

Return Value

void

at line 484
array getResultColumns()

Returns metadata for all columns in a result set.

Return Value

array

of {name, nativetype [, table, fullname, (int) size, (bool) nullable, (mixed) default, (bool) autoincrement, (array) vendor ]}

at line 505
mixed getResultResource()

Returns the result set resource.

Return Value

mixed

at line 519
array getTables()

Returns list of tables.

Return Value

array

of {name [, (bool) view ]}

at line 560
array getColumns($table)

Returns metadata for all columns in a table.

Parameters

$table

Return Value

array

of {name, nativetype [, table, fullname, (int) size, (bool) nullable, (mixed) default, (bool) autoincrement, (array) vendor ]}

at line 627
array getIndexes($table)

Returns metadata for all indexes in a table.

Parameters

$table

Return Value

array

of {name, (array of names) columns [, (bool) unique, (bool) primary ]}

at line 675
array getForeignKeys($table)

Returns metadata for all foreign keys in a table.

Parameters

$table

Return Value

array

Traits

Strict

Better OOP experience.