Class CouchbaseDocumentLoader

loader for couchbase document

Hierarchy (view full)

Implements

Constructors

constructor

Methods

lazyLoad load

Constructors

constructor

  • new CouchbaseDocumentLoader(client, query, pageContentFields?, metadataFields?): CouchbaseDocumentLoader

  • construct Couchbase document loader with a requirement for couchbase cluster client

    Parameters

    • client: Cluster

      { Cluster } [ couchbase connected client to connect to database ]

    • query: string

      { string } [ query to get results from while loading the data ]

    • Optional pageContentFields: string[]

      { Array } [ filters fields of the document and shows these only ]

    • Optional metadataFields: string[]

      { Array } [ metadata fields required ]

    Returns CouchbaseDocumentLoader

Methods

lazyLoad

  • lazyLoad(): AsyncIterable<Document<Record<string, any>>>

  • Function to load documents based on iterator rather than full load

    Returns AsyncIterable<Document<Record<string, any>>>

    [ Returns an iterator to fetch documents ]

load

  • load(): Promise<Document<Record<string, any>>[]>

  • Function to load document based on query from couchbase

    Returns Promise<Document<Record<string, any>>[]>

    [ Returns a promise of all the documents as array ]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc