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

PostgreDriver

class PostgreDriver implements Driver

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(array $config)

No description

void
disconnect()

Disconnects from a database.

bool
ping()

Pings database.

ResultDriver|null
query(string $sql)

Executes the SQL query.

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

No description

int|null
getAffectedRows()

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

int|null
getInsertId(string|null $sequence)

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

void
begin(string $savepoint = null)

Begins a transaction (if supported).

void
commit(string $savepoint = null)

Commits statements in a transaction.

void
rollback(string $savepoint = null)

Rollback changes in a transaction.

bool
inTransaction()

Is in transaction?

mixed
getResource()

Returns the connection resource.

Reflector
getReflector()

Returns the connection reflector.

PostgreResult
createResultDriver(resource $resource)

Result set driver factory.

string
escapeText(string $value)

Encodes data for use in a SQL statement.

string
escapeBinary(string $value)

No description

string
escapeIdentifier(string $value)

No description

string
escapeBool(bool $value)

No description

string
escapeDate(DateTimeInterface|string|int $value)

No description

string
escapeDateTime(DateTimeInterface|string|int $value)

No description

string
escapeLike(string $value, int $pos)

Encodes string for use in a LIKE statement.

void
applyLimit(string $sql, int|null $limit, int|null $offset)

Injects LIMIT/OFFSET to the SQL query.

Details

at line 41
__construct(array $config)

No description

Parameters

array $config

Exceptions

NotSupportedException

at line 98
void disconnect()

Disconnects from a database.

Return Value

void

at line 107
bool ping()

Pings database.

Return Value

bool

at line 117
ResultDriver|null query(string $sql)

Executes the SQL query.

Parameters

string $sql

Return Value

ResultDriver|null

Exceptions

DriverException

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

No description

Parameters

string $message
$code
string $sql

Return Value

DriverException

at line 163
int|null getAffectedRows()

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

Return Value

int|null

at line 172
int|null getInsertId(string|null $sequence)

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

Parameters

string|null $sequence

Return Value

int|null

at line 194
void begin(string $savepoint = null)

Begins a transaction (if supported).

Parameters

string $savepoint

Return Value

void

Exceptions

DriverException

at line 204
void commit(string $savepoint = null)

Commits statements in a transaction.

Parameters

string $savepoint

Return Value

void

Exceptions

DriverException

at line 214
void rollback(string $savepoint = null)

Rollback changes in a transaction.

Parameters

string $savepoint

Return Value

void

Exceptions

DriverException

at line 223
bool inTransaction()

Is in transaction?

Return Value

bool

at line 233
mixed getResource()

Returns the connection resource.

Return Value

mixed

at line 242
Reflector getReflector()

Returns the connection reflector.

Return Value

Reflector

at line 252
PostgreResult createResultDriver(resource $resource)

Result set driver factory.

Parameters

resource $resource

Return Value

PostgreResult

at line 264
string escapeText(string $value)

Encodes data for use in a SQL statement.

Parameters

string $value

Return Value

string

at line 273
string escapeBinary(string $value)

No description

Parameters

string $value

Return Value

string

at line 282
string escapeIdentifier(string $value)

No description

Parameters

string $value

Return Value

string

at line 289
string escapeBool(bool $value)

No description

Parameters

bool $value

Return Value

string

at line 298
string escapeDate(DateTimeInterface|string|int $value)

No description

Parameters

DateTimeInterface|string|int $value

Return Value

string

at line 310
string escapeDateTime(DateTimeInterface|string|int $value)

No description

Parameters

DateTimeInterface|string|int $value

Return Value

string

at line 322
string escapeLike(string $value, int $pos)

Encodes string for use in a LIKE statement.

Parameters

string $value
int $pos

Return Value

string

at line 334
void applyLimit(string $sql, int|null $limit, int|null $offset)

Injects LIMIT/OFFSET to the SQL query.

Parameters

string $sql
int|null $limit
int|null $offset

Return Value

void

Traits

Strict

Better OOP experience.