Skip to content

Commit e8ff71c

Browse files
authored
Merge pull request #81 from marklogic/feature/doc-options-fix
Added description of `options` argument
2 parents 4cc4a85 + fdef421 commit e8ff71c

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/managing-documents/searching.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,12 @@ assert len(docs) == 1
5555
The search string in the example corresponds to the `q` argument, which is the first argument in the method and thus
5656
does not need to be named.
5757

58+
With a search string, you may wish to reference a set of
59+
[MarkLogic search options](https://docs.marklogic.com/guide/search-dev/query-options) as well. You can configure a set
60+
of options via the [MarkLogic REST API](https://docs.marklogic.com/guide/rest-dev/search#id_48838) and then refer to
61+
them by name via the `options` argument. For example, if your options are named `myOptions`, you would
62+
include `options=myOptions` as an argument to `client.documents.search`.
63+
5864
## Searching via a complex query
5965

6066
More complex queries can be submitted via the `query` parameter. The value of this parameter must be one of the

0 commit comments

Comments
 (0)