Class IngestOptions

Inheritance
object
IngestOptions
Inherited Members
Namespace: Couchbase.Analytics
Assembly: Couchbase.NetClient.dll
Syntax
public class IngestOptions

Constructors

View Source

IngestOptions()

Declaration
public IngestOptions()

Methods

View Source

CancellationToken(CancellationToken)

An optional cancellation token to use for the query.

Declaration
public IngestOptions CancellationToken(CancellationToken token)
Parameters
Type Name Description
CancellationToken token
Returns
Type Description
IngestOptions
View Source

Expiry(TimeSpan)

The lifetime of the documents ingested by Couchbase. Overrides the default of zero (0) or infinite lifespan.

Declaration
public IngestOptions Expiry(TimeSpan expiry)
Parameters
Type Name Description
TimeSpan expiry
Returns
Type Description
IngestOptions
View Source

IdGenerator(Func<dynamic, string>)

Overrides the default Guid based key generator.

Declaration
public IngestOptions IdGenerator(Func<dynamic, string> idGenerator)
Parameters
Type Name Description
Func<dynamic, string> idGenerator

A Func{string} that generates a valid Couchbase server key.
Returns
Type Description
IngestOptions
View Source

IngestMethod(IngestMethod)

The ingest method to use when ingesting into Couchbase. Insert, Replace and Upsert are supported.

Declaration
public IngestOptions IngestMethod(IngestMethod ingestMethod)
Parameters
Type Name Description
IngestMethod ingestMethod
Returns
Type Description
IngestOptions
View Source

Timeout(TimeSpan)

The maximum time for the query to run. Overrides the default timeout of 75s.

Declaration
public IngestOptions Timeout(TimeSpan timeout)
Parameters
Type Name Description
TimeSpan timeout
Returns
Type Description
IngestOptions