https://github.com/yask123/es_fields
Idiomatic way to generate elastic search field mappings.
https://github.com/yask123/es_fields
dsl elasticsearch rails ruby
Last synced: 2 months ago
JSON representation
Idiomatic way to generate elastic search field mappings.
- Host: GitHub
- URL: https://github.com/yask123/es_fields
- Owner: yask123
- License: mit
- Created: 2018-06-17T23:36:47.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-18T03:44:28.000Z (about 8 years ago)
- Last Synced: 2026-02-27T23:34:38.185Z (4 months ago)
- Topics: dsl, elasticsearch, rails, ruby
- Language: Ruby
- Homepage:
- Size: 13.7 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# EsFields
Provides an idiomatic way to generate elastic search field mappings.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'es_fields'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install es_fields
## Usage
```ruby
mapping do
field :name, :string, options: [:full_text_search]
field :age, :long
field :email, :string, options: [:filtering]
end
```
This will return a Hash which can be used with ElasticSearch API to add fields to an existing index.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/yask123/es_fields.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).