driver
abstract class driver implements driver_interface
Database Abstraction Layer
Constants
LOGICAL_OP |
|
STATEMENTS |
|
LEFT_STMT |
|
COMPARE_OP |
|
RIGHT_STMT |
|
SUBQUERY_OP |
|
SUBQUERY_SELECT_TYPE |
|
SUBQUERY_BUILD |
|
Properties
$db_connect_id | |||
$query_result | |||
$return_on_error | |||
$transaction | |||
$sql_time | |||
$num_queries | |||
$open_queries | |||
$curtime | |||
$query_hold | |||
$html_hold | |||
$sql_report | |||
$persistency | |||
$user | |||
$server | |||
$dbname | |||
$sql_error_triggered | |||
$sql_error_sql | |||
$sql_error_returned | |||
$transactions | |||
$multi_insert | |||
$sql_layer | Current sql layer |
||
$any_char | Wildcards for matching any (%) or exactly one (_) character within LIKE expressions |
||
$one_char | |||
$sql_server_version | Exact version of the DBAL, directly queried |
||
protected bool | $debug_load_time | ||
protected bool | $debug_sql_explain |
Methods
Constructor
Set value for load_time debug parameter
Set value for sql_explain debug parameter
Gets the name of the sql layer.
Gets the name of the database.
Wildcards for matching any (%) character within LIKE expressions
Wildcards for matching exactly one (_) character within LIKE expressions
Gets the connect ID.
Indicates if an error was triggered.
Gets the last faulty query
Indicates if we are in a transaction.
Gets the time spent into the queries
Gets the returned error.
Indicates if multiple insertion can be used
Set if multiple insertion can be used
Return on error or display error message
Return number of sql queries and cached sql queries used
Add to query count
DBAL garbage collection, close SQL connection
Build LIMIT query
Fetch all rows
Seek to given row number
Fetch field if rownum is false, the current row is used, else it is pointing to the row (zero-based)
Correctly adjust LIKE expression for special characters Some DBMS are handling them in a different way
Correctly adjust NOT LIKE expression for special characters Some DBMS are handling them in a different way
Build a case expression
Build a concatenated expression
Returns whether results of a query need to be buffered to run a transaction while iterating over them.
SQL Transaction
Build sql statement from an array
Build IN or NOT IN sql comparison string, uses <> or = on single element arrays to improve comparison speed
Run binary AND operator on DB column.
Run binary OR operator on DB column.
Returns SQL string to cast a string expression to an int.
Gets the ID of the last inserted row immediately after an INSERT statement.
Returns SQL string to cast an integer expression to a string.
Run LOWER() on DB column of type text (i.e. neither varchar nor char).
Run more than one insert statement.
Build sql statement from array for select and select distinct statements
No description
No description
Display sql error page
Explain queries
Gets the estimated number of rows in a specified table.
Gets the exact number of rows in a specified table.
Ensure query ID can be used by cache
Details
at line 91
__construct()
Constructor
at line 111
set_debug_load_time(bool $value)
Set value for load_time debug parameter
at line 119
set_debug_sql_explain(bool $value)
Set value for sql_explain debug parameter
at line 127
string
get_sql_layer()
Gets the name of the sql layer.
at line 135
string
get_db_name()
Gets the name of the database.
at line 143
string
get_any_char()
Wildcards for matching any (%) character within LIKE expressions
at line 151
string
get_one_char()
Wildcards for matching exactly one (_) character within LIKE expressions
at line 159
mixed
get_db_connect_id()
Gets the connect ID.
at line 167
bool
get_sql_error_triggered()
Indicates if an error was triggered.
at line 175
string
get_sql_error_sql()
Gets the last faulty query
at line 183
bool
get_transaction()
Indicates if we are in a transaction.
at line 191
int
get_sql_time()
Gets the time spent into the queries
at line 199
array
get_sql_error_returned()
Gets the returned error.
at line 207
bool
get_multi_insert()
Indicates if multiple insertion can be used
at line 215
set_multi_insert(bool $multi_insert)
Set if multiple insertion can be used
at line 223
null
sql_return_on_error(bool $fail = false)
Return on error or display error message
at line 234
int
sql_num_queries(bool $cached = false)
Return number of sql queries and cached sql queries used
at line 242
null
sql_add_num_queries(bool $cached = false)
Add to query count
at line 252
mixed
sql_close()
DBAL garbage collection, close SQL connection
at line 285
mixed
sql_query_limit(string $query, int $total, int $offset = 0, int $cache_ttl = 0)
Build LIMIT query
at line 302
mixed
sql_fetchrowset(mixed $query_id = false)
Fetch all rows
at line 326
bool
sql_rowseek(mixed $rownum, mixed $query_id)
Seek to given row number
at line 368
mixed
sql_fetchfield(string $field, mixed $rownum = false, mixed $query_id = false)
Fetch field if rownum is false, the current row is used, else it is pointing to the row (zero-based)
at line 399
string
sql_like_expression(string $expression)
Correctly adjust LIKE expression for special characters Some DBMS are handling them in a different way
at line 410
string
sql_not_like_expression(string $expression)
Correctly adjust NOT LIKE expression for special characters Some DBMS are handling them in a different way
at line 421
string
sql_case(string $condition, string $action_true, mixed $action_false = false)
Build a case expression
Note: The two statements action_true and action_false must have the same data type (int, vchar, ...) in the database!
at line 433
string
sql_concatenate(string $expr1, string $expr2)
Build a concatenated expression
at line 441
bool
sql_buffer_nested_transactions()
Returns whether results of a query need to be buffered to run a transaction while iterating over them.
at line 449
mixed
sql_transaction(string $status = 'begin')
SQL Transaction
at line 516
string
sql_build_array(string $query, array $assoc_ary = false)
Build sql statement from an array
at line 564
string
sql_in_set(string $field, array $array, bool $negate = false, bool $allow_empty_set = false)
Build IN or NOT IN sql comparison string, uses <> or = on single element arrays to improve comparison speed
at line 606
string
sql_bit_and(string $column_name, int $bit, string $compare = '')
Run binary AND operator on DB column.
Results in sql statement: "{$column_name} & (1 << {$bit}) {$compare}"
at line 619
string
sql_bit_or(string $column_name, int $bit, string $compare = '')
Run binary OR operator on DB column.
at line 632
string
cast_expr_to_bigint(string $expression)
Returns SQL string to cast a string expression to an int.
at line 640
string|false
sql_nextid()
Gets the ID of the last inserted row immediately after an INSERT statement.
Note: Despite the name, the returned ID refers to the row that has just been inserted, rather than the hypothetical ID of the next row if a new one was to be inserted.
The returned value can be used for selecting the item that has just been inserted or for updating another table with an ID pointing to that item.
Alias of sql_last_inserted_id
.
at line 648
string
cast_expr_to_string(string $expression)
Returns SQL string to cast an integer expression to a string.
at line 656
string
sql_lower_text(string $column_name)
Run LOWER() on DB column of type text (i.e. neither varchar nor char).
at line 664
bool
sql_multi_insert(string $table, array $sql_ary)
Run more than one insert statement.
at line 736
string
sql_build_query(string $query, array $array)
Build sql statement from array for select and select distinct statements
Possible query values: SELECT, SELECT_DISTINCT
at line 848
protected
_process_boolean_tree_first($operations_ary)
No description
at line 860
protected
_process_boolean_tree($operations_ary)
No description
at line 975
mixed
sql_error(string $sql = '')
Display sql error page
at line 1045
mixed
sql_report(string $mode, string $query = '')
Explain queries
at line 1230
string
get_estimated_row_count(string $table_name)
Gets the estimated number of rows in a specified table.
at line 1238
string
get_row_count(string $table_name)
Gets the exact number of rows in a specified table.
at line 1252
int|string
clean_query_id(resource|int|string $query_id)
Ensure query ID can be used by cache