summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJames L Parry <jim_parry@bcit.ca>2014-12-08 12:09:29 +0100
committerJames L Parry <jim_parry@bcit.ca>2014-12-08 12:09:29 +0100
commit7381711c721eee5bcf4fa20d7d62c96e5e44390e (patch)
treef2f5c59405b72e6867d3329594d8f39b863e19bc
parent4103d0c5f8edf17e5698fb3eebec12396e714878 (diff)
User Guide - query builder
Integrated API reference with the regular query builder page. Added square brackets for optional parameters. Signed-off-by:James L Parry <jim_parry@bcit.ca>
-rw-r--r--user_guide_src/source/database/index.rst1
-rw-r--r--user_guide_src/source/database/query_builder.rst506
-rw-r--r--user_guide_src/source/database/query_builder_reference.rst507
3 files changed, 501 insertions, 513 deletions
diff --git a/user_guide_src/source/database/index.rst b/user_guide_src/source/database/index.rst
index 14a871aed..4612daf9d 100644
--- a/user_guide_src/source/database/index.rst
+++ b/user_guide_src/source/database/index.rst
@@ -16,7 +16,6 @@ patterns. The database functions offer clear, simple syntax.
Generating Query Results <results>
Query Helper Functions <helpers>
Query Builder Class <query_builder>
- Query Builder API <query_builder_reference>
Transactions <transactions>
Getting MetaData <metadata>
Custom Function Calls <call_function>
diff --git a/user_guide_src/source/database/query_builder.rst b/user_guide_src/source/database/query_builder.rst
index 701c489d6..577248b32 100644
--- a/user_guide_src/source/database/query_builder.rst
+++ b/user_guide_src/source/database/query_builder.rst
@@ -23,10 +23,6 @@ system.
:local:
:depth: 1
-.. note:: This page describes how to use the Query Builder class.
- API reference information is found on the
- `Query Builder API <query_builder_reference.html>`_ page.
-
**************
Selecting Data
**************
@@ -1037,4 +1033,504 @@ run the query::
.. note:: Double calls to ``get_compiled_select()`` while you're using the
Query Builder Caching functionality and NOT resetting your queries
will results in the cache being merged twice. That in turn will
- i.e. if you're caching a ``select()`` - select the same field twice. \ No newline at end of file
+ i.e. if you're caching a ``select()`` - select the same field twice.
+
+***************
+Class Reference
+***************
+
+.. class:: CI_DB_query_builder
+
+ .. method:: count_all_results([$table = ''])
+
+ :param string $table: Table name to query
+ :returns: Number of rows in the query result
+ :rtype: int
+
+ Generates a platform-specific query string that counts
+ all records returned by an Query Builder query.
+
+ .. method:: dbprefix([$table = ''])
+
+ :param string $table: The table name to work with
+ :returns: The modified table name
+ :rtype: string
+
+ Prepends a database prefix if one exists in configuration
+
+ .. method:: delete([$table = ''[, $where = ''[, $limit = NULL[, $reset_data = TRUE]]]])
+
+ :param mixed $table: The table(s) to delete from; string or array
+ :param string $where: The where clause
+ :param string $limit: The limit clause
+ :param boolean $reset_data: TRUE to reset the query "write" clause
+ :returns: DB_query_builder instance, FALSE on failure
+ :rtype: mixed
+
+ Compiles a delete string and runs the query
+
+ .. method:: distinct([$val = TRUE])
+
+ :param boolean $val: Desired value of the "distinct" flag
+ :returns: DB_query_driver instance
+ :rtype: object
+
+ Sets a flag which tells the query string compiler to add DISTINCT
+
+ .. method:: empty_table([$table = ''])
+
+ :param string $table: Name of table to empty
+ :returns: DB_driver instance
+ :rtype: object
+
+ Compiles a delete string and runs "DELETE FROM table"
+
+ .. method:: flush_cache()
+
+ :rtype: void
+
+ Empties the QB cache
+
+ .. method:: from($from)
+
+ :param mixed $from: Can be a string or array
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Generates the FROM portion of the query
+
+ .. method:: get([$table = ''[, $limit = NULL[, $offset = NULL]]])
+
+ :param string $table: The table to query
+ :param string $limit: The limit clause
+ :param string $offset: The offset clause
+ :returns: DB_result
+ :rtype: object
+
+ Compiles the select statement based on the other functions
+ called and runs the query
+
+ .. method:: get_compiled_delete([$table = ''[, $reset = TRUE]])
+
+ :param string $table: Name of the table to delete from
+ :param boolean $reset: TRUE: reset QB values; FALSE: leave QB values alone
+ :returns: The SQL string
+ :rtype: string
+
+ Compiles a delete query string and returns the sql
+
+ .. method:: get_compiled_insert([$table = ''[, $reset = TRUE]])
+
+ :param string $table: Name of the table to insert into
+ :param boolean $reset: TRUE: reset QB values; FALSE: leave QB values alone
+ :returns: The SQL string
+ :rtype: string
+
+ Compiles an insert query string and returns the sql
+
+ .. method:: get_compiled_select([$table = ''[, $reset = TRUE]])
+
+ :param string $table: Name of the table to select from
+ :param boolean $reset: TRUE: reset QB values; FALSE: leave QB values alone
+ :returns: The SQL string
+ :rtype: string
+
+ Compiles a select query string and returns the sql
+
+ .. method:: get_compiled_update([$table = ''[, $reset = TRUE]])
+
+ :param string $table: Name of the table to update
+ :param boolean $reset: TRUE: reset QB values; FALSE: leave QB values alone
+ :returns: The SQL string
+ :rtype: string
+
+ Compiles an update query string and returns the sql
+
+ .. method:: get_where([$table = ''[, $where = NULL[, $limit = NULL[, $offset = NULL]]]])
+
+ :param mixed $table: The table(s) to delete from; string or array
+ :param string $where: The where clause
+ :param int $limit: Number of records to return
+ :param int $offset: Number of records to skip
+ :returns: DB_result
+ :rtype: object
+
+ Allows the where clause, limit and offset to be added directly
+
+ .. method:: group_by($by[, $escape = NULL])
+
+ :param mixed $by: Field(s) to group by; string or array
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Adds a GROUPBY clause to the query
+
+ .. method:: group_end()
+
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Ends a query group
+
+ .. method:: group_start([$not = ''[, $type = 'AND ']])
+
+ :param string $not: (Internal use only)
+ :param string $type: (Internal use only)
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Starts a query group.
+
+ .. method:: having($key[, $value = NULL[, $escape = NULL]])
+
+ :param string $key: Key (string) or associative array of values
+ :param string $value: Value sought if the key is a string
+ :param string $escape: TRUE to escape the content
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Separates multiple calls with 'AND'.
+
+ .. method:: insert([$table = ''[, $set = NULL[, $escape = NULL]]])
+
+ :param string $table: The table to insert data into
+ :param array $set: An associative array of insert values
+ :param boolean $table: Whether to escape values and identifiers
+ :returns: DB_result
+ :rtype: object
+
+ Compiles an insert string and runs the query
+
+ .. method:: insert_batch([$table = ''[, $set = NULL[, $escape = NULL]]])
+
+ :param string $table: The table to insert data into
+ :param array $set: An associative array of insert values
+ :param boolean $escape: Whether to escape values and identifiers
+ :returns: Number of rows inserted or FALSE on failure
+ :rtype: mixed
+
+ Compiles batch insert strings and runs the queries
+
+ .. method:: join($table, $cond[, $type = ''[, $escape = NULL]])
+
+ :param string $table: Name of the table being joined
+ :param string $cond: The JOIN condition
+ :param string $type: The JOIN type
+ :param boolean $escape: Whether to escape values and identifiers
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Generates the JOIN portion of the query
+
+ .. method:: like($field[, $match = ''[, $side = 'both'[, $escape = NULL]]])
+
+ :param string $field: Name of field to compare
+ :param string $match: Text portion to match
+ :param string $side: Position of a match
+ :param boolean $escape: Whether to escape values and identifiers
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Generates a %LIKE% portion of the query.
+ Separates multiple calls with 'AND'.
+
+ .. method:: limit($value[, $offset = FALSE])
+
+ :param mixed $value: Number of rows to limit the results to, NULL for no limit
+ :param mixed $offset: Number of rows to skip, FALSE if no offset used
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Specify a limit and offset for the query
+
+ .. method:: not_group_start()
+
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Starts a query group, but NOTs the group
+
+ .. method:: not_like($field[, $match = ''[, $side = 'both'[, $escape = NULL]]])
+
+ :param string $field: Name of field to compare
+ :param string $match: Text portion to match
+ :param string $side: Position of a match
+ :param boolean $escape: Whether to escape values and identifiers
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Generates a NOT LIKE portion of the query.
+ Separates multiple calls with 'AND'.
+
+ .. method:: offset($offset)
+
+ :param int $offset: Number of rows to skip in a query
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Sets the OFFSET value
+
+ .. method:: or_group_start()
+
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Starts a query group, but ORs the group
+
+ .. method:: or_having($key[, $value = NULL[, $escape = NULL]])
+
+ :param string $key: Key (string) or associative array of values
+ :param string $value: Value sought if the key is a string
+ :param string $escape: TRUE to escape the content
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Separates multiple calls with 'OR'.
+
+ .. method:: or_like($field[, $match = ''[, $side = 'both'[, $escape = NULL]]])
+
+ :param string $field: Name of field to compare
+ :param string $match: Text portion to match
+ :param string $side: Position of a match
+ :param boolean $escape: Whether to escape values and identifiers
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Generates a %LIKE% portion of the query.
+ Separates multiple calls with 'OR'.
+
+ .. method:: or_not_group_start()
+
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Starts a query group, but OR NOTs the group
+
+ .. method:: or_not_like($field[, $match = ''[, $side = 'both'[, $escape = NULL]]])
+
+ :param string $field: Name of field to compare
+ :param string $match: Text portion to match
+ :param string $side: Position of a match
+ :param boolean $escape: Whether to escape values and identifiers
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Generates a NOT LIKE portion of the query.
+ Separates multiple calls with 'OR'.
+
+ .. method:: or_where($key[, $value = NULL[, $escape = NULL]])
+
+ :param mixed $key: Name of field to compare, or associative array
+ :param mixed $value: If a single key, compared to this value
+ :param boolean $escape: Whether to escape values and identifiers
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Generates the WHERE portion of the query.
+ Separates multiple calls with 'OR'.
+
+ .. method:: or_where_in([$key = NULL[, $values = NULL[, $escape = NULL]]])
+
+ :param string $key: The field to search
+ :param array $values: The values searched on
+ :param boolean $escape: Whether to escape values and identifiers
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Generates a WHERE field IN('item', 'item') SQL query,
+ joined with 'OR' if appropriate.
+
+ .. method:: or_where_not_in([$key = NULL[, $values = NULL[, $escape = NULL]]])
+
+ :param string $key: The field to search
+ :param array $values: The values searched on
+ :param boolean $escape: Whether to escape values and identifiers
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Generates a WHERE field NOT IN('item', 'item') SQL query,
+ joined with 'OR' if appropriate.
+
+ .. method:: order_by($orderby[, $direction = ''[, $escape = NULL]])
+
+ :param string $orderby: The field to order by
+ :param string $direction: The order requested - asc, desc or random
+ :param boolean $escape: Whether to escape values and identifiers
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Generates an ORDER BY clause in the SQL query
+
+ .. method:: replace([$table = ''[, $set = NULL]])
+
+ :param string $table: The table to query
+ :param array $set: Associative array of insert values
+ :returns: DB_result, FALSE on failure
+ :rtype: mixed
+
+ Compiles an replace into string and runs the query
+
+ .. method:: reset_query()
+
+ :rtype: void
+
+ Publicly-visible method to reset the QB values.
+
+ .. method:: select([$select = '*'[, $escape = NULL]])
+
+ :param string $select: Comma-separated list of fields to select
+ :param boolean $escape: Whether to escape values and identifiers
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Generates the SELECT portion of the query
+
+ .. method:: select_avg([$select = ''[, $alias = '']])
+
+ :param string $select: Field to compute the average of
+ :param string $alias: Alias for the resulting value
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Generates a SELECT AVG(field) portion of a query
+
+ .. method:: select_max([$select = ''[, $alias = '']])
+
+ :param string $select: Field to compute the maximum of
+ :param string $alias: Alias for the resulting value
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Generates a SELECT MAX(field) portion of a query
+
+ .. method:: select_min([$select = ''[, $alias = '']])
+
+ :param string $select: Field to compute the minimum of
+ :param string $alias: Alias for the resulting value
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Generates a SELECT MIN(field) portion of a query
+
+ .. method:: select_sum([$select = ''[, $alias = '']])
+
+ :param string $select: Field to compute the sum of
+ :param string $alias: Alias for the resulting value
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Generates a SELECT SUM(field) portion of a query
+
+ .. method:: set($key[, $value = ''[, $escape = NULL]])
+
+ :param mixed $key: The field to be set, or an array of key/value pairs
+ :param string $value: If a single key, its new value
+ :param boolean $escape: Whether to escape values and identifiers
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Allows key/value pairs to be set for inserting or updating
+
+ .. method:: set_dbprefix([$prefix = ''])
+
+ :param string $prefix: The new prefix to use
+ :returns: The DB prefix in use
+ :rtype: string
+
+ Set's the DB Prefix to something new without needing to reconnect
+
+ .. method:: set_insert_batch($key[, $value = ''[, $escape = NULL]])
+
+ :param mixed $key: The field to be set, or an array of key/value pairs
+ :param string $value: If a single key, its new value
+ :param boolean $escape: Whether to escape values and identifiers
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ The "set_insert_batch" function. Allows key/value pairs to be set for batch inserts
+
+ .. method:: set_update_batch($key[, $value = ''[, $escape = NULL]])
+
+ :param mixed $key: The field to be set, or an array of key/value pairs
+ :param string $value: If a single key, its new value
+ :param boolean $escape: Whether to escape values and identifiers
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ The "set_batch_batch" function. Allows key/value pairs to be set for batch batch
+
+ .. method:: start_cache()
+
+ :rtype: void
+
+ Start DB caching
+
+ .. method:: stop_cache()
+
+ :rtype: void
+
+ Stop DB caching
+
+ .. method:: truncate([$table = ''])
+
+ :param string $table: Name fo the table to truncate
+ :returns: DB_result
+ :rtype: object
+
+ Compiles a truncate string and runs the query.
+ If the database does not support the truncate() command
+ This function maps to "DELETE FROM table"
+
+ .. method:: update([$table = ''[, $set = NULL[, $where = NULL[, $limit = NULL]]]])
+
+ :param string $table: The table to insert data into
+ :param array $set: An associative array of insert values
+ :param string $where: WHERE clause to use
+ :param string $limit: LIMIT clause to use
+ :returns: DB_result
+ :rtype: object
+
+ Compiles an update string and runs the query.
+
+ .. method:: update_batch([$table = ''[, $set = NULL[, $value = NULL]]])
+
+ :param string $table: The table to update data in
+ :param mixed $set: The field to be set, or an array of key/value pairs
+ :param string $value: If a single key, its new value
+ :returns: DB_result
+ :rtype: object
+
+ Compiles an update string and runs the query.
+
+ .. method:: where($key[, $value = NULL[, $escape = NULL]])
+
+ :param mixed $key: Name of field to compare, or associative array
+ :param mixed $value: If a single key, compared to this value
+ :param boolean $escape: Whether to escape values and identifiers
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Generates the WHERE portion of the query.
+ Separates multiple calls with 'AND'.
+
+ .. method:: where_in([$key = NULL[, $values = NULL[, $escape = NULL]]])
+
+ :param string $key: Name of field to examine
+ :param array $values: Array of target values
+ :param boolean $escape: Whether to escape values and identifiers
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Generates a WHERE field IN('item', 'item') SQL query,
+ joined with 'AND' if appropriate.
+
+ .. method:: where_not_in([$key = NULL[, $values = NULL[, $escape = NULL]]])
+
+ :param string $key: Name of field to examine
+ :param array $values: Array of target values
+ :param boolean $escape: Whether to escape values and identifiers
+ :returns: DB_query_builder instance
+ :rtype: object
+
+ Generates a WHERE field NOT IN('item', 'item') SQL query,
+ joined with 'AND' if appropriate. \ No newline at end of file
diff --git a/user_guide_src/source/database/query_builder_reference.rst b/user_guide_src/source/database/query_builder_reference.rst
deleted file mode 100644
index 21b15431a..000000000
--- a/user_guide_src/source/database/query_builder_reference.rst
+++ /dev/null
@@ -1,507 +0,0 @@
-#################
-Query Builder API
-#################
-
-.. note:: This page provides a complete API reference for the Query Builder
- class. For information on how to use the class, see the
- `Query Builder Class <query_builder.html>`_ page.
-
-***************
-Class Reference
-***************
-
-.. class:: CI_DB_query_builder
-
- .. method:: count_all_results($table = '')
-
- :param string $table: Table name to query
- :returns: Number of rows in the query result
- :rtype: int
-
- Generates a platform-specific query string that counts
- all records returned by an Query Builder query.
-
- .. method:: dbprefix($table = '')
-
- :param string $table: The table name to work with
- :returns: The modified table name
- :rtype: string
-
- Prepends a database prefix if one exists in configuration
-
- .. method:: delete($table = '', $where = '', $limit = NULL, $reset_data = TRUE)
-
- :param mixed $table: The table(s) to delete from; string or array
- :param string $where: The where clause
- :param string $limit: The limit clause
- :param boolean $reset_data: TRUE to reset the query "write" clause
- :returns: DB_query_builder instance, FALSE on failure
- :rtype: mixed
-
- Compiles a delete string and runs the query
-
- .. method:: distinct($val = TRUE)
-
- :param boolean $val: Desired value of the "distinct" flag
- :returns: DB_query_driver instance
- :rtype: object
-
- Sets a flag which tells the query string compiler to add DISTINCT
-
- .. method:: empty_table($table = '')
-
- :param string $table: Name of table to empty
- :returns: DB_driver instance
- :rtype: object
-
- Compiles a delete string and runs "DELETE FROM table"
-
- .. method:: flush_cache()
-
- :rtype: void
-
- Empties the QB cache
-
- .. method:: from($from)
-
- :param mixed $from: Can be a string or array
- :returns: DB_query_builder instance
- :rtype: object
-
- Generates the FROM portion of the query
-
- .. method:: get($table = '', $limit = NULL, $offset = NULL)
-
- :param string $table: The table to query
- :param string $limit: The limit clause
- :param string $offset: The offset clause
- :returns: DB_result
- :rtype: object
-
- Compiles the select statement based on the other functions
- called and runs the query
-
- .. method:: get_compiled_delete($table = '', $reset = TRUE)
-
- :param string $table: Name of the table to delete from
- :param boolean $reset: TRUE: reset QB values; FALSE: leave QB values alone
- :returns: The SQL string
- :rtype: string
-
- Compiles a delete query string and returns the sql
-
- .. method:: get_compiled_insert($table = '', $reset = TRUE)
-
- :param string $table: Name of the table to insert into
- :param boolean $reset: TRUE: reset QB values; FALSE: leave QB values alone
- :returns: The SQL string
- :rtype: string
-
- Compiles an insert query string and returns the sql
-
- .. method:: get_compiled_select($table = '', $reset = TRUE)
-
- :param string $table: Name of the table to select from
- :param boolean $reset: TRUE: reset QB values; FALSE: leave QB values alone
- :returns: The SQL string
- :rtype: string
-
- Compiles a select query string and returns the sql
-
- .. method:: get_compiled_update($table = '', $reset = TRUE)
-
- :param string $table: Name of the table to update
- :param boolean $reset: TRUE: reset QB values; FALSE: leave QB values alone
- :returns: The SQL string
- :rtype: string
-
- Compiles an update query string and returns the sql
-
- .. method:: get_where($table = '', $where = NULL, $limit = NULL, $offset = NULL)
-
- :param mixed $table: The table(s) to delete from; string or array
- :param string $where: The where clause
- :param int $limit: Number of records to return
- :param int $offset: Number of records to skip
- :returns: DB_result
- :rtype: object
-
- Allows the where clause, limit and offset to be added directly
-
- .. method:: group_by($by, $escape = NULL)
-
- :param mixed $by: Field(s) to group by; string or array
- :returns: DB_query_builder instance
- :rtype: object
-
- Adds a GROUPBY clause to the query
-
- .. method:: group_end()
-
- :returns: DB_query_builder instance
- :rtype: object
-
- Ends a query group
-
- .. method:: group_start($not = '', $type = 'AND ')
-
- :param string $not: (Internal use only)
- :param string $type: (Internal use only)
- :returns: DB_query_builder instance
- :rtype: object
-
- Starts a query group.
-
- .. method:: having($key, $value = NULL, $escape = NULL)
-
- :param string $key: Key (string) or associative array of values
- :param string $value: Value sought if the key is a string
- :param string $escape: TRUE to escape the content
- :returns: DB_query_builder instance
- :rtype: object
-
- Separates multiple calls with 'AND'.
-
- .. method:: insert($table = '', $set = NULL, $escape = NULL)
-
- :param string $table: The table to insert data into
- :param array $set: An associative array of insert values
- :param boolean $table: Whether to escape values and identifiers
- :returns: DB_result
- :rtype: object
-
- Compiles an insert string and runs the query
-
- .. method:: insert_batch($table = '', $set = NULL, $escape = NULL)
-
- :param string $table: The table to insert data into
- :param array $set: An associative array of insert values
- :param boolean $escape: Whether to escape values and identifiers
- :returns: Number of rows inserted or FALSE on failure
- :rtype: mixed
-
- Compiles batch insert strings and runs the queries
-
- .. method:: join($table, $cond, $type = '', $escape = NULL)
-
- :param string $table: Name of the table being joined
- :param string $cond: The JOIN condition
- :param string $type: The JOIN type
- :param boolean $escape: Whether to escape values and identifiers
- :returns: DB_query_builder instance
- :rtype: object
-
- Generates the JOIN portion of the query
-
- .. method:: like($field, $match = '', $side = 'both', $escape = NULL)
-
- :param string $field: Name of field to compare
- :param string $match: Text portion to match
- :param string $side: Position of a match
- :param boolean $escape: Whether to escape values and identifiers
- :returns: DB_query_builder instance
- :rtype: object
-
- Generates a %LIKE% portion of the query.
- Separates multiple calls with 'AND'.
-
- .. method:: limit($value, $offset = FALSE)
-
- :param mixed $value: Number of rows to limit the results to, NULL for no limit
- :param mixed $offset: Number of rows to skip, FALSE if no offset used
- :returns: DB_query_builder instance
- :rtype: object
-
- Specify a limit and offset for the query
-
- .. method:: not_group_start()
-
- :returns: DB_query_builder instance
- :rtype: object
-
- Starts a query group, but NOTs the group
-
- .. method:: not_like($field, $match = '', $side = 'both', $escape = NULL)
-
- :param string $field: Name of field to compare
- :param string $match: Text portion to match
- :param string $side: Position of a match
- :param boolean $escape: Whether to escape values and identifiers
- :returns: DB_query_builder instance
- :rtype: object
-
- Generates a NOT LIKE portion of the query.
- Separates multiple calls with 'AND'.
-
- .. method:: offset($offset)
-
- :param int $offset: Number of rows to skip in a query
- :returns: DB_query_builder instance
- :rtype: object
-
- Sets the OFFSET value
-
- .. method:: or_group_start()
-
- :returns: DB_query_builder instance
- :rtype: object
-
- Starts a query group, but ORs the group
-
- .. method:: or_having($key, $value = NULL, $escape = NULL)
-
- :param string $key: Key (string) or associative array of values
- :param string $value: Value sought if the key is a string
- :param string $escape: TRUE to escape the content
- :returns: DB_query_builder instance
- :rtype: object
-
- Separates multiple calls with 'OR'.
-
- .. method:: or_like($field, $match = '', $side = 'both', $escape = NULL)
-
- :param string $field: Name of field to compare
- :param string $match: Text portion to match
- :param string $side: Position of a match
- :param boolean $escape: Whether to escape values and identifiers
- :returns: DB_query_builder instance
- :rtype: object
-
- Generates a %LIKE% portion of the query.
- Separates multiple calls with 'OR'.
-
- .. method:: or_not_group_start()
-
- :returns: DB_query_builder instance
- :rtype: object
-
- Starts a query group, but OR NOTs the group
-
- .. method:: or_not_like($field, $match = '', $side = 'both', $escape = NULL)
-
- :param string $field: Name of field to compare
- :param string $match: Text portion to match
- :param string $side: Position of a match
- :param boolean $escape: Whether to escape values and identifiers
- :returns: DB_query_builder instance
- :rtype: object
-
- Generates a NOT LIKE portion of the query.
- Separates multiple calls with 'OR'.
-
- .. method:: or_where($key, $value = NULL, $escape = NULL)
-
- :param mixed $key: Name of field to compare, or associative array
- :param mixed $value: If a single key, compared to this value
- :param boolean $escape: Whether to escape values and identifiers
- :returns: DB_query_builder instance
- :rtype: object
-
- Generates the WHERE portion of the query.
- Separates multiple calls with 'OR'.
-
- .. method:: or_where_in($key = NULL, $values = NULL, $escape = NULL)
-
- :param string $key: The field to search
- :param array $values: The values searched on
- :param boolean $escape: Whether to escape values and identifiers
- :returns: DB_query_builder instance
- :rtype: object
-
- Generates a WHERE field IN('item', 'item') SQL query,
- joined with 'OR' if appropriate.
-
- .. method:: or_where_not_in($key = NULL, $values = NULL, $escape = NULL)
-
- :param string $key: The field to search
- :param array $values: The values searched on
- :param boolean $escape: Whether to escape values and identifiers
- :returns: DB_query_builder instance
- :rtype: object
-
- Generates a WHERE field NOT IN('item', 'item') SQL query,
- joined with 'OR' if appropriate.
-
- .. method:: order_by($orderby, $direction = '', $escape = NULL)
-
- :param string $orderby: The field to order by
- :param string $direction: The order requested - asc, desc or random
- :param boolean $escape: Whether to escape values and identifiers
- :returns: DB_query_builder instance
- :rtype: object
-
- Generates an ORDER BY clause in the SQL query
-
- .. method:: replace($table = '', $set = NULL)
-
- :param string $table: The table to query
- :param array $set: Associative array of insert values
- :returns: DB_result, FALSE on failure
- :rtype: mixed
-
- Compiles an replace into string and runs the query
-
- .. method:: reset_query()
-
- :rtype: void
-
- Publicly-visible method to reset the QB values.
-
- .. method:: select($select = '*', $escape = NULL)
-
- :param string $select: Comma-separated list of fields to select
- :param boolean $escape: Whether to escape values and identifiers
- :returns: DB_query_builder instance
- :rtype: object
-
- Generates the SELECT portion of the query
-
- .. method:: select_avg($select = '', $alias = '')
-
- :param string $select: Field to compute the average of
- :param string $alias: Alias for the resulting value
- :returns: DB_query_builder instance
- :rtype: object
-
- Generates a SELECT AVG(field) portion of a query
-
- .. method:: select_max($select = '', $alias = '')
-
- :param string $select: Field to compute the maximum of
- :param string $alias: Alias for the resulting value
- :returns: DB_query_builder instance
- :rtype: object
-
- Generates a SELECT MAX(field) portion of a query
-
- .. method:: select_min($select = '', $alias = '')
-
- :param string $select: Field to compute the minimum of
- :param string $alias: Alias for the resulting value
- :returns: DB_query_builder instance
- :rtype: object
-
- Generates a SELECT MIN(field) portion of a query
-
- .. method:: select_sum($select = '', $alias = '')
-
- :param string $select: Field to compute the sum of
- :param string $alias: Alias for the resulting value
- :returns: DB_query_builder instance
- :rtype: object
-
- Generates a SELECT SUM(field) portion of a query
-
- .. method:: set($key, $value = '', $escape = NULL)
-
- :param mixed $key: The field to be set, or an array of key/value pairs
- :param string $value: If a single key, its new value
- :param boolean $escape: Whether to escape values and identifiers
- :returns: DB_query_builder instance
- :rtype: object
-
- Allows key/value pairs to be set for inserting or updating
-
- .. method:: set_dbprefix($prefix = '')
-
- :param string $prefix: The new prefix to use
- :returns: The DB prefix in use
- :rtype: string
-
- Set's the DB Prefix to something new without needing to reconnect
-
- .. method:: set_insert_batch($key, $value = '', $escape = NULL)
-
- :param mixed $key: The field to be set, or an array of key/value pairs
- :param string $value: If a single key, its new value
- :param boolean $escape: Whether to escape values and identifiers
- :returns: DB_query_builder instance
- :rtype: object
-
- The "set_insert_batch" function. Allows key/value pairs to be set for batch inserts
-
- .. method:: set_update_batch($key, $value = '', $escape = NULL)
-
- :param mixed $key: The field to be set, or an array of key/value pairs
- :param string $value: If a single key, its new value
- :param boolean $escape: Whether to escape values and identifiers
- :returns: DB_query_builder instance
- :rtype: object
-
- The "set_batch_batch" function. Allows key/value pairs to be set for batch batch
-
- .. method:: start_cache()
-
- :rtype: void
-
- Start DB caching
-
- .. method:: stop_cache()
-
- :rtype: void
-
- Stop DB caching
-
- .. method:: truncate($table = '')
-
- :param string $table: Name fo the table to truncate
- :returns: DB_result
- :rtype: object
-
- Compiles a truncate string and runs the query.
- If the database does not support the truncate() command
- This function maps to "DELETE FROM table"
-
- .. method:: update($table = '', $set = NULL, $where = NULL, $limit = NULL)
-
- :param string $table: The table to insert data into
- :param array $set: An associative array of insert values
- :param string $where: WHERE clause to use
- :param string $limit: LIMIT clause to use
- :returns: DB_result
- :rtype: object
-
- Compiles an update string and runs the query.
-
- .. method:: update_batch($table = '', $set = NULL, $value = NULL)
-
- :param string $table: The table to update data in
- :param mixed $set: The field to be set, or an array of key/value pairs
- :param string $value: If a single key, its new value
- :returns: DB_result
- :rtype: object
-
- Compiles an update string and runs the query.
-
- .. method:: where($key, $value = NULL, $escape = NULL)
-
- :param mixed $key: Name of field to compare, or associative array
- :param mixed $value: If a single key, compared to this value
- :param boolean $escape: Whether to escape values and identifiers
- :returns: DB_query_builder instance
- :rtype: object
-
- Generates the WHERE portion of the query.
- Separates multiple calls with 'AND'.
-
- .. method:: where_in($key = NULL, $values = NULL, $escape = NULL)
-
- :param string $key: Name of field to examine
- :param array $values: Array of target values
- :param boolean $escape: Whether to escape values and identifiers
- :returns: DB_query_builder instance
- :rtype: object
-
- Generates a WHERE field IN('item', 'item') SQL query,
- joined with 'AND' if appropriate.
-
- .. method:: where_not_in($key = NULL, $values = NULL, $escape = NULL)
-
- :param string $key: Name of field to examine
- :param array $values: Array of target values
- :param boolean $escape: Whether to escape values and identifiers
- :returns: DB_query_builder instance
- :rtype: object
-
- Generates a WHERE field NOT IN('item', 'item') SQL query,
- joined with 'AND' if appropriate. \ No newline at end of file