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

SmartStore

Smart store Provides a secure means for SalesforceMobileSDK Container-based applications to store objects in a persistent and searchable manner. Similar in some ways to CouchDB, SmartStore stores documents as JSON values. SmartStore is inspired by the Apple Newton OS Soup/Store model. The main challenge here is how to effectively store documents with dynamic fields, and still allow indexing and searching.

Constructors

SmartStore

constructor(dbOpenHelper: SQLiteOpenHelper)

Relies on SQLiteOpenHelper for database handling.

Types

FtsExtension

enum FtsExtension

Enum for fts extensions

SmartStoreException

open class SmartStoreException : RuntimeException

Exception thrown by smart store

Type

enum Type

Enum for column type

TypeGroup

enum TypeGroup

Enum for type groups

Properties

COLUMN_TYPE_COL

val COLUMN_TYPE_COL: String = "columnType"

FTS_SUFFIX

val FTS_SUFFIX: String = "_fts"

PATH_COL

val PATH_COL: String = "path"

SOUP_ATTRS_TABLE

val SOUP_ATTRS_TABLE: String = "soup_attrs"

SOUP_CREATED_DATE

val SOUP_CREATED_DATE: String = "_soupCreatedDate"

SOUP_ENTRY_ID

val SOUP_ENTRY_ID: String = "_soupEntryId"

SOUP_INDEX_MAP_TABLE

val SOUP_INDEX_MAP_TABLE: String = "soup_index_map"

SOUP_LAST_MODIFIED_DATE

val SOUP_LAST_MODIFIED_DATE: String = "_soupLastModifiedDate"

SOUP_NAME_COL

val SOUP_NAME_COL: String = "soupName"

Functions

alterSoup

open fun alterSoup(soupName: String, indexSpecs: Array<IndexSpec>, reIndexData: Boolean)

Alter soup using only soup name without extra soup features.

beginTransaction

open fun beginTransaction()

Start transaction NB: to avoid deadlock, caller should have synchronized(store.

changeKey

open fun changeKey(db: SQLiteDatabase, oldKey: String, newKey: String)

Changes the encryption key on the smartstore.

clearSoup

open fun clearSoup(soupName: String)

Clear all rows from a soup

convertSmartSql

open fun convertSmartSql(smartSql: String): String

countQuery

open fun countQuery(querySpec: QuerySpec): Int

create

open fun create(soupName: String, soupElt: JSONObject): JSONObject

Create (and commits) Note: Passed soupElt is modified (last modified date and soup entry id fields)

open fun create(soupName: String, soupElt: JSONObject, handleTx: Boolean): JSONObject

Create Note: Passed soupElt is modified (last modified date and soup entry id fields)

createLongOperationsStatusTable

open fun createLongOperationsStatusTable(db: SQLiteDatabase)

Create long_operations_status table

createMetaTables

open fun createMetaTables(db: SQLiteDatabase)

Create soup index map table to keep track of soups' index specs Create soup name map table to keep track of soup name to table name mappings Called when the database is first created

delete

open fun delete(soupName: String, soupEntryIds: Array<Long>)

Delete soup elements given by their ids (and commits)

open fun delete(soupName: String, soupEntryIds: Array<Long>, handleTx: Boolean)

Delete soup elements given by their ids

deleteByQuery

open fun deleteByQuery(soupName: String, querySpec: QuerySpec)

Delete soup elements selected by querySpec (and commits)

open fun deleteByQuery(soupName: String, querySpec: QuerySpec, handleTx: Boolean)

Delete soup elements selected by querySpec

dropAllSoups

open fun dropAllSoups()

Destroy all the soups in the smartstore

dropSoup

open fun dropSoup(soupName: String)

Destroy a soup Drop table for soupName Cleanup entries in soup index map table

endTransaction

open fun endTransaction()

End transaction (commit or rollback)

getAllSoupNames

open fun getAllSoupNames(): List<String>

getCipherFIPSStatus

open fun getCipherFIPSStatus(): Boolean

Get SQLCipher FIPS status

getCipherProviderVersion

open fun getCipherProviderVersion(): String

Get SQLCipher provider version

getCompileOptions

open fun getCompileOptions(): List<String>

Get SQLCipher compile options

getDatabase

open fun getDatabase(): SQLiteDatabase

Return db

getDatabaseSize

open fun getDatabaseSize(): Int

Get database size

getFtsExtension

open fun getFtsExtension(): SmartStore.FtsExtension

getLastExplainQueryPlan

open fun getLastExplainQueryPlan(): JSONObject

getLongOperations

open fun getLongOperations(): Array<LongOperation>

getRuntimeSettings

open fun getRuntimeSettings(): List<String>

Get SQLCipher runtime settings

getSoupIndexSpecs

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

Return indexSpecs of soup

getSoupTableName

open fun getSoupTableName(soupId: Long): String

getSQLCipherVersion

open fun getSQLCipherVersion(): String

Get SQLCipher version

hasIndexForPath

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

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

hasSoup

open fun hasSoup(soupName: String): Boolean

Check if soup exists

lookupSoupEntryId

open fun lookupSoupEntryId(soupName: String, fieldPath: String, fieldValue: String): Long

Look for a soup element where fieldPath's value is fieldValue Return its soupEntryId Return -1 if not found Throw an exception if fieldName is not indexed Throw an exception if more than one soup element are found

project

open fun project(soup: JSONObject, path: String): Any

projectReturningNULLObject

open fun projectReturningNULLObject(soup: JSONObject, path: String): Any

Same as project but returns JSONObject.

query

open fun query(querySpec: QuerySpec, pageIndex: Int): JSONArray

Run a query given by its query spec Returns results from selected page

queryAsString

open fun queryAsString(resultBuilder: StringBuilder, querySpec: QuerySpec, pageIndex: Int)

Run a query given by its query Spec Returns results from selected page without deserializing any JSON

queryWithArgs

open fun queryWithArgs(querySpec: QuerySpec, pageIndex: Int, whereArgs: Array<String>): JSONArray

Run a query given by its query spec with optional "where args" (i.e.

registerSoup

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

reIndexSoup

open fun reIndexSoup(soupName: String, indexPaths: Array<String>, handleTx: Boolean)

Re-index all soup elements for passed indexPaths NB: only indexPath that have IndexSpec on them will be indexed

resumeLongOperations

open fun resumeLongOperations()

Finish long operations that were interrupted

retrieve

open fun retrieve(soupName: String, soupEntryIds: Array<Long>): JSONArray

Retrieve

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

setFtsExtension

open fun setFtsExtension(ftsExtension: SmartStore.FtsExtension)

Sets the ftsX to be used when creating the virtual table to support full_text queries NB: only used in tests

setLicenseKey

open fun setLicenseKey(licenseKey: String)

Set license key for SQLCipher Needed when using commercial or enterprise editions of SQLCipher Should be called before using SmartStore

setTransactionSuccessful

open fun setTransactionSuccessful()

Mark transaction as successful (next call to endTransaction will be a commit)

update

open fun update(soupName: String, soupElt: JSONObject, soupEntryId: Long): JSONObject

Update (and commits) Note: Passed soupElt is modified (last modified date and soup entry id fields)

open fun update(soupName: String, soupElt: JSONObject, soupEntryId: Long, handleTx: Boolean): JSONObject

Update Note: Passed soupElt is modified (last modified date and soup entry id fields)

updateTableNameAndAddColumns

open fun updateTableNameAndAddColumns(db: SQLiteDatabase, oldName: String, newName: String, columns: Array<String>)

Updates the given table with a new name and adds columns if any.

upsert

open fun upsert(soupName: String, soupElt: JSONObject): JSONObject

Upsert (and commits) expecting _soupEntryId in soupElt for updates

open fun upsert(soupName: String, soupElt: JSONObject, externalIdPath: String): JSONObject

Upsert (and commits)

open fun upsert(soupName: String, soupElt: JSONObject, externalIdPath: String, handleTx: Boolean): JSONObject

Upsert