SmartStore/com.salesforce.androidsdk.smartstore.store/DBHelper

DBHelper

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)

Constructors

DBHelper

constructor()

Properties

EXPLAIN_ARGS

val EXPLAIN_ARGS: String = "args"

EXPLAIN_ROWS

val EXPLAIN_ROWS: String = "rows"

EXPLAIN_SQL

val EXPLAIN_SQL: String = "sql"

EXPLAIN_TAG

val EXPLAIN_TAG: String = "EXPLAIN"

lastExplainQueryPlan

open val lastExplainQueryPlan: JSONObject

Functions

cacheHasSoup

open fun cacheHasSoup(soupName: String, hasSoup: Boolean)

cacheIndexSpecs

open fun cacheIndexSpecs(soupName: String, indexSpecs: Array<IndexSpec>)

cacheTableName

open fun cacheTableName(soupName: String, tableName: String)

clearMemoryCache

open fun clearMemoryCache()

Resets all cached data from memory.

countQuery

open fun countQuery(db: SQLiteDatabase, table: String, whereClause: String, whereArgs: Array<String>): Cursor

Does a count query

countRawCountQuery

open fun countRawCountQuery(db: SQLiteDatabase, countSql: String, whereArgs: Array<String>): Int

Does a count for a raw count query

countRawQuery

open fun countRawQuery(db: SQLiteDatabase, sql: String, whereArgs: Array<String>): Int

Does a count for a raw query

delete

open fun delete(db: SQLiteDatabase, table: String, whereClause: String, whereArgs: Array<String>)

Does a delete (after first logging the delete statement)

getCachedHasFTS

open fun getCachedHasFTS(soupName: String): Boolean

getCachedIndexSpecs

open fun getCachedIndexSpecs(soupName: String): Array<IndexSpec>

getCachedTableName

open fun getCachedTableName(soupName: String): String

getColumnNameForPath

open fun getColumnNameForPath(db: SQLiteDatabase, soupName: String, path: String): String

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

getIndexSpecs

open fun getIndexSpecs(db: SQLiteDatabase, soupName: String): Array<IndexSpec>

Read index specs back from the soup index map table

getInsertHelper

open fun getInsertHelper(db: SQLiteDatabase, table: String): DatabaseUtils.InsertHelper

Get insert helper for a table

getInstance

open fun getInstance(db: SQLiteDatabase): DBHelper

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

getNextId

open fun getNextId(db: SQLiteDatabase, tableName: String): Long

Get next id for a table

getSoupTableName

open fun getSoupTableName(db: SQLiteDatabase, soupName: String): String

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

hasFTS

open fun hasFTS(db: SQLiteDatabase, soupName: String): Boolean

hasIndexForPath

open fun hasIndexForPath(db: SQLiteDatabase, soupName: String, path: String): Boolean

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

hasSoup

open fun hasSoup(db: SQLiteDatabase, soupName: String): Boolean

Return true if given soup exists

insert

open fun insert(db: SQLiteDatabase, table: String, contentValues: ContentValues): Long

Does an insert

limitRawQuery

open fun limitRawQuery(db: SQLiteDatabase, sql: String, limit: String, whereArgs: Array<String>): Cursor

Does a limit for a raw query

query

open fun query(db: SQLiteDatabase, table: String, columns: Array<String>, orderBy: String, limit: String, whereClause: String, whereArgs: Array<String>): Cursor

Runs a query

removeFromCache

open fun removeFromCache(soupName: String)

reset

open fun reset(ctx: Context)

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

open fun reset(ctx: Context, account: UserAccount)

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

setCaptureExplainQueryPlan

open fun setCaptureExplainQueryPlan(captureExplainQueryPlan: Boolean)

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

update

open fun update(db: SQLiteDatabase, table: String, contentValues: ContentValues, whereClause: String, whereArgs: Array<String>): Int

Does an update