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

Optional batch

batch?: string

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

Optional contentType

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.

Optional headers

headers?: OutgoingHttpHeaders

Optional ifMatch

ifMatch?: string

Header parameter to specify the document revision. Alternative to rev query parameter.

Optional newEdits

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.

Optional rev

rev?: string

Query parameter to specify a document revision.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc