com.salesforce.androidsdk.smartstore.store

Class DBHelper

java.lang.Object

com.salesforce.androidsdk.smartstore.store.DBHelper

public class DBHelper
extends java.lang.Object

SmartStore Database Helper Singleton class that provides helpful methods for accessing the database underneath the SmartStore It also caches a number of of things to speed things up (e.g. soup table name, index specs, insert helpers etc)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXPLAIN_ARGS
static java.lang.String	EXPLAIN_ROWS
static java.lang.String	EXPLAIN_SQL
static java.lang.String	EXPLAIN_TAG

Constructor Summary

Constructors

Constructor and Description
DBHelper()

Method Summary

Modifier and Type	Method and Description
void	cacheHasSoup(java.lang.String soupName, boolean hasSoup)
void	cacheIndexSpecs(java.lang.String soupName, IndexSpec[] indexSpecs)
void	cacheTableName(java.lang.String soupName, java.lang.String tableName)
void	clearMemoryCache() Resets all cached data from memory.
Cursor	countQuery(SQLiteDatabase db, java.lang.String table, java.lang.String whereClause, java.lang.String... whereArgs) Does a count query
int	countRawCountQuery(SQLiteDatabase db, java.lang.String countSql, java.lang.String... whereArgs) Does a count for a raw count query
int	countRawQuery(SQLiteDatabase db, java.lang.String sql, java.lang.String... whereArgs) Does a count for a raw query
void	delete(SQLiteDatabase db, java.lang.String table, java.lang.String whereClause, java.lang.String... whereArgs) Does a delete (after first logging the delete statement)
java.lang.Boolean	getCachedHasFTS(java.lang.String soupName)
IndexSpec[]	getCachedIndexSpecs(java.lang.String soupName)
java.lang.String	getCachedTableName(java.lang.String soupName)
java.lang.String	getColumnNameForPath(SQLiteDatabase db, java.lang.String soupName, java.lang.String path) Return column name in soup table that holds the soup projection for path
IndexSpec[]	getIndexSpecs(SQLiteDatabase db, java.lang.String soupName) Read index specs back from the soup index map table
protected IndexSpec[]	getIndexSpecsFromDb(SQLiteDatabase db, java.lang.String soupName)
InsertHelper	getInsertHelper(SQLiteDatabase db, java.lang.String table) Get insert helper for a table
static DBHelper	getInstance(SQLiteDatabase db) Returns the instance of this class associated with the database specified.
JSONObject	getLastExplainQueryPlan()
long	getNextId(SQLiteDatabase db, java.lang.String tableName) Get next id for a table
java.lang.String	getSoupTableName(SQLiteDatabase db, java.lang.String soupName) Return table name for a given soup or null if the soup doesn't exist
protected java.lang.String	getSoupTableNameFromDb(SQLiteDatabase db, java.lang.String soupName)
boolean	hasFTS(SQLiteDatabase db, java.lang.String soupName)
boolean	hasIndexForPath(SQLiteDatabase db, java.lang.String soupName, java.lang.String path) Return true if the given path is indexed on the given soup
boolean	hasSoup(SQLiteDatabase db, java.lang.String soupName) Return true if given soup exists
long	insert(SQLiteDatabase db, java.lang.String table, ContentValues contentValues) Does an insert
Cursor	limitRawQuery(SQLiteDatabase db, java.lang.String sql, java.lang.String limit, java.lang.String... whereArgs) Does a limit for a raw query
Cursor	query(SQLiteDatabase db, java.lang.String table, java.lang.String[] columns, java.lang.String orderBy, java.lang.String limit, java.lang.String whereClause, java.lang.String... whereArgs) Runs a query
void	removeFromCache(java.lang.String soupName)
void	reset(Context ctx) Resets all cached data and deletes the database for all users.
void	reset(Context ctx, UserAccount account) Resets all cached data and deletes the database for the specified user.
protected void	safeClose(Cursor cursor)
void	setCaptureExplainQueryPlan(boolean captureExplainQueryPlan) If turned on, explain query plan is run before executing a query and stored in lastExplainQueryPlan and also get logged
int	update(SQLiteDatabase db, java.lang.String table, ContentValues contentValues, java.lang.String whereClause, java.lang.String... whereArgs) Does an update

Methods inherited from class java.lang.Object

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

Field Detail

EXPLAIN_SQL

public static final java.lang.String EXPLAIN_SQL

See Also:

Constant Field Values

EXPLAIN_ARGS

public static final java.lang.String EXPLAIN_ARGS

See Also:

Constant Field Values

EXPLAIN_ROWS

public static final java.lang.String EXPLAIN_ROWS

See Also:

Constant Field Values

EXPLAIN_TAG

public static final java.lang.String EXPLAIN_TAG

See Also:

Constant Field Values

Constructor Detail

DBHelper

public DBHelper()

Method Detail

getInstance

public static DBHelper getInstance(SQLiteDatabase db)

Returns the instance of this class associated with the database specified.

Parameters:

db - Database.

Returns:

Instance of this class.

cacheTableName

public void cacheTableName(java.lang.String soupName,
                           java.lang.String tableName)

Parameters:

soupName -

tableName -

cacheHasSoup

public void cacheHasSoup(java.lang.String soupName,
                         boolean hasSoup)

Parameters:

soupName -

hasSoup -

getCachedTableName

public java.lang.String getCachedTableName(java.lang.String soupName)

Parameters:

soupName -

Returns:

cacheIndexSpecs

public void cacheIndexSpecs(java.lang.String soupName,
                            IndexSpec[] indexSpecs)

Parameters:

soupName -

indexSpecs -

getCachedIndexSpecs

public IndexSpec[] getCachedIndexSpecs(java.lang.String soupName)

Parameters:

soupName -

Returns:

getCachedHasFTS

public java.lang.Boolean getCachedHasFTS(java.lang.String soupName)

Parameters:

soupName -

Returns:

removeFromCache

public void removeFromCache(java.lang.String soupName)

Parameters:

soupName -

getNextId

public long getNextId(SQLiteDatabase db,
                      java.lang.String tableName)

Get next id for a table

Parameters:

db -

tableName -

Returns:

long

getInsertHelper

public InsertHelper getInsertHelper(SQLiteDatabase db,
                                    java.lang.String table)

Get insert helper for a table

Parameters:

table -

Returns:

countQuery

public Cursor countQuery(SQLiteDatabase db,
                         java.lang.String table,
                         java.lang.String whereClause,
                         java.lang.String... whereArgs)

Does a count query

Parameters:

db -

table -

whereClause -

whereArgs -

Returns:

limitRawQuery

public Cursor limitRawQuery(SQLiteDatabase db,
                            java.lang.String sql,
                            java.lang.String limit,
                            java.lang.String... whereArgs)

Does a limit for a raw query

Parameters:

db -

sql -

limit -

whereArgs -

Returns:

countRawCountQuery

public int countRawCountQuery(SQLiteDatabase db,
                              java.lang.String countSql,
                              java.lang.String... whereArgs)

Does a count for a raw count query

Parameters:

db -

countSql -

whereArgs -

Returns:

countRawQuery

public int countRawQuery(SQLiteDatabase db,
                         java.lang.String sql,
                         java.lang.String... whereArgs)

Does a count for a raw query

Parameters:

db -

sql -

whereArgs -

Returns:

query

public Cursor query(SQLiteDatabase db,
                    java.lang.String table,
                    java.lang.String[] columns,
                    java.lang.String orderBy,
                    java.lang.String limit,
                    java.lang.String whereClause,
                    java.lang.String... whereArgs)

Runs a query

Parameters:

db -

table -

columns -

orderBy -

limit -

whereClause -

whereArgs -

Returns:

insert

public long insert(SQLiteDatabase db,
                   java.lang.String table,
                   ContentValues contentValues)

Does an insert

Parameters:

db -

table -

contentValues -

Returns:

row id of inserted row

update

public int update(SQLiteDatabase db,
                  java.lang.String table,
                  ContentValues contentValues,
                  java.lang.String whereClause,
                  java.lang.String... whereArgs)

Does an update

Parameters:

db -

table -

contentValues -

whereClause -

whereArgs -

Returns:

number of rows affected

delete

public void delete(SQLiteDatabase db,
                   java.lang.String table,
                   java.lang.String whereClause,
                   java.lang.String... whereArgs)

Does a delete (after first logging the delete statement)

Parameters:

db -

table -

whereClause -

whereArgs -

reset

public void reset(Context ctx)

Resets all cached data and deletes the database for all users.

Parameters:

ctx - Context.

reset

public void reset(Context ctx,
                  UserAccount account)

Resets all cached data and deletes the database for the specified user.

Parameters:

ctx - Context.

account - User account.

clearMemoryCache

public void clearMemoryCache()

Resets all cached data from memory.

getColumnNameForPath

public java.lang.String getColumnNameForPath(SQLiteDatabase db,
                                             java.lang.String soupName,
                                             java.lang.String path)

Return column name in soup table that holds the soup projection for path

Parameters:

db -

soupName -

path -

Returns:

hasIndexForPath

public boolean hasIndexForPath(SQLiteDatabase db,
                               java.lang.String soupName,
                               java.lang.String path)

Return true if the given path is indexed on the given soup

Parameters:

db -

soupName -

path -

Returns:

getIndexSpecs

public IndexSpec[] getIndexSpecs(SQLiteDatabase db,
                                 java.lang.String soupName)

Read index specs back from the soup index map table

Parameters:

db -

soupName -

Returns:

getIndexSpecsFromDb

protected IndexSpec[] getIndexSpecsFromDb(SQLiteDatabase db,
                                          java.lang.String soupName)

hasFTS

public boolean hasFTS(SQLiteDatabase db,
                      java.lang.String soupName)

Parameters:

db -

soupName -

Returns:

true if soup has full-text-search index

getSoupTableName

public java.lang.String getSoupTableName(SQLiteDatabase db,
                                         java.lang.String soupName)

Return table name for a given soup or null if the soup doesn't exist

Parameters:

db -

soupName -

Returns:

hasSoup

public boolean hasSoup(SQLiteDatabase db,
                       java.lang.String soupName)

Return true if given soup exists

Parameters:

db -

soupName -

Returns:

setCaptureExplainQueryPlan

public void setCaptureExplainQueryPlan(boolean captureExplainQueryPlan)

If turned on, explain query plan is run before executing a query and stored in lastExplainQueryPlan and also get logged

Parameters:

captureExplainQueryPlan - true to turn capture on and false to turn off

getLastExplainQueryPlan

public JSONObject getLastExplainQueryPlan()

Returns:

explain query plan for last query run (if captureExplainQueryPlan is true)

getSoupTableNameFromDb

protected java.lang.String getSoupTableNameFromDb(SQLiteDatabase db,
                                                  java.lang.String soupName)

safeClose

protected void safeClose(Cursor cursor)

Parameters:

cursor -