mirrors/btcd
1
0
Fork 0
mirror of https://github.com/btcsuite/btcd.git synced 2024-11-19 01:40:07 +01:00
Code Issues Projects Releases Wiki Activity
master
btcd/database/README.md

58 lines
2.4 KiB
Markdown
Raw Permalink Normal View History

Import btcdb repo into database directory. This commit contains the entire btcdb repository along with several changes needed to move all of the files into the database directory in order to prepare it for merging. This does NOT update btcd or any of the other packages to use the new location as that will be done separately. - All import paths in the old btcdb test files have been changed to the new location - All references to btcdb as the package name have been chagned to database - The coveralls badge has been removed since it unfortunately doesn't support coverage of sub-packages This is ongoing work toward #214.
2015-01-27 18:45:10 +01:00
database
========
Initial commit.
2013-05-29 02:03:53 +02:00
docs: update shields
2021-03-04 23:12:45 +01:00
[![Build Status](https://github.com/btcsuite/btcd/workflows/Build%20and%20Test/badge.svg)](https://github.com/btcsuite/btcd/actions)
multi: Update markdown files for GFM changes. The github markdown interpreter has been changed such that it no longer allows spaces in between the brackets and parenthesis of links and now requires a newline in between anchors and other formatting. This updates all of the markdown files accordingly. While here, it also corrects a couple of inconsistencies in some of the README.md files.
2017-05-25 18:29:23 +02:00
[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
docs: update shields
2021-03-04 23:12:45 +01:00
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://pkg.go.dev/github.com/btcsuite/btcd/database)
Add support for TravisCI. Also add TravisCI build status badge to README.md.
2013-12-11 02:17:44 +01:00
database: Replace with new version. This commit removes the old database package, moves the new package into its place, and updates all imports accordingly.
2015-08-26 11:54:55 +02:00
Package database provides a block and metadata storage database.
Initial implementation.
2013-05-29 02:07:21 +02:00
Clarify how the database package is used.
2015-01-28 01:58:27 +01:00
Please note that this package is intended to enable btcd to support different
database backends and is not something that a client can directly access as only
one entity can have the database open at a time (for most database backends),
and that entity will be btcd.
When a client wants programmatic access to the data provided by btcd, they'll
database: Update rpcclient link in README.md.
2018-01-26 05:43:53 +01:00
likely want to use the [rpcclient](https://github.com/btcsuite/btcd/tree/master/rpcclient)
multi: Update markdown files for GFM changes. The github markdown interpreter has been changed such that it no longer allows spaces in between the brackets and parenthesis of links and now requires a newline in between anchors and other formatting. This updates all of the markdown files accordingly. While here, it also corrects a couple of inconsistencies in some of the README.md files.
2017-05-25 18:29:23 +02:00
package which makes use of the [JSON-RPC API](https://github.com/btcsuite/btcd/tree/master/docs/json_rpc_api.md).
Clarify how the database package is used.
2015-01-28 01:58:27 +01:00
database: Replace with new version. This commit removes the old database package, moves the new package into its place, and updates all imports accordingly.
2015-08-26 11:54:55 +02:00
However, this package could be extremely useful for any applications requiring
Bitcoin block storage capabilities.
The default backend, ffldb, has a strong focus on speed, efficiency, and
robustness. It makes use of leveldb for the metadata, flat files for block
storage, and strict checksums in key areas to ensure data integrity.
## Feature Overview
- Key/value metadata store
- Bitcoin block storage
- Efficient retrieval of block headers and regions (transactions, scripts, etc)
- Read-only and read-write transactions with both manual and managed modes
- Nested buckets
- Iteration support including cursors with seek capability
- Supports registration of backend databases
- Comprehensive test coverage
docs: Make various README.md files consistent. First, it removes the documentation section from all the README.md files and instead puts a web-based godoc badge and link at the top with the other badges. This is being done since the local godoc tool no longer ships with Go by default, so the instructions no longer work without first installing godoc. Due to this, pretty much everyone uses the web-based godoc these days anyways. Anyone who has manually installed godoc won't need instructions. Second, it makes sure the ISC license badge is at the top with the other badges and removes the textual reference in the overview section. Finally, it's modifies the Installation section to Installation and Updating and adds a '-u' to the 'go get' command since it works for both and thus is simpler.
2015-10-23 18:34:50 +02:00
## Installation and Updating
Initial implementation.
2013-05-29 02:07:21 +02:00
```bash
docs: Make various README.md files consistent. First, it removes the documentation section from all the README.md files and instead puts a web-based godoc badge and link at the top with the other badges. This is being done since the local godoc tool no longer ships with Go by default, so the instructions no longer work without first installing godoc. Due to this, pretty much everyone uses the web-based godoc these days anyways. Anyone who has manually installed godoc won't need instructions. Second, it makes sure the ISC license badge is at the top with the other badges and removes the textual reference in the overview section. Finally, it's modifies the Installation section to Installation and Updating and adds a '-u' to the 'go get' command since it works for both and thus is simpler.
2015-10-23 18:34:50 +02:00
$ go get -u github.com/btcsuite/btcd/database
Initial implementation.
2013-05-29 02:07:21 +02:00
```
Use testable example and update README.md. This commit moves the example to a test file so it integrates nicely with Go's example tooling. This allows the example output to be tested as a part of running the normal Go tests to help ensure it doesn't get out of date with the code. It is also nice to have the example in one place rather than repeating it in doc.go and README.md. Links and information about the example have been included in README.md in place of the example.
2014-07-08 15:45:37 +02:00
## Examples
docs: update shields
2021-03-04 23:12:45 +01:00
* [Basic Usage Example](https://pkg.go.dev/github.com/btcsuite/btcd/database#example-package--BasicUsage)
database: Replace with new version. This commit removes the old database package, moves the new package into its place, and updates all imports accordingly.
2015-08-26 11:54:55 +02:00
Demonstrates creating a new database and using a managed read-write
transaction to store and retrieve metadata.
Initial implementation.
2013-05-29 02:07:21 +02:00
docs: update shields
2021-03-04 23:12:45 +01:00
* [Block Storage and Retrieval Example](https://pkg.go.dev/github.com/btcsuite/btcd/database#example-package--BlockStorageAndRetrieval)
database: Replace with new version. This commit removes the old database package, moves the new package into its place, and updates all imports accordingly.
2015-08-26 11:54:55 +02:00
Demonstrates creating a new database, using a managed read-write transaction
to store a block, and then using a managed read-only transaction to fetch the
block.
Initial implementation.
2013-05-29 02:07:21 +02:00
## License
Import btcdb repo into database directory. This commit contains the entire btcdb repository along with several changes needed to move all of the files into the database directory in order to prepare it for merging. This does NOT update btcd or any of the other packages to use the new location as that will be done separately. - All import paths in the old btcdb test files have been changed to the new location - All references to btcdb as the package name have been chagned to database - The coveralls badge has been removed since it unfortunately doesn't support coverage of sub-packages This is ongoing work toward #214.
2015-01-27 18:45:10 +01:00
Package database is licensed under the [copyfree](http://copyfree.org) ISC
License.
Reference in New Issue Copy Permalink