Class ActiveTask

Schema for information about a running task.

Constructors

constructor

Properties

bulkGetAttempts? bulkGetDocs? changesDone? changesPending? checkpointedSourceSeq? checkpointInterval? continuous? database designDocument? docId? docsRead? docsWritten? docWriteFailures? index? indexerPid? missingRevisionsFound? node phase? pid processStatus? progress? replicationId? retry? revisionsChecked? source? sourceSeq? startedOn target? throughSeq? totalChanges? type updatedOn user? view?

Methods

deserialize serialize

Constructors

constructor

Properties

OptionalbulkGetAttempts

bulkGetAttempts?: number

The total count of attempted doc revisions fetched with _bulk_get. Available for replication type tasks.

OptionalbulkGetDocs

bulkGetDocs?: number

The total count of successful docs fetched with _bulk_get. Available for replication type tasks.

OptionalchangesDone

changesDone?: number

Processed changes. Available for database_compaction, indexer, search_indexer, view_compaction type tasks.

OptionalchangesPending

changesPending?: number

The count of changes not yet replicated. Available for replication type tasks.

OptionalcheckpointedSourceSeq

checkpointedSourceSeq?: string

The source sequence id which was last successfully replicated. Available for replication type tasks.

OptionalcheckpointInterval

checkpointInterval?: number

Specifies the checkpoint interval in ms. Available for replication type tasks.

Optionalcontinuous

continuous?: boolean

The replication configured to be continuous. Available for replication type tasks.

database

database: string

Source database.

OptionaldesignDocument

designDocument?: string

The design document that belongs to this task. Available for indexer, search_indexer, view_compaction type tasks.

OptionaldocId

docId?: string

Replication document ID. Available for replication type tasks.

OptionaldocsRead

docsRead?: number

Number of documents read. Available for replication type tasks.

OptionaldocsWritten

docsWritten?: number

Number of documents written to target. Available for replication type tasks.

OptionaldocWriteFailures

docWriteFailures?: number

Number of document write failures. Available for replication type tasks.

Optionalindex

index?: string

The search index that belongs to this task. Available for search_indexer type tasks.

OptionalindexerPid

indexerPid?: string

Indexer process ID. Available for indexer type tasks.

OptionalmissingRevisionsFound

missingRevisionsFound?: number

The count of docs which have been read from the source. Available for replication type tasks.

node

node: string

Cluster node where the task is running.

Optionalphase

phase?: string

The phase the active task is in. docid_sort, docid_copy, document_copy phases are available for database_compaction, while ids and view phases are available for view_compaction type tasks.

pid

pid: string

Process ID.

OptionalprocessStatus

processStatus?: string

Process status.

Optionalprogress

progress?: number

Current percentage progress. Available for database_compaction, indexer, search_indexer, view_compaction type tasks.

OptionalreplicationId

replicationId?: string

Replication ID. Available for replication type tasks.

Optionalretry

retry?: boolean

Indicates whether a compaction retry is currently running on the database. Available for database_compaction type tasks.

OptionalrevisionsChecked

revisionsChecked?: number

The count of revisions which have been checked since this replication began. Available for replication type tasks.

Optionalsource

source?: string

Replication source. Available for replication type tasks.

OptionalsourceSeq

sourceSeq?: string

The last sequence number obtained from the source database changes feed. Available for replication type tasks.

startedOn

startedOn: number

Schema for a Unix epoch timestamp.

Optionaltarget

target?: string

Replication target. Available for replication type tasks.

OptionalthroughSeq

throughSeq?: string

The last sequence number processed by the replicator. Available for replication type tasks.

OptionaltotalChanges

totalChanges?: number

Total changes to process. Available for database_compaction, indexer, search_indexer, view_compaction type tasks.

type

type: string

Operation type.

updatedOn

updatedOn: number

Schema for a Unix epoch timestamp.

Optionaluser

user?: string

Name of user running the process.

Optionalview

view?: number

Number of view indexes. Available for view_compaction type tasks.

Methods

Staticdeserialize

Staticserialize

Settings

Member Visibility

On This Page

Constructors
Properties
Methods