summaryrefslogtreecommitdiffstats
path: root/user_guide_src/source/database/helpers.rst
diff options
context:
space:
mode:
authorJoseph Wensley <jwensley2@gmail.com>2011-10-07 04:53:29 +0200
committerJoseph Wensley <jwensley2@gmail.com>2011-10-07 04:53:29 +0200
commitf24f404a34081241c1398f568b506e2c9d9bec5b (patch)
tree061763329891ffccb78a6c55955b2528e8cb89a5 /user_guide_src/source/database/helpers.rst
parent1b9732987f28f1b47f59c68303613c6977300580 (diff)
cleaning up and formatting database pages
Diffstat (limited to 'user_guide_src/source/database/helpers.rst')
-rw-r--r--user_guide_src/source/database/helpers.rst22
1 files changed, 16 insertions, 6 deletions
diff --git a/user_guide_src/source/database/helpers.rst b/user_guide_src/source/database/helpers.rst
index b0a5ce97b..7ea19e9f6 100644
--- a/user_guide_src/source/database/helpers.rst
+++ b/user_guide_src/source/database/helpers.rst
@@ -28,7 +28,9 @@ $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::
- echo $this->db->count_all('my_table'); // Produces an integer, like 25
+ echo $this->db->count_all('my_table');
+
+ // Produces an integer, like 25
$this->db->platform()
=====================
@@ -51,7 +53,9 @@ $this->db->last_query();
Returns the last query that was run (the query string, not the result).
Example::
- $str = $this->db->last_query(); // Produces: SELECT * FROM sometable....
+ $str = $this->db->last_query();
+
+ // Produces: SELECT * FROM sometable....
The following two functions help simplify the process of writing
database INSERTs and UPDATEs.
@@ -62,14 +66,16 @@ $this->db->insert_string();
This function simplifies the process of writing database inserts. It
returns a correctly formatted SQL insert string. Example::
- $data = array('name' => $name, 'email' => $email, 'url' => $url); $str = $this->db->insert_string('table_name', $data);
+ $data = array('name' => $name, 'email' => $email, 'url' => $url);
+
+ $str = $this->db->insert_string('table_name', $data);
The first parameter is the table name, the second is an associative
array with the data to be inserted. The above example produces::
INSERT INTO table_name (name, email, url) VALUES ('Rick', 'rick@example.com', 'example.com')
-Note: Values are automatically escaped, producing safer queries.
+.. note:: Values are automatically escaped, producing safer queries.
$this->db->update_string();
============================
@@ -77,7 +83,11 @@ $this->db->update_string();
This function simplifies the process of writing database updates. It
returns a correctly formatted SQL update string. Example::
- $data = array('name' => $name, 'email' => $email, 'url' => $url); $where = "author_id = 1 AND status = 'active'"; $str = $this->db->update_string('table_name', $data, $where);
+ $data = array('name' => $name, 'email' => $email, 'url' => $url);
+
+ $where = "author_id = 1 AND status = 'active'";
+
+ $str = $this->db->update_string('table_name', $data, $where);
The first parameter is the table name, the second is an associative
array with the data to be updated, and the third parameter is the
@@ -85,4 +95,4 @@ array with the data to be updated, and the third parameter is the
UPDATE table_name SET name = 'Rick', email = 'rick@example.com', url = 'example.com' WHERE author_id = 1 AND status = 'active'
-Note: Values are automatically escaped, producing safer queries.
+.. note:: Values are automatically escaped, producing safer queries.