SOSL

Understanding SOSL (Salesforce Object Search Language)

Salesforce Object Search Language (SOSL) is a powerful search language designed to perform text searches across multiple standard and custom objects in Salesforce. Unlike SOQL (Salesforce Object Query Language), which is used to query records from a single object, SOSL allows you to search for specific text across multiple objects simultaneously. This makes SOSL particularly useful when you need to find records that match a search term across various fields and objects.

Key Differences Between SOSL and SOQL

Feature	SOSL	SOQL
Scope	Searches across multiple objects in a single query.	Queries a single object at a time.
Search Type	Performs text-based searches (word matches).	Performs exact matches by default (unless wildcards are used).
Use Case	Ideal for searching text across multiple objects and fields.	Ideal for retrieving specific records from a single object.
Syntax	Uses FIND keyword.	Uses SELECT keyword.
Wildcards	Supports wildcards (* and ?) for flexible searching.	Supports wildcards (% and _) but only in specific contexts.

When to Use SOSL

• Searching Across Multiple Objects: If you need to search for a term across multiple objects (e.g., Accounts, Contacts, Leads), SOSL is the right choice.
• Text-Based Searches: SOSL is ideal for finding records based on text matches in fields like Name, Email, or Description.
• Global Search: SOSL is used in Salesforce global search functionality, allowing users to search for records across the entire org.

Basic SOSL Syntax

The basic structure of a SOSL query is as follows:

FIND 'SearchQuery' [IN SearchGroup] [RETURNING ObjectsAndFields]

• SearchQuery: The text or phrase to search for. Can include wildcards (*, ?) and logical operators (AND, OR).
• SearchGroup: Specifies the scope of fields to search (e.g., ALL FIELDS, NAME FIELDS, EMAIL FIELDS). If not specified, the default is ALL FIELDS.
• ObjectsAndFields: Specifies the objects and fields to return in the search results.

Example SOSL Queries

1. Simple SOSL Query

Search for the term "SFDC" across all fields in the Account and Contact objects.

List> searchList = [FIND 'SFDC' IN ALL FIELDS RETURNING Account(Name), Contact(FirstName, LastName)];

2. Using Wildcards

Search for records with fields starting with "win" (e.g., "Wingo", "Wingate").

List> searchList = [FIND 'win*' IN ALL FIELDS RETURNING Account(Name), Contact(FirstName, LastName)];

3. Using Logical Operators

Search for records containing either "Wingo" or "SFDC".

List> searchList = [FIND 'Wingo OR SFDC' IN ALL FIELDS RETURNING Account(Name), Contact(FirstName, LastName)];

4. Filtering Results

Search for "Wingo" in all fields but only return Accounts in the "Technology" industry.

List> searchList = [FIND 'Wingo' IN ALL FIELDS RETURNING Account(Name, Industry WHERE Industry = 'Technology')];

Using SOSL in Apex

SOSL can be embedded directly in Apex code, making it easy to integrate search functionality into your custom logic. Here’s an example:

String searchTerm = 'Wingo OR SFDC';
List> searchResults = [FIND :searchTerm IN ALL FIELDS RETURNING Account(Name), Contact(FirstName, LastName)];

// Extract results
Account[] accounts = (Account[]) searchResults[0];
Contact[] contacts = (Contact[]) searchResults[1];

// Debug results
System.debug('Found Accounts: ' + accounts);
System.debug('Found Contacts: ' + contacts);

Using the Query Editor

The Developer Console’s Query Editor allows you to test SOSL queries without writing Apex code. Here’s how:

1. Open the Developer Console.
2. Navigate to the Query Editor tab.
3. Enter your SOSL query (enclosed in curly braces {}).

Example:

FIND {Wingo} IN ALL FIELDS RETURNING Account(Name), Contact(FirstName, LastName)

4. Click Execute to view the results.

Advanced SOSL Features

1. Filtering Results

You can filter SOSL results using the WHERE clause in the RETURNING statement.

FIND 'Wingo' IN ALL FIELDS RETURNING Account(Name, Industry WHERE Industry = 'Technology')

2. Ordering Results

Use ORDER BY to sort the results.

FIND 'Wingo' IN ALL FIELDS RETURNING Account(Name ORDER BY Name)

3. Limiting Results

Use LIMIT to restrict the number of records returned.

FIND 'Wingo' IN ALL FIELDS RETURNING Account(Name LIMIT 10)

Best Practices for SOSL

• Use Wildcards Sparingly: Wildcards (*, ?) can slow down queries if overused.
• Leverage Filters: Use WHERE clauses to narrow down results and improve performance.
• Test in Query Editor: Always test your SOSL queries in the Query Editor before embedding them in Apex.
• Combine with SOQL: Use SOSL for broad searches and SOQL for detailed queries on specific objects.

Example Use Case

Searching for Contacts and Leads

Suppose you want to search for Contacts and Leads with the last name "Smith". Here’s how you can do it:

public class ContactAndLeadSearch {
    public static List> searchContactsAndLeads(String lastName) {
        List> searchResults = [FIND :lastName IN ALL FIELDS RETURNING Contact(FirstName, LastName), Lead(FirstName, LastName)];
        return searchResults;
    }
}

Execute this method using Anonymous Apex:

System.debug(ContactAndLeadSearch.searchContactsAndLeads('Smith'));

Conclusion

SOSL is a versatile tool for performing text-based searches across multiple objects in Salesforce. Whether you’re building a global search feature or need to find records based on specific text, SOSL provides the flexibility and power to meet your needs. By combining SOSL with SOQL and leveraging its advanced features like filtering, ordering, and limiting results, you can create efficient and effective search functionality in your Salesforce applications.