Class ZDatabaseJsonFolder

Represents a set of database operations for a document database.

Implements

IZDatabaseDocument

Index

Constructors

Methods

count create delete read update

Constructors

constructor

new ZDatabaseJsonFolder(_options): ZDatabaseJsonFolder
Parameters
- _options: IZDatabaseOptions
Returns ZDatabaseJsonFolder
- Defined in database-json-folder/database-json-folder.mts:32

Methods

count

count(source, scope?): 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-json-folder/database-json-folder.mts:34

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-json-folder/database-json-folder.mts:43

delete

delete(source, scope?): 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-json-folder/database-json-folder.mts:127

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.
- 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-json-folder/database-json-folder.mts:118

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.
- 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-json-folder/database-json-folder.mts:91