@ibm-cloud/cloudant - v0.12.8
    Preparing search index...

    Class ActiveTask

    Schema for information about a running task.

    Index

    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

    Properties

    bulkGetAttempts?: number

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

    bulkGetDocs?: number

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

    changesDone?: number

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

    changesPending?: number

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

    checkpointedSourceSeq?: string

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

    checkpointInterval?: number

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

    continuous?: boolean

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

    database: string

    Source database.

    designDocument?: string

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

    docId?: string

    Replication document ID. Available for replication type tasks.

    docsRead?: number

    Number of documents read. Available for replication type tasks.

    docsWritten?: number

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

    docWriteFailures?: number

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

    index?: string

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

    indexerPid?: string

    Indexer process ID. Available for indexer type tasks.

    missingRevisionsFound?: number

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

    node: string

    Cluster node where the task is running.

    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: string

    Process ID.

    processStatus?: string

    Process status.

    progress?: number

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

    replicationId?: string

    Replication ID. Available for replication type tasks.

    retry?: boolean

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

    revisionsChecked?: number

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

    source?: string

    Replication source. Available for replication type tasks.

    sourceSeq?: string

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

    startedOn: number

    Schema for a Unix epoch timestamp.

    target?: string

    Replication target. Available for replication type tasks.

    throughSeq?: string

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

    totalChanges?: number

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

    type: string

    Operation type.

    updatedOn: number

    Schema for a Unix epoch timestamp.

    user?: string

    Name of user running the process.

    view?: number

    Number of view indexes. Available for view_compaction type tasks.

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods