# activerecord-indexhint

**Repository Path**: rubygems/activerecord-indexhint

## Basic Information

- **Project Name**: activerecord-indexhint
- **Description**: No description available
- **Primary Language**: Ruby
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2016-10-14
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Activerecord::Indexhint

[![Build Status](https://travis-ci.org/hirocaster/activerecord-indexhint.svg?branch=master)](https://travis-ci.org/hirocaster/activerecord-indexhint) [![Coverage Status](https://coveralls.io/repos/hirocaster/activerecord-slave/badge.svg?branch=master&service=github)](https://coveralls.io/github/hirocaster/activerecord-slave?branch=master) [![Code Climate](https://codeclimate.com/github/hirocaster/activerecord-indexhint/badges/gpa.svg)](https://codeclimate.com/github/hirocaster/activerecord-indexhint) [![Dependency Status](https://gemnasium.com/hirocaster/activerecord-indexhint.svg)](https://gemnasium.com/hirocaster/activerecord-indexhint)

Add method, index hint(use/ignore/force index) for ActiveRecord(MySQL).

## Installation

Add this line to your application's Gemfile:

    gem 'activerecord-indexhint'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install activerecord-indexhint

## Usage

```ruby
class User < ActiveRecord::Base
end

index_name = "index_users_on_name"

User.use_index(index_name).where(name: "foo")
# => "SELECT `users`.* FROM `users` USE INDEX (index_users_on_name) WHERE `users`.`name` = 'foo'"

User.ignore_index(index_name).where(name: "foo")
# => "SELECT `users`.* FROM `users` IGNORE INDEX (index_users_on_name) WHERE `users`.`name` = 'foo'"

User.force_index(index_name).where(name: "foo")
# => "SELECT `users`.* FROM `users` FORCE INDEX (index_users_on_name) WHERE `users`.`name` = 'foo'"
```

## Contributing

1. Fork it ( http://github.com/hirocaster/activerecord-indexhint/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 new Pull Request