Interface PutDocumentParams

Parameters for the putDocument operation.

interface PutDocumentParams {
    batch?: string;
    contentType?: string;
    db: string;
    docId: string;
    document: Buffer | ReadableStream | Document;
    headers?: OutgoingHttpHeaders;
    ifMatch?: string;
    newEdits?: boolean;
    rev?: string;
}

Properties

batch? contentType? db docId document headers? ifMatch? newEdits? rev?

Properties

Optionalbatch

batch?: string

Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.

OptionalcontentType

contentType?: string

The type of the input.

db

db: string

Path parameter to specify the database name.

docId

docId: string

Path parameter to specify the document ID.

document

document: Buffer | ReadableStream | Document

HTTP request body for Document operations.

Optionalheaders

headers?: OutgoingHttpHeaders

OptionalifMatch

ifMatch?: string

Header parameter for a conditional HTTP request matching an ETag.

OptionalnewEdits

newEdits?: boolean

Query parameter to specify whether to prevent insertion of conflicting document revisions. If false, a well-formed _rev must be included in the document. False is used by the replicator to insert documents into the target database even if that leads to the creation of conflicts.

Avoid using this parameter, since this option applies document revisions without checking for conflicts, so it is very easy to accidentally end up with a large number of conflicts.

Optionalrev

rev?: string

Query parameter to specify a document revision.

Settings

Member Visibility

On This Page

Properties