From 141288d1fb32c11d28ea46f06eedafff76e795c4 Mon Sep 17 00:00:00 2001 From: James L Parry Date: Sat, 6 Dec 2014 01:45:12 -0800 Subject: 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 --- .../source/database/query_builder_reference.rst | 23 ++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 user_guide_src/source/database/query_builder_reference.rst (limited to 'user_guide_src/source/database/query_builder_reference.rst') 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 `_ 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. + -- cgit v1.2.3-24-g4f1b