Class: LevelDBStorage<T>

Defined in: index.ts:47

LevelDB storage implementation class

Extends

Type Parameters

T

T extends SchemaTypeRecord

Constructors

Constructor

typescript
1
new LevelDBStorage<T>(level, name, schemas, options): LevelDBStorage<T>

Defined in: index.ts:48

Parameters

level

Level

name

string

schemas

T

options

any

Returns

LevelDBStorage<T>

Overrides

BaseStorage<T>.constructor

Properties

core

typescript
1
readonly core: CoreStorage

Defined in: ../../ridb-core/build/ridb_core.d.ts:368

Inherited from

BaseStorage.core

dbName

typescript
1
readonly dbName: string

Defined in: ../../ridb-core/build/ridb_core.d.ts:365

Inherited from

BaseStorage.dbName

level

typescript
1
level: Level

Defined in: index.ts:48

options

typescript
1
readonly options: BaseStorageOptions

Defined in: ../../ridb-core/build/ridb_core.d.ts:367

Inherited from

BaseStorage.options

schemas

typescript
1
readonly schemas: Record<keyof Schemas, Schema<Schemas[keyof Schemas]>>

Defined in: ../../ridb-core/build/ridb_core.d.ts:366

Inherited from

BaseStorage.schemas

Methods

addIndexSchemas()

typescript
1
addIndexSchemas(): null

Defined in: ../../ridb-core/build/ridb_core.d.ts:378

Returns

null

Inherited from

BaseStorage.addIndexSchemas

close()

typescript
1
close(): Promise<void>

Defined in: index.ts:77

Close the database

Returns

Promise<void>

Overrides

BaseStorage.close

count()

typescript
1
count(collectionName, query, options?): Promise<number>

Defined in: index.ts:148

Count documents matching a query (supports offset & limit)

Parameters

collectionName

keyof T

query

QueryType<T[keyof T]>

options?

QueryOptions

Returns

Promise<number>

Overrides

BaseStorage.count

find()

typescript
1
find(collectionName, query, options?): Promise<Doc<T[keyof T]>[]>

Defined in: index.ts:197

Find documents matching a query with pagination

Parameters

collectionName

keyof T

query

QueryType<T[keyof T]>

options?

QueryOptions

Returns

Promise<Doc<T[keyof T]>[]>

Overrides

BaseStorage.find

findDocumentById()

typescript
1
findDocumentById(collectionName, id): Promise<null | Doc<T[keyof T]>>

Defined in: index.ts:82

Find a document by its ID

Parameters

collectionName

keyof T

id

string

Returns

Promise<null | Doc<T[keyof T]>>

Overrides

BaseStorage.findDocumentById

getOption()

typescript
1
getOption(name): undefined | string | number | boolean

Defined in: ../../ridb-core/build/ridb_core.d.ts:375

Parameters

name

string

Returns

undefined | string | number | boolean

Inherited from

BaseStorage.getOption

getSchema()

typescript
1
getSchema(name): Schema<any>

Defined in: ../../ridb-core/build/ridb_core.d.ts:376

Parameters

name

string

Returns

Schema<any>

Inherited from

BaseStorage.getSchema

start()

typescript
1
start(): Promise<void>

Defined in: index.ts:72

Start the database

Returns

Promise<void>

Overrides

BaseStorage.start

write()

typescript
1
write(op): Promise<Doc<T[keyof T]>>

Defined in: index.ts:104

Write an operation (insert, update, delete)

Parameters

op

Operation<T[keyof T]>

Returns

Promise<Doc<T[keyof T]>>

Overrides

BaseStorage.write

create()

typescript
1
static create<SchemasCreate>(name, schemas, options?): Promise<LevelDBStorage<SchemasCreate>>

Defined in: index.ts:60

Create a new LevelDB storage instance

Type Parameters

SchemasCreate

SchemasCreate extends SchemaTypeRecord

Parameters

name

string

Database name

schemas

SchemasCreate

Collection schemas

options?

BaseStorageOptions

Storage options

Returns

Promise<LevelDBStorage<SchemasCreate>>

A new Instance of LevelDB storage

Overrides

BaseStorage.create