Class ZDatabaseMongo

Represents an IZDatabase object that connects to mongodb.

Implements

IZDatabaseDocument

Index

Constructors

Accessors

$database $options $url

Methods

count create delete read update

Constructors

constructor

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

Accessors

$database

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

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

$options

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

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

$url

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

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

Methods

count

count(
source: string | IZDatabaseDocumentCollection,
scope?: IZFilter,
): Promise<number>
Retrieves the count of documents from the source.
Parameters
- source: string | IZDatabaseDocumentCollection
  The source collection to count.
- Optionalscope: 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.mts:60

create

create<T>(source: string, template: T[]): 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.mts:72

delete

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

read

read<T>(
source: string | IZDatabaseDocumentCollection,
request?: IZDataRequest,
): Promise<T[]>
Reads documents from the database.
Type Parameters
- T
Parameters
- source: string | IZDatabaseDocumentCollection
  The source collection to read from.
- Optionalrequest: 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.mts:104

update

update<T>(
    source: string,
    template: Partial<T>,
    scope?: IZFilter,
): 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.
- Optionalscope: 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.mts:91