Skip to content

Commit

Permalink
added documentation for flags
Browse files Browse the repository at this point in the history
  • Loading branch information
iraikov committed Mar 1, 2020
1 parent 14d3cf5 commit f7fdb7f
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,23 @@ Opens or creates LMDB database with optional encryption key and map size.
`(db-close db)`
Closes LMDB database handle.

`(db-begin db [dbname: dbname])`
Begins LMDB transaction with optional database name.

`(db-end db)`
`(db-begin db [dbname: dbname] [flags: 0])`
Begins LMDB transaction with optional database name and flags returned by db-flags.`
Commits and ends LMDB transaction.

`(db-flags flag-name ..)`
Returns a bit mask that represents LMDB environment flags. The flag name is one of the following keywords:
- `#:fixed-map` : mmap at a fixed address
- `#:no-subdirectory` : no environment directory
- `#:read-only` : read only
- `#:write-map` : use writable mmap
- `#:no-meta-sync` : don't fsync metapage after commit
- `#:no-sync` : don't fsync after commit
- `#:map-async` : use asynchronous sync with `#:write-map` is used
- `#:no-lock` : don't do locking
- `#:no-read-ahead` : don't do readahead


`(db-abort db)`
Aborts LMDB transaction.

Expand Down

0 comments on commit f7fdb7f

Please sign in to comment.