Crecto

https://www.crecto.dev/

Robust database wrapper for Crystal. Inspired by Ecto for Elixir language.

With built in query composer, associations, transactions, validations, constraints, and more.

Website with guides and examples - https://www.crecto.dev/

Example

user = User.new
user.name = "Shakira"

changeset = Repo.insert(user)
changeset.errors.any?

inserted_user = changeset.instance
inserted_user.name = "Keanu"

changeset = Repo.update(user)
changeset.errors.any?

updated_user = changeset.instance

changeset = Repo.delete(updated_user)

Usage and Guides

New website and API docs coming soon!

Benchmarks

• VS raw crystal-pg

Development

Testing

Specs are located in the spec directory. Since this is an ORM, running specs requires a database connection.

Quick Start (SQLite)

The project comes pre-configured with SQLite support. Simply run:

crystal spec

This will create a local SQLite database (./crecto_test.db) and run all 223 tests.

Testing with Other Databases

To test with PostgreSQL or MySQL:

1. Copy the example configuration:

   cp spec/repo.example.cr spec/repo.cr

2. Edit spec/repo.cr to uncomment and configure your preferred database:

   # For PostgreSQL:
   config do |conf|
     conf.adapter = Crecto::Adapters::Postgres
     conf.uri = "postgres://localhost/crecto_test"
   end
   
   # For MySQL:
   config do |conf|
     conf.adapter = Crecto::Adapters::MySQL
     conf.uri = "mysql://localhost/crecto_test"
   end

3. Run the tests:

   crystal spec

Testing with Docker

To test all three supported database types using Docker:

docker-compose up

This will start PostgreSQL and MySQL containers and run the test suite against all database adapters.

Database Setup

The database must exist prior to testing. Migrations for each database type are available in spec/migrations/.

When contributing, please test against all supported databases before submitting a pull request.

Contributing

1. Fork it ( https://github.com/Crecto/crecto/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

Development Notes

When developing against crecto, the database must exist prior to testing. There are migrations for each database type in spec/migrations, and references on how to migrate then in the .travis.yml file.

Create a new file spec/repo.cr and create a module name Repo to use for testing. There are example repos for each database type in the spec folder: travis_pg_repo.cr, travis_mysql_repo.cr, and travis_sqlite_repo.cr

When submitting a pull request, please test against all 3 databases.

Thanks / Inspiration

• Ecto
• AciveRecord
• active_record.cr
• crystal-api-backend