|
sl@0
|
1 |
// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
2 |
// All rights reserved.
|
|
sl@0
|
3 |
// This component and the accompanying materials are made available
|
|
sl@0
|
4 |
// under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
5 |
// which accompanies this distribution, and is available
|
|
sl@0
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
7 |
//
|
|
sl@0
|
8 |
// Initial Contributors:
|
|
sl@0
|
9 |
// Nokia Corporation - initial contribution.
|
|
sl@0
|
10 |
//
|
|
sl@0
|
11 |
// Contributors:
|
|
sl@0
|
12 |
//
|
|
sl@0
|
13 |
// Description:
|
|
sl@0
|
14 |
// Initializes RSqlDbSession data members with their default values.
|
|
sl@0
|
15 |
//
|
|
sl@0
|
16 |
//
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
inline RSqlDbSession::RSqlDbSession() :
|
|
sl@0
|
19 |
iLastErrorMessage(NULL)
|
|
sl@0
|
20 |
{
|
|
sl@0
|
21 |
}
|
|
sl@0
|
22 |
|
|
sl@0
|
23 |
/**
|
|
sl@0
|
24 |
Sends a command to the server to detach previously attached database.
|
|
sl@0
|
25 |
|
|
sl@0
|
26 |
@param aDbName Logical database name.
|
|
sl@0
|
27 |
|
|
sl@0
|
28 |
@return KErrNone, operation has completed successfully;
|
|
sl@0
|
29 |
KErrNotFound, no attached database with aDbName name.
|
|
sl@0
|
30 |
Note that database specific errors categorised as ESqlDbError, and
|
|
sl@0
|
31 |
other system-wide error codes may also be returned.
|
|
sl@0
|
32 |
|
|
sl@0
|
33 |
Usage of the IPC call arguments:
|
|
sl@0
|
34 |
Arg 0: [out] Logical database name length.
|
|
sl@0
|
35 |
Arg 1: [out] Logical database name.
|
|
sl@0
|
36 |
*/
|
|
sl@0
|
37 |
inline TInt RSqlDbSession::Detach(const TDesC& aDbName)
|
|
sl@0
|
38 |
{
|
|
sl@0
|
39 |
return SendReceive(ESqlSrvDbDetach, TIpcArgs(aDbName.Length(), &aDbName));
|
|
sl@0
|
40 |
}
|
|
sl@0
|
41 |
|
|
sl@0
|
42 |
/**
|
|
sl@0
|
43 |
Executes one or more 16-bit SQL statements.
|
|
sl@0
|
44 |
|
|
sl@0
|
45 |
The method sends a message to the SQL server containing one or more 16-bit SQL statements to be executed.
|
|
sl@0
|
46 |
SQL statements of any kind can be executed, but the method won't return any record(s)
|
|
sl@0
|
47 |
if the SQL statement type is "SELECT".
|
|
sl@0
|
48 |
If the SQL statement(s) contains one or more parameters, these parameters will be set to NULL before the
|
|
sl@0
|
49 |
execution.
|
|
sl@0
|
50 |
If the call fails and the error class is ESqlDbError, a text description of the error can be obtained using
|
|
sl@0
|
51 |
LastErrorMessage() method.
|
|
sl@0
|
52 |
|
|
sl@0
|
53 |
@param aSqlStmt String containing one or more 8/16-bit SQL statements, separated with ';'.
|
|
sl@0
|
54 |
|
|
sl@0
|
55 |
@return >=0, The operation has completed successfully. The number of database rows that were
|
|
sl@0
|
56 |
changed/inserted/deleted by the most recently completed INSERT/UPDATE/DELETE sql statement.
|
|
sl@0
|
57 |
Exception: If the executed statement is "DELETE FROM <table>", then the function returns 0
|
|
sl@0
|
58 |
if the operation has completed successfully (disregarding the number of the deleted rows);
|
|
sl@0
|
59 |
KErrNoMemory, an out of memory condition has occured;
|
|
sl@0
|
60 |
KSqlErrGeneral, Syntax error. A text message describing the problem can be obtained calling
|
|
sl@0
|
61 |
LastErrorMessage().
|
|
sl@0
|
62 |
|
|
sl@0
|
63 |
Usage of the IPC call arguments:
|
|
sl@0
|
64 |
Arg 0: [out] 16-bit character length of SQL statement.
|
|
sl@0
|
65 |
Arg 1: [out] SQL statement(s).
|
|
sl@0
|
66 |
*/
|
|
sl@0
|
67 |
inline TInt RSqlDbSession::Exec(const TDesC& aSqlStmt)
|
|
sl@0
|
68 |
{
|
|
sl@0
|
69 |
return SendReceive(ESqlSrvDbExec16, TIpcArgs(aSqlStmt.Length(), &aSqlStmt));
|
|
sl@0
|
70 |
}
|
|
sl@0
|
71 |
|
|
sl@0
|
72 |
/**
|
|
sl@0
|
73 |
Executes one or more 8-bit SQL statements.
|
|
sl@0
|
74 |
|
|
sl@0
|
75 |
The method sends a message to the SQL server containing one or more 8-bit SQL statements to be executed.
|
|
sl@0
|
76 |
SQL statements of any kind can be executed, but the method won't return any record(s)
|
|
sl@0
|
77 |
if the SQL statement type is "SELECT".
|
|
sl@0
|
78 |
If the SQL statement(s) contains one or more parameters, these parameters will be set to NULL before the
|
|
sl@0
|
79 |
execution.
|
|
sl@0
|
80 |
If the call fails and the error class is ESqlDbError, a text description of the error can be obtained using
|
|
sl@0
|
81 |
LastErrorMessage() method.
|
|
sl@0
|
82 |
|
|
sl@0
|
83 |
@param aSqlStmt String containing one or more 8-bit SQL statements, separated with ';'.
|
|
sl@0
|
84 |
|
|
sl@0
|
85 |
@return >=0, The operation has completed successfully. The number of database rows that were
|
|
sl@0
|
86 |
changed/inserted/deleted by the most recently completed INSERT/UPDATE/DELETE sql statement.
|
|
sl@0
|
87 |
Exception: If the executed statement is "DELETE FROM <table>", then the function returns 0
|
|
sl@0
|
88 |
if the operation has completed successfully (disregarding the number of the deleted rows);
|
|
sl@0
|
89 |
KErrNoMemory, an out of memory condition has occured;
|
|
sl@0
|
90 |
KSqlErrGeneral, Syntax error. A text message describing the problem can be obtained calling
|
|
sl@0
|
91 |
LastErrorMessage().
|
|
sl@0
|
92 |
|
|
sl@0
|
93 |
Usage of the IPC call arguments:
|
|
sl@0
|
94 |
Arg 0: [out] 8-bit character length of SQL statement.
|
|
sl@0
|
95 |
Arg 1: [out] SQL statement(s).
|
|
sl@0
|
96 |
*/
|
|
sl@0
|
97 |
inline TInt RSqlDbSession::Exec(const TDesC8& aSqlStmt)
|
|
sl@0
|
98 |
{
|
|
sl@0
|
99 |
return SendReceive(ESqlSrvDbExec8, TIpcArgs(aSqlStmt.Length(), &aSqlStmt));
|
|
sl@0
|
100 |
}
|
|
sl@0
|
101 |
|
|
sl@0
|
102 |
/**
|
|
sl@0
|
103 |
Executes one or more 16-bit SQL statements asynchronously.
|
|
sl@0
|
104 |
|
|
sl@0
|
105 |
The method sends a message to the SQL server containing one or more 16-bit SQL statements to be executed.
|
|
sl@0
|
106 |
SQL statements of any kind can be executed, but the method won't return any record(s)
|
|
sl@0
|
107 |
if the SQL statement type is "SELECT".
|
|
sl@0
|
108 |
If the SQL statement(s) contains one or more parameters, these parameters will be set to NULL before the
|
|
sl@0
|
109 |
execution.
|
|
sl@0
|
110 |
If the call fails and the error class is ESqlDbError, a text description of the error can be obtained using
|
|
sl@0
|
111 |
LastErrorMessage() method.
|
|
sl@0
|
112 |
|
|
sl@0
|
113 |
@param aSqlStmt String containing one or more 16-bit SQL statements, separated with ';'.
|
|
sl@0
|
114 |
@param aStatus Completion status of asynchronous request, one of the following:
|
|
sl@0
|
115 |
@code
|
|
sl@0
|
116 |
- >=0, The operation has completed successfully. The number of database rows that were
|
|
sl@0
|
117 |
changed/inserted/deleted by the most recently completed INSERT/UPDATE/DELETE sql statement.
|
|
sl@0
|
118 |
Exception: If the executed statement is "DELETE FROM <table>", then the function returns 0
|
|
sl@0
|
119 |
if the operation has completed successfully (disregarding the number of the deleted rows);
|
|
sl@0
|
120 |
- KSqlErrStmtExpired, the SQL statement has expired (if new functions or
|
|
sl@0
|
121 |
collating sequences have been registered or if an
|
|
sl@0
|
122 |
authorizer function has been added or changed);
|
|
sl@0
|
123 |
- KErrNoMemory, an out of memory condition has occurred - the statement
|
|
sl@0
|
124 |
will be reset.
|
|
sl@0
|
125 |
Note that aStatus may be set with database specific errors categorised as ESqlDbError,
|
|
sl@0
|
126 |
and other system-wide error codes.
|
|
sl@0
|
127 |
@endcode
|
|
sl@0
|
128 |
|
|
sl@0
|
129 |
Usage of the IPC call arguments:
|
|
sl@0
|
130 |
Arg 0: [out] 16-bit character length of SQL statement.
|
|
sl@0
|
131 |
Arg 1: [out] SQL statement(s).
|
|
sl@0
|
132 |
*/
|
|
sl@0
|
133 |
inline void RSqlDbSession::Exec(const TDesC& aSqlStmt, TRequestStatus& aStatus)
|
|
sl@0
|
134 |
{
|
|
sl@0
|
135 |
SendReceive(ESqlSrvDbExec16, TIpcArgs(aSqlStmt.Length(), &aSqlStmt), aStatus);
|
|
sl@0
|
136 |
}
|
|
sl@0
|
137 |
|
|
sl@0
|
138 |
/**
|
|
sl@0
|
139 |
Executes one or more 8-bit SQL statements asynchronously.
|
|
sl@0
|
140 |
|
|
sl@0
|
141 |
The method sends a message to the SQL server containing one or more 8-bit SQL statements to be executed.
|
|
sl@0
|
142 |
SQL statements of any kind can be executed, but the method won't return any record(s)
|
|
sl@0
|
143 |
if the SQL statement type is "SELECT".
|
|
sl@0
|
144 |
If the SQL statement(s) contains one or more parameters, these parameters will be set to NULL before the
|
|
sl@0
|
145 |
execution.
|
|
sl@0
|
146 |
If the call fails and the error class is ESqlDbError, a text description of the error can be obtained using
|
|
sl@0
|
147 |
LastErrorMessage() method.
|
|
sl@0
|
148 |
|
|
sl@0
|
149 |
@param aSqlStmt String containing one or more 8-bit SQL statements, separated with ';'.
|
|
sl@0
|
150 |
@param aStatus Completion status of asynchronous request, one of the following:
|
|
sl@0
|
151 |
@code
|
|
sl@0
|
152 |
- >=0, The operation has completed successfully. The number of database rows that were
|
|
sl@0
|
153 |
changed/inserted/deleted by the most recently completed INSERT/UPDATE/DELETE sql statement.
|
|
sl@0
|
154 |
Exception: If the executed statement is "DELETE FROM <table>", then the function returns 0
|
|
sl@0
|
155 |
if the operation has completed successfully (disregarding the number of the deleted rows);
|
|
sl@0
|
156 |
- KSqlErrStmtExpired, the SQL statement has expired (if new functions or
|
|
sl@0
|
157 |
collating sequences have been registered or if an
|
|
sl@0
|
158 |
authorizer function has been added or changed);
|
|
sl@0
|
159 |
- KErrNoMemory, an out of memory condition has occurred - the statement
|
|
sl@0
|
160 |
will be reset.
|
|
sl@0
|
161 |
Note that aStatus may be set with database specific errors categorised as ESqlDbError,
|
|
sl@0
|
162 |
and other system-wide error codes.
|
|
sl@0
|
163 |
@endcode
|
|
sl@0
|
164 |
|
|
sl@0
|
165 |
Usage of the IPC call arguments:
|
|
sl@0
|
166 |
Arg 0: [out] 8-bit character length of SQL statement.
|
|
sl@0
|
167 |
Arg 1: [out] SQL statement(s).
|
|
sl@0
|
168 |
*/
|
|
sl@0
|
169 |
inline void RSqlDbSession::Exec(const TDesC8& aSqlStmt, TRequestStatus& aStatus)
|
|
sl@0
|
170 |
{
|
|
sl@0
|
171 |
SendReceive(ESqlSrvDbExec8, TIpcArgs(aSqlStmt.Length(), &aSqlStmt), aStatus);
|
|
sl@0
|
172 |
}
|
|
sl@0
|
173 |
|
|
sl@0
|
174 |
/**
|
|
sl@0
|
175 |
Sets the transaction isolation level.
|
|
sl@0
|
176 |
|
|
sl@0
|
177 |
The method sends a message to the SQL server to set the desired isolation level.
|
|
sl@0
|
178 |
The default isolation level is RSqlDatabase::ESerializable, but can be changed to
|
|
sl@0
|
179 |
RSqlDatabase::EReadUncommitted for database connections which share the access to the same database file.
|
|
sl@0
|
180 |
|
|
sl@0
|
181 |
@param aIsolationLevel Desired isolation level: RSqlDatabase::ESerializable or RSqlDatabase::EReadUncommitted.
|
|
sl@0
|
182 |
@return KErrNone, the operation has completed successfully.
|
|
sl@0
|
183 |
The function may also return some other system-wide error codes.
|
|
sl@0
|
184 |
|
|
sl@0
|
185 |
Usage of the IPC call arguments:
|
|
sl@0
|
186 |
Arg 0: [out] Isolation level type.
|
|
sl@0
|
187 |
*/
|
|
sl@0
|
188 |
inline TInt RSqlDbSession::SetIsolationLevel(RSqlDatabase::TIsolationLevel aIsolationLevel)
|
|
sl@0
|
189 |
{
|
|
sl@0
|
190 |
return SendReceive(ESqlSrvDbSetIsolationLevel, TIpcArgs(static_cast <TInt> (aIsolationLevel)));
|
|
sl@0
|
191 |
}
|
|
sl@0
|
192 |
|
|
sl@0
|
193 |
/**
|
|
sl@0
|
194 |
Usage of the IPC call arguments:
|
|
sl@0
|
195 |
Arg 0: [out] (16-bit character length of SQL statement) | (expected column value type << 24).
|
|
sl@0
|
196 |
Arg 1: [out] SQL statement.
|
|
sl@0
|
197 |
Arg 2: [out] Byte max length of the receiving buffer
|
|
sl@0
|
198 |
Arg 3: [in/out] The receiving buffer
|
|
sl@0
|
199 |
*/
|
|
sl@0
|
200 |
inline TInt RSqlDbSession::ExecScalarFullSelect(const TDesC& aSqlStmt, TSqlColumnType aType, TDes8& aRes)
|
|
sl@0
|
201 |
{
|
|
sl@0
|
202 |
return SendReceive(ESqlSrvDbScalarFullSelect16, TIpcArgs(aSqlStmt.Length() | (aType << 24), &aSqlStmt, aRes.MaxLength(), &aRes));
|
|
sl@0
|
203 |
}
|
|
sl@0
|
204 |
|
|
sl@0
|
205 |
/**
|
|
sl@0
|
206 |
Usage of the IPC call arguments:
|
|
sl@0
|
207 |
Arg 0: [out] (8-bit character length of SQL statement) | (expected column value type << 24).
|
|
sl@0
|
208 |
Arg 1: [out] SQL statement.
|
|
sl@0
|
209 |
Arg 2: [out] Byte max length of the receiving buffer
|
|
sl@0
|
210 |
Arg 3: [in/out] The receiving buffer
|
|
sl@0
|
211 |
*/
|
|
sl@0
|
212 |
inline TInt RSqlDbSession::ExecScalarFullSelect(const TDesC8& aSqlStmt, TSqlColumnType aType, TDes8& aRes)
|
|
sl@0
|
213 |
{
|
|
sl@0
|
214 |
return SendReceive(ESqlSrvDbScalarFullSelect8, TIpcArgs(aSqlStmt.Length() | (aType << 24), &aSqlStmt, aRes.MaxLength(), &aRes));
|
|
sl@0
|
215 |
}
|
|
sl@0
|
216 |
|
|
sl@0
|
217 |
/**
|
|
sl@0
|
218 |
The method sends a message to the SQL server.
|
|
sl@0
|
219 |
|
|
sl@0
|
220 |
@param aFunction Function code
|
|
sl@0
|
221 |
|
|
sl@0
|
222 |
@return KErrNone or system-wide error codes.
|
|
sl@0
|
223 |
*/
|
|
sl@0
|
224 |
inline TInt RSqlDbSession::SendReceive(TInt aFunction)
|
|
sl@0
|
225 |
{
|
|
sl@0
|
226 |
return RSessionBase::SendReceive(aFunction);
|
|
sl@0
|
227 |
}
|
|
sl@0
|
228 |
|
|
sl@0
|
229 |
/**
|
|
sl@0
|
230 |
The method sends a message asynchronously to the SQL server.
|
|
sl@0
|
231 |
|
|
sl@0
|
232 |
@param aFunction Function code
|
|
sl@0
|
233 |
|
|
sl@0
|
234 |
@return KErrNone or system-wide error codes.
|
|
sl@0
|
235 |
*/
|
|
sl@0
|
236 |
inline void RSqlDbSession::SendReceive(TInt aFunction, TRequestStatus& aStatus)
|
|
sl@0
|
237 |
{
|
|
sl@0
|
238 |
RSessionBase::SendReceive(aFunction, aStatus);
|
|
sl@0
|
239 |
}
|
|
sl@0
|
240 |
|
|
sl@0
|
241 |
/**
|
|
sl@0
|
242 |
The method sends a message with arguments to the SQL server.
|
|
sl@0
|
243 |
|
|
sl@0
|
244 |
@param aFunction Function code
|
|
sl@0
|
245 |
@param aArgs Message arguments
|
|
sl@0
|
246 |
|
|
sl@0
|
247 |
@return KErrNone or system-wide error codes.
|
|
sl@0
|
248 |
*/
|
|
sl@0
|
249 |
inline TInt RSqlDbSession::SendReceive(TInt aFunction, const TIpcArgs& aArgs)
|
|
sl@0
|
250 |
{
|
|
sl@0
|
251 |
return RSessionBase::SendReceive(aFunction, aArgs);
|
|
sl@0
|
252 |
}
|
|
sl@0
|
253 |
|
|
sl@0
|
254 |
/**
|
|
sl@0
|
255 |
The method sends asynchronously a message with arguments to the SQL server.
|
|
sl@0
|
256 |
|
|
sl@0
|
257 |
@param aFunction Function code
|
|
sl@0
|
258 |
@param aArgs Message arguments
|
|
sl@0
|
259 |
@param aStatus Completion status of asynchronous request
|
|
sl@0
|
260 |
*/
|
|
sl@0
|
261 |
inline void RSqlDbSession::SendReceive(TInt aFunction,const TIpcArgs& aArgs, TRequestStatus& aStatus)
|
|
sl@0
|
262 |
{
|
|
sl@0
|
263 |
RSessionBase::SendReceive(aFunction, aArgs, aStatus);
|
|
sl@0
|
264 |
}
|