From 957d850b5158a4eebf915476058e720f43459584 Mon Sep 17 00:00:00 2001 From: Ben Johnson Date: Mon, 18 May 2015 13:50:00 -0600 Subject: README --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index b76a473..c828200 100644 --- a/README.md +++ b/README.md @@ -446,6 +446,21 @@ It's also useful to pipe these stats to a service such as statsd for monitoring or to provide an HTTP endpoint that will perform a fixed-length sample. +### Read-Only Mode + +Sometimes it is useful to create a shared, read-only Bolt database. To this, +set the `Options.ReadOnly` flag when opening your database. Read-only mode +uses a shared lock to allow multiple processes to read from the database but +it will block any processes from opening the database in read-write mode. + +```go +db, err := bolt.Open("my.db", 0666, &bolt.Options{ReadOnly: true}) +if err != nil { + log.Fatal(err) +} +``` + + ## Resources For more information on getting started with Bolt, check out the following articles: -- cgit v1.2.3