The Sophora Query Language (SoQL)—pronounced "so cool"—is a powerful tool for building structured queries. While the basic search covers most daily needs, SoQL allows you to define complex criteria. Refer to the SoQL documentation for details.
Before you begin
- Purpose: Use SoQL for advanced filtering that basic search cannot handle.
- Syntax: Although it looks like SQL, SoQL is not a database query language. It runs against SolrCloud.
- Complexity: If your search is simple, stick to the basic search for faster results.
Using SoQL search
To perform an advanced search:
- In the navigation pane, click or tap Search.
- Click the blitz icon (⚡) in the search box to switch to SoQL mode.
- Enter your expression. For example:
sophora-content:title='My Story' AND state='inProcess' order by modificationDate desc
Helpful features
| Feature | How to use |
|---|---|
| Validation | Errors are marked with a red wavy underline. Hover over the underlined text to see details and correction tips. |
| Autocompletion | As you type, a menu will suggest document types and properties. Select a suggestion to complete your query. |
| Context Help | Click the book icon within the SoQL box to open the help panel. |
SoQL context help tabs
If you need a reminder of the syntax while working, the help panel offers three sections:
- SoQL Syntax: An overview of operators, keywords, and special query terms.
- Content: A reference list of node types, properties, mixins, and users specific to your repository.
- Examples: Ready-to-use search strings that you can adapt.
