Class DocIdQuery

A docId query is a query that directly matches the documents whose ID have been provided. It can be combined within a ConjunctionQuery to restrict matches on the set of documents.

Inheritance
object
SearchQueryBase
DocIdQuery
Implements
Inherited Members
Namespace: Couchbase.Search.Queries.Simple
Assembly: Couchbase.NetClient.dll
Syntax
public class DocIdQuery : SearchQueryBase, ISearchQuery

Constructors

View Source

DocIdQuery(params string[])

Declaration
public DocIdQuery(params string[] docIds)
Parameters
Type Name Description
string[] docIds

Methods

View Source

Add(params string[])

Adds the specified document ids.

Declaration
public DocIdQuery Add(params string[] docIds)
Parameters
Type Name Description
string[] docIds

The document ids.
Returns
Type Description
DocIdQuery
View Source

AsReadOnly()

Declaration
public DocIdQuery.ReadOnly AsReadOnly()
Returns
Type Description
DocIdQuery.ReadOnly
View Source

Deconstruct(out IReadOnlyList<string>)

Declaration
public void Deconstruct(out IReadOnlyList<string> docIds)
Parameters
Type Name Description
IReadOnlyList<string> docIds
View Source

Export()

Gets a JSON object representing this query instance />

Declaration
[RequiresUnreferencedCode("Couchbase FTS might require types that cannot be statically analyzed. Make sure all required types are preserved.")]
[RequiresDynamicCode("Couchbase FTS might require types that cannot be statically analyzed and might need runtime code generation. Do not use for native AOT applications.")]
public override JObject Export()
Returns
Type Description
JObject
Overrides

Implements

See Also