Commit 33d339e24ae852b28b0665ba3991f1abdfdab375
1 parent
90275986
Exists in
master
and in
1 other branch
Removed Searchkick 3 upgrade doc [skip ci]
Showing
1 changed file
with
0 additions
and
57 deletions
Show diff stats
docs/Searchkick-3-Upgrade.md
... | ... | @@ -1,57 +0,0 @@ |
1 | -# Searchkick 3 Upgrade | |
2 | - | |
3 | -## Before You Upgrade | |
4 | - | |
5 | -Searchkick 3 no longer uses types, since they are deprecated in Elasticsearch 6. | |
6 | - | |
7 | -If you use inheritance, add to your parent model: | |
8 | - | |
9 | -```ruby | |
10 | -class Animal < ApplicationRecord | |
11 | - searchkick inheritance: true | |
12 | -end | |
13 | -``` | |
14 | - | |
15 | -And do a full reindex before upgrading. | |
16 | - | |
17 | -## Upgrading | |
18 | - | |
19 | -Update your Gemfile: | |
20 | - | |
21 | -```ruby | |
22 | -gem 'searchkick', '~> 3' | |
23 | -``` | |
24 | - | |
25 | -And run: | |
26 | - | |
27 | -```sh | |
28 | -bundle update searchkick | |
29 | -``` | |
30 | - | |
31 | -We recommend you don’t stem conversions anymore, so conversions for `pepper` don’t affect `peppers`, but if you want to keep the old behavior, use: | |
32 | - | |
33 | -```ruby | |
34 | -Searchkick.model_options = { | |
35 | - stem_conversions: true | |
36 | -} | |
37 | -``` | |
38 | - | |
39 | -Searchkick 3 disables the `_all` field by default, since Elasticsearch 6 removes the ability to reindex with it. If you’re on Elasticsearch 5 and still need it, add to your model: | |
40 | - | |
41 | -```ruby | |
42 | -class Product < ApplicationRecord | |
43 | - searchkick _all: true | |
44 | -end | |
45 | -``` | |
46 | - | |
47 | -If you use `record.reindex_async` or `record.reindex(async: true)`, replace it with: | |
48 | - | |
49 | -```ruby | |
50 | -record.reindex(mode: :async) | |
51 | -``` | |
52 | - | |
53 | -If you use `log: true` with `boost_by`, replace it with `modifier: "ln2p"`. | |
54 | - | |
55 | -If you use the `body` option and have warnings about incompatible options, remove them, as they now throw an `ArgumentError`. | |
56 | - | |
57 | -Check out the [changelog](https://github.com/ankane/searchkick/blob/master/CHANGELOG.md) for the full list of changes. |