Commit Graph

91 Commits (8b08bd4a8065cb7a240761c3683e8f837b06cc3c)

Author SHA1 Message Date
Matt Silverlock d6ce6a9a80 [docs] Add table of contents
- Generated and tweaked a TOC using [doctoc](https://github.com/thlorenz/doctoc)
- (removed generated headers and fixed broken ampersand conversion)
2015-12-31 08:04:02 -08:00
ReadmeCritic 6179274f76 Update README URLs based on HTTP redirects 2015-12-14 07:44:42 -08:00
Ben Johnson f27abf2cc7 README
Replace reference to the coalescer with a reference to `DB.Batch()`.

Fixes #465.
2015-12-05 20:27:15 -07:00
Rodolfo Carvalho a2144ebbf1 Put backticks around function name in description 2015-12-05 19:00:07 +01:00
Mark Rushakoff e991375cad Explain iterating over sub-buckets in README 2015-11-22 18:20:48 -08:00
Ben Johnson 6b1bbf0ab4 update WriteTo() docs
This commit updates and revises some of the documentation around
Tx.WriteTo() and how O_DIRECT is no longer the default.
2015-11-06 13:18:58 -07:00
Charlie Cochrane 13944fb3e3 updated README.md to fix typo 2015-11-03 14:04:31 +00:00
Hung Nguyen Viet 40aeece092 typo and highlight 2015-10-28 11:59:29 -06:00
Ben Johnson 54254e97b9 README: add 'Reading the Source' section
This commit adds a section to help people understand the
source better while reading it.
2015-10-24 13:31:18 -06:00
Patrick Mezard b7f23b8e55 README: mention the memory map consumes a lot of address space
I have been bitten by this when running a simple application on a
Raspberry Pi 2. It had 3 stores: two 512M stores and one 128M. The
application refused to start the moment the first index grew from 512M
to 1G.

Bolt is really nice but it is easy to overlook this limitation,
especially with the note about supporting stores much larger than
*physical* memory.
2015-10-20 14:08:43 +02:00
Rogier Lommers 1af2ec9768 Add example of NextSequence() usage to readme 2015-10-18 15:00:36 +02:00
John ShaggyTwoDope Jenkins a7a29a20cd typos 2015-10-13 17:14:11 -07:00
Jason Voigt 130d6c5d98 add stow and buckets to projects list 2015-09-21 13:31:50 -05:00
Tommi Virtanen df7ec9554b Better URL for Bazil in README 2015-07-29 16:39:44 -07:00
Emmanuel Odeke c46c54210a README: add drive to projects using bolt 2015-07-14 13:12:25 -06:00
AJ Bahnken af0644b17a Added Kala to Projects Using Bolt section 2015-06-10 18:24:53 -07:00
Ben Johnson a03d52a9dd Add docs for dependent transactions.
This commit adds documentation to clarify that read-only and read-write
transactions should not be mixed in the same goroutine as it can cause
deadlocks during remapping.

See: https://github.com/boltdb/bolt/issues/378
2015-05-21 09:50:13 -06:00
Ryan Uber 89ab219630 Add Consul to README 2015-05-19 19:12:40 -07:00
Ben Johnson 957d850b51 README 2015-05-18 13:50:00 -06:00
Oliver 27f88b367d Update README.md
Adding prometheus annotation server to the list projects using BoltDB.
2015-05-18 09:34:19 -04:00
Ben Johnson da700e8fdb Add caveat regarding endianness of data files as suggested by Raphael Geronimi. 2015-05-06 09:26:22 -06:00
Tim Shannon 07590fc00b Added Freehold to the projects list in README.
Added a few lines of documentation to clarify that read-only
transactions need to be rolled back and not committed, as per the
discussion in issue #344
2015-04-23 09:49:55 -05:00
Mike Marcacci c50df3a891 Added InfluxDB to list of projects using bolt 2015-04-11 18:16:07 -07:00
chrislusf 393eacd1fe Update README.md 2015-03-29 13:05:23 -07:00
chrislusf 4eced79bd1 Update README.md 2015-03-29 13:04:56 -07:00
Daniel Speichert 597d69fa1e Update README.md: fixed type mismatch 2015-03-28 18:59:17 -04:00
Ben Johnson a8ee2caab1 Add link to page reclamation comment. 2015-03-27 16:13:55 -06:00
Ben Johnson 9d1dd87a79 README
Document use of free pages and page reclamation works.
2015-03-27 15:27:32 -06:00
Ben Johnson 112f143631 Document key/value safety.
This commit adds safety documentation to the data accessor functions
in Bolt as well as the README. This was documented once in the package
level godoc but it's important enough that it should be more clear.
2015-03-24 11:06:28 -06:00
Ben Johnson a9651995e1 Merge pull request #330 from benbjohnson/tx-writer-to
Implement io.WriterTo interface on Tx.
2015-03-22 15:26:13 -06:00
Ben Johnson 4d30731e91 Merge pull request #285 from tv42/batch
Add transaction batching
2015-03-18 10:11:07 -06:00
Ben Johnson 8c6af54aec Implement io.WriterTo interface on Tx.
This commit moves the functionality in Tx.Copy() to Tx.WriteTo(). This
allows Tx to be used as an io.WriterTo which makes it easier to mock.

The Tx.Copy() function still exists but it's simply a wrapper around
Tx.WriteTo().
2015-03-18 08:23:55 -06:00
Baiju Muthukadan ec2610abdb link to Bolt article 2015-03-12 17:54:06 +05:30
Vitor De Mario d6a67f7cce Fixed missing parenthesis on the readme 2015-02-23 16:35:38 -03:00
Tommi Virtanen adbb1a19c1 Add transaction batching
DB.Batch makes it easy to make lots of small transactions with
significantly better performance. Batch combines multiple concurrent
Update calls into a single disk transaction, managing errors smartly.
2015-02-18 12:26:45 -08:00
everdev 656f479184 added gocode.io to list of projects using bolt 2015-02-17 17:10:32 -08:00
Ben Johnson 75f70a1938 README
Removed reference to LMDB's append mode being unsafe.
2015-02-16 08:09:08 -07:00
Philipp Tarasiewicz e238914be8 fix 'range scans' example
Due to the fact that you want to iterate over all keys that are before or equal to `max` starting from `min` the bytes.Compare() check should look like the commit suggests.
2015-01-18 16:39:15 +01:00
mbertschler 565600c841 Fix syntax error in README stats example 2015-01-15 21:09:34 +01:00
Ben Johnson 33e7a074e2 README
Add a section to the README for "Managing transactions manually".
2014-12-11 13:48:25 -07:00
Russ Ferriday 2a13d5ca83 grammar & typo 2014-12-04 22:23:20 +00:00
Ben Johnson a5e6bc6658 README 2014-11-28 11:23:15 -07:00
Ben Johnson 746cadce7a README
Added a "Comparison" section to compare Bolt against other DB options:

1. Relational databases
2. LevelDB
3. LMDB
2014-11-28 11:17:47 -07:00
Ben Johnson aa66506030 v1.0 2014-11-27 17:29:59 -07:00
Eric Berg 16247c3a42 fix link in readme 2014-11-25 15:10:19 -05:00
Ben Johnson 7022ade6e6 Add caveat for memory usage.
This commit adds a caveat for high memory usage shown by processes with large
Bolt databases. This is expected behavior and is handled by the OS page cache.
2014-09-15 11:09:55 -06:00
Kevin Gillette c0a48fb4be Fixed typo in README.md 2014-09-11 20:50:44 -06:00
Guilhem Lettron d902166ae5 Tentacool is using bolt too ;) 2014-09-01 11:39:07 +02:00
Conrad Pankoff d5bf4d234f add bleve to project list 2014-08-31 00:57:54 +10:00
Martin Czygan e786ef2a5d Add cayley to projects using bolt list. 2014-08-28 16:34:18 +02:00