Skip to content

TomGrozev/arangox_ecto

Repository files navigation

ArangoX Ecto

github.com hex.pm hex.pm hex.pm github.com

ArangoXEcto is an all-in-one Arango database adapter for the Elixir Ecto package. It has full support for Graphing, Arango Search, Geo Functions, AQL Integration, amongst other features.

Table of Contents

About The Project

After playing around with different packages that implemented ArangoDB in Elixir, I found that there wasn't a package that suited my needs. I needed ArangoDB to work with Ecto seamlessly but there was no up-to-date adapter for Ecto available. ArangoX Ecto uses the power of ArangoX to communicate with ArangoDB and Ecto for the API in Elixir. Ecto is integrated with many other packages and can now be used with ArangoDB thanks to this package.

Built With

Getting Started

To get the adapter integrated with your project, follow these simple steps.

Prerequisites

  • Elixir 1.16.3+ / Erlang OTP 25.3.2.12+ (Others may versions may work but this is the oldest it is tested on)

Installation

Add the following line to your mix dependencies to get started.

{:arangox_ecto, "~> 2.0"}

You can find more information in the Getting Started Guide.

Roadmap

See the the roadmap for a list of proposed features (and known issues) planned.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

Checkout the Contributing Guide.

License

Distributed under the Apache 2.0 License. See LICENSE for more information.

Contact

Project Home: https://github.com/TomGrozev/arangox_ecto

Acknowledgements

  • mpoeter - Wrote the original Ecto Query to AQL code
  • kianmeng - README changes & CI dep change
  • bodbdigr - Fixed AQL query typespec
  • hengestone - Added option to use different migrations directory

About

An ArangoDB Ecto adapter using ArangoX

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages