fern4lvarez / piladb

Lightweight RESTful database engine based on stack data structures

piladb

[pee-lah-dee-bee]. pila means stack or battery in Spanish.

piladb is a lightweight RESTful database engine based on stack data structures. Create as many stacks as you need, PUSH or POP elements of any kind, and have access to the one on top always in constant time.

Features

• Stacks are auto-scalable and are only limited by the capacity of the host or by configuration.
• Available POP, PUSH, PEEK,SIZE, and FLUSH operations for each of the stacks.
• Manage stacks and other resources by using a REST API, so you can use it with your favorite programming language.
• Manage elements in JSON-compatible data types: strings, numbers, arrays, objects, etc.
• Totally configurable using a REST API, or CLI parameters.
• In-memory store.
• Written in Go, i.e. binaries are self-contained and distributable.

Documentation

• Main documentation page.
• Go pila package documentation.
• pilad's RESTful API documentation.

Install

You can download binaries for Linux and Mac in the Releases page.

From Source Code

You need Go installed. Version 1.6+ recommended.

go get github.com/fern4lvarez/piladb/...
cd $GOPATH/src/github.com/fern4lvarez/piladb
make pilad

Clients

• shell: https://github.com/oscillatingworks/piladb-sh:

  source <(curl -s https://raw.githubusercontent.com/oscillatingworks/piladb-sh/master/piladb.sh)
  piladb_help
  

Development

You need Go installed. Version 1.6+ is mandatory.

go get github.com/fern4lvarez/piladb/...
cd $GOPATH/src/github.com/fern4lvarez/piladb
make all

You can also use Docker to create piladb builds or development environment. Please see the dev directory.

Dependencies

piladb aims to minimize the amount of third party dependencies and to rely on the Go standard library as much as possible.

Even though, it uses dep to vendor its few dependencies.

piladb also provides a go.mod file, which turns this project into a Go module. To learn more about Go modules and the vgo prototype, please read the Go & Versioning series by Russ Cox.

Code Coverage

We aim for a universal 100% code coverage for all suppackages. If some piece of code is not testable, it probably needs to be changed.

Check current code coverage of the project: https://codecov.io/gh/fern4lvarez/piladb

Release

You need Docker installed.

It's possible to get pilad binary releases by executing make release. This will cross-compile pilad in all available OS's and architectures.

Alternatively, if you don't have docker installed, you can release pilad binary with the make gox command. For this, you need a configured Go environment and gox installed.

Credits

piladb is developed by Fernando Álvarez and ≅oscillatingworks on a Dell XPS 13 laptop, running Ubuntu, and using vim-go plugin within the vim editor, in Berlin and Madrid, with the support of Gali, Godín and other friends.

Logo was designed by GraphicLoads.

Typography Lily Script One designed by Julia Petretta.

License

MIT

piladb's Issues

Implement `pila` package

Write `piladb` complete documentation

piladb needs proper documentation.

The chosen approach is to use GitBook, as it provides Git/Github compatibility, Markdown, well structured sections, nice user interface and possibility to export to PDF, Mobi or ePub.

The project will be called docs.piladb.org.

GitBook site: https://www.gitbook.com/book/fern4lvarez/docs.piladb.org
Github repository: https://github.com/oscillatingworks/docs.piladb.org

New Stack operations

This is a proposal to extend the capabilities of a Stack by adding new operations, that will allow to fit piladb into a larger set of use cases. The following criteria are not definitive, and open to be changed.

The main idea is that all new operations have also O(1) complexity.

EMPTY

Returns true/false ifsize is 0 or not, respectively.

FULL

Returns true if size equals MAX_SIZE_STACK config value, false otherwise.

BLOCK

Blocks a Stack. When a Stack is blocked, it's not possible to modify its contents.

ROTATE

Moves the bottommost element up to the top, rotating each element one position down.

top ->           |3|     ->    |5| 
                 |4|     ->    |3|
                 |6|     ->    |4|
bottom ->        |5|     ->    |6|

BASE

Bases the stack on top of an element, which will result as the new bottommost one.

                             +   +
                             |   |
  +   +                      +---+
  |   |                      | Y |
  +---+           +------->  +---+
  | Y |                      | X |
  +---+    +---+             +---+
  | X |    | A |             | A |
  +---+    +---+             +---+
  stack   element            stack

CONCAT

Concatenates two stacks into one.

                           +   +
                           |   |
                           +---+
                           | Z |
                           +---+
                           | Y |
+   +   +   +              +---+   +   +
|   |   |   |              | X |   |   |
+---+   +---+              +---+   +---+
| Z |   | C |              | C |   | C |
+---+   +---+   +------->  +---+   +---+
| Y |   | B |              | B |   | B |
+---+   +---+              +---+   +---+
| X |   | A |              | A |   | A |
+---+   +---+              +---+   +---+

  S1      S2                 S1      S2

These operations would join the already existing ones: PUSH, POP, PEEK, SIZE, and FLUSH.

New logo

New custom logo that replaces the one used until now:

Adopt JSON API specification for `pilad` REST API

TBC

Implement replication

TBC

Implement restore from "snapshot"

TBC

Tweaks and refinements for 0.1 release

Link all technical PRs addressing the release of 0.1 version to this issue.

Design and implement REST API for `pilad`

Introduce configuration

Configuration for piladb:

• Configuration will be an embedded pila.Database into pilad.Conn that will contain a stack per config value.
• A /_config endpoint and hanlders will be implemented, so configuration can be accessed and modifed dinamically via HTTP requests.
• No env vars or config files.
• pilad will provide cli arguments to initialize the config with custom values.

Add code coverage bagde

I've been using codecov for a month (https://codecov.io/gh/fern4lvarez/piladb). It could be a nice touch for thrust.

Implement authentication method

a.k.a. pilaauth

TBC

Implement version control

Version control will be the way piladb persists its contents: instead of writing data into disk, it will decode all atomic operations into a binary log, that will contain the history of the piladb server. This will make possible to recover the state of a piladb instance from a file in order to implement #14, and also to share the state with other instances in a distributed fashion, so we can achieve #13.

Implement pilaql: a query language