Full-Text Query Syntax

Mobile SDK full-text queries use SQLite's enhanced query syntax. With this syntax, you can use logical operators to refine your search.

The following table shows the syntactical options that Mobile SDK queries support. Following the table are keyed examples of the various query styles and sample output. For more information, see Sections 3.1, “Full-text Index Queries,” and 3.2, “Set Operations Using The Enhanced Query Syntax,” at sqlite.org.

Query OptionSmartStore BehaviorRelated Examples
Specify one or more full-text indexed pathsPerforms match against values only at the paths you defined.

g, h, i, j, and k

Set the path to a null valuePerforms match against all full-text indexed paths

Note: If your path is null, you can still specify a target field in the matchKey argument. Use this format: {soupName:path}:term

a,b,c,d,e, and f

Specify more than one term without operators or groupingAssumes an “AND” between termsb and h
Place a star at the end of a termMatches rows containing words that start with the query termd and j
Use “OR” between termsFinds one or both termsc and i
Use the unary “NOT” operator before a termIgnores rows that contain that terme, f, and k
Specify a phrase search by placing multiple terms within double quotes (“ ”).Returns soup elements in which the entire phrase occurs in one or more full-text indexed fields 

Example 

For these examples, a soup named “animals” contains the following records. The name and color fields are indexed as full_text.

{"id”: 1, "name": "cat", "color": "black"}
{"id”: 2, "name": "cat", "color": "white"}
{"id”: 3, "name": "dog", "color": "black"}
{"id”: 4, "name": "dog", "color": "brown"}
{"id”: 5, "name": "dog", "color": "white"}

Query Syntax Examples 
ExamplePathMatch KeySelects...Records Returned
a.null“black”Records containing the word “black” in any full-text indexed field1, 3
b.null“black cat”Records containing the words “black” and “cat” in any full-text indexed field1
c.null“black OR cat”Records containing either the word “black” or the word “cat” in any full-text indexed field1, 2, 3
d.null“b*”Records containing a word starting with “b” in any full-text indexed field1, 3
e.null“black NOT cat”Records containing the word “black” but not the word “cat” in any full-text indexed field3
f.null“{animals} NOT cat”Records containing the word “black” in the color field and not having the word “cat” in any full-text indexed field3
g.“color”“black”Records containing the word “black” in the color field1, 3
h.“color”“black cat”Records containing the words “black” and “cat” in the color fieldNo records
i.“color”“black OR cat”Records containing either the word “black” or the word “cat” in the color field1, 3
j.“color”“b*”Records containing a word starting with “b” in the color field1, 3
k.“color”“black NOT cat”Records containing the word “black” but not the word “cat” in the color field1, 3

We've Moved

Welcome to the new home of the Mobile SDK Developer Guide! For now, the Japanese guide can be found in PDF form.

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Introduction to Mobile Development
Introduction to Salesforce Mobile SDK Development
What’s New in Mobile SDK 13.0
Getting Started With Mobile SDK 13.0 for iOS and Android
Updating Mobile SDK Apps (5.0 and Later)
Native iOS Development
Native Android Development
HTML5 and Hybrid Development
React Native Development
Offline Management
Using SmartStore to Securely Store Offline Data
About SmartStore
Enabling SmartStore in Hybrid and Native Apps
Adding SmartStore to Existing Android Apps
Creating and Accessing User-based Stores
Using Global SmartStore
Registering Soups with Configuration Files
Using Arrays in Index Paths
Populating a Soup
Retrieving Data from a Soup
Smart SQL Queries
Using Full-Text Search Queries
Full-Text Search Index Specs
Full-Text Query Specs
Full-Text Query Syntax
Working with Query Results
Inserting, Updating, and Upserting Data
Using External Storage for Large Soup Elements
Removing Soup Elements
Managing Soups
Managing Stores
Testing with the SmartStore Inspector
Using the Mock SmartStore
Preparing Soups for Mobile Sync
Using SQLCipher with SmartStore
Using SmartStore in Swift Apps
Using Mobile Sync to Access Salesforce Objects
Validating Configuration Files
Files and Networking
Push Notifications and Mobile SDK
Authentication, Security, and Identity in Mobile Apps
Login Screen Customization
Identity Provider Apps
REST Wrappers for SFAP APIs
Using Key-Value Stores for Secure Data Storage
Dark Mode and Dark Theme Settings
Using Experience Cloud Sites With Mobile SDK Apps
Multi-User Support in Mobile SDK
Mobile SDK Tools for Developers
Logging and Analytics
Migrating from the Previous Release
Reference
Deprecations and Removed APIs