Methods

__construct()

__construct(string $dsn, string $username, string $password, array $driver_options)

Constructor/Connection method

Parameters

string $dsn
string $username
string $password
array $driver_options

prepare_query()

prepare_query(string $sql, array $data) : \PDOStatement

Simplifies prepared statements for database queries

Parameters

string $sql
array $data

Throws

\InvalidArgumentException

Returns

\PDOStatement —

| FALSE

beginTransaction()

beginTransaction() : bool

Begin a transaction

Returns

bool

commit()

commit() : bool

Commit a transaction

Returns

bool

errorCode()

errorCode() : mixed

Return the current error code

Returns

mixed

errorInfo()

errorInfo() : array

Return information about the current error

Returns

array

exec()

exec(string $statement) : int

Execute an SQL statement and return the number of affected rows

Parameters

string $statement

Returns

int

getAttribute()

getAttribute(int $attribute) : mixed

Get a connection attribute for the current db driver

Parameters

int $attribute

Returns

mixed

rollback()

rollback() : bool

Rollback a transaction

Returns

bool

setAttribute()

setAttribute(int $attribute, mixed $value) : bool

Set a connection attribute

Parameters

int $attribute
mixed $value

Returns

bool

get_columns()

get_columns(string $table) : array

Retrieve column information for the current database table

Parameters

string $table

Returns

array

get_types()

get_types() : array

Retrieve list of data types for the database

Returns

array

get_indexes()

get_indexes(string $table) : array

Retrieve indexes for the table

Parameters

string $table

Returns

array

get_fks()

get_fks(string $table) : array

Retrieve foreign keys for the table

Parameters

string $table

Returns

array

get_tables()

get_tables() : array

Return list of tables for the current database

Returns

array

get_system_tables()

get_system_tables() : array

Retrieves an array of non-user-created tables for the connection/database

Returns

array

get_dbs()

get_dbs() : array

Return list of dbs for the current connection, if possible

Returns

array

get_views()

get_views() : array

Return list of views for the current database

Returns

array

get_sequences()

get_sequences() : array

Return list of sequences for the current database, if they exist

Returns

array

get_functions()

get_functions() : array

Return list of functions for the current database

Returns

array

get_procedures()

get_procedures() : array

Return list of stored procedures for the current database

Returns

array

get_triggers()

get_triggers() : array

Return list of triggers for the current database

Returns

array

quote_ident()

quote_ident(mixed $ident) : string

Surrounds the string with the databases identifier escape characters

Parameters

mixed $ident

Returns

string

quote_table()

quote_table(string $table) : string

Quote database table name, and set prefix

Parameters

string $table

Returns

string

prepare_execute()

prepare_execute(string $sql, array $params) : \PDOStatement

Create and execute a prepared statement with the provided parameters

Parameters

string $sql
array $params

Returns

\PDOStatement

get_sql()

get_sql() : \Query\Driver\SQL_Interface

Get the SQL class for the current driver

Returns

\Query\Driver\SQL_Interface

get_util()

get_util() : \Query\Driver\Abstract_Util

Get the Util class for the current driver

Returns

\Query\Driver\Abstract_Util

driver_query()

driver_query(string|array|null $query, bool $filtered_index) : array

Method to simplify retrieving db results for meta-data queries

Parameters

string|array|null $query
bool $filtered_index

Returns

array

affected_rows()

affected_rows() : int

Returns number of rows affected by an INSERT, UPDATE, DELETE type query

Returns

int

num_rows()

num_rows() : int

Return the number of rows returned for a SELECT query

Returns

int

prefix_table()

prefix_table(string $table) : string

Prefixes a table if it is not already prefixed

Parameters

string $table

Returns

string

insert_batch()

insert_batch(string $table, array $data) : array

Create sql for batch insert

Parameters

string $table
array $data

Returns

array