View source on GitHub |
Represents the result of executing a search request.
Inherits From: expected_type
google.appengine.api.search.SearchResults(
number_found, results=None, cursor=None, facets=None
)
Args | |
---|---|
number_found
|
The number of documents found for the query. |
results
|
The list of ScoredDocuments returned from executing a search request. |
cursor
|
A Cursor to continue the search from the end of the search results. |
facets
|
The list of FacetResults returned from executing a search request with faceted search enabled. |
Raises | |
---|---|
TypeError
|
If any of the parameters have an invalid type, or an unknown attribute is passed. |
ValueError
|
If any of the parameters have an invalid value. |
Attributes | |
---|---|
cursor
|
Returns a cursor that can be used to continue search from last result.
This corresponds to using a ResultsCursor in QueryOptions, otherwise this will be None. |
facets
|
Return the list of FacetResults that found in matched documents. |
number_found
|
Returns the number of documents which were found for the search.
Note that this is an approximation and not an exact count. If QueryOptions.number_found_accuracy parameter is set to 100 for example, then number_found <= 100 is accurate. |
results
|
Returns the list of ScoredDocuments that matched the query. |
Methods
__iter__
__iter__()