Class CreateQueryIndexOptions

Inheritance

object

CreateQueryIndexOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Couchbase.Management.Query

Assembly: Couchbase.NetClient.dll

Syntax

public class CreateQueryIndexOptions

Constructors

View Source

CreateQueryIndexOptions()

Declaration

public CreateQueryIndexOptions()

Fields

View Source

DefaultReadOnly

Declaration

public static readonly CreateQueryIndexOptions.ReadOnly DefaultReadOnly

Field Value

Type	Description
CreateQueryIndexOptions.ReadOnly

Properties

View Source

Default

Declaration

public static CreateQueryIndexOptions Default { get; }

Property Value

Type	Description
CreateQueryIndexOptions

Methods

View Source

AsReadOnly()

Declaration

public CreateQueryIndexOptions.ReadOnly AsReadOnly()

Returns

Type	Description
CreateQueryIndexOptions.ReadOnly

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 CreateQueryIndexOptions CancellationToken(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The Token to cancel the operation.

Returns

Type	Description
CreateQueryIndexOptions	This class for method chaining.

View Source

CollectionName(string)

Sets the collection name for this query management operation.

Declaration

[Obsolete("Use collection.QueryIndexes instead.")]
public CreateQueryIndexOptions CollectionName(string collectionName)

Parameters

Type	Name	Description
string	collectionName	The collection name to use.

Returns

Type	Description
CreateQueryIndexOptions	A CreateQueryIndexOptions for chaining options.

Remarks

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

View Source

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

Declaration

public void Deconstruct(out bool ignoreIfExistsValue, out bool deferredValue, out CancellationToken tokenValue, out string? scopeNameValue, out string? collectionNameValue, out string? queryContext, out TimeSpan timeoutValue)

Parameters

Type	Name	Description
bool	ignoreIfExistsValue
bool	deferredValue
CancellationToken	tokenValue
string	scopeNameValue
string	collectionNameValue
string	queryContext
TimeSpan	timeoutValue

View Source

Deferred(bool)

Declaration

public CreateQueryIndexOptions Deferred(bool deferred)

Parameters

Type	Name	Description
bool	deferred

Returns

Type	Description
CreateQueryIndexOptions

View Source

IgnoreIfExists(bool)

Declaration

public CreateQueryIndexOptions IgnoreIfExists(bool ignoreIfExists)

Parameters

Type	Name	Description
bool	ignoreIfExists

Returns

Type	Description
CreateQueryIndexOptions

View Source

RequestSpan(IRequestSpan)

Allows to pass in a custom IRequestSpan

Declaration

public CreateQueryIndexOptions RequestSpan(IRequestSpan span)

Parameters

Type	Name	Description
IRequestSpan	span	The custom IRequestSpan to use for this operation.

Returns

Type	Description
CreateQueryIndexOptions	This class for method chaining.

View Source

ScopeName(string)

Sets the scope name for this query management operation.

Declaration

[Obsolete("Use collection.QueryIndexes instead.")]
public CreateQueryIndexOptions ScopeName(string scopeName)

Parameters

Type	Name	Description
string	scopeName	The scope name to use.

Returns

Type	Description
CreateQueryIndexOptions	A CreateQueryIndexOptions for chaining options.

Remarks

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

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 CreateQueryIndexOptions Timeout(TimeSpan timeout)

Parameters

Type	Name	Description
TimeSpan	timeout	The duration of the Timeout. Set to 75s by default.

Returns

Type	Description
CreateQueryIndexOptions	This class for method chaining.