Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(clp-json): Update list of characters that requires escaping in queries. #617

Merged
merged 3 commits into from
Dec 2, 2024
Merged

docs(clp-json): Update list of characters that requires escaping in queries. #617

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ee70056
Update docs for escaping characters in clp-s search
gibber9809 Dec 2, 2024
58a7251
Remove sentence about escaping AND OR NOT
gibber9809 Dec 2, 2024
0967dc8
Simplify to clarify.
kirkrodrigues Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions docs/src/user-guide/reference-json-search-syntax.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,17 @@ To search for a key or value with multiple words, you must quote the key/value w
"multi-word key": "multi-word value"
```

Queries for keys or values with the following literal characters must escape the characters using a
`\` (backslash): `\`, `(`, `)`, `:`, `<`, `>`, `"`, `*`, `{`, `}`.
Keys or values with the following literal characters must escape the characters using a `\`
(backslash): `\`, `"`.

Unquoted keys or values must also escape the following characters: `(`, `)`, `:`, `<`, `>`, `{`,
`}`. The unquoted keywords `and`, `or`, and `not` can also be escaped with a `\`.

Values containing `?` and `*` can escape these characters with a `\` to differentiate them from the
`?` and `*` characters used to specify arbitrary single character match and wildcard match.

Keys containing `.` can escape the `.` with `\` to differentiate from the special `.` character that
indicates nested keys.

:::{caution}
Currently, a query that contains spaces is interpreted as a substring search, i.e., it will match
Expand Down
Loading