Class Database

Hierarchy

TypedEmitter
- Database

Constructors

constructor

new Database(options): Database
Parameters
- options: IDatabaseOptions
Returns Database
Overrides TypedEmitter.constructor
- Defined in src/structs/Database.ts:11

Properties

`Private` #options

#options: IDatabaseOptions

`Private` #readyAt

#readyAt: number = -1

`Private` #tables

#tables: Map<string, Table> = ...

`Static` defaultMaxListeners

defaultMaxListeners: number

Accessors

name

get name(): string
Returns string
- Defined in src/structs/Database.ts:214

options

get options(): IDatabaseOptions
Returns IDatabaseOptions
- Defined in src/structs/Database.ts:206

path

get path(): string
Returns string
- Defined in src/structs/Database.ts:210

readyAt

get readyAt(): number
Returns number
- Defined in src/structs/Database.ts:198

size

get size(): number
Returns number
- Defined in src/structs/Database.ts:218

tables

get tables(): Map<string, Table>
Returns Map<string, Table>
- Defined in src/structs/Database.ts:202

Methods

`Private` #areAllTablesReady

#areAllTablesReady(table): void
Parameters
- table: Table
Returns void
- Defined in src/structs/Database.ts:16

addListener

addListener(event, listener): this
Type Parameters
- U extends string | number
Parameters
- event: U
- listener: DefaultListener[U]
Returns this
Inherited from TypedEmitter.addListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:11

bloomCheck

bloomCheck(table, data): boolean
Parameters
- table: string
- data: {
  column: string;
  key: PossibleKeyType;
  }
  - column: string
  - key: PossibleKeyType
Returns boolean
- Defined in src/structs/Database.ts:105

clear

clear(table, column?): Promise<void>
Parameters
- table: string
- Optional column: string
Returns Promise<void>
- Defined in src/structs/Database.ts:141

close

close(): Promise<void>
Returns Promise<void>
- Defined in src/structs/Database.ts:44

delete

delete(table, data): Promise<void>
Parameters
- table: string
- data: {
 column: string;
 key: PossibleKeyType;
 }
 - column: string
 - key: PossibleKeyType
Returns Promise<void>
- Defined in src/structs/Database.ts:123

emit

emit(event, ...args): boolean
Type Parameters
- U extends string | number
Parameters
- event: U
- Rest ...args: Parameters<DefaultListener[U]>
Returns boolean
Inherited from TypedEmitter.emit
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:19

eventNames

eventNames(): U[]
Type Parameters
- U extends string | number
Returns U[]
Inherited from TypedEmitter.eventNames
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:20

get

get(table, data): Promise<undefined | null | DataNode>
Parameters
- table: string
- data: {
 column: string;
 key: PossibleKeyType;
 }
 - column: string
 - key: PossibleKeyType
Returns Promise<undefined | null | DataNode>
- Defined in src/structs/Database.ts:69

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from TypedEmitter.getMaxListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:24

has

has(table, data): Promise<boolean>
Parameters
- table: string
- data: {
 column: string;
 key: PossibleKeyType;
 }
 - column: string
 - key: PossibleKeyType
Returns Promise<boolean>
- Defined in src/structs/Database.ts:87

init

init(): Promise<Database>
Returns Promise<Database>
- Defined in src/structs/Database.ts:25

insert

insert(table, data): void
Parameters
- table: string
- data: {
      column: string;
      key: PossibleKeyType;
      value: PossibleKeyType;
  }
  - column: string
  - key: PossibleKeyType
  - value: PossibleKeyType
Returns void
- Defined in src/structs/Database.ts:50

listenerCount

listenerCount(type): number
Parameters
- type: string | number
Returns number
Inherited from TypedEmitter.listenerCount
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:21

listeners

listeners(type): DefaultListener[U][]
Type Parameters
- U extends string | number
Parameters
- type: U
Returns DefaultListener[U][]
Inherited from TypedEmitter.listeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:22

off

off(event, listener): this
Type Parameters
- U extends string | number
Parameters
- event: U
- listener: DefaultListener[U]
Returns this
Inherited from TypedEmitter.off
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:18

on

on(event, listener): this
Type Parameters
- U extends string | number
Parameters
- event: U
- listener: DefaultListener[U]
Returns this
Inherited from TypedEmitter.on
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:17

once

once(event, listener): this
Type Parameters
- U extends string | number
Parameters
- event: U
- listener: DefaultListener[U]
Returns this
Inherited from TypedEmitter.once
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:16

ping

ping(): Promise<number>
Returns Promise<number>
- Defined in src/structs/Database.ts:153

prependListener

prependListener(event, listener): this
Type Parameters
- U extends string | number
Parameters
- event: U
- listener: DefaultListener[U]
Returns this
Inherited from TypedEmitter.prependListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:12

prependOnceListener

prependOnceListener(event, listener): this
Type Parameters
- U extends string | number
Parameters
- event: U
- listener: DefaultListener[U]
Returns this
Inherited from TypedEmitter.prependOnceListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:13

rawListeners

rawListeners(type): DefaultListener[U][]
Type Parameters
- U extends string | number
Parameters
- type: U
Returns DefaultListener[U][]
Inherited from TypedEmitter.rawListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:23

removeAllListeners

removeAllListeners(event?): this
Parameters
- Optional event: string | number
Returns this
Inherited from TypedEmitter.removeAllListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:15

removeListener

removeListener(event, listener): this
Type Parameters
- U extends string | number
Parameters
- event: U
- listener: DefaultListener[U]
Returns this
Inherited from TypedEmitter.removeListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:14

restoreFromSnapshot

restoreFromSnapshot(snapshotPath): Promise<void>
Parameters
- snapshotPath: string
Returns Promise<void>
- Defined in src/structs/Database.ts:187

setMaxListeners

setMaxListeners(n): this
Parameters
- n: number
Returns this
Inherited from TypedEmitter.setMaxListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:25

snapshot

snapshot(): Promise<string>
Returns Promise<string>
- Defined in src/structs/Database.ts:169

stats

stats(): Promise<{
 inMem: {
 isEmpty: boolean;
 lock: boolean;
 size: number;
 };
 sst: {
 count: number;
 level: number;
 ssts: {
 bloomFilterSize: number;
 btreeSize: number;
 fileSize: number;
 kvCount: number;
 }[];
 }[];
 wal: {
 entries: number;
 fileSize: number;
 };
}[][]>
Returns Promise<{
 inMem: {
 isEmpty: boolean;
 lock: boolean;
 size: number;
 };
 sst: {
 count: number;
 level: number;
 ssts: {
 bloomFilterSize: number;
 btreeSize: number;
 fileSize: number;
 kvCount: number;
 }[];
 }[];
 wal: {
 entries: number;
 fileSize: number;
 };
}[][]>
- Defined in src/structs/Database.ts:161

Class Database

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Database

Properties

Private #options

Private #readyAt

Private #tables

Static defaultMaxListeners

Accessors

name

Returns string

options

Returns IDatabaseOptions

path

Returns string

readyAt

Returns number

size

Returns number

tables

Returns Map<string, Table>

Methods

Private #areAllTablesReady

Parameters

Returns void

addListener

Type Parameters

Parameters

Returns this

bloomCheck

Parameters

column: string

key: PossibleKeyType

Returns boolean

clear

Parameters

Returns Promise<void>

close

Returns Promise<void>

delete

Parameters

column: string

key: PossibleKeyType

Returns Promise<void>

emit

Type Parameters

Parameters

Returns boolean

eventNames

Type Parameters

Returns U[]

get

Parameters

column: string

key: PossibleKeyType

Returns Promise<undefined | null | DataNode>

getMaxListeners

Returns number

has

Parameters

column: string

key: PossibleKeyType

Returns Promise<boolean>

init

Returns Promise<Database>

insert

Parameters

column: string

key: PossibleKeyType

value: PossibleKeyType

Returns void

listenerCount

`Private` #options

`Private` #readyAt

`Private` #tables

`Static` defaultMaxListeners

`Private` #areAllTablesReady

Returns Promise<{
inMem: {
isEmpty: boolean;
lock: boolean;
size: number;
};
sst: {
count: number;
level: number;
ssts: {
bloomFilterSize: number;
btreeSize: number;
fileSize: number;
kvCount: number;
}[];
}[];
wal: {
entries: number;
fileSize: number;
};
}[][]>