aboutsummaryrefslogtreecommitdiffstats
path: root/src/modules/objects/class_sql.cpp
diff options
context:
space:
mode:
authorGravatar Noldor2009-02-06 17:16:45 +0000
committerGravatar Noldor2009-02-06 17:16:45 +0000
commit297902ea5e74cdec38a55a75f0dda92258a5e74d (patch)
tree50a10818a9813f319c76041536a7bbfcc4fe7c84 /src/modules/objects/class_sql.cpp
parentNew kvs classes(w.i.p.) (diff)
downloadKVIrc-297902ea5e74cdec38a55a75f0dda92258a5e74d.tar.gz
KVIrc-297902ea5e74cdec38a55a75f0dda92258a5e74d.tar.bz2
KVIrc-297902ea5e74cdec38a55a75f0dda92258a5e74d.zip
Fix doc indent in kvs class sql
git-svn-id: https://svn.kvirc.de/svn/trunk/kvirc@3070 17fca916-40b9-46aa-a4ea-0a15b648b75c
Diffstat (limited to 'src/modules/objects/class_sql.cpp')
-rw-r--r--src/modules/objects/class_sql.cpp90
1 files changed, 45 insertions, 45 deletions
diff --git a/src/modules/objects/class_sql.cpp b/src/modules/objects/class_sql.cpp
index 0101ba052..3cba363e0 100644
--- a/src/modules/objects/class_sql.cpp
+++ b/src/modules/objects/class_sql.cpp
@@ -50,52 +50,52 @@
@inherits:
[class]object[/class]
@description:
- This class permits KVIrc to have an interface with a SQL database supported by Qt library drivers.
+ This class permits KVIrc to have an interface with a SQL database supported by Qt library drivers.
@functions:
- !fn: <boolean> $setConnection(<connection_name:string>,<database_name:string>,[<user:string>,<host_name_string>,<password:string>,<database_driver:string>])
- Connects to the DBMS using the connection <connection_name> and selecting the database <database_name>.[br]
- If the optional parameter <database_driver> is passed, it will be used the corresponding driver (if present), otherwise Sqlite will be used.
- Returns true if the operation is successful, false otherwise.
- !fn: $queryInit(<connection_name:string>)
- Initialize the query for the database <connection_name> which has to be already connected.
- !fn: $setCurrentQuery(<connection_name:string>)
- Sets the query for the database connection <connection_name> , which has to be already connected, as current query.
- !fn: <connection_name:string> $currentQuery()
- Returns the name of the database connection for the current query, or an empty string if there aren't any initialized queries.
- !fn: $closeConnection(<connection_name:string>)
- Closes the connection <connection_name>.
- !fn: <size:integer> $queryResultsSize()
- Returns the query size in rows or -1 if the query is empty or the database driver doesn' support the function.
- !fn: <ok:boolean> $queryExec([<query:string>])
- Execs the current query <query>. The string must follow the right syntax against the database in use.
- If there are no parameters, it will exec the query previously done.
- After the execution, the query will positioned on the first resulting record.
- Returns true if the operation is successful, false otherwise.
- See also [classfnc]$queryPrepare[/classfnc]()
- !fn: <ok:boolean> $queryPrepare(<query_string>)
- Prepare the query <query> to execute. The string must follow the right syntax against the database in use.
- It's possible to use the placeholders. It's supported either the identifier ':' and '?' but it's not possible to use them together.
- Returns true if the operation is successful, false otherwise.
- See also [classfnc]$queryExec[/classfnc]and[classfnc]$queryBindValue[/classfnc.
- !fn: $queryBindValue()
- Sets the placeholder <placeholder> to be bound to the value <val> in the prepared statement.
- Note that the placeholder mark (e.g :) must be included when specifing the placeholder name.
- !fn: <boolean> $queryPrevious()
- Sets the current query position to the previous resulting record.
- Returns true if the operation is successful, false otherwise.
- !fn: <boolean> $queryNext()
- Sets the current query position to the next resulting record.
- Returns true if the operation is successful, false otherwise.
- !fn: <boolean> $queryLast()
- Sets the current query position to the last resulting record.
- Returns true if the operation is successful, false otherwise.
- !fn: <boolean> $queryFirst()
- Sets the current query position to the first resulting record.
- Returns true if the operation is successful, false otherwise.
- !fn: <record:hash> $queryRecord()
- Returns a hash containing the current query's record fields.
- !fn: $queryFinish()
- Sets the current query to inactive.
+ !fn: <boolean> $setConnection(<connection_name:string>,<database_name:string>,[<user:string>,<host_name_string>,<password:string>,<database_driver:string>])
+ Connects to the DBMS using the connection <connection_name> and selecting the database <database_name>.[br]
+ If the optional parameter <database_driver> is passed, it will be used the corresponding driver (if present), otherwise Sqlite will be used.
+ Returns true if the operation is successful, false otherwise.
+ !fn: $queryInit(<connection_name:string>)
+ Initialize the query for the database <connection_name> which has to be already connected.
+ !fn: $setCurrentQuery(<connection_name:string>)
+ Sets the query for the database connection <connection_name> , which has to be already connected, as current query.
+ !fn: <connection_name:string> $currentQuery()
+ Returns the name of the database connection for the current query, or an empty string if there aren't any initialized queries.
+ !fn: $closeConnection(<connection_name:string>)
+ Closes the connection <connection_name>.
+ !fn: <size:integer> $queryResultsSize()
+ Returns the query size in rows or -1 if the query is empty or the database driver doesn' support the function.
+ !fn: <ok:boolean> $queryExec([<query:string>])
+ Execs the current query <query>. The string must follow the right syntax against the database in use.
+ If there are no parameters, it will exec the query previously done.
+ After the execution, the query will positioned on the first resulting record.
+ Returns true if the operation is successful, false otherwise.
+ See also [classfnc]$queryPrepare[/classfnc]()
+ !fn: <ok:boolean> $queryPrepare(<query_string>)
+ Prepare the query <query> to execute. The string must follow the right syntax against the database in use.
+ It's possible to use the placeholders. It's supported either the identifier ':' and '?' but it's not possible to use them together.
+ Returns true if the operation is successful, false otherwise.
+ See also [classfnc]$queryExec[/classfnc]and[classfnc]$queryBindValue[/classfnc.
+ !fn: $queryBindValue()
+ Sets the placeholder <placeholder> to be bound to the value <val> in the prepared statement.
+ Note that the placeholder mark (e.g :) must be included when specifing the placeholder name.
+ !fn: <boolean> $queryPrevious()
+ Sets the current query position to the previous resulting record.
+ Returns true if the operation is successful, false otherwise.
+ !fn: <boolean> $queryNext()
+ Sets the current query position to the next resulting record.
+ Returns true if the operation is successful, false otherwise.
+ !fn: <boolean> $queryLast()
+ Sets the current query position to the last resulting record.
+ Returns true if the operation is successful, false otherwise.
+ !fn: <boolean> $queryFirst()
+ Sets the current query position to the first resulting record.
+ Returns true if the operation is successful, false otherwise.
+ !fn: <record:hash> $queryRecord()
+ Returns a hash containing the current query's record fields.
+ !fn: $queryFinish()
+ Sets the current query to inactive.
*/