1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
|
#################
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.
|