- Preparing search index...
- The search index is not available
@matrixai/db
Methods
batchClear
- batchClear(batch): void
-
Returns void
batchDel
- batchDel(batch, key): void
-
Returns void
batchDo
- batchDo(database, operations, options): Promise<void>
-
Returns Promise<void>
batchPut
- batchPut(batch, key, value): void
-
Parameters
-
-
key: string | Buffer
-
value: string | Buffer
Returns void
batchWrite
- batchWrite(batch, options): Promise<void>
-
Returns Promise<void>
dbApproximateSize
- dbApproximateSize(database, start, end): Promise<number>
-
Parameters
-
-
start: string | Buffer
-
end: string | Buffer
Returns Promise<number>
dbClear
- dbClear(database, options): Promise<void>
-
Returns Promise<void>
dbClose
- dbClose(database): Promise<void>
-
Returns Promise<void>
dbCompactRange
- dbCompactRange(database, start, end): Promise<void>
-
Parameters
-
-
start: string | Buffer
-
end: string | Buffer
Returns Promise<void>
dbCount
- dbCount(database, options): Promise<number>
-
Returns Promise<number>
dbDel
- dbDel(database, key, options): Promise<void>
-
Returns Promise<void>
dbGet
- dbGet(database, key, options): Promise<string>
-
Returns Promise<string>
- dbGet(database, key, options): Promise<Buffer>
-
Returns Promise<Buffer>
dbGetProperty
- dbGetProperty(database, property): string
-
Returns string
dbMultiGet
- dbMultiGet(database, keys, options): Promise<string[]>
-
Returns Promise<string[]>
- dbMultiGet(database, keys, options): Promise<Buffer[]>
-
Returns Promise<Buffer[]>
dbOpen
- dbOpen(database, location, options): Promise<void>
-
Returns Promise<void>
dbPut
- dbPut(database, key, value, options): Promise<void>
-
Parameters
-
-
key: string | Buffer
-
value: string | Buffer
-
Returns Promise<void>
destroyDb
- destroyDb(location): Promise<void>
-
Returns Promise<void>
iteratorClose
- iteratorClose(iterator): Promise<void>
-
Returns Promise<void>
iteratorNextv
- iteratorNextv<K, V>(iterator, size): Promise<[[K, V][], boolean]>
-
Type Parameters
-
K extends string | Buffer
-
V extends string | Buffer
Returns Promise<[[K, V][], boolean]>
iteratorSeek
- iteratorSeek<K>(iterator, target): void
-
Type Parameters
-
K extends string | Buffer
Returns void
repairDb
- repairDb(location): Promise<void>
-
Returns Promise<void>
snapshotRelease
- snapshotRelease(snapshot): Promise<void>
-
Returns Promise<void>
transactionClear
- transactionClear(transaction, options): Promise<void>
-
Returns Promise<void>
transactionCommit
- transactionCommit(transaction): Promise<void>
-
Returns Promise<void>
transactionCount
- transactionCount(transaction, options): Promise<number>
-
Returns Promise<number>
transactionDel
- transactionDel(transaction, key): Promise<void>
-
Returns Promise<void>
transactionGet
- transactionGet(transaction, key, options): Promise<string>
-
Returns Promise<string>
- transactionGet(transaction, key, options): Promise<Buffer>
-
Returns Promise<Buffer>
transactionGetForUpdate
- transactionGetForUpdate(transaction, key, options): Promise<string>
-
Returns Promise<string>
- transactionGetForUpdate(transaction, key, options): Promise<Buffer>
-
Returns Promise<Buffer>
transactionId
- transactionId(transaction): number
-
Returns number
transactionIteratorInit
- transactionIteratorInit(transaction, options): RocksDBIterator<Buffer, Buffer>
-
- transactionIteratorInit(transaction, options): RocksDBIterator<Buffer, string>
-
- transactionIteratorInit(transaction, options): RocksDBIterator<string, Buffer>
-
- transactionIteratorInit(database, options): RocksDBIterator<string, string>
-
transactionMultiGet
- transactionMultiGet(transaction, keys, options): Promise<string[]>
-
Parameters
-
-
keys: (string | Buffer)[]
-
Returns Promise<string[]>
- transactionMultiGet(transaction, keys, options): Promise<Buffer[]>
-
Parameters
-
-
keys: (string | Buffer)[]
-
Returns Promise<Buffer[]>
transactionMultiGetForUpdate
- transactionMultiGetForUpdate(transaction, keys, options): Promise<string[]>
-
Parameters
-
-
keys: (string | Buffer)[]
-
Returns Promise<string[]>
- transactionMultiGetForUpdate(transaction, keys, options): Promise<Buffer[]>
-
Parameters
-
-
keys: (string | Buffer)[]
-
Returns Promise<Buffer[]>
transactionPut
- transactionPut(transaction, key, value): Promise<void>
-
Parameters
-
-
key: string | Buffer
-
value: string | Buffer
Returns Promise<void>
transactionRollback
- transactionRollback(transaction): Promise<void>
-
Returns Promise<void>