libraries/drivers/Database – Kohana API 2.3 Documentation

system/libraries/drivers/Database.php

Class: Database_Driver

abstract class Database_Driver

Database API driver

Methods

Database_Driver -> connect

abstract public function connect

Connect to our database. Returns FALSE on failure or a MySQL resource.

Return: mixed

Database_Driver -> query

abstract public function query

Perform a query based on a manually written query.

Parameters:

string sql
SQL query to execute

Return: Database_Result

Database_Driver -> delete

public function delete

Builds a DELETE query.

Parameters:

string table
table name
array where
where clause

Return: string

Database_Driver -> update

public function update

Builds an UPDATE query.

Parameters:

string table
table name
array values
key => value pairs
array where
where clause

Return: string

Database_Driver -> set_charset

public function set_charset

Set the charset using 'SET NAMES '.

Parameters:

string charset
character set to use

Database_Driver -> escape_table

abstract public function escape_table

Wrap the tablename in backticks, has support for: table.field syntax.

Parameters:

string table
table name

Return: string

Database_Driver -> escape_column

abstract public function escape_column

Escape a column/field name, has support for special commands.

Parameters:

string column
column name

Return: string

Database_Driver -> where

public function where

Builds a WHERE portion of a query.

Parameters:

mixed key
key
string value
value
string type
type
int num_wheres
number of where clauses
boolean quote
escape the value

Return: string

Database_Driver -> like

public function like

Builds a LIKE portion of a query.

Parameters:

mixed field
field name
string match
value to match with field
boolean auto
add wildcards before and after the match
string type
clause type (AND or OR)
int num_likes
number of likes

Return: string

Database_Driver -> notlike

public function notlike

Builds a NOT LIKE portion of a query.

Parameters:

mixed field
field name
string match
value to match with field
string auto
clause type (AND or OR)
int type
number of likes
num_likes

Return: string

Database_Driver -> regex

public function regex

Builds a REGEX portion of a query.

Parameters:

string field
field name
string match
value to match with field
string type
clause type (AND or OR)
integer num_regexs
number of regexes

Return: string

Database_Driver -> notregex

public function notregex

Builds a NOT REGEX portion of a query.

Parameters:

string field
field name
string match
value to match with field
string type
clause type (AND or OR)
integer num_regexs
number of regexes

Return: string

Database_Driver -> insert

public function insert

Builds an INSERT query.

Parameters:

string table
table name
array keys
keys
array values
values

Return: string

Database_Driver -> merge

public function merge

Builds a MERGE portion of a query.

Parameters:

string table
table name
array keys
keys
array values
values

Return: string

Database_Driver -> limit

abstract public function limit

Builds a LIMIT portion of a query.

Parameters:

integer limit
limit
integer offset
(int 0) offset

Return: string

Database_Driver -> stmt_prepare

public function stmt_prepare

Creates a prepared statement.

Parameters:

string sql
(string ) SQL query

Return: Database_Stmt

Database_Driver -> compile_select

abstract public function compile_select

Compiles the SELECT statement. Generates a query string based on which functions were used. Should not be called directly, the get() function calls it.

Parameters:

array database
select query values

Return: string

Database_Driver -> has_operator

public function has_operator

Determines if the string has an arithmetic operator in it.

Parameters:

string str
string to check

Return: boolean

Database_Driver -> escape

public function escape

Escapes any input value.

Parameters:

mixed value
value to escape

Return: string

Database_Driver -> escape_str

abstract public function escape_str

Escapes a string for a query.

Parameters:

mixed str
value to escape

Return: string

Database_Driver -> list_tables

abstract public function list_tables

Lists all tables in the database.

Return: array

Database_Driver -> list_fields

abstract public function list_fields

Lists all fields in a table.

Parameters:

string table
table name

Return: array

Database_Driver -> show_error

abstract public function show_error

Returns the last database error.

Return: string

Database_Driver -> field_data

abstract public function field_data

Returns field data about a table.

Parameters:

string table
table name

Return: array

Database_Driver -> sql_type

protected function sql_type

Fetches SQL type information about a field, in a generic format.

Parameters:

string str
field datatype

Return: array

Database_Driver -> clear_cache

public function clear_cache

Clears the internal query cache.

Parameters:

string sql
(NULL) SQL query

Database_Driver -> query_hash

protected function query_hash

Creates a hash for an SQL query string. Replaces newlines with spaces, trims, and hashes.

Parameters:

string sql
SQL query

Return: string

Class: Database_Result

abstract class Database_Result implements ArrayAccess, Iterator, Traversable, Countable

Database_Result

Methods

Database_Result -> sql

public function sql

Returns the SQL used to fetch the result.

Return: string

Database_Result -> insert_id

public function insert_id

Returns the insert id from the result.

Return: mixed

Database_Result -> result

abstract public function result

Prepares the query result.

Parameters:

boolean object
(TRUE) return rows as objects
mixed type
(FALSE) type

Return: Database_Result

Database_Result -> result_array

abstract public function result_array

Builds an array of query results.

Parameters:

boolean object
(NULL) return rows as objects
mixed type
(FALSE) type

Return: array

Database_Result -> list_fields

abstract public function list_fields

Gets the fields of an already run query.

Return: array

Database_Result -> seek

abstract public function seek

Seek to an offset in the results.

Parameters:

offset

Return: boolean

Database_Result -> count

public function count

Countable: count

Database_Result -> offsetExists

public function offsetExists

ArrayAccess: offsetExists

Parameters:

offset

Database_Result -> offsetGet

public function offsetGet

ArrayAccess: offsetGet

Parameters:

offset

Database_Result -> offsetSet

final public function offsetSet

ArrayAccess: offsetSet

Parameters:

offset
value

Throws: Kohana_Database_Exception

Database_Result -> offsetUnset

final public function offsetUnset

ArrayAccess: offsetUnset

Parameters:

offset

Throws: Kohana_Database_Exception

Database_Result -> current

public function current

Iterator: current

Database_Result -> key

public function key

Iterator: key

Database_Result -> next

public function next

Iterator: next

Database_Result -> prev

public function prev

Iterator: prev

Database_Result -> rewind

public function rewind

Iterator: rewind

Database_Result -> valid

public function valid

Iterator: valid