dbx v0.4.1

ORM and query builder for Crystal lang.

crystal-lang db database sql query orm crystal-db dbx crystal query-builder

Install & Use

Add the following code to your project's shard.yml under:

dependencies to use in production
- OR -
development_dependencies to use in development


dbx:
  github: Nicolab/crystal-dbx

Readme

✨ DBX

DB connections manager
Query builder
ORM

DBX is a Crystal lang module to query the database, built on top of crystal-db (common API for DB drivers).

DBX is designed in a decoupled way to embed only the necessary features (multi-connections manager, query builder, query executor and ORM).

Documentation

🚀 Guide
📘 API doc
📑 Spec tests

Contributing

Fork it (https://github.com/Nicolab/crystal-dbx/fork).
Create your feature branch (git checkout -b my-new-feature).
See Development.
Commit your changes (git commit -am 'Add some feature').
Push to the branch (git push origin my-new-feature).
Create a new Pull Request.

Development

You only need Git, Docker and Docker-compose installed on your machine.
Clone this repo and run ./scripts/prepare.
Run first docker-compose up,
1. then enter to container docker-compose exec test_pg bash (or test_sqlite service),
2. into the container just dev-spec.
Check the project before committing or pushing, from the host: ./scripts/check

It's just Docker and docker-compose, you can directly type all the commands Docker and docker-compose.

✨ Example:

Terminal 1

# Start the dev stack
docker-compose up

Terminal 2

# enter in the test_pg container
docker-compose exec test_pg bash

# then in the test_pg container
crystal run ./src/app.cr

# or with a recipe (helper)
just dev-spec # <= auto reload when the code change

# recipe list
just --list

Also, quickly: