com.pushtorefresh.storio.sqlite

Class StorIOSQLite.LowLevel

java.lang.Object

com.pushtorefresh.storio.sqlite.StorIOSQLite.LowLevel

Direct Known Subclasses:

StorIOSQLite.Internal

Enclosing class:

StorIOSQLite

public abstract static class StorIOSQLite.LowLevel
extends java.lang.Object

API for low level operations with StorIOSQLite, we made it separate to make StorIOSQLite API clean and easy to understand.

Constructor Summary

Constructors

Constructor and Description
LowLevel()

Method Summary

Modifier and Type	Method and Description
abstract void	beginTransaction() Begins a transaction in EXCLUSIVE mode.
abstract int	delete(DeleteQuery deleteQuery) Deletes one or multiple rows in the database.
abstract void	endTransaction() Ends a transaction.
abstract void	executeSQL(RawQuery rawQuery) Executes a single SQL statement that is NOT a SELECT/INSERT/UPDATE/DELETE on the database.
abstract long	insert(InsertQuery insertQuery, android.content.ContentValues contentValues) Inserts a row into the database.
abstract long	insertWithOnConflict(InsertQuery insertQuery, android.content.ContentValues contentValues, int conflictAlgorithm) Inserts a row into the database.
abstract void	notifyAboutChanges(Changes changes) Notifies subscribers about changes happened in StorIOSQLite.
abstract android.database.Cursor	query(Query query) Executes query on the database and returns Cursor over the result set.
abstract android.database.Cursor	rawQuery(RawQuery rawQuery) Executes raw query on the database and returns Cursor over the result set.
abstract void	setTransactionSuccessful() Marks the current transaction as successful.
abstract android.database.sqlite.SQLiteOpenHelper	sqliteOpenHelper() Returns SQLiteOpenHelper for the direct access to underlining database.
abstract <T> SQLiteTypeMapping<T>	typeMapping(java.lang.Class<T> type) Gets SQLiteTypeMapping for required type.
abstract int	update(UpdateQuery updateQuery, android.content.ContentValues contentValues) Updates one or multiple rows in the database.

Methods inherited from class java.lang.Object

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

Constructor Detail

LowLevel

public LowLevel()

Method Detail

typeMapping

@Nullable
public abstract <T> SQLiteTypeMapping<T> typeMapping(@NonNull
                                                               java.lang.Class<T> type)

Gets SQLiteTypeMapping for required type.

Result can be null.

Type Parameters:

T - type.

Parameters:

type - type.

Returns:

SQLiteTypeMapping for required type or null.

executeSQL

@WorkerThread
public abstract void executeSQL(@NonNull
                                              RawQuery rawQuery)

Executes a single SQL statement that is NOT a SELECT/INSERT/UPDATE/DELETE on the database.

Parameters:

rawQuery - sql query.

rawQuery

@WorkerThread
 @NonNull
public abstract android.database.Cursor rawQuery(@NonNull
                                                                         RawQuery rawQuery)

Executes raw query on the database and returns Cursor over the result set.

Parameters:

rawQuery - sql query

Returns:

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

query

@WorkerThread
 @NonNull
public abstract android.database.Cursor query(@NonNull
                                                                      Query query)

Executes query on the database and returns Cursor over the result set.

Parameters:

query - sql query.

Returns:

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

insert

@WorkerThread
public abstract long insert(@NonNull
                                          InsertQuery insertQuery,
                                          @NonNull
                                          android.content.ContentValues contentValues)

Inserts a row into the database.

Parameters:

insertQuery - query.

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

Returns:

id of inserted row.

insertWithOnConflict

@WorkerThread
public abstract long insertWithOnConflict(@NonNull
                                                        InsertQuery insertQuery,
                                                        @NonNull
                                                        android.content.ContentValues contentValues,
                                                        int conflictAlgorithm)

Inserts a row into the database.

Parameters:

insertQuery - query.

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

conflictAlgorithm - for insert conflict resolver.

Returns:

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

See Also:

SQLiteDatabase.insertWithOnConflict(String, String, ContentValues, int), SQLiteDatabase.CONFLICT_REPLACE, SQLiteDatabase.CONFLICT_ABORT, SQLiteDatabase.CONFLICT_FAIL, SQLiteDatabase.CONFLICT_ROLLBACK, SQLiteDatabase.CONFLICT_IGNORE

update

@WorkerThread
public abstract int update(@NonNull
                                         UpdateQuery updateQuery,
                                         @NonNull
                                         android.content.ContentValues contentValues)

Updates one or multiple rows in the database.

Parameters:

updateQuery - query.

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

Returns:

the number of rows affected.

delete

@WorkerThread
public abstract int delete(@NonNull
                                         DeleteQuery deleteQuery)

Deletes one or multiple rows in the database.

Parameters:

deleteQuery - query.

Returns:

the number of rows deleted.

notifyAboutChanges

public abstract void notifyAboutChanges(@NonNull
                                        Changes changes)

Notifies subscribers about changes happened in StorIOSQLite. Operations can be executed in transaction or one operation can affect multiple tables, so to reduce number of notifications you can call this method once and provide aggregated Changes object.

Parameters:

changes - changes happened in StorIOSQLite.

beginTransaction

public abstract void beginTransaction()

Begins a transaction in EXCLUSIVE mode.

Thread will be blocked on call to this method if another thread already in transaction, as soon as first thread will end its transaction this thread will be unblocked.

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();
   }
 

setTransactionSuccessful

public abstract void setTransactionSuccessful()

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.

Throws:

java.lang.IllegalStateException - if the transaction is already marked as successful.

endTransaction

public abstract void endTransaction()

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

sqliteOpenHelper

@NonNull
public abstract android.database.sqlite.SQLiteOpenHelper sqliteOpenHelper()

Returns SQLiteOpenHelper for the direct access to underlining database. It can be used in cases when StorIOSQLite APIs are not enough.

Notice: Database changes through the direct access to the SQLiteOpenHelper will not trigger notifications. If it possible you should use StorIOSQLite methods instead or call notifyAboutChanges(Changes) manually.

Returns:

SQLiteOpenHelper.