appmonit-db

Version, currently master branch1 version
  • master branchlatestDec 1, 2017

github.com/appmonit/appmonit-db

No description declared in shard.yml.

0 stars
0 dependents
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  appmonit-db:
    github: appmonit/appmonit-db
    branch: master

master is a branch, not a release, so this tracks it rather than pinning a version.

Then run:

shards install

shard.yml

Crystal
0.20.3
License
MIT
Author
Benoist Claassen

Dependencies

Runtime Dependencies

  • snappy>= 0.1.0github: benoist/snappy-crystal
  • msgpack>= 0.3.0github: benoist/msgpack-crystal
  • encoding*github: benoist/encoding-crystal, branch: master

README

appmonit-db

This shard will contain the code used for the internal storage layer for Appmonit. This is pre Alpha stage, not used in production yet, expect lots of things to change.

Installation

Add this to your application's shard.yml:

dependencies:
  appmonit-db:
    github: appmonit/appmonit-db

Usage

require "appmonit-db"

File conventions

  • Collection: /some-dir/collection-name
  • Shard: /some-dir/collection-name/[start-epoch]-[end-epoch]
  • ADB File: /some-dir/collection-name/[start-epoch]-[end-epoch]/[level]-[sequence].adb
  • WAL Files: /some-dir/collection-name/_0000000000[sequence].wal

Development

TODO: Write development instructions here

Contributing

  1. Fork it ( https://github.com/appmonit/appmonit-db/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors

  • benoist Benoist Claassen - creator, maintainer