Class ZDatabaseMongo

Represents an IZDatabase object that connects to mongodb.

Implements

IZDatabaseDocument

Index

Constructors

constructor

new ZDatabaseMongo(options): ZDatabaseMongo
Initializes a new instance of this object.
Parameters
- options: IZDatabaseOptions
  The initialize options for the database.
Returns ZDatabaseMongo
- Defined in database-mongo/database-mongo.mts:26

Properties

`Private` _options

_options: IZDatabaseOptions = ...

Accessors

$database

get $database(): string
Gets the connection database.

Returns string
The connection database.
- Defined in database-mongo/database-mongo.mts:53

$options

get $options(): IZDatabaseOptions
Gets the connection options.

Returns IZDatabaseOptions
A copy of the connection options.
- Defined in database-mongo/database-mongo.mts:35

$url

get $url(): string
Gets the connection url.

Returns string
The connection host.
- Defined in database-mongo/database-mongo.mts:44

Methods

`Private` _createCullAggregate

_createCullAggregate(source, filter?): Document[]
Parameters
- source: string | IZDatabaseDocumentCollection
- Optional filter: IZFilter
Returns Document[]
- Defined in database-mongo/database-mongo.mts:114

`Private` _do

_do<T>(collection, fn): Promise<T>
Type Parameters
- T
Parameters
- collection: string | IZDatabaseDocumentCollection
- fn: ((col) => Promise<T>)
  - - (col): Promise<T>
    - Parameters
      col: Collection<Document>
      Returns Promise<T>
Returns Promise<T>
- Defined in database-mongo/database-mongo.mts:130

count

count(source, scope?): Promise<number>
Retrieves the count of documents from the source.
Parameters
- source: string | IZDatabaseDocumentCollection
  The source collection to count.
- Optional scope: IZFilter
  The data scope. If this is undefined, then the total number of documents in the database should be returned.
Returns Promise<number>
The total source count.
Implementation of IZDatabaseDocument.count
- Defined in database-mongo/database-mongo.mts:57

create

create<T>(source, template): Promise<T[]>
Inserts many documents in the database.
Type Parameters
- T
Parameters
- source: string
  The source to create into.
- template: T[]
  The template documents.
Returns Promise<T[]>
A list of matching documents that have been inserted into the database.
Implementation of IZDatabaseDocument.create
- Defined in database-mongo/database-mongo.mts:66

delete

delete(source, scope?): Promise<number>
Deletes documents from the database.
Parameters
- source: string
  The source to delete from.
- Optional scope: IZFilter
  The scope of data to delete.
Returns Promise<number>
The total number of documents deleted.
Implementation of IZDatabaseDocument.delete
- Defined in database-mongo/database-mongo.mts:107

read

read<T>(source, request?): Promise<T[]>
Reads documents from the database.
Type Parameters
- T
Parameters
- source: string | IZDatabaseDocumentCollection
  The source collection to read from.
- Optional request: IZDataRequest
  The request scope. If this is undefined, then all documents are read from the database.
Returns Promise<T[]>
A page of documents that match the request scope.
Implementation of IZDatabaseDocument.read
- Defined in database-mongo/database-mongo.mts:87

update

update<T>(source, template, scope?): Promise<number>
Updates fields in the database.
Type Parameters
- T
Parameters
- source: string
  The source to update.
- template: Partial<T>
  The partial template that contains the fields to update.
- Optional scope: IZFilter
  The scope to filter to. If this is undefined, then all documents are updated.
Returns Promise<number>
The total number of documents updated.
Implementation of IZDatabaseDocument.update
- Defined in database-mongo/database-mongo.mts:80

Class ZDatabaseMongo

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: IZDatabaseOptions

Returns ZDatabaseMongo

Properties

Private _options

Accessors

$database

Returns string

$options

Returns IZDatabaseOptions

$url

Returns string

Methods

Private _createCullAggregate

Parameters

source: string | IZDatabaseDocumentCollection

Optional filter: IZFilter

Returns Document[]

Private _do

Type Parameters

T

Parameters

collection: string | IZDatabaseDocumentCollection

fn: ((col) => Promise<T>)

Parameters

col: Collection<Document>

Returns Promise<T>

Returns Promise<T>

count

Parameters

source: string | IZDatabaseDocumentCollection

Optional scope: IZFilter

Returns Promise<number>

create

Type Parameters

T

Parameters

source: string

template: T[]

Returns Promise<T[]>

delete

Parameters

source: string

Optional scope: IZFilter

Returns Promise<number>

read

Type Parameters

T

Parameters

source: string | IZDatabaseDocumentCollection

Optional request: IZDataRequest

Returns Promise<T[]>

update

Type Parameters

T

Parameters

source: string

template: Partial<T>

Optional scope: IZFilter

Returns Promise<number>

Settings

Member Visibility

Theme

On This Page

`Private` _options

`Private` _createCullAggregate

`Optional` filter: IZFilter

`Private` _do

`Optional` scope: IZFilter

`Optional` scope: IZFilter

`Optional` request: IZDataRequest

`Optional` scope: IZFilter