Giter Club home page Giter Club logo

getsetdb's Introduction

GetSetDB

An extremely optimised and lightweight NoSQL in memory database system written in Go.

Systems Supported

  • Debian / Ubuntu 16.04 and up
  • Fedora / Red Hat Enterprise Linux
  • MacOS

note - Windows support not determined as it's not been tested

Installation

To see the instructions for building from source, refer this.

  • for Ubuntu / Debian users -
    • option 1 - download a pre-built binary and place it in /usr/bin/
    • option 2 - download a pre-built .deb package from here - getsetdb-v1.deb
  • for Fedora / Red Hat Enterprise Linux users -
    • download a pre-built binary and place it in /usr/bin/
  • for MacOS users
    • download a pre-built binary and place it in /usr/bin/

Usage

Since GetSetDB is an extremely lightweight database, A Tour of GetSetDB should be enough for most people to get up and running with it.

If you wish to use it in conjunction with a programming language, please look out for upcoming connectors for different languages.

Documentation

For a tutorial that covers everything from the structuring of GetSetDB to the syntax for the commands, check out A Tour of GetSetDB

API documentation for reference will be coming soon.

Building From Source

GetSetDB is written purely in Go, so you need to have Go installed on your system to build it from souce. Install it from here. Next, configure your $GOPATH - by default, it is your home directory.

$ mkdir -p ~/go/src/
$ go get github.com/getsetdb/getsetdb

This should automatically build GetSetDB for you and will place the executable binary in ~/go/bin/. To run it from anywhere, you'll have to add this binary to your $PATH. To do so, run the following -

$ echo 'export PATH="$HOME/go/bin:$PATH"' >> ~/.bashrc

Developing

If you're a developer looking for documentation on making connectors for a language that GetSetDB doesn't already support , please be paitent - documentation for that will be coming soon.

Same goes for contributing to the database itself.

Connectors In Development

  1. Python
  2. Go
  3. Ruby
  4. C++
  5. Perl

getsetdb's People

Contributors

mentix02 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.