Code Monkey home page Code Monkey logo

mysql_adapter.cr's Introduction

mysql_adapter.cr Build Status

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

TODO

  • Implement with some default connection config
  • 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 crystal deps or crystal deps update.

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

mysql_adapter.cr's People

Contributors

waterlink avatar

Watchers

Tanner Donovan avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.