createIterator
constcreateIterator: (transactionId,startKey?,endKey?,reverse?) =>number
Defined in: .work/repos/olmdb/src/lowlevel.ts:130
Creates an iterator for scanning a range of keys within a transaction.
Parameters
Section titled “Parameters”transactionId
Section titled “transactionId”number
The ID of the transaction
startKey?
Section titled “startKey?”ArrayBufferLike
Optional key to start iteration from (inclusive)
endKey?
Section titled “endKey?”ArrayBufferLike
Optional key to end iteration at (exclusive)
reverse?
Section titled “reverse?”boolean
If true, keys are returned in descending order
Returns
Section titled “Returns”number
An iterator ID to be used with readIterator() and closeIterator()
Throws
Section titled “Throws”DatabaseError if the operation fails