diff options
author | Andrey Andreev <narf@bofh.bg> | 2012-06-15 14:16:51 +0200 |
---|---|---|
committer | Andrey Andreev <narf@bofh.bg> | 2012-06-15 14:16:51 +0200 |
commit | 1922a885b40ef63cf0a5141eb8377d04e3bee172 (patch) | |
tree | 8db81b4215127568d380964d83db47cd4b3f9fca /user_guide_src/source/database | |
parent | 26315d1621bbf91ec27503378a2b8a1597ff27b4 (diff) |
Update simple_query() documentation (issue #1484)
Diffstat (limited to 'user_guide_src/source/database')
-rw-r--r-- | user_guide_src/source/database/queries.rst | 30 |
1 files changed, 25 insertions, 5 deletions
diff --git a/user_guide_src/source/database/queries.rst b/user_guide_src/source/database/queries.rst index d23efecb3..11dd78392 100644 --- a/user_guide_src/source/database/queries.rst +++ b/user_guide_src/source/database/queries.rst @@ -21,11 +21,31 @@ this:: $this->db->simple_query(); =========================== -This is a simplified version of the $this->db->query() function. It ONLY -returns TRUE/FALSE on success or failure. It DOES NOT return a database -result set, nor does it set the query timer, or compile bind data, or -store your query for debugging. It simply lets you submit a query. Most -users will rarely use this function. +This is a simplified version of the $this->db->query() method. It DOES +NOT return a database result set, nor does it set the query timer, or +compile bind data, or store your query for debugging. It simply lets you +submit a query. Most users will rarely use this function. + +It returns whatever the database drivers' "execute" function returns. +That typically is TRUE/FALSE on success or failure for write type queries +such as INSERT, DELETE or UPDATE statements (which is what it really +should be used for) and a resource/object on success for queries with +fetchable results. + +:: + + if ($this->db->simple_query('YOUR QUERY')) + { + echo "Success!"; + } + else + { + echo "Query failed!"; + } + +.. note:: PostgreSQL's pg_exec() function always returns a resource on + success, even for write type queries. So take that in mind if + you're looking for a boolean value. *************************************** Working with Database prefixes manually |