Class SSTFile

Constructors

constructor

new SSTFile(options): SSTFile
Parameters
- options: ISSTFileOptions
Returns SSTFile
- Defined in src/files/SST.ts:62

Properties

`Private` #bloomFileHandle

#bloomFileHandle: FileHandle

`Private` #bloomFilter

#bloomFilter: BloomFilter<availableDataTypeForHash>

`Private` #btree

#btree: default<PossibleKeyType, number> = ...

`Private` #defaultOptions

#defaultOptions: ISSTFileOptions = ...

`Private` #fileHandle

#fileHandle: FileHandle

`Private` #fileSize

#fileSize: number = -1

`Private` #headerData

#headerData: IHeaderData

`Private` #indexFileHandle

#indexFileHandle: FileHandle

`Private` #lastOffset

#lastOffset: number = 13

`Private` #lowerPair

#lowerPair: [PossibleKeyType, number] = ...

`Private` #metaData

#metaData: IMetadata

`Private` #mmap

#mmap: null | Buffer

`Private` #options

#options: DeepRequired<ISSTFileOptions>

Accessors

btree

get btree(): default<PossibleKeyType, number>
Returns default<PossibleKeyType, number>
- Defined in src/files/SST.ts:908

btreeSize

get btreeSize(): number
Returns number
- Defined in src/files/SST.ts:916

fileHandle

get fileHandle(): FileHandle
Returns FileHandle
- Defined in src/files/SST.ts:912

fileSize

get fileSize(): number
Returns number
- Defined in src/files/SST.ts:904

Methods

`Private` #batchVerifyChecksum

#batchVerifyChecksum(offset): Promise<void>
Parameters
- offset: number
Returns Promise<void>
- Defined in src/files/SST.ts:304

`Private` #buildAppendIndexTree

#buildAppendIndexTree(data, offset): Promise<void>
Parameters
- data: Uint8Array[]
- offset: number
Returns Promise<void>
- Defined in src/files/SST.ts:867

`Private` #buildIndexTree

#buildIndexTree(data): Promise<void>
Parameters
- data: Uint8Array[]
Returns Promise<void>
- Defined in src/files/SST.ts:424

`Private` #convertUint8ArrayToDataNode

#convertUint8ArrayToDataNode(line, offset): BufferNode
Parameters
- line: Uint8Array
- offset: number
Returns BufferNode
- Defined in src/files/SST.ts:415

`Private` #finalizeOptions

#finalizeOptions(options): DeepRequired<ISSTFileOptions>
Parameters
- options: ISSTFileOptions
Returns DeepRequired<ISSTFileOptions>
- Defined in src/files/SST.ts:88

`Private` #generateFileInfo

#generateFileInfo(): Promise<void>
Returns Promise<void>
- Defined in src/files/SST.ts:96

`Private` #getKeyFromUint8Array

#getKeyFromUint8Array(line): PossibleKeyType
Parameters
- line: Uint8Array
Returns PossibleKeyType
- Defined in src/files/SST.ts:447

`Private` #loadBloomFilter

#loadBloomFilter(): Promise<void>
Returns Promise<void>
- Defined in src/files/SST.ts:460

`Private` #loadIndexTree

#loadIndexTree(): Promise<void>
Returns Promise<void>
- Defined in src/files/SST.ts:469

`Private` #optiGetKeyBuffer

#optiGetKeyBuffer(chunk, offset): PossibleKeyType
Parameters
- chunk: Uint8Array
- offset: number
Returns PossibleKeyType
- Defined in src/files/SST.ts:668

`Private` #readFromOffset

#readFromOffset(offset): Promise<BufferNode>
Parameters
- offset: number
Returns Promise<BufferNode>
- Defined in src/files/SST.ts:406

`Private` #validateChecksum

#validateChecksum(offset_): Promise<void>
Parameters
- offset_: number
Returns Promise<void>
- Defined in src/files/SST.ts:317

`Private` #verifyFileInfo

#verifyFileInfo(): Promise<void>
Returns Promise<void>
- Defined in src/files/SST.ts:167

append

append(data): Promise<void>
we will never use this function damn we actually use this function for k way merge
Parameters
- data: Uint8Array[]
Returns Promise<void>
- Defined in src/files/SST.ts:827

clearData

clearData(): Promise<void>
Returns Promise<void>
- Defined in src/files/SST.ts:792

close

close(): Promise<void>
Returns Promise<void>
- Defined in src/files/SST.ts:540

hasKey

hasKey(key, useMmap): Promise<boolean>
Parameters
- key: PossibleKeyType
- useMmap: boolean
Returns Promise<boolean>
- Defined in src/files/SST.ts:802

mayHasKey

mayHasKey(key): boolean
Parameters
- key: PossibleKeyType
Returns boolean
- Defined in src/files/SST.ts:796

open

open(): Promise<void>
Returns Promise<void>
- Defined in src/files/SST.ts:483

optreadKeyMmap

optreadKeyMmap(key): Promise<null | BufferNode>
Parameters
- key: PossibleKeyType
Returns Promise<null | BufferNode>
- Defined in src/files/SST.ts:684

ping

ping(): Promise<number>
Returns Promise<number>
- Defined in src/files/SST.ts:928

readAll

readAll(returnDataNode): Promise<BufferNode[]>
Parameters
- returnDataNode: true
Returns Promise<BufferNode[]>
- Defined in src/files/SST.ts:739
readAll(returnDataNode): Promise<{
    checksum: Uint8Array | Buffer;
    dataBuffer: Uint8Array;
    delete: boolean;
    key: PossibleKeyType;
    keyType: dataType;
    length: number;
    offset: number;
    timestamp: number;
    value: unknown;
    valueType: dataType;
}[]>
Parameters
- returnDataNode: false
Returns Promise<{
    checksum: Uint8Array | Buffer;
    dataBuffer: Uint8Array;
    delete: boolean;
    key: PossibleKeyType;
    keyType: dataType;
    length: number;
    offset: number;
    timestamp: number;
    value: unknown;
    valueType: dataType;
}[]>
- Defined in src/files/SST.ts:740

readKey

readKey(key): Promise<null | BufferNode>
Parameters
- key: PossibleKeyType
Returns Promise<null | BufferNode>
- Defined in src/files/SST.ts:552

readKeyMmap

readKeyMmap(key): Promise<null | BufferNode>
Parameters
- key: PossibleKeyType
Returns Promise<null | BufferNode>
- Defined in src/files/SST.ts:608

readN

readN(n): Promise<BufferNode>
Parameters
- n: number
Returns Promise<BufferNode>
- Defined in src/files/SST.ts:727

stats

stats(): Promise<{
    bloomFilterSize: number;
    btreeSize: number;
    fileSize: number;
    kvCount: number;
}>
Returns Promise<{
    bloomFilterSize: number;
    btreeSize: number;
    fileSize: number;
    kvCount: number;
}>
- Defined in src/files/SST.ts:920

unlink

unlink(): Promise<void>
Returns Promise<void>
- Defined in src/files/SST.ts:810

write

write(data): Promise<void>
Parameters
- data: Uint8Array[]
Returns Promise<void>
- Defined in src/files/SST.ts:759

Class SSTFile

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SSTFile

Properties

Private #bloomFileHandle

Private #bloomFilter

Private #btree

Private #defaultOptions

Private #fileHandle

Private #fileSize

Private #headerData

Private #indexFileHandle

Private #lastOffset

Private #lowerPair

Private #metaData

Private #mmap

Private #options

Accessors

btree

Returns default<PossibleKeyType, number>

btreeSize

Returns number

fileHandle

Returns FileHandle

fileSize

Returns number

headerData

Returns IHeaderData

metaData

Returns IMetadata

options

Returns DeepRequired<ISSTFileOptions>

Methods

Private #batchVerifyChecksum

Parameters

Returns Promise<void>

Private #buildAppendIndexTree

Parameters

Returns Promise<void>

Private #buildIndexTree

Parameters

Returns Promise<void>

Private #convertUint8ArrayToDataNode

Parameters

Returns BufferNode

Private #finalizeOptions

Parameters

Returns DeepRequired<ISSTFileOptions>

Private #generateFileInfo

Returns Promise<void>

Private #getKeyFromUint8Array

Parameters

Returns PossibleKeyType

Private #loadBloomFilter

Returns Promise<void>

Private #loadIndexTree

Returns Promise<void>

Private #optiGetKeyBuffer

Parameters

Returns PossibleKeyType

Private #readFromOffset

Parameters

Returns Promise<BufferNode>

Private #validateChecksum

Parameters

Returns Promise<void>

Private #verifyFileInfo

Returns Promise<void>

append

Parameters

Returns Promise<void>

clearData

Returns Promise<void>

`Private` #bloomFileHandle

`Private` #bloomFilter

`Private` #btree

`Private` #defaultOptions

`Private` #fileHandle

`Private` #fileSize

`Private` #headerData

`Private` #indexFileHandle

`Private` #lastOffset

`Private` #lowerPair

`Private` #metaData

`Private` #mmap

`Private` #options

`Private` #batchVerifyChecksum

`Private` #buildAppendIndexTree

`Private` #buildIndexTree

`Private` #convertUint8ArrayToDataNode

`Private` #finalizeOptions

`Private` #generateFileInfo

`Private` #getKeyFromUint8Array

`Private` #loadBloomFilter

`Private` #loadIndexTree

`Private` #optiGetKeyBuffer

`Private` #readFromOffset

`Private` #validateChecksum

`Private` #verifyFileInfo

Returns Promise<{
checksum: Uint8Array | Buffer;
dataBuffer: Uint8Array;
delete: boolean;
key: PossibleKeyType;
keyType: dataType;
length: number;
offset: number;
timestamp: number;
value: unknown;
valueType: dataType;
}[]>

Returns Promise<{
bloomFilterSize: number;
btreeSize: number;
fileSize: number;
kvCount: number;
}>