hord

README

Hord

Hord provides a modular key-value interface for interacting with databases. The goal is to provide a consistent interface regardless, of the underlying database.

With this package, users can switch out the underlying database without major refactoring.

Installation

To use Hord within your project you must first import the Hord interface itself.

import "github.com/madflojo/hord"

Then import the database driver you wish to use

import "github.com/madflojo/hord/driver/cassandra"

Available drivers are a follows:

• Cassandra
• Redis

Our TODO list:

• Couchbase
• CockRoachDB
• MySQL
• TiKV
• PostgreSQL

Usage

The below example shows using Hord to connect and interact with Cassandra.

import "github.com/madflojo/hord"
import "github.com/madflojo/hord/driver/cassandra"

func main() {
  // Define our DB Interface
  var db hord.Database

  // Connect to a Cassandra Cluster
  db, err := cassandra.Dial(&cassandra.Config{})
  if err != nil {
    // do stuff
  }

  // Setup and Initialize the Keyspace if necessary
  err = db.Setup()
  if err != nil {
    // do stuff
  }

  // Write data to the cluster
  err = db.Set("mykey", []byte("My Data"))
  if err != nil {
    // do stuff
  }

  // Fetch the same data
  d, err := db.Get("mykey")
  if err != nil {
    // do stuff
  }
}

Contributing

Thank you for your interest in helping develop Hord. The time, skills, and perspectives you contribute to this project are valued.

Please reference our Contributing Guide for details.

License

Apache License 2.0

Documentation

Overview

Package hord provides a modular key-value interface for interacting with databases. The goal is to provide a consistent interface regardless, of the underlying database.

With this package, users can switch out the underlying database without major refactoring.

The below example shows using Hord to connect and interact with Cassandra.

import "github.com/madflojo/hord"
import "github.com/madflojo/hord/driver/cassandra"

func main() {
  // Define our DB Interface
  var db hord.Database

  // Connect to a Cassandra Cluster
  db, err := cassandra.Dial(&cassandra.Config{})
  if err != nil {
    // do stuff
  }

  // Setup and Initialize the Keyspace if necessary
  err = db.Setup()
  if err != nil {
    // do stuff
  }

  // Write data to the cluster
  err = db.Set("mykey", []byte("My Data"))
  if err != nil {
    // do stuff
  }

  // Fetch the same data
  d, err := db.Get("mykey")
  if err != nil {
    // do stuff
  }
}

Index

• type Database

Types

type Database

type Database interface {
	// Setup is used to setup and configure the underlying database. This can include setting optimal cluster
	// setting, creating a database or tablespace, or even creating db structure. Setup is meant to allow users to
	// start with a fresh database service and turn it into a production ready datastore.
	Setup() error

	// HealthCheck performs a check against the underlying database. If any errors are returned, this health check
	// will return an error. An error returned from HealthCheck should be treated as the database service is
	// untrustworthy.
	HealthCheck() error

	// Get is used to fetch data with the provided key.
	Get(key string) ([]byte, error)

	// Set is used to insert and update the specified key. This function can be used on exiting keys, with the new
	// data overwriting existing data.
	Set(key string, data []byte) error

	// Delete will delete both the data for the specified key.
	Delete(key string) error

	// Keys will return a list of keys for the entire database. This operation can be expensive, use with caution.
	Keys() ([]string, error)

	// Close will close the database connection. After executing close all other functions should return an error.
	Close()
}

Database is an interface that is used to create a unified database access object