Class ZDatabaseDocumentCollectionBuilder

A builder that builds a collection for a document database.

Index

Constructors

Methods

Constructors

constructor

new ZDatabaseDocumentCollectionBuilder(
name: string,
): ZDatabaseDocumentCollectionBuilder
Initializes a new instance of this object.
Parameters
- name: string
  The name of the collection.
Returns ZDatabaseDocumentCollectionBuilder
- Defined in database/database-document-collection.mts:27

Methods

build

build(): IZDatabaseDocumentCollection
Returns the built collection.

Returns IZDatabaseDocumentCollection
The built collection.
- Defined in database/database-document-collection.mts:65

join

join(
    target: string,
    local: string,
    foreign: string,
    as: string,
): ZDatabaseDocumentCollectionBuilder
Adds a left outer join to the collection.
Parameters
- target: string
  The target collection to join against.
- local: string
  The local field to match on.
- foreign: string
  The foreign field to match the local to.
- as: string
  The output property.
Returns ZDatabaseDocumentCollectionBuilder
This object.
- Defined in database/database-document-collection.mts:49