SalesforceMobileSDK-Android

14.0.0-rc.0

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

QuerySpec

open class QuerySpec

Simple class to represent a query spec

Types

enum Order

Simple class to represent query order

Query type enum

Properties

val BEGIN_KEY: String = "beginKey"

val beginKey: String

val countSmartSql: String

val END_KEY: String = "endKey"

val endKey: String

val idsSmartSql: String

val INDEX_PATH: String = "indexPath"

val LIKE_KEY: String = "likeKey"

val likeKey: String

val MATCH_KEY: String = "matchKey"

val matchKey: String

val ORDER: String = "order"

val order: QuerySpec.Order

val ORDER_PATH: String = "orderPath"

val orderPath: String

val PAGE_SIZE: String = "pageSize"

val pageSize: Int

val path: String

val QUERY_TYPE: String = "queryType"

val queryType: QuerySpec.QueryType

val SELECT_PATHS: String = "selectPaths"

val selectPaths: Array<String>

val SMART_SQL: String = "smartSql"

val smartSql: String

val soupName: String

Functions

buildAllQuerySpec

open fun buildAllQuerySpec(soupName: String, orderPath: String, order: QuerySpec.Order, pageSize: Int): QuerySpec

open fun buildAllQuerySpec(soupName: String, selectPaths: Array<String>, orderPath: String, order: QuerySpec.Order, pageSize: Int): QuerySpec

Return query spec for an all query

buildExactQuerySpec

open fun buildExactQuerySpec(soupName: String, path: String, exactMatchKey: String, orderPath: String, order: QuerySpec.Order, pageSize: Int): QuerySpec

open fun buildExactQuerySpec(soupName: String, selectPaths: Array<String>, path: String, exactMatchKey: String, orderPath: String, order: QuerySpec.Order, pageSize: Int): QuerySpec

Return a query spec for an exact match query

buildLikeQuerySpec

open fun buildLikeQuerySpec(soupName: String, path: String, likeKey: String, orderPath: String, order: QuerySpec.Order, pageSize: Int): QuerySpec

open fun buildLikeQuerySpec(soupName: String, selectPaths: Array<String>, path: String, likeKey: String, orderPath: String, order: QuerySpec.Order, pageSize: Int): QuerySpec

Return a query spec for a like query

buildMatchQuerySpec

open fun buildMatchQuerySpec(soupName: String, path: String, matchKey: String, orderPath: String, order: QuerySpec.Order, pageSize: Int): QuerySpec

open fun buildMatchQuerySpec(soupName: String, selectPaths: Array<String>, path: String, matchKey: String, orderPath: String, order: QuerySpec.Order, pageSize: Int): QuerySpec

Return a query spec for a match query (full-text search)

buildRangeQuerySpec

open fun buildRangeQuerySpec(soupName: String, path: String, beginKey: String, endKey: String, orderPath: String, order: QuerySpec.Order, pageSize: Int): QuerySpec

open fun buildRangeQuerySpec(soupName: String, selectPaths: Array<String>, path: String, beginKey: String, endKey: String, orderPath: String, order: QuerySpec.Order, pageSize: Int): QuerySpec

Return a query spec for a range query

buildSmartQuerySpec

open fun buildSmartQuerySpec(smartSql: String, pageSize: Int): QuerySpec

Return a query spec for a smart query

open fun fromJSON(soupName: String, querySpecJson: JSONObject): QuerySpec

open fun getArgs(): Array<String>

qualifyMatchKey

open fun qualifyMatchKey(field: String, matchKey: String): String

fts5 doesn't allow WHERE column MATCH 'value' - only allows WHERE table MATCH 'column:value' This method changes the matchKey to add field: in the right places