com.cloudant.sync.sqlite.android

Class AndroidSQLite

java.lang.Object

com.cloudant.sync.sqlite.SQLDatabase

com.cloudant.sync.sqlite.android.AndroidSQLite

public class AndroidSQLite
extends SQLDatabase

API Status: Private - API users are discouraged from using this class as fields, method signatures, and implementation details may be subject to change

Field Summary

Fields inherited from class com.cloudant.sync.sqlite.SQLDatabase

CONFLICT_ABORT, CONFLICT_FAIL, CONFLICT_IGNORE, CONFLICT_NONE, CONFLICT_REPLACE, CONFLICT_ROLLBACK, filename

Constructor Summary

Constructors

Constructor and Description
AndroidSQLite(android.database.sqlite.SQLiteDatabase database)

Method Summary

Modifier and Type	Method and Description
void	beginTransaction() Begins a transaction in EXCLUSIVE mode.
void	close() Close the database
void	compactDatabase() For SQLite database, this is to call: this.execSQL("VACUUM");
static AndroidSQLite	createAndroidSQLite(java.lang.String path)
int	delete(java.lang.String table, java.lang.String whereClause, java.lang.String[] whereArgs) Convenience method for deleting rows in the database.
void	endTransaction() End a transaction.
void	execSQL(java.lang.String sql) Execute a single SQL statement that is NOT a SELECT or any other SQL statement that returns data.
void	execSQL(java.lang.String sql, java.lang.Object[] bindArgs) Execute a single SQL statement that is NOT a SELECT/INSERT/UPDATE/DELETE.
int	getVersion() Gets the database version, and SQLDatabase's version is defined as:
long	insert(java.lang.String table, ContentValues args) Convenience method for inserting a row into the database.
long	insertWithOnConflict(java.lang.String table, ContentValues initialValues, int conflictAlgorithm)
boolean	isOpen()
void	open() Open the database
Cursor	rawQuery(java.lang.String sql, java.lang.String[] values) Runs the provided SQL and returns a Cursor over the result set.
void	setTransactionSuccessful() Marks the current transaction as successful.
int	update(java.lang.String table, ContentValues args, java.lang.String whereClause, java.lang.String[] whereArgs) Convenience method for updating rows in the database.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AndroidSQLite

public AndroidSQLite(android.database.sqlite.SQLiteDatabase database)

Method Detail

createAndroidSQLite

public static AndroidSQLite createAndroidSQLite(java.lang.String path)

compactDatabase

public void compactDatabase()

Description copied from class: SQLDatabase

For SQLite database, this is to call: this.execSQL("VACUUM");

Specified by:

compactDatabase in class SQLDatabase

open

public void open()

Description copied from class: SQLDatabase

Open the database

Specified by:

open in class SQLDatabase

close

public void close()

Description copied from class: SQLDatabase

Close the database

Specified by:

close in class SQLDatabase

isOpen

public boolean isOpen()

Specified by:

isOpen in class SQLDatabase

Returns:

true if the database is open

beginTransaction

public void beginTransaction()

Description copied from class: SQLDatabase

Begins a transaction in EXCLUSIVE mode.

Transactions can be nested. When the outer transaction is ended all of the work done in that transaction and all of the nested transactions will be committed or rolled back. The changes will be rolled back if any transaction is ended without being marked as clean (by calling setTransactionSuccessful). Otherwise they will be committed.

Here is the standard idiom for transactions:

   db.beginTransaction();
   try {
     ...
     db.setTransactionSuccessful();
   } finally {
     db.endTransaction();
   }
 

Specified by:

beginTransaction in class SQLDatabase

endTransaction

public void endTransaction()

Description copied from class: SQLDatabase

End a transaction. See beginTransaction for notes about how to use this and when transactions are committed and rolled back.

Specified by:

endTransaction in class SQLDatabase

setTransactionSuccessful

public void setTransactionSuccessful()

Description copied from class: SQLDatabase

Marks the current transaction as successful. Do not do any more database work between calling this and calling endTransaction. Do as little non-database work as possible in that situation too. If any errors are encountered between this and endTransaction the transaction will still be committed.

Specified by:

setTransactionSuccessful in class SQLDatabase

execSQL

public void execSQL(java.lang.String sql)
             throws java.sql.SQLException

Description copied from class: SQLDatabase

Execute a single SQL statement that is NOT a SELECT or any other SQL statement that returns data.

Specified by:

execSQL in class SQLDatabase

Parameters:

sql - the SQL statement to be executed. Multiple statements separated by semicolons are not supported.

Throws:

java.sql.SQLException - if the SQL string is invalid

execSQL

public void execSQL(java.lang.String sql,
                    java.lang.Object[] bindArgs)
             throws java.sql.SQLException

Description copied from class: SQLDatabase

Execute a single SQL statement that is NOT a SELECT/INSERT/UPDATE/DELETE.

Specified by:

execSQL in class SQLDatabase

Parameters:

sql - the SQL statement to be executed. Multiple statements separated by semicolons are not supported.

bindArgs - only byte[], String, Long and Double are supported in bindArgs.

Throws:

java.sql.SQLException - if the SQL string is invalid

getVersion

public int getVersion()

Description copied from class: SQLDatabase

Gets the database version, and SQLDatabase's version is defined as:

    PRAGMA user_version;

Specified by:

getVersion in class SQLDatabase

Returns:

the database version

See Also:

SQLite user_version

update

public int update(java.lang.String table,
                  ContentValues args,
                  java.lang.String whereClause,
                  java.lang.String[] whereArgs)

Description copied from class: SQLDatabase

Convenience method for updating rows in the database.

Specified by:

update in class SQLDatabase

Parameters:

table - the table to update in

args - a map from column names to new column values. null is a valid value that will be translated to NULL.

whereClause - the optional WHERE clause to apply when updating. Passing null will update all rows.

Returns:

the number of rows affected

rawQuery

public Cursor rawQuery(java.lang.String sql,
                       java.lang.String[] values)

Description copied from class: SQLDatabase

Runs the provided SQL and returns a Cursor over the result set.

Specified by:

rawQuery in class SQLDatabase

Parameters:

sql - the SQL query. The SQL string must not be ; terminated

values - You may include ?s in where clause in the query, which will be replaced by the values from selectionArgs. The values will be bound as Strings.

Returns:

A Cursor object, which is positioned before the first entry. Note that Cursors are not synchronized, see the documentation for more details.

delete

public int delete(java.lang.String table,
                  java.lang.String whereClause,
                  java.lang.String[] whereArgs)

Description copied from class: SQLDatabase

Convenience method for deleting rows in the database.

Specified by:

delete in class SQLDatabase

Parameters:

table - the table to delete from

whereClause - the optional WHERE clause to apply when deleting. Passing null will delete all rows. And, do not include "where" in the clause.

Returns:

the number of rows affected if a whereClause is passed in, 0 otherwise. To delete all rows and get a count pass "1" as the whereClause.

insert

public long insert(java.lang.String table,
                   ContentValues args)

Description copied from class: SQLDatabase

Convenience method for inserting a row into the database.

Specified by:

insert in class SQLDatabase

Parameters:

table - the table to insert the row into

args - this map contains the initial column values for the row. The keys should be the column names and the values the column values

Returns:

the row ID of the newly inserted row, or -1 if an error occurred

insertWithOnConflict

public long insertWithOnConflict(java.lang.String table,
                                 ContentValues initialValues,
                                 int conflictAlgorithm)

Specified by:

insertWithOnConflict in class SQLDatabase

Returns:

the row ID of the newly inserted row OR the primary key of the existing row if the input param 'conflictAlgorithm' = CONFLICT_IGNORE OR -1 if any error