Class ViewIndexManager

ViewIndexManager is an interface which enables the management of view indexes on the cluster.

Index

Methods

dropDesignDocument getAllDesignDocuments getDesignDocument publishDesignDocument upsertDesignDocument

Methods

dropDesignDocument

dropDesignDocument(designDocName, options?, callback?): Promise<void>
Drops an existing design document.
Parameters
- designDocName: string
  The name of the design document to drop.
- Optional options: DropDesignDocumentOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
Deprecated
- Defined in lib/viewindexmanager.ts:547
dropDesignDocument(designDocName, namespace, options?, callback?): Promise<void>
Drops an existing design document.
Parameters
- designDocName: string
  The name of the design document to drop.
- namespace: DesignDocumentNamespace
  The DesignDocument namespace.
- Optional options: DropDesignDocumentOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/viewindexmanager.ts:561

getAllDesignDocuments

getAllDesignDocuments(options?, callback?): Promise<DesignDocument[]>
Returns a list of all the design documents in this bucket.
Parameters
- Optional options: GetAllDesignDocumentOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<DesignDocument[]>
  A node-style callback to be invoked after execution.
Returns Promise<DesignDocument[]>
Deprecated
- Defined in lib/viewindexmanager.ts:282
getAllDesignDocuments(namespace, options?, callback?): Promise<DesignDocument[]>
Returns a list of all the design documents in this bucket.
Parameters
- namespace: DesignDocumentNamespace
  The DesignDocument namespace.
- Optional options: GetAllDesignDocumentOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<DesignDocument[]>
  A node-style callback to be invoked after execution.
Returns Promise<DesignDocument[]>
- Defined in lib/viewindexmanager.ts:294

getDesignDocument

getDesignDocument(designDocName, options?, callback?): Promise<DesignDocument>
Returns the specified design document.
Parameters
- designDocName: string
  The name of the design document to fetch.
- Optional options: GetDesignDocumentOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<DesignDocument>
  A node-style callback to be invoked after execution.
Returns Promise<DesignDocument>
Deprecated
- Defined in lib/viewindexmanager.ts:367
getDesignDocument(designDocName, namespace, options?, callback?): Promise<DesignDocument>
Returns the specified design document.
Parameters
- designDocName: string
  The name of the design document to fetch.
- namespace: DesignDocumentNamespace
  The DesignDocument namespace.
- Optional options: GetDesignDocumentOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<DesignDocument>
  A node-style callback to be invoked after execution.
Returns Promise<DesignDocument>
- Defined in lib/viewindexmanager.ts:381

publishDesignDocument

publishDesignDocument(designDocName, options?, callback?): Promise<void>
Publishes a development design document to be a production design document. It does this by fetching the design document by the passed name with dev_ appended, and then performs an upsert of the production name (no dev_) with the data which was just fetched.
Parameters
- designDocName: string
  The name of the design document to publish.
- Optional options: PublishDesignDocumentOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/viewindexmanager.ts:639

upsertDesignDocument

upsertDesignDocument(designDoc, options?, callback?): Promise<void>
Creates or updates a design document.
Parameters
- designDoc: DesignDocument
  The DesignDocument to upsert.
- Optional options: UpsertDesignDocumentOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
Deprecated
- Defined in lib/viewindexmanager.ts:458
upsertDesignDocument(designDoc, namespace?, options?, callback?): Promise<void>
Creates or updates a design document.
Parameters
- designDoc: DesignDocument
  The DesignDocument to upsert.
- Optional namespace: DesignDocumentNamespace
  The DesignDocument namespace.
- Optional options: UpsertDesignDocumentOptions
  Optional parameters for this operation.
- Optional callback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/viewindexmanager.ts:472

Class ViewIndexManager

Index

Methods

Methods

dropDesignDocument

Parameters

Returns Promise<void>

Deprecated

Parameters

Returns Promise<void>

getAllDesignDocuments

Parameters

Returns Promise<DesignDocument[]>

Deprecated

Parameters

Returns Promise<DesignDocument[]>

getDesignDocument

Parameters

Returns Promise<DesignDocument>

Deprecated

Parameters

Returns Promise<DesignDocument>

publishDesignDocument

Parameters

Returns Promise<void>

upsertDesignDocument

Parameters

Returns Promise<void>

Deprecated

Parameters

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page