Documentation

Fields

• fpName :: String
   
• createFilter :: [ByteString] -> ByteString
   
• keyMayMatch :: ByteString -> ByteString -> Bool
   

Fields

• comparator :: !(Maybe Comparator)

  Comparator used to defined the order of keys in the table.

  If Nothing, the default comparator is used, which uses lexicographic bytes-wise ordering.

  NOTE: the client must ensure that the comparator supplied here has the same name and orders keys exactly the same as the comparator provided to previous open calls on the same DB.

  Default: Nothing

• compression :: !Compression

  Compress blocks using the specified compression algorithm.

  This parameter can be changed dynamically.

  Default: EnableCompression

• createIfMissing :: !Bool

  If true, the database will be created if it is missing.

  Default: False

• errorIfExists :: !Bool

  It true, an error is raised if the database already exists.

  Default: False

• maxOpenFiles :: !Int

  Number of open files that can be used by the DB.

  You may need to increase this if your database has a large working set (budget one open file per 2MB of working set).

  Default: 1000

• paranoidChecks :: !Bool

  If true, the implementation will do aggressive checking of the data it is processing and will stop early if it detects any errors.

  This may have unforeseen ramifications: for example, a corruption of one DB entry may cause a large number of entries to become unreadable or for the entire DB to become unopenable.

  Default: False

• writeBufferSize :: !Int

  Amount of data to build up in memory (backed by an unsorted log on disk) before converting to a sorted on-disk file.

  Larger values increase performance, especially during bulk loads. Up to to write buffers may be held in memory at the same time, so you may with to adjust this parameter to control memory usage. Also, a larger write buffer will result in a longer recovery time the next time the database is opened.

  Default: 4MB

Fields

• verifyCheckSums :: !Bool

  If true, all data read from underlying storage will be verified against corresponding checksuyms.

  Default: False

• fillCache :: !Bool

  Should the data read for this iteration be cached in memory? Callers may with to set this field to false for bulk scans.

  Default: True

• useSnapshot :: !(Maybe Snapshot)

  If Just, read as of the supplied snapshot (which must belong to the DB that is being read and which must not have been released). If Nothing, use an implicit snapshot of the state at the beginning of this read operation.

  Default: Nothing

Fields

• sync :: !Bool

  If true, the write will be flushed from the operating system buffer cache (by calling WritableFile::Sync()) before the write is considered complete. If this flag is true, writes will be slower.

  If this flag is false, and the machine crashes, some recent writes may be lost. Note that if it is just the process that crashes (i.e., the machine does not reboot), no writes will be lost even if sync==false.

  In other words, a DB write with sync==false has similar crash semantics as the "write()" system call. A DB write with sync==true has similar crash semantics to a "write()" system call followed by "fsync()".

  Default: False