Interface RocksDB

Hierarchy

RocksDB

Methods

batchClear

batchClear(batch): void
Parameters
- batch: RocksDBBatch
Returns void
- Defined in src/native/rocksdb.ts:142

batchDel

batchDel(batch, key): void
Parameters
- batch: RocksDBBatch
- key: string | Buffer
Returns void
- Defined in src/native/rocksdb.ts:141

batchDo

batchDo(database, operations, options, callback): void
Parameters
- database: RocksDBDatabase
- operations: (RocksDBBatchPutOperation | RocksDBBatchDelOperation)[]
- options: RocksDBPutOptions
- callback: Callback<[], void>
Returns void
- Defined in src/native/rocksdb.ts:129

batchInit

batchInit(database): RocksDBBatch
Parameters
- database: RocksDBDatabase
Returns RocksDBBatch
- Defined in src/native/rocksdb.ts:135

batchPut

batchPut(batch, key, value): void
Parameters
- batch: RocksDBBatch
- key: string | Buffer
- value: string | Buffer
Returns void
- Defined in src/native/rocksdb.ts:136

batchWrite

batchWrite(batch, options, callback): void
Parameters
- batch: RocksDBBatch
- options: RocksDBPutOptions
- callback: Callback<[], void>
Returns void
- Defined in src/native/rocksdb.ts:143

dbApproximateSize

dbApproximateSize(database, start, end, callback): void
Parameters
- database: RocksDBDatabase
- start: string | Buffer
- end: string | Buffer
- callback: Callback<[number], void>
Returns void
- Defined in src/native/rocksdb.ts:80

dbClear

dbClear(database, options, callback): void
Parameters
- database: RocksDBDatabase
- options: RocksDBClearOptions
- callback: Callback<[], void>
Returns void
- Defined in src/native/rocksdb.ts:70

dbClose

dbClose(database, callback): void
Parameters
- database: RocksDBDatabase
- callback: Callback<[], void>
Returns void
- Defined in src/native/rocksdb.ts:32

dbCompactRange

dbCompactRange(database, start, end, callback): void
Parameters
- database: RocksDBDatabase
- start: string | Buffer
- end: string | Buffer
- callback: Callback<[], void>
Returns void
- Defined in src/native/rocksdb.ts:86

dbCount

dbCount(database, options, callback): void
Parameters
- database: RocksDBDatabase
- options: RocksDBCountOptions
- callback: Callback<[number], void>
Returns void
- Defined in src/native/rocksdb.ts:75

dbDel

dbDel(database, key, options, callback): void
Parameters
- database: RocksDBDatabase
- key: string | Buffer
- options: RocksDBPutOptions
- callback: Callback<[], void>
Returns void
- Defined in src/native/rocksdb.ts:64

dbGet

dbGet(database, key, options, callback): void
Parameters
- database: RocksDBDatabase
- key: string | Buffer
- options: RocksDBGetOptions & {
  valueEncoding?: "utf8";
  }
- callback: Callback<[string], void>
Returns void
- Defined in src/native/rocksdb.ts:33
dbGet(database, key, options, callback): void
Parameters
- database: RocksDBDatabase
- key: string | Buffer
- options: RocksDBGetOptions & {
  valueEncoding: "buffer";
  }
- callback: Callback<[Buffer], void>
Returns void
- Defined in src/native/rocksdb.ts:39

dbGetProperty

dbGetProperty(database, property): string
Parameters
- database: RocksDBDatabase
- property: string
Returns string
- Defined in src/native/rocksdb.ts:92

dbInit

dbInit(): RocksDBDatabase
Returns RocksDBDatabase
- Defined in src/native/rocksdb.ts:25

dbMultiGet

dbMultiGet(database, keys, options, callback): void
Parameters
- database: RocksDBDatabase
- keys: (string | Buffer)[]
- options: RocksDBGetOptions & {
  valueEncoding?: "utf8";
  }
- callback: Callback<[string[]], void>
Returns void
- Defined in src/native/rocksdb.ts:45
dbMultiGet(database, keys, options, callback): void
Parameters
- database: RocksDBDatabase
- keys: (string | Buffer)[]
- options: RocksDBGetOptions & {
  valueEncoding: "buffer";
  }
- callback: Callback<[Buffer[]], void>
Returns void
- Defined in src/native/rocksdb.ts:51

dbOpen

dbOpen(database, location, options, callback): void
Parameters
- database: RocksDBDatabase
- location: string
- options: RocksDBDatabaseOptions
- callback: Callback<[], void>
Returns void
- Defined in src/native/rocksdb.ts:26

dbPut

dbPut(database, key, value, options, callback): void
Parameters
- database: RocksDBDatabase
- key: string | Buffer
- value: string | Buffer
- options: RocksDBPutOptions
- callback: Callback<[], void>
Returns void
- Defined in src/native/rocksdb.ts:57

destroyDb

destroyDb(location, callback): void
Parameters
- location: string
- callback: Callback<[], void>
Returns void
- Defined in src/native/rocksdb.ts:98

iteratorClose

iteratorClose(iterator, callback): void
Parameters
- iterator: RocksDBIterator
- callback: Callback<[], void>
Returns void
- Defined in src/native/rocksdb.ts:123

iteratorInit

iteratorInit(database, options): RocksDBIterator<Buffer, Buffer>
Parameters
- database: RocksDBDatabase
- options: RocksDBGetOptions<RocksDBSnapshot> & RocksDBRangeOptions & {
      highWaterMarkBytes?: number;
      keyEncoding?: "utf8" | "buffer";
      keys?: boolean;
      values?: boolean;
  } & {
      keyEncoding: "buffer";
      valueEncoding: "buffer";
  }
Returns RocksDBIterator<Buffer, Buffer>
- Defined in src/native/rocksdb.ts:100
iteratorInit(database, options): RocksDBIterator<Buffer, string>
Parameters
- database: RocksDBDatabase
- options: RocksDBGetOptions<RocksDBSnapshot> & RocksDBRangeOptions & {
      highWaterMarkBytes?: number;
      keyEncoding?: "utf8" | "buffer";
      keys?: boolean;
      values?: boolean;
  } & {
      keyEncoding: "buffer";
  }
Returns RocksDBIterator<Buffer, string>
- Defined in src/native/rocksdb.ts:107
iteratorInit(database, options): RocksDBIterator<string, Buffer>
Parameters
- database: RocksDBDatabase
- options: RocksDBGetOptions<RocksDBSnapshot> & RocksDBRangeOptions & {
      highWaterMarkBytes?: number;
      keyEncoding?: "utf8" | "buffer";
      keys?: boolean;
      values?: boolean;
  } & {
      valueEncoding: "buffer";
  }
Returns RocksDBIterator<string, Buffer>
- Defined in src/native/rocksdb.ts:111
iteratorInit(database, options): RocksDBIterator<string, string>
Parameters
- database: RocksDBDatabase
- options: RocksDBIteratorOptions
Returns RocksDBIterator<string, string>
- Defined in src/native/rocksdb.ts:115

iteratorNextv

iteratorNextv<K, V>(iterator, size, callback): void
Type Parameters
- K extends string | Buffer
- V extends string | Buffer
Parameters
- iterator: RocksDBIterator<K, V>
- size: number
- callback: Callback<[[K, V][], boolean], void>
Returns void
- Defined in src/native/rocksdb.ts:124

iteratorSeek

iteratorSeek<K>(iterator, target): void
Type Parameters
- K extends string | Buffer
Parameters
- iterator: RocksDBIterator<K>
- target: K
Returns void
- Defined in src/native/rocksdb.ts:119

repairDb

repairDb(location, callback): void
Parameters
- location: string
- callback: Callback<[], void>
Returns void
- Defined in src/native/rocksdb.ts:99

snapshotInit

snapshotInit(database): RocksDBSnapshot
Parameters
- database: RocksDBDatabase
Returns RocksDBSnapshot
- Defined in src/native/rocksdb.ts:93

snapshotRelease

snapshotRelease(snapshot, callback): void
Parameters
- snapshot: RocksDBSnapshot
- callback: Callback<[], void>
Returns void
- Defined in src/native/rocksdb.ts:94

transactionClear

transactionClear(transaction, options, callback): void
Parameters
- transaction: RocksDBTransaction
- options: RocksDBClearOptions<RocksDBTransactionSnapshot>
- callback: Callback<[], void>
Returns void
- Defined in src/native/rocksdb.ts:262

transactionCommit

transactionCommit(transaction, callback): void
Parameters
- transaction: RocksDBTransaction
- callback: Callback<[], void>
Returns void
- Defined in src/native/rocksdb.ts:153

transactionCount

transactionCount(transaction, options, callback): void
Parameters
- transaction: RocksDBTransaction
- options: RocksDBCountOptions<RocksDBTransactionSnapshot>
- callback: Callback<[number], void>
Returns void
- Defined in src/native/rocksdb.ts:267

transactionDel

transactionDel(transaction, key, callback): void
Parameters
- transaction: RocksDBTransaction
- key: string | Buffer
- callback: Callback<[], void>
Returns void
- Defined in src/native/rocksdb.ts:231

transactionGet

transactionGet(transaction, key, options, callback): void
Parameters
- transaction: RocksDBTransaction
- key: string | Buffer
- options: RocksDBGetOptions<RocksDBTransactionSnapshot> & {
  valueEncoding?: "utf8";
  }
- callback: Callback<[string], void>
Returns void
- Defined in src/native/rocksdb.ts:161
transactionGet(transaction, key, options, callback): void
Parameters
- transaction: RocksDBTransaction
- key: string | Buffer
- options: RocksDBGetOptions<RocksDBTransactionSnapshot> & {
  valueEncoding: "buffer";
  }
- callback: Callback<[Buffer], void>
Returns void
- Defined in src/native/rocksdb.ts:169

transactionGetForUpdate

transactionGetForUpdate(transaction, key, options, callback): void
Parameters
- transaction: RocksDBTransaction
- key: string | Buffer
- options: RocksDBGetOptions<RocksDBTransactionSnapshot> & {
  valueEncoding?: "utf8";
  }
- callback: Callback<[string], void>
Returns void
- Defined in src/native/rocksdb.ts:177
transactionGetForUpdate(transaction, key, options, callback): void
Parameters
- transaction: RocksDBTransaction
- key: string | Buffer
- options: RocksDBGetOptions<RocksDBTransactionSnapshot> & {
  valueEncoding: "buffer";
  }
- callback: Callback<[Buffer], void>
Returns void
- Defined in src/native/rocksdb.ts:185

transactionId

transactionId(transaction): number
Parameters
- transaction: RocksDBTransaction
Returns number
- Defined in src/native/rocksdb.ts:152

transactionInit

transactionInit(database, options): RocksDBTransaction
Parameters
- database: RocksDBDatabase
- options: RocksDBPutOptions
Returns RocksDBTransaction
- Defined in src/native/rocksdb.ts:148

transactionIteratorInit

transactionIteratorInit(transaction, options): RocksDBIterator<Buffer, Buffer>
Parameters
- transaction: RocksDBTransaction
- options: RocksDBGetOptions<RocksDBTransactionSnapshot> & RocksDBRangeOptions & {
      highWaterMarkBytes?: number;
      keyEncoding?: "utf8" | "buffer";
      keys?: boolean;
      values?: boolean;
  } & {
      keyEncoding: "buffer";
      valueEncoding: "buffer";
  }
Returns RocksDBIterator<Buffer, Buffer>
- Defined in src/native/rocksdb.ts:239
transactionIteratorInit(transaction, options): RocksDBIterator<Buffer, string>
Parameters
- transaction: RocksDBTransaction
- options: RocksDBGetOptions<RocksDBTransactionSnapshot> & RocksDBRangeOptions & {
      highWaterMarkBytes?: number;
      keyEncoding?: "utf8" | "buffer";
      keys?: boolean;
      values?: boolean;
  } & {
      keyEncoding: "buffer";
  }
Returns RocksDBIterator<Buffer, string>
- Defined in src/native/rocksdb.ts:246
transactionIteratorInit(transaction, options): RocksDBIterator<string, Buffer>
Parameters
- transaction: RocksDBTransaction
- options: RocksDBGetOptions<RocksDBTransactionSnapshot> & RocksDBRangeOptions & {
      highWaterMarkBytes?: number;
      keyEncoding?: "utf8" | "buffer";
      keys?: boolean;
      values?: boolean;
  } & {
      valueEncoding: "buffer";
  }
Returns RocksDBIterator<string, Buffer>
- Defined in src/native/rocksdb.ts:252
transactionIteratorInit(transaction, options): RocksDBIterator<string, string>
Parameters
- transaction: RocksDBTransaction
- options: RocksDBIteratorOptions<RocksDBTransactionSnapshot>
Returns RocksDBIterator<string, string>
- Defined in src/native/rocksdb.ts:258

transactionMultiGet

transactionMultiGet(transaction, keys, options, callback): void
Parameters
- transaction: RocksDBTransaction
- keys: (string | Buffer)[]
- options: RocksDBGetOptions<RocksDBTransactionSnapshot> & {
  valueEncoding?: "utf8";
  }
- callback: Callback<[string[]], void>
Returns void
- Defined in src/native/rocksdb.ts:193
transactionMultiGet(transaction, keys, options, callback): void
Parameters
- transaction: RocksDBTransaction
- keys: (string | Buffer)[]
- options: RocksDBGetOptions<RocksDBTransactionSnapshot> & {
  valueEncoding: "buffer";
  }
- callback: Callback<[Buffer[]], void>
Returns void
- Defined in src/native/rocksdb.ts:201

transactionMultiGetForUpdate

transactionMultiGetForUpdate(transaction, keys, options, callback): void
Parameters
- transaction: RocksDBTransaction
- keys: (string | Buffer)[]
- options: RocksDBGetOptions<RocksDBTransactionSnapshot> & {
  valueEncoding?: "utf8";
  }
- callback: Callback<[string[]], void>
Returns void
- Defined in src/native/rocksdb.ts:209
transactionMultiGetForUpdate(transaction, keys, options, callback): void
Parameters
- transaction: RocksDBTransaction
- keys: (string | Buffer)[]
- options: RocksDBGetOptions<RocksDBTransactionSnapshot> & {
  valueEncoding: "buffer";
  }
- callback: Callback<[Buffer[]], void>
Returns void
- Defined in src/native/rocksdb.ts:217

transactionPut

transactionPut(transaction, key, value, callback): void
Parameters
- transaction: RocksDBTransaction
- key: string | Buffer
- value: string | Buffer
- callback: Callback<[], void>
Returns void
- Defined in src/native/rocksdb.ts:225

transactionRollback

transactionRollback(transaction, callback): void
Parameters
- transaction: RocksDBTransaction
- callback: Callback<[], void>
Returns void
- Defined in src/native/rocksdb.ts:157

transactionSnapshot

transactionSnapshot(transaction): RocksDBTransactionSnapshot
Parameters
- transaction: RocksDBTransaction
Returns RocksDBTransactionSnapshot
- Defined in src/native/rocksdb.ts:236

Interface RocksDB

Hierarchy

Index

Methods

Methods

batchClear

Parameters

batch: RocksDBBatch

Returns void

batchDel

Parameters

batch: RocksDBBatch

key: string | Buffer

Returns void

batchDo

Parameters

database: RocksDBDatabase

operations: (RocksDBBatchPutOperation | RocksDBBatchDelOperation)[]

options: RocksDBPutOptions

callback: Callback<[], void>

Returns void

batchInit

Parameters

database: RocksDBDatabase

Returns RocksDBBatch

batchPut

Parameters

batch: RocksDBBatch

key: string | Buffer

value: string | Buffer

Returns void

batchWrite

Parameters

batch: RocksDBBatch

options: RocksDBPutOptions

callback: Callback<[], void>

Returns void

dbApproximateSize

Parameters

database: RocksDBDatabase

start: string | Buffer

end: string | Buffer

callback: Callback<[number], void>

Returns void

dbClear

Parameters

database: RocksDBDatabase

options: RocksDBClearOptions

callback: Callback<[], void>

Returns void

dbClose

Parameters

database: RocksDBDatabase

callback: Callback<[], void>

Returns void

dbCompactRange

Parameters

database: RocksDBDatabase

start: string | Buffer

end: string | Buffer

callback: Callback<[], void>

Returns void

dbCount

Parameters

database: RocksDBDatabase

options: RocksDBCountOptions

callback: Callback<[number], void>

Returns void

dbDel

Parameters

database: RocksDBDatabase

key: string | Buffer

options: RocksDBPutOptions

callback: Callback<[], void>

Returns void

dbGet

Parameters

database: RocksDBDatabase

key: string | Buffer

options: RocksDBGetOptions & { valueEncoding?: "utf8"; }

options: RocksDBGetOptions & {
valueEncoding?: "utf8";
}

options: RocksDBGetOptions & {
valueEncoding: "buffer";
}

options: RocksDBGetOptions & {
valueEncoding?: "utf8";
}

options: RocksDBGetOptions & {
valueEncoding: "buffer";
}

options: RocksDBGetOptions<RocksDBSnapshot> & RocksDBRangeOptions & {
highWaterMarkBytes?: number;
keyEncoding?: "utf8" | "buffer";
keys?: boolean;
values?: boolean;
} & {
keyEncoding: "buffer";
valueEncoding: "buffer";
}

options: RocksDBGetOptions<RocksDBSnapshot> & RocksDBRangeOptions & {
highWaterMarkBytes?: number;
keyEncoding?: "utf8" | "buffer";
keys?: boolean;
values?: boolean;
} & {
keyEncoding: "buffer";
}

options: RocksDBGetOptions<RocksDBSnapshot> & RocksDBRangeOptions & {
highWaterMarkBytes?: number;
keyEncoding?: "utf8" | "buffer";
keys?: boolean;
values?: boolean;
} & {
valueEncoding: "buffer";
}