View source: R/cloudsearchdomain_operations.R
cloudsearchdomain_search | R Documentation |
Retrieves a list of documents that match the specified search criteria. How you specify the search criteria depends on which query parser you use. Amazon CloudSearch supports four query parsers:
See https://www.paws-r-sdk.com/docs/cloudsearchdomain_search/ for full documentation.
cloudsearchdomain_search(
cursor = NULL,
expr = NULL,
facet = NULL,
filterQuery = NULL,
highlight = NULL,
partial = NULL,
query,
queryOptions = NULL,
queryParser = NULL,
return = NULL,
size = NULL,
sort = NULL,
start = NULL,
stats = NULL
)
cursor |
Retrieves a cursor value you can use to page through large result sets.
Use the For more information, see Paginating Results in the Amazon CloudSearch Developer Guide. |
expr |
Defines one or more numeric expressions that can be used to sort results or specify search or filter criteria. You can also specify expressions as return fields. You specify the expressions in JSON using the form
For information about the variables, operators, and functions you can use in expressions, see Writing Expressions in the Amazon CloudSearch Developer Guide. |
facet |
Specifies one or more fields for which to get facet information, and
options that control how the facet information is returned. Each
specified field must be facet-enabled in the domain configuration. The
fields and options are specified in JSON using the form
You can specify the following faceting options:
If no facet options are specified, facet counts are computed for all field values, the facets are sorted by facet count, and the top 10 facets are returned in the results. To count particular buckets of values, use the
To sort facets by facet count, use the
To sort the facets by value, use the
For more information, see Getting and Using Facet Information in the Amazon CloudSearch Developer Guide. |
filterQuery |
Specifies a structured query that filters the results of a search
without affecting how the results are scored and sorted. You use
For more information about using filters, see Filtering Matching Documents in the Amazon CloudSearch Developer Guide. |
highlight |
Retrieves highlights for matches in the specified You can specify the following highlight options:
If no highlight options are specified for a field, the returned field
text is treated as HTML and the first match is highlighted with emphasis
tags: For example, the following request retrieves highlights for the
|
partial |
Enables partial results to be returned if one or more index partitions are unavailable. When your search index is partitioned across multiple search instances, by default Amazon CloudSearch only returns results if every partition can be queried. This means that the failure of a single search instance can result in 5xx (internal server) errors. When you enable partial results, Amazon CloudSearch returns whatever results are available and includes the percentage of documents searched in the search results (percent-searched). This enables you to more gracefully degrade your users' search experience. For example, rather than displaying no results, you could display the partial results and a message indicating that the results might be incomplete due to a temporary system outage. |
query |
[required] Specifies the search criteria for the request. How you specify the
search criteria depends on the query parser used for the request and the
parser options specified in the For more information about specifying search criteria, see Searching Your Data in the Amazon CloudSearch Developer Guide. |
queryOptions |
Configures options for the query parser specified in the The options you can configure vary according to which parser you use:
|
queryParser |
Specifies which query parser to use to process the request. If
Amazon CloudSearch supports four query parsers:
|
return |
Specifies the field and expression values to include in the response.
Multiple fields or expressions are specified as a comma-separated list.
By default, a search response includes all return enabled fields
( |
size |
Specifies the maximum number of search hits to include in the response. |
sort |
Specifies the fields or custom expressions to use to sort the search
results. Multiple fields or expressions are specified as a
comma-separated list. You must specify the sort direction ( For more information, see Sorting Results in the Amazon CloudSearch Developer Guide. |
start |
Specifies the offset of the first search hit you want to return. Note
that the result set is zero-based; the first result is at index 0. You
can specify either the For more information, see Paginating Results in the Amazon CloudSearch Developer Guide. |
stats |
Specifies one or more fields for which to get statistics information. Each specified field must be facet-enabled in the domain configuration. The fields are specified in JSON using the form:
There are currently no options supported for statistics. |
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.