README
¶
fdb-go
Go language bindings for FoundationDB, a distributed key-value store with ACID transactions.
This package requires:
- Go 1.1+ with CGO enabled
- Mono (macOS or Windows) or Visual Studio (Windows) (build-time only)
- FoundationDB C API 2.0.x, 3.0.x, or 4.x.y (part of the FoundationDB clients package)
Use of this package requires the selection of a FoundationDB API version at runtime. This package currently supports FoundationDB API versions 200-520.
To build this package, in the top level of this repository run:
make fdb_go
This will create binary packages for the appropriate platform within the "build" subdirectory of this folder.
To install this package, you can run the "fdb-go-install.sh" script:
./fdb-go-install.sh install
The "install" command of this script does not depend on the presence of the repo in general and will download the repository into your local go path. Running "localinstall" instead of "install" will use the local copy here (with a symlink) instead of downloading from the remote repository.
Documentation
Directories
¶
| Path | Synopsis |
|---|---|
|
src
|
|
|
fdb
Package fdb provides an interface to FoundationDB databases (version 2.0 or higher).
|
Package fdb provides an interface to FoundationDB databases (version 2.0 or higher). |
|
fdb/directory
Package directory provides a tool for managing related subspaces.
|
Package directory provides a tool for managing related subspaces. |
|
fdb/subspace
Package subspace provides a convenient way to use FoundationDB tuples to define namespaces for different categories of data.
|
Package subspace provides a convenient way to use FoundationDB tuples to define namespaces for different categories of data. |
|
fdb/tuple
Package tuple provides a layer for encoding and decoding multi-element tuples into keys usable by FoundationDB.
|
Package tuple provides a layer for encoding and decoding multi-element tuples into keys usable by FoundationDB. |