ash_cubdb/README.md
James Harton 08197e5cde
All checks were successful
continuous-integration/drone/push Build is passing
chore: release version v0.6.1-rc.1
2024-04-02 10:40:36 +13:00

2.4 KiB

AshCubDB

Build Status Hex.pm Hippocratic License HL3-FULL

An Ash DataLayer which adds support for CubDB.

Status

AshCubDb is still a work in progress. Feel free to give it a go.

Feature Status
Create
Upsert (by primary key)
Upsert (by identity)
Read (all)
Read (by primary key)
Read (filters)
Read (sort)
Read (distinct sort)
Read (calculations)
Read (aggregates)
Update
Destroy
Transactions

Github Mirror

This repository is mirrored on Github from it's primary location on my Forgejo instance. Feel free to raise issues and open PRs on Github.

Installation

AshCubDB is available in Hex, the package can be installed by adding ash_cubdb to your list of dependencies in mix.exs:

def deps do
  [
    {:ash_cubdb, "~> 0.6.1-rc.1"}
  ]
end

Documentation for the latest release can be found on HexDocs and for the main branch on docs.harton.nz.

License

This software is licensed under the terms of the HL3-FULL, see the LICENSE.md file included with this package for the terms.

This license actively proscribes this software being used by and for some industries, countries and activities. If your usage of this software doesn't comply with the terms of this license, then contact me with the details of your use-case to organise the purchase of a license - the cost of which may include a donation to a suitable charity or NGO.