Query Builder Class

Query Builder Class

CodeIgniter gives you access to a Query Builder class. This pattern
allows information to be retrieved, inserted, and updated in your
database with minimal scripting. In some cases only one or two lines
of code are necessary to perform a database action.
CodeIgniter does not require that each database table be its own class
file. It instead provides a more simplified interface.

Beyond simplicity, a major benefit to using the Query Builder features
is that it allows you to create database independent applications, since
the query syntax is generated by each database adapter. It also allows
for safer queries, since the values are escaped automatically by the
system.

Note

If you intend to write your own queries you can disable this
class in your database config file, allowing the core database library
and adapter to utilize fewer resources.

Selecting Data

The following functions allow you to build SQL SELECT statements.

$this->db->get()

Runs the selection query and returns the result. Can be used by itself
to retrieve all records from a table:

The second and third parameters enable you to set a limit and offset
clause:

You’ll notice that the above function is assigned to a variable named
$query, which can be used to show the results:

Please visit the result functions page for a full
discussion regarding result generation.

$this->db->get_compiled_select()

Compiles the selection query just like $this->db->get() but does not run
the query. This method simply returns the SQL query as a string.

Example:

The second parameter enables you to set whether or not the query builder query
will be reset (by default it will be reset, just like when using $this->db->get()):

The key thing to notice in the above example is that the second query did not
utilize $this->db->from() and did not pass a table name into the first
parameter. The reason for this outcome is because the query has not been
executed using $this->db->get() which resets values or reset directly
using $this->db->reset_query().

$this->db->get_where()

Identical to the above function except that it permits you to add a
“where” clause in the second parameter, instead of using the db->where()
function:

Please read the about the where function below for more information.

Note

get_where() was formerly known as getwhere(), which has been removed

$this->db->select()

Permits you to write the SELECT portion of your query:

Note

If you are selecting all (*) from a table you do not need to
use this function. When omitted, CodeIgniter assumes that you wish
to select all fields and automatically adds ‘SELECT *’.

$this->db->select() accepts an optional second parameter. If you set it
to FALSE, CodeIgniter will not try to protect your field or table names.
This is useful if you need a compound select statement where automatic
escaping of fields may break them.

$this->db->select_max()

Writes a SELECT MAX(field) portion for your query. You can optionally
include a second parameter to rename the resulting field.

$this->db->select_min()

Writes a “SELECT MIN(field)” portion for your query. As with
select_max(), You can optionally include a second parameter to rename
the resulting field.

$this->db->select_avg()

Writes a “SELECT AVG(field)” portion for your query. As with
select_max(), You can optionally include a second parameter to rename
the resulting field.

$this->db->select_sum()

Writes a “SELECT SUM(field)” portion for your query. As with
select_max(), You can optionally include a second parameter to rename
the resulting field.

$this->db->from()

Permits you to write the FROM portion of your query:

Note

As shown earlier, the FROM portion of your query can be specified
in the $this->db->get() function, so use whichever method you prefer.

$this->db->join()

Permits you to write the JOIN portion of your query:

Multiple function calls can be made if you need several joins in one
query.

If you need a specific type of JOIN you can specify it via the third
parameter of the function. Options are: left, right, outer, inner, left
outer, and right outer.

Looking for Specific Data

$this->db->where()

This function enables you to set WHERE clauses using one of four
methods:

Note

All values passed to this function are escaped automatically,
producing safer queries.

  1. Simple key/value method:

    Notice that the equal sign is added for you.

    If you use multiple function calls they will be chained together with
    AND between them:

  2. Custom key/value method:

    You can include an operator in the first parameter in order to
    control the comparison:

  3. Associative array method:

    You can include your own operators using this method as well:

  4. Custom string:

    You can write your own clauses manually:

$this->db->where() accepts an optional third parameter. If you set it to
FALSE, CodeIgniter will not try to protect your field or table names.

$this->db->or_where()

This function is identical to the one above, except that multiple
instances are joined by OR:

Note

or_where() was formerly known as orwhere(), which has been
removed.

$this->db->where_in()

Generates a WHERE field IN (‘item’, ‘item’) SQL query joined with AND if
appropriate

$this->db->or_where_in()

Generates a WHERE field IN (‘item’, ‘item’) SQL query joined with OR if
appropriate

$this->db->where_not_in()

Generates a WHERE field NOT IN (‘item’, ‘item’) SQL query joined with
AND if appropriate

$this->db->or_where_not_in()

Generates a WHERE field NOT IN (‘item’, ‘item’) SQL query joined with OR
if appropriate

Looking for Similar Data

$this->db->like()

This method enables you to generate LIKE clauses, useful for doing
searches.

Note

All values passed to this method are escaped automatically.

  1. Simple key/value method:

    If you use multiple method calls they will be chained together with
    AND between them:

    If you want to control where the wildcard (%) is placed, you can use
    an optional third argument. Your options are ‘before’, ‘after’ and
    ‘both’ (which is the default).

  2. Associative array method:

$this->db->or_like()

This method is identical to the one above, except that multiple
instances are joined by OR:

Note

or_like() was formerly known as orlike(), which has been removed.

$this->db->not_like()

This method is identical to like(), except that it generates
NOT LIKE statements:

$this->db->or_not_like()

This method is identical to not_like(), except that multiple
instances are joined by OR:

$this->db->group_by()

Permits you to write the GROUP BY portion of your query:

You can also pass an array of multiple values as well:

Note

group_by() was formerly known as groupby(), which has been
removed.

$this->db->distinct()

Adds the “DISTINCT” keyword to a query

$this->db->having()

Permits you to write the HAVING portion of your query. There are 2
possible syntaxes, 1 argument or 2:

You can also pass an array of multiple values as well:

If you are using a database that CodeIgniter escapes queries for, you
can prevent escaping content by passing an optional third argument, and
setting it to FALSE.

$this->db->or_having()

Identical to having(), only separates multiple clauses with “OR”.

Ordering results

$this->db->order_by()

Lets you set an ORDER BY clause.

The first parameter contains the name of the column you would like to order by.

The second parameter lets you set the direction of the result.
Options are ASC, DESC AND RANDOM.

You can also pass your own string in the first parameter:

Or multiple function calls can be made if you need multiple fields.

If you choose the RANDOM direction option, then the first parameters will
be ignored, unless you specify a numeric seed value.

Note

order_by() was formerly known as orderby(), which has been
removed.

Note

Random ordering is not currently supported in Oracle and
will default to ASC instead.

Limiting or Counting Results

$this->db->limit()

Lets you limit the number of rows you would like returned by the query:

The second parameter lets you set a result offset.

$this->db->count_all_results()

Permits you to determine the number of rows in a particular Active
Record query. Queries will accept Query Builder restrictors such as
where(), or_where(), like(), or_like(), etc. Example:

However, this method also resets any field values that you may have passed
to select(). If you need to keep them, you can pass FALSE as the
second parameter:

$this->db->count_all()

Permits you to determine the number of rows in a particular table.
Submit the table name in the first parameter. Example:

Query grouping

Query grouping allows you to create groups of WHERE clauses by enclosing them in parentheses. This will allow
you to create queries with complex WHERE clauses. Nested groups are supported. Example:

Note

groups need to be balanced, make sure every group_start() is matched by a group_end().

$this->db->group_start()

Starts a new group by adding an opening parenthesis to the WHERE clause of the query.

$this->db->or_group_start()

Starts a new group by adding an opening parenthesis to the WHERE clause of the query, prefixing it with ‘OR’.

$this->db->not_group_start()

Starts a new group by adding an opening parenthesis to the WHERE clause of the query, prefixing it with ‘NOT’.

$this->db->or_not_group_start()

Starts a new group by adding an opening parenthesis to the WHERE clause of the query, prefixing it with ‘OR NOT’.

$this->db->group_end()

Ends the current group by adding an closing parenthesis to the WHERE clause of the query.

Inserting Data

$this->db->insert()

Generates an insert string based on the data you supply, and runs the
query. You can either pass an array or an object to the
function. Here is an example using an array:

The first parameter will contain the table name, the second is an
associative array of values.

Here is an example using an object:

The first parameter will contain the table name, the second is an
object.

Note

All values are escaped automatically producing safer queries.

$this->db->get_compiled_insert()

Compiles the insertion query just like $this->db->insert() but does not
run the query. This method simply returns the SQL query as a string.

Example:

The second parameter enables you to set whether or not the query builder query
will be reset (by default it will be–just like $this->db->insert()):

The key thing to notice in the above example is that the second query did not
utlize $this->db->from() nor did it pass a table name into the first
parameter. The reason this worked is because the query has not been executed
using $this->db->insert() which resets values or reset directly using
$this->db->reset_query().

Note

This method doesn’t work for batched inserts.

$this->db->insert_batch()

Generates an insert string based on the data you supply, and runs the
query. You can either pass an array or an object to the
function. Here is an example using an array:

The first parameter will contain the table name, the second is an
associative array of values.

Note

All values are escaped automatically producing safer queries.

Updating Data

$this->db->replace()

This method executes a REPLACE statement, which is basically the SQL
standard for (optional) DELETE + INSERT, using PRIMARY and UNIQUE
keys as the determining factor.
In our case, it will save you from the need to implement complex
logics with different combinations of select(), update(),
delete() and insert() calls.

Example:

In the above example, if we assume that the title field is our primary
key, then if a row containing ‘My title’ as the title value, that row
will be deleted with our new row data replacing it.

Usage of the set() method is also allowed and all fields are
automatically escaped, just like with insert().

$this->db->set()

This function enables you to set values for inserts or updates.

It can be used instead of passing a data array directly to the insert
or update functions:

If you use multiple function called they will be assembled properly
based on whether you are doing an insert or an update:

set() will also accept an optional third parameter ($escape), that
will prevent data from being escaped if set to FALSE. To illustrate the
difference, here is set() used both with and without the escape
parameter.

You can also pass an associative array to this function:

Or an object:

$this->db->update()

Generates an update string and runs the query based on the data you
supply. You can pass an array or an object to the function. Here
is an example using an array:

Or you can supply an object:

Note

All values are escaped automatically producing safer queries.

You’ll notice the use of the $this->db->where() function, enabling you
to set the WHERE clause. You can optionally pass this information
directly into the update function as a string:

Or as an array:

You may also use the $this->db->set() function described above when
performing updates.

$this->db->update_batch()

Generates an update string based on the data you supply, and runs the query.
You can either pass an array or an object to the function.
Here is an example using an array:

The first parameter will contain the table name, the second is an associative
array of values, the third parameter is the where key.

Note

All values are escaped automatically producing safer queries.

Note

affected_rows() won’t give you proper results with this method,
due to the very nature of how it works. Instead, update_batch()
returns the number of rows affected.

$this->db->get_compiled_update()

This works exactly the same way as $this->db->get_compiled_insert() except
that it produces an UPDATE SQL string instead of an INSERT SQL string.

For more information view documentation for $this->db->get_compiled_insert().

Note

This method doesn’t work for batched updates.

Deleting Data

$this->db->delete()

Generates a delete SQL string and runs the query.

The first parameter is the table name, the second is the where clause.
You can also use the where() or or_where() functions instead of passing
the data to the second parameter of the function:

An array of table names can be passed into delete() if you would like to
delete data from more than 1 table.

If you want to delete all data from a table, you can use the truncate()
function, or empty_table().

$this->db->empty_table()

Generates a delete SQL string and runs the
query.:

$this->db->truncate()

Generates a truncate SQL string and runs the query.

Note

If the TRUNCATE command isn’t available, truncate() will
execute as “DELETE FROM table”.

$this->db->get_compiled_delete()

This works exactly the same way as $this->db->get_compiled_insert() except
that it produces a DELETE SQL string instead of an INSERT SQL string.

For more information view documentation for $this->db->get_compiled_insert().

Method Chaining

Method chaining allows you to simplify your syntax by connecting
multiple functions. Consider this example:

Query Builder Caching

While not “true” caching, Query Builder enables you to save (or “cache”)
certain parts of your queries for reuse at a later point in your
script’s execution. Normally, when an Query Builder call is completed,
all stored information is reset for the next call. With caching, you can
prevent this reset, and reuse information easily.

Cached calls are cumulative. If you make 2 cached select() calls, and
then 2 uncached select() calls, this will result in 4 select() calls.
There are three Caching functions available:

$this->db->start_cache()

This function must be called to begin caching. All Query Builder queries
of the correct type (see below for supported queries) are stored for
later use.

$this->db->stop_cache()

This function can be called to stop caching.

$this->db->flush_cache()

This function deletes all items from the Query Builder cache.

An example of caching

Here’s a usage example:

Note

The following statements can be cached: select, from, join,
where, like, group_by, having, order_by

Resetting Query Builder

$this->db->reset_query()

Resetting Query Builder allows you to start fresh with your query without
executing it first using a method like $this->db->get() or $this->db->insert().
Just like the methods that execute a query, this will not reset items you’ve
cached using Query Builder Caching.

This is useful in situations where you are using Query Builder to generate SQL
(ex. $this->db->get_compiled_select()) but then choose to, for instance,
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.

Class Reference

class CI_DB_query_builder
reset_query()
Returns: CI_DB_query_builder instance (method chaining)
Return type: CI_DB_query_builder

Resets the current Query Builder state. Useful when you want
to build a query that can be cancelled under certain conditions.

start_cache()
Returns: CI_DB_query_builder instance (method chaining)
Return type: CI_DB_query_builder

Starts the Query Builder cache.

stop_cache()
Returns: CI_DB_query_builder instance (method chaining)
Return type: CI_DB_query_builder

Stops the Query Builder cache.

flush_cache()
Returns: CI_DB_query_builder instance (method chaining)
Return type: CI_DB_query_builder

Empties the Query Builder cache.

set_dbprefix([$prefix = ”])
Parameters:
  • $prefix (string) – The new prefix to use
Returns:

The DB prefix in use
Return type:

string

Sets the database prefix, without having to reconnect.

dbprefix([$table = ”])
Parameters:
  • $table (string) – The table name to prefix
Returns:

The prefixed table name
Return type:

string

Prepends a database prefix, if one exists in configuration.

count_all_results([$table = ”[, $reset = TRUE]])
Parameters:
  • $table (string) – Table name
  • $reset (bool) – Whether to reset values for SELECTs
Returns:

Number of rows in the query result
Return type:

int

Generates a platform-specific query string that counts
all records returned by an Query Builder query.

get([$table = ”[, $limit = NULL[, $offset = NULL]]])
Parameters:
  • $table (string) – The table to query
  • $limit (int) – The LIMIT clause
  • $offset (int) – The OFFSET clause
Returns:

CI_DB_result instance (method chaining)
Return type:

CI_DB_result

Compiles and runs SELECT statement based on the already
called Query Builder methods.

get_where([$table = ”[, $where = NULL[, $limit = NULL[, $offset = NULL]]]])
Parameters:
  • $table (mixed) – The table(s) to fetch data from; string or array
  • $where (string) – The WHERE clause
  • $limit (int) – The LIMIT clause
  • $offset (int) – The OFFSET clause
Returns:

CI_DB_result instance (method chaining)
Return type:

CI_DB_result

Same as get(), but also allows the WHERE to be added directly.

select([$select = ‘*’[, $escape = NULL]])
Parameters:
  • $select (string) – The SELECT portion of a query
  • $escape (bool) – Whether to escape values and identifiers
Returns:

CI_DB_query_builder instance (method chaining)
Return type:

CI_DB_query_builder

Adds a SELECT clause to a query.

select_avg([$select = ”[, $alias = ”]])
Parameters:
  • $select (string) – Field to compute the average of
  • $alias (string) – Alias for the resulting value name
Returns:

CI_DB_query_builder instance (method chaining)
Return type:

CI_DB_query_builder

Adds a SELECT AVG(field) clause to a query.

select_max([$select = ”[, $alias = ”]])
Parameters:
  • $select (string) – Field to compute the maximum of
  • $alias (string) – Alias for the resulting value name
Returns:

CI_DB_query_builder instance (method chaining)
Return type:

CI_DB_query_builder

Adds a SELECT MAX(field) clause to a query.

select_min([$select = ”[, $alias = ”]])
Parameters:
  • $select (string) – Field to compute the minimum of
  • $alias (string) – Alias for the resulting value name
Returns:

CI_DB_query_builder instance (method chaining)
Return type:

CI_DB_query_builder

Adds a SELECT MIN(field) clause to a query.

select_sum([$select = ”[, $alias = ”]])
Parameters:
  • $select (string) – Field to compute the sum of
  • $alias (string) – Alias for the resulting value name
Returns:

CI_DB_query_builder instance (method chaining)
Return type:

CI_DB_query_builder

Adds a SELECT SUM(field) clause to a query.

distinct([$val = TRUE])
Parameters:
  • $val (bool) – Desired value of the “distinct” flag
Returns:

CI_DB_query_builder instance (method chaining)
Return type:

CI_DB_query_builder

Sets a flag which tells the query builder to add
a DISTINCT clause to the SELECT portion of the query.

from($from)
Parameters:
  • $from (mixed) – Table name(s); string or array
Returns:

CI_DB_query_builder instance (method chaining)
Return type:

CI_DB_query_builder

Specifies the FROM clause of a query.

join($table, $cond[, $type = ”[, $escape = NULL]])
Parameters:
  • $table (string) – Table name to join
  • $cond (string) – The JOIN ON condition
  • $type (string) – The JOIN type
  • $escape (bool) – Whether to escape values and identifiers
Returns:

CI_DB_query_builder instance (method chaining)
Return type:

CI_DB_query_builder

Adds a JOIN clause to a query.

where($key[, $value = NULL[, $escape = NULL]])
Parameters:
  • $key (mixed) – Name of field to compare, or associative array
  • $value (mixed) – If a single key, compared to this value
  • $escape (bool) – Whether to escape values and identifiers
Returns:

DB_query_builder instance
Return type:

object

Generates the WHERE portion of the query.
Separates multiple calls with ‘AND’.

or_where($key[, $value = NULL[, $escape = NULL]])
Parameters:
  • $key (mixed) – Name of field to compare, or associative array
  • $value (mixed) – If a single key, compared to this value
  • $escape (bool) – Whether to escape values and identifiers
Returns:

DB_query_builder instance
Return type:

object

Generates the WHERE portion of the query.
Separates multiple calls with ‘OR’.

or_where_in([$key = NULL[, $values = NULL[, $escape = NULL]]])
Parameters:
  • $key (string) – The field to search
  • $values (array) – The values searched on
  • $escape (bool) – Whether to escape values and identifiers
Returns:

DB_query_builder instance
Return type:

object

Generates a WHERE field IN(‘item’, ‘item’) SQL query,
joined with ‘OR’ if appropriate.

or_where_not_in([$key = NULL[, $values = NULL[, $escape = NULL]]])
Parameters:
  • $key (string) – The field to search
  • $values (array) – The values searched on
  • $escape (bool) – Whether to escape values and identifiers
Returns:

DB_query_builder instance
Return type:

object

Generates a WHERE field NOT IN(‘item’, ‘item’) SQL query,
joined with ‘OR’ if appropriate.

where_in([$key = NULL[, $values = NULL[, $escape = NULL]]])
Parameters:
  • $key (string) – Name of field to examine
  • $values (array) – Array of target values
  • $escape (bool) – Whether to escape values and identifiers
Returns:

DB_query_builder instance
Return type:

object

Generates a WHERE field IN(‘item’, ‘item’) SQL query,
joined with ‘AND’ if appropriate.

where_not_in([$key = NULL[, $values = NULL[, $escape = NULL]]])
Parameters:
  • $key (string) – Name of field to examine
  • $values (array) – Array of target values
  • $escape (bool) – Whether to escape values and identifiers
Returns:

DB_query_builder instance
Return type:

object

Generates a WHERE field NOT IN(‘item’, ‘item’) SQL query,
joined with ‘AND’ if appropriate.

group_start()
Returns: CI_DB_query_builder instance (method chaining)
Return type: CI_DB_query_builder

Starts a group expression, using ANDs for the conditions inside it.

or_group_start()
Returns: CI_DB_query_builder instance (method chaining)
Return type: CI_DB_query_builder

Starts a group expression, using ORs for the conditions inside it.

not_group_start()
Returns: CI_DB_query_builder instance (method chaining)
Return type: CI_DB_query_builder

Starts a group expression, using AND NOTs for the conditions inside it.

or_not_group_start()
Returns: CI_DB_query_builder instance (method chaining)
Return type: CI_DB_query_builder

Starts a group expression, using OR NOTs for the conditions inside it.

group_end()
Returns: DB_query_builder instance
Return type: object

Ends a group expression.

like($field[, $match = ”[, $side = ‘both’[, $escape = NULL]]])
Parameters:
  • $field (string) – Field name
  • $match (string) – Text portion to match
  • $side (string) – Which side of the expression to put the ‘%’ wildcard on
  • $escape (bool) – Whether to escape values and identifiers
Returns:

CI_DB_query_builder instance (method chaining)
Return type:

CI_DB_query_builder

Adds a LIKE clause to a query, separating multiple calls with AND.

or_like($field[, $match = ”[, $side = ‘both’[, $escape = NULL]]])
Parameters:
  • $field (string) – Field name
  • $match (string) – Text portion to match
  • $side (string) – Which side of the expression to put the ‘%’ wildcard on
  • $escape (bool) – Whether to escape values and identifiers
Returns:

CI_DB_query_builder instance (method chaining)
Return type:

CI_DB_query_builder

Adds a LIKE clause to a query, separating multiple class with OR.

not_like($field[, $match = ”[, $side = ‘both’[, $escape = NULL]]])
Parameters:
  • $field (string) – Field name
  • $match (string) – Text portion to match
  • $side (string) – Which side of the expression to put the ‘%’ wildcard on
  • $escape (bool) – Whether to escape values and identifiers
Returns:

CI_DB_query_builder instance (method chaining)
Return type:

CI_DB_query_builder

Adds a NOT LIKE clause to a query, separating multiple calls with AND.

or_not_like($field[, $match = ”[, $side = ‘both’[, $escape = NULL]]])
Parameters:
  • $field (string) – Field name
  • $match (string) – Text portion to match
  • $side (string) – Which side of the expression to put the ‘%’ wildcard on
  • $escape (bool) – Whether to escape values and identifiers
Returns:

CI_DB_query_builder instance (method chaining)
Return type:

CI_DB_query_builder

Adds a NOT LIKE clause to a query, separating multiple calls with OR.

having($key[, $value = NULL[, $escape = NULL]])
Parameters:
  • $key (mixed) – Identifier (string) or associative array of field/value pairs
  • $value (string) – Value sought if $key is an identifier
  • $escape (string) – Whether to escape values and identifiers
Returns:

CI_DB_query_builder instance (method chaining)
Return type:

CI_DB_query_builder

Adds a HAVING clause to a query, separating multiple calls with AND.

or_having($key[, $value = NULL[, $escape = NULL]])
Parameters:
  • $key (mixed) – Identifier (string) or associative array of field/value pairs
  • $value (string) – Value sought if $key is an identifier
  • $escape (string) – Whether to escape values and identifiers
Returns:

CI_DB_query_builder instance (method chaining)
Return type:

CI_DB_query_builder

Adds a HAVING clause to a query, separating multiple calls with OR.

group_by($by[, $escape = NULL])
Parameters:
  • $by (mixed) – Field(s) to group by; string or array
Returns:

CI_DB_query_builder instance (method chaining)
Return type:

CI_DB_query_builder

Adds a GROUP BY clause to a query.

order_by($orderby[, $direction = ”[, $escape = NULL]])
Parameters:
  • $orderby (string) – Field to order by
  • $direction (string) – The order requested – ASC, DESC or random
  • $escape (bool) – Whether to escape values and identifiers
Returns:

CI_DB_query_builder instance (method chaining)
Return type:

CI_DB_query_builder

Adds an ORDER BY clause to a query.

limit($value[, $offset = 0])
Parameters:
  • $value (int) – Number of rows to limit the results to
  • $offset (int) – Number of rows to skip
Returns:

CI_DB_query_builder instance (method chaining)
Return type:

CI_DB_query_builder

Adds LIMIT and OFFSET clauses to a query.

offset($offset)
Parameters:
  • $offset (int) – Number of rows to skip
Returns:

CI_DB_query_builder instance (method chaining)
Return type:

CI_DB_query_builder

Adds an OFFSET clause to a query.

set($key[, $value = ”[, $escape = NULL]])
Parameters:
  • $key (mixed) – Field name, or an array of field/value pairs
  • $value (string) – Field value, if $key is a single field
  • $escape (bool) – Whether to escape values and identifiers
Returns:

CI_DB_query_builder instance (method chaining)
Return type:

CI_DB_query_builder

Adds field/value pairs to be passed later to insert(),
update() or replace().

insert([$table = ”[, $set = NULL[, $escape = NULL]]])
Parameters:
  • $table (string) – Table name
  • $set (array) – An associative array of field/value pairs
  • $escape (bool) – Whether to escape values and identifiers
Returns:

TRUE on success, FALSE on failure
Return type:

bool

Compiles and executes an INSERT statement.

insert_batch($table[, $set = NULL[, $escape = NULL[, $batch_size = 100]]])
Parameters:
  • $table (string) – Table name
  • $set (array) – Data to insert
  • $escape (bool) – Whether to escape values and identifiers
  • $batch_size (int) – Count of rows to insert at once
Returns:

Number of rows inserted or FALSE on failure
Return type:

mixed

Compiles and executes batch INSERT statements.

Note

When more than $batch_size rows are provided, multiple
INSERT queries will be executed, each trying to insert
up to $batch_size rows.

set_insert_batch($key[, $value = ”[, $escape = NULL]])
P