Stay organized with collections Save and categorize content based on your preferences.
Class Query represents a request on the search service to query the index.
Query is defined in the google.appengine.api.search module.
The Query class allows you to specify a query string and other options, such as sort order, limit, and a cursor, for a search on an index. You set these options by instantiating the QueryOptions class to the Query.options parameter.
For example, the following code fragment requests a search for documents where first occurs in subject and good occurs anywhere, returning at most 20 documents, returning a single document cursor for the results, sorting by subject in descending order, returning the author, subject, and summary fields as well as a snippeted field content.
from google.appengine.api import search
...
results = index.search(search.Query(
# Specify the query string using the Search API's Query language.
query_string='subject:first good',
options=search.QueryOptions(
limit=20,
cursor=search.Cursor(),
sort_options=search.SortOptions(
expressions=[
search.SortExpression(expression='subject', default_value='')],
limit=1000),
returned_fields=['author', 'subject', 'summary'],
snippeted_fields=['content'])))
...
You have the option to return a cursor with each set of search results. This cursor allows you to more easily page through search results. To get a Cursor, specify it in QueryOptions.cursor and extract the cursor for the next request from SearchResults.cursor. This allows you to continue your search from the last found document, as shown below:
...
results = index.search(
search.Query(query_string='subject:first good',
options=search.QueryOptions(cursor=results.cursor))) Constructor
The constructor for class Query is defined as follows:
class Query(query_string, options=None, enable_facet_discovery=False, return_facets=None, facet_options=None, facet_refinements=None)
Request the search service to query an index, specifying parameters for that query.
Arguments
The query to match against documents in the index. A query is a boolean expression containing terms. For example, the query job tag:"very important" sent < 2011-02-28 finds documents with the term job in any field, and also contain the phrase very important in a tag field, and a sent date prior to February 28, 2011.
Instantiation of the QueryOptions class with instructions for post-processing search results.
Enable the discovery of the most relevant facets used by the documents that satisfy this search query and return them.
An iterable of FacetRequest or basestring as facet name to return specific facet with the result.
A FacetOption describing processing of facets.
An iterable of FacetRefinement objects or refinement token strings used to filter out search results based on a facet value. refinements for different facets will be conjunction and refinements for the same facet will be disjunction.
Result value
A new instance of class Query.
Exceptions
Raised when query_string is not a string or options is not a QueryOptions object.
Raised when the query_string could not be parsed.
An instance of class Query has the following properties:
Returns the query string to search in this request.
Returns the QueryOptions defining post-processing of the search results.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-07 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["The `Query` class is used to define and send search requests to an index in the search service, specifying the query string and other search parameters."],["You can customize search parameters like sort order, result limits, and cursors for pagination by using the `QueryOptions` class in conjunction with the `Query` class."],["The `query_string` within the `Query` object represents a boolean expression used to match documents within the index, enabling complex searches."],["The `Query` class allows for the retrieval of a cursor from `SearchResults` to enable efficient pagination through large result sets, allowing for continued searches."],["The `Query` constructor can handle options related to facet discovery and refinements, providing advanced filtering and analysis of search results."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4