Class Column

Hierarchy

TypedEmitter
- Column

Index

Constructors

constructor

new Column(options, table): Column
Parameters
- options: IColumnOptions
- table: Table
Returns Column
Overrides TypedEmitter.constructor
- Defined in src/structs/Column.ts:24

Properties

`Private` #cache

#cache: Cache

`Private` #inMem

#inMem: InMemoryBuffer

`Private` #kvLength

#kvLength: number

`Private` #options

#options: IColumnOptions

`Private` #sstManager

#sstManager: SSTManager

`Private` #table

#table: Table

`Private` #wal

#wal: WalFile

`Static` defaultMaxListeners

defaultMaxListeners: number

Accessors

Methods

`Private` #flush

#flush(): Promise<void>
Returns Promise<void>
- Defined in src/structs/Column.ts:70

`Private` #syncLogs

#syncLogs(): Promise<void>
Returns Promise<void>
- Defined in src/structs/Column.ts:75

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

clear

clear(): Promise<void>
Returns Promise<void>
- Defined in src/structs/Column.ts:180

close

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

delete

delete(key): Promise<undefined | false>
Parameters
- key: PossibleKeyType
Returns Promise<undefined | false>
- Defined in src/structs/Column.ts:153

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(key): Promise<undefined | null | DataNode>
Parameters
- key: PossibleKeyType
Returns Promise<undefined | null | DataNode>
- Defined in src/structs/Column.ts:127

getMaxListeners

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

has

has(key): Promise<boolean>
Parameters
- key: PossibleKeyType
Returns Promise<boolean>
- Defined in src/structs/Column.ts:145

init

init(): Promise<void>
Returns Promise<void>
- Defined in src/structs/Column.ts:90

insert

insert(key, value): void
Parameters
- key: PossibleKeyType
- value: unknown
Returns void
- Defined in src/structs/Column.ts:100

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

mayHasKey

mayHasKey(key): boolean
Parameters
- key: PossibleKeyType
Returns boolean
- Defined in src/structs/Column.ts:141

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/Column.ts:194

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

readLogs

readLogs(): Promise<Uint8Array[]>
Returns Promise<Uint8Array[]>
- Defined in src/structs/Column.ts:96

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

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

setPath

setPath(path): void
Parameters
- path: string
Returns void
- Defined in src/structs/Column.ts:44

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/Column.ts:186

`Static` defaultOptions

defaultOptions(): IColumnOptions
Returns IColumnOptions
- Defined in src/structs/Column.ts:54

Class Column

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Column

Properties

Private #cache

Private #inMem

Private #kvLength

Private #options

Private #sstManager

Private #table

Private #wal

Static defaultMaxListeners

Accessors

inMem

Returns InMemoryBuffer

options

Returns IColumnOptions

table

Returns Table

wal

Returns WalFile

Methods

Private #flush

Returns Promise<void>

Private #syncLogs

Returns Promise<void>

addListener

Type Parameters

Parameters

Returns this

clear

Returns Promise<void>

close

Returns Promise<void>

delete

Parameters

Returns Promise<undefined | false>

emit

Type Parameters

Parameters

Returns boolean

eventNames

Type Parameters

Returns U[]

get

Parameters

Returns Promise<undefined | null | DataNode>

getMaxListeners

Returns number

has

Parameters

Returns Promise<boolean>

init

Returns Promise<void>

insert

Parameters

Returns void

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns DefaultListener[U][]

mayHasKey

Parameters

Returns boolean

off

Type Parameters

Parameters

Returns this

on

`Private` #cache

`Private` #inMem

`Private` #kvLength

`Private` #options

`Private` #sstManager

`Private` #table

`Private` #wal

`Static` defaultMaxListeners

`Private` #flush

`Private` #syncLogs

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;
};
}>

`Static` defaultOptions