aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorthe lemons <citrons@mondecitronne.com>2022-12-05 20:00:26 -0600
committerthe lemons <citrons@mondecitronne.com>2022-12-05 20:00:26 -0600
commit4384b3d0bdeca1fa3df5bb8a7cc13cf043b8c3a6 (patch)
tree7c4dbf2fa07708cb400453ec20804fd6ddff6249 /README.md
parent187933ca79bfbad8ca06505fcd18dacc8ee66925 (diff)
env:txn_begin(): make read-only by default
this is more sensible behavior. read-write transactions are less performant, so the programmer should have to engage them explicitly.
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index bd19045..dd0fdef 100644
--- a/README.md
+++ b/README.md
@@ -19,8 +19,8 @@ create a new environment handle and open the database at the `path`. returns the
### `lmdb.version()`
returns the LMDB version as `major, minor, patch`.
-### `env:txn_begin(rdonly)`
-create a new transaction in the environment. if `rdonly` is true, then the transaction is not to be used to perform write operations. returns the transaction handle (`txn`) on success.
+### `env:txn_begin(write_enabled)`
+create a new transaction in the environment. if `write_enabled` is true, then the transaction may make modifications to the database. returns the transaction handle (`txn`) on success.
### `env:copy(path)`
copy the environment to the specified `path`. return `true` on success.
@@ -45,5 +45,5 @@ abandon all operations performed in the transaction.
### `txn:commit()`
commit all operations of the transaction into the database.
-### `txn:txn_begin(rdonly)`
+### `txn:txn_begin()`
create a nested transaction in the parent transaction.