Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add GitHub Flavored Markdown to README #7

Merged
merged 1 commit into from
Dec 31, 2012
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 43 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,62 +6,80 @@ ElasticSearch ruby client. Credit goes to my coworkers at GitHub, I just turned

Add to Gemfile

gem 'elasticsearch-client', :require => 'elasticsearch'
```ruby
gem 'elasticsearch-client', :require => 'elasticsearch'
```

Create connection:

index = 'twitter'
url = 'http://localhost:9200'
es = ElasticSearch::Index.new(index, url)
```ruby
index = 'twitter'
url = 'http://localhost:9200'
es = ElasticSearch::Index.new(index, url)
```

Index a document:

type = 'tweet'
doc = {:id => 'abcd', :foo => 'bar'}
es.add(type, doc[:id], doc)
```ruby
type = 'tweet'
doc = {:id => 'abcd', :foo => 'bar'}
es.add(type, doc[:id], doc)
```

Get a document:

id = '1234'
es.mget(type, [id])
```ruby
id = '1234'
es.mget(type, [id])
```

Get documents:

id2 = 'abcd'
es.mget(type, [id, id2])
```ruby
id2 = 'abcd'
es.mget(type, [id, id2])
```

Search:

query = {
:query => {
:bool => {
:must => {
:query_string => {
:default_field => '_all',
:query => 'foobar!',
}
}
```ruby
query = {
:query => {
:bool => {
:must => {
:query_string => {
:default_field => '_all',
:query => 'foobar!',
}
}
}
es.search(type, query)
}
}
es.search(type, query)
```

Remove record:

es.remove(type, id)
```ruby
es.remove(type, id)
```

Remove by query:

es.remove_by_query(type, :term => {:foo => 'bar'})
```ruby
es.remove_by_query(type, :term => {:foo => 'bar'})
```

Remove all of type:

es.remove_all(type)
```ruby
es.remove_all(type)
```

## Note on Patches/Pull Requests

* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so we don't break it in a future version unintentionally.
* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine, but bump version in a commit by itself so we can ignore when we pull)
* Send us a pull request. Bonus points for topic branches.
* Send us a pull request. Bonus points for topic branches.