class Database

import { Database } from "https://deno.land/x/aloedb@0.1.0/mod.ts";

AloeDB 🌿

Light, Embeddable, NoSQL database for Deno

Constructors

new

Database()

Database initialization.

new

Database(path: string)

new

Database(config: Partial<DatabaseConfig>)

new

Database(config?: Partial<DatabaseConfig> | string)

Type Parameters

optional

Schema extends Acceptable<Schema> = Document

Properties

private

readonly

config: DatabaseConfig

Database configuration.

private

readonly

storage: Storage

File storage manager.

documents: Schema[]

In-Memory documents storage.

WARNING: It is better not to modify these documents manually, as the changes will not pass the necessary checks. However, if you modify storage manualy ( bypassing compiler checks ), call the method db.save() to save your changes.

Methods

count(query?: Query<Schema> | QueryFunction<Schema>): Promise<number>

Count found documents.

deleteMany(query?: Query<Schema> | QueryFunction<Schema>): Promise<Schema[]>

Delete many documents.

deleteOne(query?: Query<Schema> | QueryFunction<Schema>): Promise<Schema | null>

Delete one document.

drop(): Promise<void>

Delete all documents.

findMany(query?: Query<Schema> | QueryFunction<Schema>): Promise<Schema[]>

Find multiple documents by search query.

findOne(query?: Query<Schema> | QueryFunction<Schema>): Promise<Schema | null>

Find document by search query.

insertMany(documents: Schema[]): Promise<Schema[]>

Inserts multiple documents.

insertOne(document: Schema): Promise<Schema>

Insert a document.

save(): Promise<void>

Write documents to the database file. Called automatically after each insert, update or delete operation.

updateMany(query: Query<Schema> | QueryFunction<Schema>, update: Update<Schema> | UpdateFunction<Schema>): Promise<Schema[]>

Modifies all documents that match search query.

updateOne(query: Query<Schema> | QueryFunction<Schema>, update: Update<Schema> | UpdateFunction<Schema>): Promise<Schema | null>

Modifies an existing document.