https://github.com/localytics/odbc_adapter

An ActiveRecord ODBC adapter
https://github.com/localytics/odbc_adapter

active-record odbc rails ruby

Last synced: 2 months ago
JSON representation

An ActiveRecord ODBC adapter

• Host: GitHub
• URL: https://github.com/localytics/odbc_adapter
• Owner: localytics
• License: mit
• Created: 2017-01-11T22:11:36.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-08-13T06:49:54.000Z (6 months ago)
• Last Synced: 2024-11-13T08:57:19.881Z (3 months ago)
• Topics: active-record, odbc, rails, ruby
• Language: Ruby
• Homepage:
• Size: 162 KB
• Stars: 46
• Watchers: 8
• Forks: 107
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ODBCAdapter

[![Build Status](https://travis-ci.org/localytics/odbc_adapter.svg?branch=master)](https://travis-ci.org/localytics/odbc_adapter)

[![Gem](https://img.shields.io/gem/v/odbc_adapter.svg)](https://rubygems.org/gems/odbc_adapter)

An ActiveRecord ODBC adapter. Master branch is working off of Rails 5.0.1. Previous work has been done to make it compatible with Rails 3.2 and 4.2; for those versions use the 3.2.x or 4.2.x gem releases.

This adapter will work for basic queries for most DBMSs out of the box, without support for migrations. Full support is built-in for MySQL 5 and PostgreSQL 9 databases. You can register your own adapter to get more support for your DBMS using the `ODBCAdapter.register` function.

A lot of this work is based on [OpenLink's ActiveRecord adapter](http://odbc-rails.rubyforge.org/) which works for earlier versions of Rails.

## Installation

Ensure you have the ODBC driver installed on your machine. You will also need the driver for whichever database to which you want ODBC to connect.

Add this line to your application's Gemfile:

```ruby

gem 'odbc_adapter'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install odbc_adapter

## Usage

Configure your `database.yml` by either using the `dsn` option to point to a DSN that corresponds to a valid entry in your `~/.odbc.ini` file:

```

development:

  adapter:  odbc

  dsn: MyDatabaseDSN

```

or by using the `conn_str` option and specifying the entire connection string:

```

development:

  adapter: odbc

  conn_str: "DRIVER={PostgreSQL ANSI};SERVER=localhost;PORT=5432;DATABASE=my_database;UID=postgres;"

```

ActiveRecord models that use this connection will now be connecting to the configured database using the ODBC driver.

## Testing

To run the tests, you'll need the ODBC driver as well as the connection adapter for each database against which you're trying to test. Then run `DSN=MyDatabaseDSN bundle exec rake test` and the test suite will be run by connecting to your database.

## Testing Using a Docker Container Because ODBC on Mac is Hard

Tested on Sierra.

Run from project root:

```

bundle package

docker build -f Dockerfile.dev -t odbc-dev .

# Local mount mysql directory to avoid some permissions problems

mkdir -p /tmp/mysql

docker run -it --rm -v $(pwd):/workspace -v /tmp/mysql:/var/lib/mysql odbc-dev:latest

# In container

docker/test.sh

```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/localytics/odbc_adapter.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).