-
Notifications
You must be signed in to change notification settings - Fork 58
/
README.Rmd
288 lines (191 loc) · 10.7 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
elastic
=======
```{r echo=FALSE}
knitr::opts_chunk$set(
comment = "#>",
collapse = TRUE,
warning = FALSE,
message = FALSE
)
```
[](https://www.repostatus.org/#active)
[](https://github.com/ropensci/elastic/actions?query=workflow%3AR-check)
[](https://cranchecks.info/pkgs/elastic)
[](https://github.com/r-hub/cranlogs.app)
[](https://cran.r-project.org/package=elastic)
<!-- [](https://codecov.io/github/ropensci/elastic?branch=master) -->
**A general purpose R interface to [Elasticsearch](https://www.elastic.co/elasticsearch/)**
## Elasticsearch info
* [Elasticsearch home page](https://www.elastic.co/elasticsearch/)
* [API docs](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html)
## Compatibility
This client is developed following the latest stable releases, currently `v7.10.0`. It is generally compatible with older versions of Elasticsearch. Unlike the [Python client](https://github.com/elastic/elasticsearch-py#compatibility), we try to keep as much compatibility as possible within a single version of this client, as that's an easier setup in R world.
## Security
You're fine running ES locally on your machine, but be careful just throwing up ES on a server with a public IP address - make sure to think about security.
* Elastic has paid products - but probably only applicable to enterprise users
* DIY security - there are a variety of techniques for securing your Elasticsearch installation. A number of resources are collected in a [blog post](https://recology.info/2015/02/secure-elasticsearch/) - tools include putting your ES behind something like Nginx, putting basic auth on top of it, using https, etc.
## Installation
Stable version from CRAN
```{r eval=FALSE}
install.packages("elastic")
```
Development version from GitHub
```{r eval=FALSE}
remotes::install_github("ropensci/elastic")
```
```{r}
library('elastic')
```
## Install Elasticsearch
* [Elasticsearch installation help](https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html)
__w/ Docker__
Pull the official elasticsearch image
```
# elasticsearch needs to have a version tag. We're pulling 7.10.1 here
docker pull elasticsearch:7.10.1
```
Then start up a container
```
docker run -d -p 9200:9200 elasticsearch:7.10.1
```
Then elasticsearch should be available on port 9200, try `curl localhost:9200` and you should get the familiar message indicating ES is on.
If you're using boot2docker, you'll need to use the IP address in place of localhost. Get it by doing `boot2docker ip`.
__on OSX__
+ Download zip or tar file from Elasticsearch [see here for download](https://www.elastic.co/downloads), e.g., `curl -L -O https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-7.10.0-darwin-x86_64.tar.gz`
+ Extract: `tar -zxvf elasticsearch-7.10.0-darwin-x86_64.tar.gz`
+ Move it: `sudo mv elasticsearch-7.10.0 /usr/local`
+ Navigate to /usr/local: `cd /usr/local`
+ Delete symlinked `elasticsearch` directory: `rm -rf elasticsearch`
+ Add shortcut: `sudo ln -s elasticsearch-7.10.0 elasticsearch` (replace version with your version)
You can also install via Homebrew: `brew install elasticsearch`
> Note: for the 1.6 and greater upgrades of Elasticsearch, they want you to have java 8 or greater. I downloaded Java 8 from here http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html and it seemed to work great.
## Upgrading Elasticsearch
I am not totally clear on best practice here, but from what I understand, when you upgrade to a new version of Elasticsearch, place old `elasticsearch/data` and `elasticsearch/config` directories into the new installation (`elasticsearch/` dir). The new elasticsearch instance with replaced data and config directories should automatically update data to the new version and start working. Maybe if you use homebrew on a Mac to upgrade it takes care of this for you - not sure.
Obviously, upgrading Elasticsearch while keeping it running is a different thing ([some help here from Elastic](https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-upgrade.html)).
## Start Elasticsearch
* Navigate to elasticsearch: `cd /usr/local/elasticsearch`
* Start elasticsearch: `bin/elasticsearch`
I create a little bash shortcut called `es` that does both of the above commands in one step (`cd /usr/local/elasticsearch && bin/elasticsearch`).
## Initialization
The function `connect()` is used before doing anything else to set the connection details to your remote or local elasticsearch store. The details created by `connect()` are written to your options for the current session, and are used by `elastic` functions.
```{r}
x <- connect(port = 9200)
```
> If you're following along here with a local instance of Elasticsearch, you'll use `x` below to
do more stuff.
For AWS hosted elasticsearch, make sure to specify path = "" and the correct port - transport schema pair.
```{r eval=FALSE}
connect(host = <aws_es_endpoint>, path = "", port = 80, transport_schema = "http")
# or
connect(host = <aws_es_endpoint>, path = "", port = 443, transport_schema = "https")
```
If you are using Elastic Cloud or an installation with authentication (X-pack), make sure to specify path = "", user = "", pwd = "" and the correct port - transport schema pair.
```r
connect(host = <ec_endpoint>, path = "", user="test", pwd = "1234", port = 9243, transport_schema = "https")
```
<br>
## Get some data
Elasticsearch has a bulk load API to load data in fast. The format is pretty weird though. It's sort of JSON, but would pass no JSON linter. I include a few data sets in `elastic` so it's easy to get up and running, and so when you run examples in this package they'll actually run the same way (hopefully).
I have prepare a non-exported function useful for preparing the weird format that Elasticsearch wants for bulk data loads, that is somewhat specific to PLOS data (See below), but you could modify for your purposes. See `make_bulk_plos()` and `make_bulk_gbif()` [here](https://github.com/ropensci/elastic/blob/master/R/docs_bulk.r).
### Shakespeare data
Elasticsearch provides some data on Shakespeare plays. I've provided a subset of this data in this package. Get the path for the file specific to your machine:
```{r echo=FALSE}
library(elastic)
x <- connect()
if (x$es_ver() < 600) {
shakespeare <- system.file("examples", "shakespeare_data.json", package = "elastic")
} else {
shakespeare <- system.file("examples", "shakespeare_data_.json", package = "elastic")
shakespeare <- type_remover(shakespeare)
}
```
```{r eval=FALSE}
shakespeare <- system.file("examples", "shakespeare_data.json", package = "elastic")
# If you're on Elastic v6 or greater, use this one
shakespeare <- system.file("examples", "shakespeare_data_.json", package = "elastic")
shakespeare <- type_remover(shakespeare)
```
Then load the data into Elasticsearch:
> make sure to create your connection object with `connect()`
```{r eval=FALSE}
# x <- connect() # do this now if you didn't do this above
invisible(docs_bulk(x, shakespeare))
```
If you need some big data to play with, the shakespeare dataset is a good one to start with. You can get the whole thing and pop it into Elasticsearch (beware, may take up to 10 minutes or so.):
```sh
curl -XGET https://download.elastic.co/demos/kibana/gettingstarted/shakespeare_6.0.json > shakespeare.json
curl -XPUT localhost:9200/_bulk --data-binary @shakespeare.json
```
### Public Library of Science (PLOS) data
A dataset inluded in the `elastic` package is metadata for PLOS scholarly articles. Get the file path, then load:
```{r}
if (index_exists(x, "plos")) index_delete(x, "plos")
plosdat <- system.file("examples", "plos_data.json", package = "elastic")
plosdat <- type_remover(plosdat)
invisible(docs_bulk(x, plosdat))
```
### Global Biodiversity Information Facility (GBIF) data
A dataset inluded in the `elastic` package is data for GBIF species occurrence records. Get the file path, then load:
```{r}
if (index_exists(x, "gbif")) index_delete(x, "gbif")
gbifdat <- system.file("examples", "gbif_data.json", package = "elastic")
gbifdat <- type_remover(gbifdat)
invisible(docs_bulk(x, gbifdat))
```
GBIF geo data with a coordinates element to allow `geo_shape` queries
```{r}
if (index_exists(x, "gbifgeo")) index_delete(x, "gbifgeo")
gbifgeo <- system.file("examples", "gbif_geo.json", package = "elastic")
gbifgeo <- type_remover(gbifgeo)
invisible(docs_bulk(x, gbifgeo))
```
### More data sets
There are more datasets formatted for bulk loading in the `sckott/elastic_data` GitHub repository. Find it at <https://github.com/sckott/elastic_data>
<br>
## Search
Search the `plos` index and only return 1 result
```{r}
Search(x, index = "plos", size = 1)$hits$hits
```
Search the `plos` index, and query for _antibody_, limit to 1 result
```{r}
Search(x, index = "plos", q = "antibody", size = 1)$hits$hits
```
## Get documents
Get document with id=4
```{r}
docs_get(x, index = 'plos', id = 4)
```
Get certain fields
```{r}
docs_get(x, index = 'plos', id = 4, fields = 'id')
```
## Get multiple documents via the multiget API
Same index and different document ids
```{r}
docs_mget(x, index = "plos", id = 1:2)
```
## Parsing
You can optionally get back raw `json` from `Search()`, `docs_get()`, and `docs_mget()` setting parameter `raw=TRUE`.
For example:
```{r}
(out <- docs_mget(x, index = "plos", id = 1:2, raw = TRUE))
```
Then parse
```{r}
jsonlite::fromJSON(out)
```
## Known pain points
* On secure Elasticsearch servers:
* `HEAD` requests don't seem to work, not sure why
* If you allow only `GET` requests, a number of functions that require
`POST` requests obviously then won't work. A big one is `Search()`, but
you can use `Search_uri()` to get around this, which uses `GET` instead
of `POST`, but you can't pass a more complicated query via the body
## Screencast
A screencast introducing the package: <a href="https://vimeo.com/124659179">vimeo.com/124659179</a>
## Meta
* Please [report any issues or bugs](https://github.com/ropensci/elastic/issues)
* License: MIT
* Get citation information for `elastic` in R doing `citation(package = 'elastic')`
* Please note that this package is released with a [Contributor Code of Conduct](https://ropensci.org/code-of-conduct/). By contributing to this project, you agree to abide by its terms.