elastic v1.2.0

NEW FEATURES

• Search() and Search_uri() gain new parameter ignore_unavailable to determine what happens if an index name does not exist (#273)
• connect() gains new parameter ignore_version. Internally, elastic sometimes checks the Elasticsearch version that the user is connected to to determine what to do. may be useful when it's not possible to check the Elasticsearch version, e.g., when its not possible to ping the root route of the API (#275)
• all docs bulk functions gain parameter digits that is passed down to jsonlite::toJSON() used internally. thus, digits will control the number of decimal digits used in the JSON the package creates to be bulk loaded into Elasticsearch (#279)

MINOR IMPROVEMENTS

• fix README instructions on installing Elasticsearch from docker; there's no latest tag, so use a specific version (#277) thanks @ColinFay

elastic v1.1.0

NEW FEATURES

• types were deprecated in Elasticsearch v7 and greater, and will be removed in Elasticsearch v8 and greater. this version makes type optional in all/most functions so that users with older Elasticsearch versions can still use them, but users with v7 or v8 installations don't have to use them (#251) (#270)
• gains new method index_shrink() for index shrinking (#192)
• through fixing functionality in docs_bulk() to allow pipline attachments to work, all docs_bulk methods that do http requests (i.e, not prep fxns) gain the parameter query to pass through query parameters to the http request, including for example pipeline, _source etc. (#253)
• Search() and Search_uri() gain the parameter track_total_hits (default: TRUE) (#262) thanks @orenov

MINOR IMPROVEMENTS

• the warn parameter in connect() was not being used across the entire package; now all methods should capture any warnings returned in the Elasticsearch HTTP API headers (#261)
• clarify in docs that connect() does not create a DBI like connection object (#265)
• fix warning in index_analyze() function where as is method I() should only be applied if the input parameter is not NULL - to avoid a warning (#269)

BUG FIXES

• fix to docs_bulk_update(): subsetting data.frame's was not working correctly when data.frame's had only 1 column; fixed (#260)
• fix to internal method es_ver() in the Elasticsearch class to be more flexible in capturing Elasticsearch version (#268)
• require newest crul version, helps fix a problem with passing along authentication details (#267)

elastic v1.0.0

BREAKING CHANGE

(#87) The connect() function is essentially the same, with some changes, but now you pass the connection object to each function all. This indeed will break code. That's why this is a major version bump.

There is one very big downside to this: breaks existing code. That's the big one. I do apologize for this, but I believe that is outweighed by the upsides: passing the connection object matches behavior in similar R packages (e.g., all the SQL database clients); you can now manage as many different connection objects as you like in the same R session; having the connection object as an R6 class allows us to have some simple methods on that object to ping the server, etc. In addition, all functions will error with an informative message if you don't pass the connection object as the first thing.

NEW FEATURES

• gains new ingest functions pipeline_create, pipeline_delete, pipeline_get, pipeline_simulate, and pipeline_attachment() (#191) (#226)
• gains new function docs_delete_by_query() and docs_update_by_query() to delete or update multiple documents at once, respectively; and new function reindex() to reindex all documents from one index to another (#237) (#195)
• now using crul for HTTP requests. this only should matter with respect to passing in curl options (#168)
• recent versions of Elasticsearch are starting to include warnings in response headers for deprecations and other things. These can now be turned on or off with connect() (#241)
• gains new functions for the bulk API: docs_bulk_create(), docs_bulk_delete(), docs_bulk_index(). each of which are tailored to doing the operation in the function name: creating docs, deleting docs, or indexing docs (#183)
• gains new function type_remover() as a utility function to help users remove types from their files to use for bulk loading; could be used on example files in this package or user supplied files (#180)
• gains function alias_rename() to rename aliases

MINOR IMPROVEMENTS

• fixed scroll() example that wasn't working (#228)
• rework alias_create() (#230)
• move initialize Elasticsearch connection section of README higher up to emphasize it in the right place (#231) thanks @mbannert
• whether you want "simple" or "complete" errors no longer sets env vars internally, but is passed through the internal error checker so that choices about type of errors for different connection objects do not affect one another (#242)
• docs_get gains new parameters source_includes and source_excludes to include or exclude certain fields in the returned document (#246) thanks @Jensxy
• added more examples to index_create() (#211)
• add examples to Search() and Search_uri() docs of how to use profiles (https://www.elastic.co/guide/en/elasticsearch/reference/current/search-profile.html) (#194)
• additional example added to docs_bulk_prep() for doing a mix of actions (i.e., delete, create, etc.)
• improved examples throughout package docs so that examples are more self-contained
• add include_type_name param in mappings fxns (#250)

BUG FIXES

• docs_bulk_update() was not handling boolean values correctly. now fixed (#239) (#240) thanks to @dpmccabe

DEPRECATED AND DEFUNCT

• the info() method has been moved inside of the connection object. after calling x = connect() you can call x$info()
• the ping() method has been marked as deprecated; instead, call ping() on the connection object created by a call to connect()

elastic v1.0.0-rc1

install: remotes::install_github("ropensci/[email protected]")

BREAKING CHANGE

(#87) The connect() function is essentially the same, with some changes, but now you pass the connection object to each function all. This indeed will break code. That's why this is a major version bump.

There is one very big downside to this: breaks existing code. That's the big one. I do apologize for this, but I believe that is outweighed by the upsides: passing the connection object matches behavior in similar R packages (e.g., all the SQL database clients); you can now manage as many different connection objects as you like in the same R session; having the connection object as an R6 class allows us to have some simple methods on that object to ping the server, etc. In addition, all functions will error with an informative message if you don't pass the connection object as the first thing.

NEW FEATURES

• gains new ingest functions pipeline_create, pipeline_delete, pipeline_get, pipeline_simulate, and pipeline_attachment() (#191) (#226)
• gains new function docs_delete_by_query() and docs_update_by_query() to delete or update multiple documents at once, respectively; and new function reindex() to reindex all documents from one index to another (#237) (#195)
• now using crul for HTTP requests. this only should matter with respect to passing in curl options (#168)
• recent versions of Elasticsearch are starting to include warnings in response headers for deprecations and other things. These can now be turned on or off with connect() (#241)
• gains new functions for the bulk API: docs_bulk_create(), docs_bulk_delete(), docs_bulk_index(). each of which are tailored to doing the operation in the function name: creating docs, deleting docs, or indexing docs (#183)
• gains new function type_remover() as a utility function to help users remove types from their files to use for bulk loading; could be used on example files in this package or user supplied files (#180)
• gains function alias_rename() to rename aliases

MINOR IMPROVEMENTS

• fixed scroll() example that wasn't working (#228)
• rework alias_create() (#230)
• move initialize Elasticsearch connection section of README higher up to emphasize it in the right place (#231) thanks @mbannert
• whether you want "simple" or "complete" errors no longer sets env vars internally, but is passed through the internal error checker so that choices about type of errors for different connection objects do not affect one another (#242)
• docs_get gains new parameters source_includes and source_excludes to include or exclude certain fields in the returned document (#246) thanks @Jensxy
• added more examples to index_create() (#211)
• add examples to Search() and Search_uri() docs of how to use profiles (https://www.elastic.co/guide/en/elasticsearch/reference/current/search-profile.html) (#194)
• additional example added to docs_bulk_prep() for doing a mix of actions (i.e., delete, create, etc.)
• improved examples throughout package docs so that examples are more self-contained

BUG FIXES

• docs_bulk_update() was not handling boolean values correctly. now fixed (#239) (#240) thanks to @dpmccabe

DEPRECATED AND DEFUNCT

• the info() method has been moved inside of the connection object. after calling x = connect() you can call x$info()
• the ping() method has been marked as deprecated; instead, call ping() on the connection object created by a call to connect()

elastic v0.8.4

NEW FEATURES

• Gains new function docs_bulk_update() to do bulk updates to documents (#169)

MINOR IMPROVEMENTS

• Vignettes weren't showing up on CRAN, fixed (#205)
• Added an example of using WKT in a query (#215)
• using markdown docs (#209)
• id is now optional in docs_create() - if you don't pass a document identifier Elasticsearch generates one for you (#216) thanks @jbrant
• docs_bulk() gains new parameter quiet to optionally turn off the progress bar (#202)

BUG FIXES

• Fix to docs_bulk() for encoding in different locales (#223) (#224) thanks @Lchiffon
• Fix for index_get(): you can now only pass in one value to the features parameter (one of settings, mappings, or aliases) (#218) thanks @happyshows
• Fix to index_create() to handle a list body, in addition to a JSON body (#214) thanks @emillykkejensen
• Fix to docs_bulk() for document IDs as factors (#212) thanks @AMR-KELEG
• Temporary files created when using docs_bulk() (and taking up disk space) are cleaned up now (deleted), though if you pass in your own file paths you have to clean them up (#208) thanks @emillykkejensen

elastic v0.8.0

Scroll changes

• changed to S3 setup, with methods for character and
  list.
• first parameter of scroll() and scroll_clear() is now x, should
  only matter if you specified the parameter name for the first parameter
• scroll parameter in scroll() function is now time_scroll
• Added asdf (for "as data.frame") to scroll() to give back a
  data.frame (#163)
• streaming option added to scroll(), see parameter stream_opts in the
  docs and examples (#160)
• general docs improvements (#182)

NEW FEATURES

• New functions tasks and tasks_cancel for the tasks API (#145)
• streaming option added to Search(), see parameter stream_opts in the
  docs and examples. scroll parameter in Search() is now time_scroll
  (#160)
• New function field_caps (for field capabilities) - in ES v5.4 and
  greater
• New function reindex for the reindex ES API (#134)
• New functions index_template_get, index_template_put,
  index_template_exists, and index_template_delete for the indices
  templates ES API (#133)
• New function index_forcemerge for the ES index _forcemerge
  route (#176)

MINOR IMPROVEMENTS

• Added examples to docs for Search and Search_uri for how
  to show progress bar (#162)
• Small docs fix to docs_bulk to clarify what's allowed as first
  parameter input (#173)
• docs_bulk change to internal JSON preparation to use
  na = "null" and auto_unbox = TRUE in the jsonlite::toJSON
  call. This means that NA's in R become null in the JSON
  and atomic vectors are unboxed (#174) thanks @pieterprovoost
• mapping_create gains update_all_types parameter; and new man
  file to explain how to enable fielddata if sorting needed (#164)
• suggest is used through query DSL instead of a route, added
  example to Search (#102)
• Now caching internal ping() calls - so that after the first one
  we used the cached version if called again within the same R session.
  Should help speed up some code with respect to http calls (#184)
  thanks @henfiber
• Fixes to percolate functions and docs for differences in percolate
  functionality pre v5 and post v5 (#176)
• All http requests now contain content-type headers, for the most part
  application/json (#197), though functions that work with the bulk API
  use application/x-ndjson (#186)
• docs fix to mapping_create egs (#199)
• README now includes example of how to connect when your ES is using X-pack
  (#185) thanks @ugosan

BUG FIXES

• fixes for normalizing url paths (#181)
• fix to type_exists to work on ES versions less to and greater than
  v5 (#189)
• fix to field_stats to indicate that its no longer avail. in
  ES v5.4 and above - and that the fields parameter in ES >= v5 is
  gone (#190)

elastic v0.7.8

NEW FEATURES

• New function docs_update() to do partial document updates (#152)
• New function docs_bulk_prep() to prepare bulk format files
  that you can use to load into Elasticsearch with this package, on the
  command line, or in any other context (Python, Ruby, etc.) (#154)

MINOR IMPROVEMENTS

• We're no longer running a check that your ES server is up before
  every request to the server. This makes request faster, but may lead to
  less informative errors when your server is down or in some other state
  than fully operational (#149)
• Tweaks here and there to make sure elastic works with Elasticsearch
  v5. Note that not all v5 features are included here yet. (#153)

BUG FIXES

• docs_bulk() was not working on single column data.frame's. now is
  working. (#151) thanks @gustavobio
• docs_* functions now support ids with whitespace in them. (#155)
• fixes to docs_mget() to fix requesting certain fields back.

elastic v0.7.6

BUG FIXES

• Allow usage of es_base parameter in connect() - Now, instead of
  stop() on es_base usage, we use its value for es_host. Only
  pass in one or the other of es_base and es_host, not both.
  (#146) thanks @MarcinKosinski

elastic v0.7.4

NEW FEATURES

• package gains new set of functions for working with search templates:
  Search_template(), Search_template_register(), Search_template_get(),
  Search_template_delete(), and Search_template_render() (#101)

MINOR IMPROVEMENTS

• Improved documentation for docs_delete, docs_get and docs_create
  to list correctly that numeric and character values are accepted for
  the id parameter - before stated that numeric values allowed only (#144)
  thanks @dominoFire
• Added tests for illegal characters in index names.

BUG FIXES

• Fixed bug introduced into Search and related functions where
  wildcards in indeces didn't work. Turned out we url escaped twice
  unintentionally. Fixed now, and more tests added for wildcards.
  (#143) thanks @martijnvanbeers

elastic v0.7.2

MINOR IMPROVEMENTS

• Changed docs_bulk() to always return a list, whether it's given a file,
  data.frame, or list. For a file, a named list is returned, while for a
  data.frame or list an unnamed list is returned as many chunks can be processed
  and we don't attempt to wrangle the list output. Inputs of data.frame and list
  used to return NULL as we didn't return anything from the internal for loop.
  You can wrap docs_bulk in invisible() if you don't want the list printed
  (#142)

BUG FIXES

• Fixed bug in docs_bulk() and msearch() in which base URL construction
  was not done correctly (#141) thanks @steeled !