import "berty.tech/go-orbit-db"
orbitdb implements the OrbitDB interface
func NewOrbitDB(ctx context.Context, i coreapi.CoreAPI, options *NewOrbitDBOptions) (iface.OrbitDB, error)
NewOrbitDB Creates a new OrbitDB instance with default access controllers and store types
type CreateDBOptions = iface.CreateDBOptions
CreateDBOptions An alias of the type defined in the iface package
type DetermineAddressOptions = iface.DetermineAddressOptions
DetermineAddressOptions An alias of the type defined in the iface package
type EventLogStore = iface.EventLogStore
EventLogStore An alias of the type defined in the iface package
type IndexConstructor = iface.IndexConstructor
IndexConstructor An alias of the type defined in the iface package
type KeyValueStore = iface.KeyValueStore
KeyValueStore An alias of the type defined in the iface package
type NewOrbitDBOptions = baseorbitdb.NewOrbitDBOptions
NewOrbitDBOptions Options for a new OrbitDB instance
type OnWritePrototype = iface.OnWritePrototype
OnWritePrototype An alias of the type defined in the iface package
OrbitDB An alias of the type defined in the iface package
Store An alias of the type defined in the iface package
type StoreConstructor = iface.StoreConstructor
StoreConstructor An alias of the type defined in the iface package
type StoreIndex = iface.StoreIndex
StoreIndex An alias of the type defined in the iface package
type StreamOptions = iface.StreamOptions
StreamOptions An alias of the type defined in the iface package
| Path | Synopsis |
|---|---|
| accesscontroller | accesscontroller is a package handling permissions for OrbitDB stores |
| accesscontroller/ipfs | ipfs is an access controller |
| accesscontroller/orbitdb | orbitdb is an access controller for OrbitDB stores |
| accesscontroller/simple | simple is an access controller without any persistence |
| accesscontroller/utils | utils is a package containing tools related to access controllers |
| address | address is a package for managing OrbitDB addresses |
| baseorbitdb | baseorbitdb package containing the base implementation of OrbitDB |
| cache | cache is a package defining the interface of cache factories |
| cache/cacheleveldown | cacheleveldown is a package returning level db data stores for OrbitDB |
| events | events defines an event subscriber and dispatcher |
| iface | iface package containing common structures and interfaces of orbitdb |
| internal/buildconstraints | |
| pubsub | pubsub a publish subscribe client for IPFS PubSub |
| pubsub/directchannel | directchannel |
| pubsub/oneonone | oneonone is a pubsub channel for communication between two peers |
| pubsub/pubsubcoreapi | pubsubcoreapi pubsub helpers using IPFS CoreAPI |
| pubsub/pubsubraw | pubsubraw pubsub helpers using IPFS Golang implementation |
| stores | stores registers constructors for OrbitDB stores |
| stores/basestore | basestore defines a set of operations common to the different store types |
| stores/eventlogstore | eventlogstore an event log store for OrbitDB |
| stores/kvstore | kvstore a key value store for OrbitDB |
| stores/operation | operation a serializable operation that can be appended to IPFS log |
| stores/replicator | replicator is a package managing the replication of data among peers |
| tests | tests is a package containing tests and tools for testing orbitdb |
| utils | utils contains functions that are useful in some context |
Package orbitdb imports 10 packages (graph) and is imported by 2 packages. Updated 2020-12-15. Refresh now. Tools for package owners.