Class WatchQueryIndexOptions

Inheritance
object
WatchQueryIndexOptions
Inherited Members
Namespace: Couchbase.Management.Query
Assembly: Couchbase.NetClient.dll
Syntax
public class WatchQueryIndexOptions

Fields

| Edit this page View Source

DefaultReadOnly

Declaration
public static readonly WatchQueryIndexOptions.ReadOnly DefaultReadOnly
Field Value
Type Description
WatchQueryIndexOptions.ReadOnly

Properties

| Edit this page View Source

Default

Declaration
public static WatchQueryIndexOptions Default { get; }
Property Value
Type Description
WatchQueryIndexOptions

Methods

| Edit this page View Source

AsReadOnly()

Declaration
public WatchQueryIndexOptions.ReadOnly AsReadOnly()
Returns
Type Description
WatchQueryIndexOptions.ReadOnly
| Edit this page View Source

CancellationToken(CancellationToken)

Allows to pass in a custom CancellationToken from a CancellationTokenSource. Note that CancellationToken() takes precedence over Timeout(). If both CancellationToken and Timeout are set, the former will be used in the operation.

Declaration
public WatchQueryIndexOptions CancellationToken(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken

The Token to cancel the operation.
Returns
Type Description
WatchQueryIndexOptions

This class for method chaining.
| Edit this page View Source

CollectionName(string)

Sets the collection name for this query management operation.

Declaration
[Obsolete("Use collection.QueryIndexes instead.")]
public WatchQueryIndexOptions CollectionName(string collectionName)
Parameters
Type Name Description
string collectionName

The collection name to use.
Returns
Type Description
WatchQueryIndexOptions

A WatchQueryIndexOptions for chaining options.
Remarks

If the collection name is set then the scope name must be set as well.

| Edit this page View Source

Deconstruct(out bool, out CancellationToken, out string?, out string?, out string?, out TimeSpan)

Declaration
public void Deconstruct(out bool watchPrimaryValue, out CancellationToken tokenValue, out string? scopeNameValue, out string? collectionNameValue, out string? queryContext, out TimeSpan timeoutValue)
Parameters
Type Name Description
bool watchPrimaryValue
CancellationToken tokenValue
string scopeNameValue
string collectionNameValue
string queryContext
TimeSpan timeoutValue
| Edit this page View Source

ScopeName(string)

Sets the scope name for this query management operation.

Declaration
[Obsolete("Use collection.QueryIndexes instead.")]
public WatchQueryIndexOptions ScopeName(string scopeName)
Parameters
Type Name Description
string scopeName

The scope name to use.
Returns
Type Description
WatchQueryIndexOptions

A WatchQueryIndexOptions for chaining options.
Remarks

If the scope name is set then the collection name must be set as well.

| Edit this page View Source

Timeout(TimeSpan)

Allows to set a Timeout for the operation. Note that CancellationToken() takes precedence over Timeout(). If both CancellationToken and Timeout are set, the former will be used in the operation.

Declaration
public WatchQueryIndexOptions Timeout(TimeSpan timeout)
Parameters
Type Name Description
TimeSpan timeout

The duration of the Timeout. Set to 75s by default.
Returns
Type Description
WatchQueryIndexOptions

This class for method chaining.
| Edit this page View Source

WatchPrimary(bool)

Declaration
public WatchQueryIndexOptions WatchPrimary(bool watchPrimary)
Parameters
Type Name Description
bool watchPrimary
Returns
Type Description
WatchQueryIndexOptions