diff options
author | Daniel J Walsh <dwalsh@redhat.com> | 2020-03-29 06:16:27 -0400 |
---|---|---|
committer | Daniel J Walsh <dwalsh@redhat.com> | 2020-03-29 06:16:27 -0400 |
commit | 366001fb5fa96b3b0f2f9e84b7ebc56dc4c94adc (patch) | |
tree | f0bb3892c5fdf7fc1704dcd28a46b4aa751ff593 /vendor/go.etcd.io/bbolt/doc.go | |
parent | 684b4bd2f16d078edd25d262bb8baefc699508e9 (diff) | |
download | podman-366001fb5fa96b3b0f2f9e84b7ebc56dc4c94adc.tar.gz podman-366001fb5fa96b3b0f2f9e84b7ebc56dc4c94adc.tar.bz2 podman-366001fb5fa96b3b0f2f9e84b7ebc56dc4c94adc.zip |
Update vendor of boltdb and containers/image
Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
Diffstat (limited to 'vendor/go.etcd.io/bbolt/doc.go')
-rw-r--r-- | vendor/go.etcd.io/bbolt/doc.go | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/vendor/go.etcd.io/bbolt/doc.go b/vendor/go.etcd.io/bbolt/doc.go new file mode 100644 index 000000000..95f25f01c --- /dev/null +++ b/vendor/go.etcd.io/bbolt/doc.go @@ -0,0 +1,44 @@ +/* +package bbolt implements a low-level key/value store in pure Go. It supports +fully serializable transactions, ACID semantics, and lock-free MVCC with +multiple readers and a single writer. Bolt can be used for projects that +want a simple data store without the need to add large dependencies such as +Postgres or MySQL. + +Bolt is a single-level, zero-copy, B+tree data store. This means that Bolt is +optimized for fast read access and does not require recovery in the event of a +system crash. Transactions which have not finished committing will simply be +rolled back in the event of a crash. + +The design of Bolt is based on Howard Chu's LMDB database project. + +Bolt currently works on Windows, Mac OS X, and Linux. + + +Basics + +There are only a few types in Bolt: DB, Bucket, Tx, and Cursor. The DB is +a collection of buckets and is represented by a single file on disk. A bucket is +a collection of unique keys that are associated with values. + +Transactions provide either read-only or read-write access to the database. +Read-only transactions can retrieve key/value pairs and can use Cursors to +iterate over the dataset sequentially. Read-write transactions can create and +delete buckets and can insert and remove keys. Only one read-write transaction +is allowed at a time. + + +Caveats + +The database uses a read-only, memory-mapped data file to ensure that +applications cannot corrupt the database, however, this means that keys and +values returned from Bolt cannot be changed. Writing to a read-only byte slice +will cause Go to panic. + +Keys and values retrieved from the database are only valid for the life of +the transaction. When used outside the transaction, these byte slices can +point to different data or can point to invalid memory which will cause a panic. + + +*/ +package bbolt |