Class ZDatabaseMongo

Represents an IZDatabase object that connects to mongodb.

Hierarchy

ZDatabaseMongo

Implements

IZDatabase

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new ZDatabaseMongo(): ZDatabaseMongo

Returns ZDatabaseMongo

Accessors

$database

get $database(): string

- Defined in packages/works.dal/src/database/database-mongo.class.ts:51
Gets the connection database.

Returns string
The connection database.

$options

get $options(): IZDatabaseOptions

- Defined in packages/works.dal/src/database/database-mongo.class.ts:33
Gets the connection options.

Returns IZDatabaseOptions
A copy of the connection options.

$url

get $url(): string

- Defined in packages/works.dal/src/database/database-mongo.class.ts:42
Gets the connection url.

Returns string
The connection host.

Methods

count

count(source: string): IZDatabaseQuery<number>

Implementation of IZDatabase.count
- Defined in packages/works.dal/src/database/database-mongo.class.ts:62
Returns a query that gives the document count for a filter.

Parameters
- source: string
  
  The source to count.
Returns IZDatabaseQuery<number>
The count query.

create

create<T>(source: string, template: T[]): IZDatabaseQuery<T[]>

Implementation of IZDatabase.create
- Defined in packages/works.dal/src/database/database-mongo.class.ts:79
Adds all documents in template to the database.

Type parameters
- T
Parameters
- source: string
  
  The source to modify.
- template: T[]
  
  The list of documents to add.
Returns IZDatabaseQuery<T[]>
The create query.

delete

delete(source: string): IZDatabaseQuery<number>

Implementation of IZDatabase.delete
- Defined in packages/works.dal/src/database/database-mongo.class.ts:152
Deletes documents from the database that match a query.

WARNING: If you do not specify a filter object for the delete, then the collection is completely emptied.

Parameters
- source: string
  
  The source to delete from.
Returns IZDatabaseQuery<number>
The delete query.

read

read<T>(source: string): IZDatabaseQuery<T[]>

Implementation of IZDatabase.read
- Defined in packages/works.dal/src/database/database-mongo.class.ts:115
Reads document from the database that match a query.

Type parameters
- T
Parameters
- source: string
  
  The source to query.
Returns IZDatabaseQuery<T[]>
The read query.

update

update<T>(source: string, template: Partial<T>): IZDatabaseQuery<number>

Implementation of IZDatabase.update
- Defined in packages/works.dal/src/database/database-mongo.class.ts:99
Updates all documents that match the query filter with template.

Type parameters
- T
Parameters
- source: string
  
  The source to update.
- template: Partial<T>
  
  The template to update with.
Returns IZDatabaseQuery<number>
The update query.

Static connect

connect(options: IZDatabaseOptions): ZDatabaseMongo

- Defined in packages/works.dal/src/database/database-mongo.class.ts:20
Establishes connection parameters to a database.

Parameters
- options: IZDatabaseOptions
  
  The database options. All options are used here.
Returns ZDatabaseMongo
A new database can can be used to connect and query a mongodb database instance.

Generated using TypeDoc