namespace

Documentation

Overview

Package namespace introduces a namespace Datastore Shim, which basically mounts the entire child datastore under a prefix.

Use the Wrap function to wrap a datastore with any Key prefix. For example:

import (
  "fmt"

  ds "github.com/ipfs/go-datastore"
  nsds "github.com/ipfs/go-datastore/namespace"
)

func main() {
  mp := ds.NewMapDatastore()
  ns := nsds.Wrap(mp, ds.NewKey("/foo/bar"))

  // in the Namespace Datastore:
  ns.Put(ds.NewKey("/beep"), "boop")
  v2, _ := ns.Get(ds.NewKey("/beep")) // v2 == "boop"

  // and, in the underlying MapDatastore:
  v3, _ := mp.Get(ds.NewKey("/foo/bar/beep")) // v3 == "boop"
}

Index

• func PrefixTransform(prefix ds.Key) ktds.KeyTransform
• func Wrap(child ds.Datastore, prefix ds.Key) *datastore

Functions

func PrefixTransform

func PrefixTransform(prefix ds.Key) ktds.KeyTransform

PrefixTransform constructs a KeyTransform with a pair of functions that add or remove the given prefix key.

Warning: Will panic if prefix not found when it should be there. This is to avoid insidious data inconsistency errors.

func Wrap

func Wrap(child ds.Datastore, prefix ds.Key) *datastore

Wrap wraps a given datastore with a key-prefix.