Press on the image to return to the main documentation page.

SQLCipher

List of types:

SQLCipher

SQLCipher type is an extension to SQL which supports encryption.
See the tutorial for more information.

Events:

None

Members:

AddNonQueryToBatch (Statement As String, Args As List)

BeginTransaction

Close

EndTransaction

ExecNonQuery (Statement As String)

ExecNonQuery2 (Statement As String, Args As List)

ExecNonQueryBatch (EventName As String) As Object

ExecQuery (Query As String) As android.database.Cursor

ExecQuery2 (Query As String, StringArgs() As String) As android.database.Cursor

ExecQueryAsync (EventName As String, Query As String, Args As List) As Object

ExecQuerySingleResult (Query As String) As String

ExecQuerySingleResult2 (Query As String, StringArgs() As String) As String

Initialize (Dir As String, FileName As String, CreateIfNecessary As Boolean, Password As String, Unused As String)

IsInitialized As Boolean

TransactionSuccessful

Members description:

AddNonQueryToBatch (Statement As String, Args As List)

Adds a non-query statement to the batch of statements.
The statements are (asynchronously) executed when you call ExecNonQueryBatch.
Args parameter can be Null if it is not needed.
Example:
For i = 1 To 1000
sql.AddNonQueryToBatch("INSERT INTO table1 VALUES (?)", Array(Rnd(0, 100000)))
Next
Dim SenderFilter As Object = sql.ExecNonQueryBatch("SQL")
Wait For (SenderFilter) SQL_NonQueryComplete (Success As Boolean)
Log("NonQuery: " & Success)

BeginTransaction

Begins a transaction. A transaction is a set of multiple "writing" statements that are atomically committed,
hence all changes will be made or no changes will be made.
As a side effect those statements will be executed significantly faster (in the default case a transaction is implicitly created for
each statement).
It is very important to handle transaction carefully and close them.
The transaction is considered successful only if TransactionSuccessful is called. Otherwise no changes will be made.
Typical usage:
SQL1.BeginTransaction
Try
  'block of statements like:
  For i = 1 to 1000
    SQL1.ExecNonQuery("INSERT INTO table1 VALUES(...)
  Next
  SQL1.TransactionSuccessful
Catch
  Log(LastException.Message) 'no changes will be made
End Try
SQL1.EndTransaction

Close

Closes the database.
Does not do anything if the database is not opened or was closed before.

EndTransaction

Ends the transaction.

ExecNonQuery (Statement As String)

Executes a single non query SQL statement.
Example:
SQL1.ExecNonQuery("CREATE TABLE table1 (col1 TEXT , col2 INTEGER, col3 INTEGER)")
If you plan to do many "writing" queries one after another, then you should consider using BeginTransaction / EndTransaction.
It will execute significantly faster.

ExecNonQuery2 (Statement As String, Args As List)

Executes a single non query SQL statement.
The statement can include question marks which will be replaced by the items in the given list.
Note that Basic4android converts arrays to lists implicitly.
The values in the list should be strings, numbers or bytes arrays.
Example:
SQL1.ExecNonQuery2("INSERT INTO table1 VALUES (?, ?, 0)", Array As Object("some text", 2))

ExecNonQueryBatch (EventName As String) As Object

Asynchronously executes a batch of non-query statements (such as INSERT).
The NonQueryComplete event is raised after the statements are completed.
You should call AddNonQueryToBatch one or more times before calling this method to add statements to the batch.
Note that this method internally begins and ends a transaction.
Returns an object that can be used as the sender filter for Wait For calls.
Example:
For i = 1 To 1000
sql.AddNonQueryToBatch("INSERT INTO table1 VALUES (?)", Array(Rnd(0, 100000)))
Next
Dim SenderFilter As Object = sql.ExecNonQueryBatch("SQL")
Wait For (SenderFilter) SQL_NonQueryComplete (Success As Boolean)
Log("NonQuery: " & Success)

ExecQuery (Query As String) As android.database.Cursor

Executes the query and returns a cursor which is used to go over the results.
Example:
Dim Cursor As Cursor
Cursor = SQL1.ExecQuery("SELECT col1, col2 FROM table1")
For i = 0 To Cursor.RowCount - 1
  Cursor.Position = i
  Log(Cursor.GetString("col1"))
  Log(Cursor.GetInt("col2"))
Next

ExecQuery2 (Query As String, StringArgs() As String) As android.database.Cursor

Executes the query and returns a cursor which is used to go over the results.
The query can include question marks which will be replaced with the values in the array.
Example:
Dim Cursor As Cursor
Cursor = sql1.ExecQuery2("SELECT col1 FROM table1 WHERE col3 = ?", Array As String(22))
SQLite will try to convert the string values based on the columns types.

ExecQueryAsync (EventName As String, Query As String, Args As List) As Object

Asynchronously executes the given query. The QueryComplete event will be raised when the results are ready.
Note that ResultSet extends Cursor. You can use Cursor if preferred.
Returns an object that can be used as the sender filter for Wait For calls.
Example:
Dim SenderFilter As Object = sql.ExecQueryAsync("SQL", "SELECT * FROM table1", Null)
Wait For (SenderFilter) SQL_QueryComplete (Success As Boolean, rs As ResultSet)
If Success Then
  Do While rs.NextRow
    Log(rs.GetInt2(0))
  Loop
  rs.Close
Else
  Log(LastException)
End If

ExecQuerySingleResult (Query As String) As String

Executes the query and returns the value in the first column and the first row (in the result set).
Returns Null if no results were found.
Example:
Dim NumberOfMatches As Int
NumberOfMatches = SQL1.ExecQuerySingleResult("SELECT count(*) FROM table1 WHERE col2 > 300")

ExecQuerySingleResult2 (Query As String, StringArgs() As String) As String

Executes the query and returns the value in the first column and the first row (in the result set).
Returns Null if no results were found.
Example:
Dim NumberOfMatches As Int
NumberOfMatches = SQL1.ExecQuerySingleResult2("SELECT count(*) FROM table1 WHERE col2 > ?", Array As String(300))

Initialize (Dir As String, FileName As String, CreateIfNecessary As Boolean, Password As String, Unused As String)

Opens the database file. A new database will be created if it does not exist and CreateIfNecessary is true.

IsInitialized As Boolean

Tests whether the database is initialized and opened.

TransactionSuccessful

Marks the transaction as a successful transaction. No further statements should be executed till calling EndTransaction.