×
Namespaces

Variants
Actions
(Difference between revisions)

Archived:Using Symbian SQL API with SQL statements which do not return data

From Nokia Developer Wiki
Jump to: navigation, search
Forum Nokia KB (Talk | contribs)
lpvalente (Talk | contribs)
m (Lpvalente -)
 
(12 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__
+
[[Category:Symbian C++]][[Category:Code Snippet]][[Category:Files/Data]][[Category:S60 3rd Edition FP2]][[Category:Code Snippet]]
__NOEDITSECTION__
+
{{Archived|timestamp=20120313131234|user=roy.debjit| }}
 
+
{|style="background:#eceff2" width="660px" border="1" cellpadding="5" cellspacing="0"
+
|-
+
|'''ID''' ||  
+
|'''Creation date''' || April 24, 2008
+
|-
+
|'''Platform''' || S60 3rd Edition, FP2
+
|'''Tested on devices''' || Nokia 6220 Classic
+
|-
+
|'''Category''' || Symbian C++
+
|'''Subcategory''' || Files/Data
+
|}
+
 
+
 
+
{|style="background:#eceff2" width="660px" border="1" cellpadding="5" cellspacing="0"
+
|-
+
|'''Keywords (APIs, classes, methods, functions):''' RSqlDatabase, RSqlStatement, RSqlDatabase::Open(), RSqlDatabase::Exec(), RSqlDatabase::Close() RSqlStatement::Prepare(), RSqlStatement::ParameterIndex(), RSqlStatement::BindInt(), RSqlStatement::BindText(), RSqlStatement::Reset(), RSqlStatement::Close()
+
|}
+
  
 +
{{ArticleMetaData <!-- v1.2 -->
 +
|sourcecode= <!-- Link to example source code (e.g. [[Media:The Code Example ZIP.zip]]) -->
 +
|installfile= <!-- Link to installation file (e.g. [[Media:The Installation File.sis]]) -->
 +
|devices= Nokia 6220 Classic
 +
|sdk= <!-- SDK(s) built and tested against (e.g. [http://linktosdkdownload/ Nokia Qt SDK 1.1]) -->
 +
|platform= S60 3rd Edition, FP2
 +
|devicecompatability= <!-- Compatible devices (e.g.: All* (must have GPS) ) -->
 +
|dependencies= <!-- Any other/external dependencies e.g.: Google Maps Api v1.0 -->
 +
|signing= <!-- Empty or one of Self-Signed, DevCert, Manufacturer -->
 +
|capabilities= <!-- Capabilities required by the article/code example (e.g. Location, NetworkServices. -->
 +
|keywords= RSqlDatabase, RSqlStatement, RSqlDatabase::Open(), RSqlDatabase::Exec(), RSqlDatabase::Close() RSqlStatement::Prepare(), RSqlStatement::ParameterIndex(), RSqlStatement::BindInt(), RSqlStatement::BindText(), RSqlStatement::Reset(), RSqlStatement::Close()
 +
|language= <!-- Language category code for non-English topics - e.g. Lang-Chinese -->
 +
|translated-by= <!-- [[User:XXXX]] -->
 +
|translated-from-title= <!-- Title only -->
 +
|translated-from-id= <!-- Id of translated revision -->
 +
|review-by= <!-- After re-review: [[User:username]] -->
 +
|review-timestamp= <!-- After re-review: YYYYMMDD -->
 +
|update-by= <!-- After significant update: [[User:username]]-->
 +
|update-timestamp= <!-- After significant update: YYYYMMDD -->
 +
|creationdate= 20080424
 +
|author= [[User:Aknyman]]
 +
<!-- The following are not in current metadata -->
 +
|subcategory= Files/Data
 +
|id= CS000927
 +
}}
 +
 
 
==Overview==
 
==Overview==
  
The <tt>RSqlStatement</tt> class provides functionality to execute all types of SQL statements when using SQL API. <tt>RSqlStatement</tt> encapsulates a SQL statement and the data that it returns. <tt>RSqlStatement</tt> statements can be executed with methods: <tt>Exec()</tt> and <tt>Next()</tt>. The method <tt>Exec()</tt> is used when statement do not return any data and <tt>Next()</tt> when statement do. This snippet shows some examples how to use the <tt>Exec()</tt> method.
+
{{Abstract|The {{Icode|RSqlStatement}} class provides functionality to execute all types of SQL statements when using the SQL API. {{Icode|RSqlStatement}} encapsulates an SQL statement and the data that it returns. {{Icode|RSqlStatement}} statements can be executed with the methods {{Icode|Exec()}} and {{Icode|Next()}}. The method {{Icode|Exec()}} is used when the statement does not return any data and {{Icode|Next()}} when the statement returns data. This snippet gives some examples on how to use the {{Icode|Exec()}} method.}}
  
Statements use so called placeholders (:) in descriptors to mark positions where dynamic data is inserted at runtime. The user can bind the actual data to placeholders with different <tt>Bind()</tt> methods e.g. BindText() is one of them. It is a good practise to resolve the placeholder index with <tt>RSqlStatement::ParameterIndex()</tt> method, and not use hardcoded values.
+
Statements use so-called placeholders (:) in descriptors to mark positions where dynamic data is inserted at runtime. The user can bind the actual data to placeholders with different {{Icode|Bind()}} methods, such as BindText(). It is good practise to resolve the placeholder index with the {{Icode|RSqlStatement::ParameterIndex()}} method, and not to use hardcoded values.
  
 
'''NOTE:
 
'''NOTE:
SQL statements can also be executed using the <tt>RSqlDatabase::Exec()</tt> methods, but the behaviour is more limited, because the <tt>RSqlDatabase::Exec()</tt> method is not able to return any records.
+
SQL statements can also be executed using the {{Icode|RSqlDatabase::Exec()}} methods, but the behaviour is more limited because the {{Icode|RSqlDatabase::Exec()}} method is not able to return any records.
 
+
If asyncronous functionality is required, <tt>RSqlDatabase</tt> and <tt>RSqlStatement</tt> classes have also asyncronous versions of Exec() methods.
+
  
 +
If asyncronous functionality is required, {{Icode|RSqlDatabase}} and {{Icode|RSqlStatement}} classes have also asyncronous versions of {{Icode|Exec()}} methods.
  
 
This snippet can be self-signed.
 
This snippet can be self-signed.
Line 40: Line 47:
  
 
<code>
 
<code>
LIBRARY euser.lib
+
LIBRARY euser.lib
LIBRARY sqldb.lib
+
LIBRARY sqldb.lib
 
</code>
 
</code>
  
Line 54: Line 61:
 
==Preconditions==
 
==Preconditions==
  
Databases nonsecure.db and [UID3]secure.db needs to be created before this code snippet.
+
Databases nonsecure.db and [UID3]secure.db need to be created before executing this code snippet. See [[Archived:Using SQL API for creating non-secure and secure databases on Symbian]].
 
+
See [[Using_SQL_API_for_creating_non-secure_and_secure_databases]]
+
  
 
<!--
 
<!--
Line 171: Line 176:
 
//== Delete statement==
 
//== Delete statement==
  
   /* Note: It is possible to use RSqlStatement object to delete rows from table,
+
   /* Note: It is possible to use a RSqlStatement object to delete rows from table,
   * but it is computationally more expensive and it is not recommented.
+
   * but it is computationally more expensive and it is not recommended.
 
   * Use RSqlDatabase::Exec() method instead */
 
   * Use RSqlDatabase::Exec() method instead */
  
Line 195: Line 200:
 
==Postconditions==
 
==Postconditions==
  
The <tt>RSqlStatement</tt> class is used to insert a new row into the table ([UID3]secure.db) and to update the existing row (nonsecure.db). The <tt>RSqlDatabase</tt> is used to delete one row from the table ([UID3]secure.db).
+
The {{Icode|RSqlStatement}} class is used to insert a new row into the table ([UID3]secure.db) and to update the existing row (nonsecure.db). The {{Icode|RSqlDatabase}} is used to delete one row from the table ([UID3]secure.db).
  
 
==See also==
 
==See also==
  
* [[Using_SQL_API_for_creating_non-secure_and_secure_databases]]
+
* [[Archived:Using SQL API for creating non-secure and secure databases on Symbian]]
* [[Using_SQL_API_for_attaching_and_detaching_databases]]
+
* [[Archived:Using Symbian SQL API for attaching and detaching databases]]
* [[Using_SQL_API_with_SQL_statements_which_return_data]]
+
* [[Archived:Using Symbian SQL API with SQL statements which return data]]
* [[Using_SQL_API_with_scalar_queries]]
+
* [[Archived:Using Symbian SQL API with scalar queries]]
* [[Using_SQL_API_with_data_streams]]
+
* [[Archived:Using Symbian SQL API with data streams]]
 
+
[[Category:Symbian C++]][[Category:Code Examples]][[Category:Files/Data]]
+

Latest revision as of 20:34, 20 August 2012

Archived.pngArchived: This article is archived because it is not considered relevant for third-party developers creating commercial solutions today. If you think this article is still relevant, let us know by adding the template {{ReviewForRemovalFromArchive|user=~~~~|write your reason here}}.

Article Metadata
Tested with
Devices(s): Nokia 6220 Classic
Compatibility
Platform(s): S60 3rd Edition, FP2
S60 3rd Edition FP2
Article
Keywords: RSqlDatabase, RSqlStatement, RSqlDatabase::Open(), RSqlDatabase::Exec(), RSqlDatabase::Close() RSqlStatement::Prepare(), RSqlStatement::ParameterIndex(), RSqlStatement::BindInt(), RSqlStatement::BindText(), RSqlStatement::Reset(), RSqlStatement::Close()
Created: aknyman (24 Apr 2008)
Last edited: lpvalente (20 Aug 2012)

Contents

[edit] Overview

The RSqlStatement class provides functionality to execute all types of SQL statements when using the SQL API. RSqlStatement encapsulates an SQL statement and the data that it returns. RSqlStatement statements can be executed with the methods Exec() and Next(). The method Exec() is used when the statement does not return any data and Next() when the statement returns data. This snippet gives some examples on how to use the Exec() method.

Statements use so-called placeholders (:) in descriptors to mark positions where dynamic data is inserted at runtime. The user can bind the actual data to placeholders with different Bind() methods, such as BindText(). It is good practise to resolve the placeholder index with the RSqlStatement::ParameterIndex() method, and not to use hardcoded values.

NOTE: SQL statements can also be executed using the RSqlDatabase::Exec() methods, but the behaviour is more limited because the RSqlDatabase::Exec() method is not able to return any records.

If asyncronous functionality is required, RSqlDatabase and RSqlStatement classes have also asyncronous versions of Exec() methods.

This snippet can be self-signed.


[edit] MMP file

The following libraries are required:

LIBRARY euser.lib
LIBRARY sqldb.lib


The following capabilities are needed to test the example secure database:

CAPABILITY ReadUserData
CAPABILITY WriteUserData

[edit] Preconditions

Databases nonsecure.db and [UID3]secure.db need to be created before executing this code snippet. See Archived:Using SQL API for creating non-secure and secure databases on Symbian.


[edit] Source file

#include <e32base.h>
#include <SqlDb.h>
 
void ExecStatementsL()
{
RSqlDatabase database;
 
_LIT(KSecureDbName, "[E80000AF]secure.db");
 
//== Insert into table statement==
TInt error = database.Open(KSecureDbName);
 
if (error == KErrNone)
{
CleanupClosePushL(database);
 
RSqlStatement sqlInsertIntoBooksStatement;
 
_LIT(KSqlInsertIntoBooksTable, "INSERT INTO BOOKS(ID, TITLE, AUTHOR)
VALUES(:Val1, :Val2, :Val3)"
);
TInt ret = sqlInsertIntoBooksStatement.Prepare(database, KSqlInsertIntoBooksTable);
 
if(ret == KErrNone)
{
CleanupClosePushL(sqlInsertIntoBooksStatement);
 
TInt paramIndex1 = sqlInsertIntoBooksStatement.ParameterIndex(_L(":Val1"));
TInt paramIndex2 = sqlInsertIntoBooksStatement.ParameterIndex(_L(":Val2"));
TInt paramIndex3 = sqlInsertIntoBooksStatement.ParameterIndex(_L(":Val3"));
 
User::LeaveIfError(sqlInsertIntoBooksStatement.BindInt(paramIndex1, 10));
User::LeaveIfError(sqlInsertIntoBooksStatement.BindText(paramIndex2,
_L("RSqlStatementTitle")));
User::LeaveIfError(sqlInsertIntoBooksStatement.BindText(paramIndex3,
_L("RSqlStatementAuthor")));
 
User::LeaveIfError(sqlInsertIntoBooksStatement.Exec());
 
//It is possible to reuse statement after reset call
User::LeaveIfError(sqlInsertIntoBooksStatement.Reset());
//Bind new values here...
 
CleanupStack::PopAndDestroy(1); //KSqlInsertIntoBooksStatement
 
}
else
{
//prepare sql statement failed
}
CleanupStack::PopAndDestroy(1); //database
}
else
{
//open database failed
}
 
//== Update statement==
 
_LIT(KNonSecureDbName, "\\nonsecure.db");
 
error = database.Open(KNonSecureDbName);
 
if (error == KErrNone)
{
CleanupClosePushL(database);
 
RSqlStatement sqlUpdateMoviesRowStatement;
 
_LIT(KSqlUpdateMoviesRow, "UPDATE MOVIES SET TITLE=:Val1 WHERE ID=:Val2");
TInt ret = sqlUpdateMoviesRowStatement.Prepare(database, KSqlUpdateMoviesRow);
 
if(ret == KErrNone)
{
CleanupClosePushL(sqlUpdateMoviesRowStatement);
 
TInt paramIndex1 = sqlUpdateMoviesRowStatement.ParameterIndex(_L(":Val1"));
TInt paramIndex2 = sqlUpdateMoviesRowStatement.ParameterIndex(_L(":Val2"));
 
User::LeaveIfError(sqlUpdateMoviesRowStatement.BindText(paramIndex1,
_L("RSqlStatementUpdatedTitle")));
User::LeaveIfError(sqlUpdateMoviesRowStatement.BindInt(paramIndex2, 1));
 
User::LeaveIfError(sqlUpdateMoviesRowStatement.Exec());
 
//It is possible to reuse statement after reset call
User::LeaveIfError(sqlUpdateMoviesRowStatement.Reset());
//Bind new values here...
 
CleanupStack::PopAndDestroy(1); //sqlUpdateMoviesRowStatement
 
}
else
{
//prepare sql statement failed
}
CleanupStack::PopAndDestroy(1); //database
}
else
{
//open database failed
}
 
//== Delete statement==
 
/* Note: It is possible to use a RSqlStatement object to delete rows from table,
* but it is computationally more expensive and it is not recommended.
* Use RSqlDatabase::Exec() method instead */

 
error = database.Open(KSecureDbName);
 
if (error == KErrNone)
{
_LIT(KSqlDeleteFromBooksTable, "DELETE FROM BOOKS WHERE ID > 9;");
TInt ret = database.Exec(KSqlDeleteFromBooksTable);
 
database.Close();
}
else
{
//open database failed
}
 
}

[edit] Postconditions

The RSqlStatement class is used to insert a new row into the table ([UID3]secure.db) and to update the existing row (nonsecure.db). The RSqlDatabase is used to delete one row from the table ([UID3]secure.db).

[edit] See also

This page was last modified on 20 August 2012, at 20:34.
111 page views in the last 30 days.

Was this page helpful?

Your feedback about this content is important. Let us know what you think.

 

Thank you!

We appreciate your feedback.

×