diff options
author | James L Parry <jim_parry@bcit.ca> | 2014-12-06 10:45:12 +0100 |
---|---|---|
committer | James L Parry <jim_parry@bcit.ca> | 2014-12-06 10:45:12 +0100 |
commit | 141288d1fb32c11d28ea46f06eedafff76e795c4 (patch) | |
tree | b07543a0594a0c3ad594495a0e857f2b3dbf69ac /user_guide_src/source/database/query_builder_reference.rst | |
parent | 3c0427e7dd11380692f9898d7cc04ba1b5a8491b (diff) |
User Guide - query builder
Removed API stuff from the query builder page.
Added a new API reference page.
Updated the index to include the API ref in the TOC.
Started on the API reference page.
Signed-off-by:James L Parry <jim_parry@bcit.ca>
Diffstat (limited to 'user_guide_src/source/database/query_builder_reference.rst')
-rw-r--r-- | user_guide_src/source/database/query_builder_reference.rst | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/user_guide_src/source/database/query_builder_reference.rst b/user_guide_src/source/database/query_builder_reference.rst new file mode 100644 index 000000000..f20a1e70d --- /dev/null +++ b/user_guide_src/source/database/query_builder_reference.rst @@ -0,0 +1,23 @@ +################# +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. + |