C# Class Couchbase.Search.SearchQuery

Represents a Full Text Search (FTS) query against an index for a given IFtsQuery implementation using ISearchParams.

Afficher le fichier Open project: couchbase/couchbase-net-client Class Usage Examples

Private Properties

Свойство	Type	Description
RelativeUri	string

Méthodes publiques

Méthode	Description
Explain ( bool explain ) : SearchQuery	If true, the response will include additional search score explanations.
Facets ( ) : SearchQuery	ISearchFacets used to aggregate information collected on a particluar result set.
Fields ( ) : SearchQuery	List of fields values that should be returned in the result assuming that they were indexed.
Highlighting ( HighLightStyle highLightStyle ) : SearchQuery	Allows setting of additional highlighting on the result set of matching terms.
Limit ( int limit ) : SearchQuery	Limits the number of matching results from a returned result-set.
SearchQuery ( ) : System
Skip ( int skip ) : SearchQuery	Skip indicates how many matching results to skip on the result set before returing matches.
Sort ( ) : SearchQuery	Configures the list of fields which are used for sorting the search result. Fields with a prefix of "-" indicate a decending nature. If no sort is provided, it is equal to sort("-_score"), since the server will sort it by score in descending order by default.
Timeout ( System.TimeSpan timeout ) : SearchQuery	The server side timeout allows to specify an upper boundary of request execution so that it potentially doesn't run infinitely.
ToJson ( ) : string	Gets the JSON representation of this object.
WithConsistency ( ScanConsistency consistency ) : SearchQuery	The ScanConsistency you require for you ISearchQueryResults.

Private Methods

Méthode	Description
RelativeUri ( ) : string	Gets the relative path for the FTS API service.

Method Details

Explain() public méthode

If true, the response will include additional search score explanations.

public Explain ( bool explain ) : SearchQuery
explain	bool
Résultat	SearchQuery

Facets() public méthode

ISearchFacets used to aggregate information collected on a particluar result set.

public Facets ( ) : SearchQuery
Résultat	SearchQuery

Fields() public méthode

List of fields values that should be returned in the result assuming that they were indexed.

public Fields ( ) : SearchQuery
Résultat	SearchQuery

Highlighting() public méthode

Allows setting of additional highlighting on the result set of matching terms.

public Highlighting ( HighLightStyle highLightStyle ) : SearchQuery
highLightStyle	HighLightStyle	The to use.
Résultat	SearchQuery

Limit() public méthode

Limits the number of matching results from a returned result-set.

public Limit ( int limit ) : SearchQuery
limit	int
Résultat	SearchQuery

SearchQuery() public méthode

public SearchQuery ( ) : System
Résultat	System

Skip() public méthode

Skip indicates how many matching results to skip on the result set before returing matches.

public Skip ( int skip ) : SearchQuery
skip	int
Résultat	SearchQuery

Sort() public méthode

Configures the list of fields which are used for sorting the search result. Fields with a prefix of "-" indicate a decending nature. If no sort is provided, it is equal to sort("-_score"), since the server will sort it by score in descending order by default.

public Sort ( ) : SearchQuery
Résultat	SearchQuery

Timeout() public méthode

The server side timeout allows to specify an upper boundary of request execution so that it potentially doesn't run infinitely.

public Timeout ( System.TimeSpan timeout ) : SearchQuery
timeout	System.TimeSpan	The max length of time that that will be given to execute the query.
Résultat	SearchQuery

ToJson() public méthode

Gets the JSON representation of this object.

public ToJson ( ) : string
Résultat	string

WithConsistency() public méthode

The ScanConsistency you require for you ISearchQueryResults.

public WithConsistency ( ScanConsistency consistency ) : SearchQuery
consistency	ScanConsistency	The for documents to be included in the query results.
Résultat	SearchQuery