This README is the one indexed from the repository at its latest ref, not from the tag for this version.

mysql_adapter.cr

Mysql adapter for active_record.cr. Uses crystal-mysql library

TODO

• [x] Implement with some default connection config
• [x] Fix segfaults from upstrem lib (crystal-mysql)
• [ ] Figure out a way to provide connection pool

Installation

Add it to your shard.yml

dependencies:
  mysql_adapter:
    github: waterlink/mysql_adapter.cr
    version: ~> 0.2

Usage

require "active_record"
require "mysql_adapter"

class Person < ActiveRecord::Model
  adapter mysql
  # ...
end

Connection configuration

Currently, connection can be configured through environment variables:

$ export MYSQL_HOST=localhost
$ export MYSQL_PORT=3306
$ export MYSQL_USER=test
$ export MYSQL_PASSWORD=welcome
$ export MYSQL_DATABASE=test_db

# And run your code
$ crystal run src/your_code.cr

Alternative way of doing that is to set these variables programmatically before using mysql_adapter or active_record:

# You are free to read these values from config file for instance.
ENV["MYSQL_HOST"] = "localhost"
ENV["MYSQL_PORT"] = 3306
ENV["MYSQL_USER"] = "test"
ENV["MYSQL_PASSWORD"] = "welcome"
ENV["MYSQL_DATABASE"] = "test_db"

Development

After cloning run initial setup:

./bin/setup

Just use normal TDD cycle. To run tests use:

./bin/test

This will run unit test in spec/ and integration spec in integration/.

Contributing

1. Fork it ( https://github.com/waterlink/mysql_adapter.cr/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

• waterlink Oleksii Fedorov - creator, maintainer