elasticgraph-elasticsearch 1.0.0.rc3 → 1.0.0.rc4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +51 -1
  3. metadata +11 -17
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8732c5f31cf9b1c703e9517ce6cacd9450e5d1e7ebf58d2b180390df8e2b9f89
4
- data.tar.gz: 726f4139deb35f25f44b4750d43fd8ac1cb4f1f201c672200cbe24dc7b56f4f6
3
+ metadata.gz: f2e6e0888ef072451b36909565146055b08fabe0c4afbff486e4fc778ea0334e
4
+ data.tar.gz: 93d2648ec5fda6dd21811a3c2b8fd7e0e2a2c88a0fa6a63a6c0ea67e03694f8d
5
5
  SHA512:
6
- metadata.gz: 68d016960d80436f405940b4f4cd0805ba9477f6bf286e031e6a9f59eaad0b2064c7ff9612a2be22a69141a33fdad9be2848be1a25f154e13ecb37412902cdb0
7
- data.tar.gz: 83547bf47b2f4e16af7c6adacbddae12a4d7474bf4f02cc212e8219857813aa5edbe1b12ffb019d08e610f21fe132aef4131e1894ba174c6481f482d2c76f17f
6
+ metadata.gz: a42440a4a568f2a04a8ef7067626acf976c97ad5e6a25adf32db5360e168387b32a937eaa4be543dec9bf375dde1c99236b41775e37f60460b85f8ec1b51b2eb
7
+ data.tar.gz: 588cb1048f3df35591946d53878e234d4b4feed1a69a0710b0a474c163032bb81703d767af97d309c275e41060c2e4554e3845286b946ee023408590b4582ec6
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # ElasticGraph::Elasticsearch
2
2
 
3
- Wraps the official Elasticsearch client for use by ElasticGraph.
3
+ Wraps the official [Elasticsearch client](https://github.com/elastic/elasticsearch-ruby) for use by ElasticGraph.
4
4
 
5
5
  ## Dependency Diagram
6
6
 
@@ -27,3 +27,53 @@ graph LR;
27
27
  click faraday href "https://rubygems.org/gems/faraday" "Open on RubyGems.org" _blank;
28
28
  click faraday-retry href "https://rubygems.org/gems/faraday-retry" "Open on RubyGems.org" _blank;
29
29
  ```
30
+
31
+ ## Usage
32
+
33
+ ElasticGraph projects are configured to use this gem or `elasticgraph-opensearch`, based on which datastore is being used.
34
+
35
+ To use an ElasticGraph project with Elasticsearch, bootstrap an ElasticGraph project with `--datastore elasticsearch`:
36
+
37
+ ```bash
38
+ gem exec elasticgraph new path/to/project --datastore elasticsearch
39
+ ```
40
+
41
+ ### Migrate from OpenSearch to Elasticsearch
42
+
43
+ If you need to convert an existing project to use Elasticsearch instead of OpenSearch, here's how to do that.
44
+
45
+ First, replace `elasticgraph-opensearch` with `elasticgraph-elasticsearch` in the `Gemfile`:
46
+
47
+ ```diff
48
+ diff --git a/Gemfile b/Gemfile
49
+ index 4a5ef1e..cc0e1fb 100644
50
+ --- a/Gemfile
51
+ +++ b/Gemfile
52
+ @@ -7,7 +7,7 @@ gem "elasticgraph-local", *elasticgraph_details
53
+ gem "elasticgraph-query_registry", *elasticgraph_details
54
+
55
+ # Can be elasticgraph-elasticsearch or elasticgraph-opensearch based on the datastore you want to use.
56
+ -gem "elasticgraph-opensearch", *elasticgraph_details
57
+ +gem "elasticgraph-elasticsearch", *elasticgraph_details
58
+
59
+ gem "httpx", "~> 1.3"
60
+
61
+ ```
62
+
63
+ Then, update the settings YAML file to configure `elasticsearch` as the cluster backend:
64
+
65
+ ```diff
66
+ diff --git a/config/settings/local.yaml b/config/settings/local.yaml
67
+ index 963f4f9..16eb063 100644
68
+ --- a/config/settings/local.yaml
69
+ +++ b/config/settings/local.yaml
70
+ @@ -4,7 +4,7 @@ datastore:
71
+ require: httpx/adapters/faraday
72
+ clusters:
73
+ main:
74
+ - backend: opensearch
75
+ + backend: elasticsearch
76
+ url: http://localhost:9200
77
+ settings: {}
78
+ index_definitions:
79
+ ```
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: elasticgraph-elasticsearch
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0.rc3
4
+ version: 1.0.0.rc4
5
5
  platform: ruby
6
6
  authors:
7
7
  - Myron Marston
@@ -17,34 +17,28 @@ dependencies:
17
17
  requirements:
18
18
  - - '='
19
19
  - !ruby/object:Gem::Version
20
- version: 1.0.0.rc3
20
+ version: 1.0.0.rc4
21
21
  type: :runtime
22
22
  prerelease: false
23
23
  version_requirements: !ruby/object:Gem::Requirement
24
24
  requirements:
25
25
  - - '='
26
26
  - !ruby/object:Gem::Version
27
- version: 1.0.0.rc3
27
+ version: 1.0.0.rc4
28
28
  - !ruby/object:Gem::Dependency
29
29
  name: elasticsearch
30
30
  requirement: !ruby/object:Gem::Requirement
31
31
  requirements:
32
32
  - - "~>"
33
33
  - !ruby/object:Gem::Version
34
- version: '9.0'
35
- - - ">="
36
- - !ruby/object:Gem::Version
37
- version: 9.0.3
34
+ version: '9.1'
38
35
  type: :runtime
39
36
  prerelease: false
40
37
  version_requirements: !ruby/object:Gem::Requirement
41
38
  requirements:
42
39
  - - "~>"
43
40
  - !ruby/object:Gem::Version
44
- version: '9.0'
45
- - - ">="
46
- - !ruby/object:Gem::Version
47
- version: 9.0.3
41
+ version: '9.1'
48
42
  - !ruby/object:Gem::Dependency
49
43
  name: faraday
50
44
  requirement: !ruby/object:Gem::Requirement
@@ -54,7 +48,7 @@ dependencies:
54
48
  version: '2.13'
55
49
  - - ">="
56
50
  - !ruby/object:Gem::Version
57
- version: 2.13.2
51
+ version: 2.13.4
58
52
  type: :runtime
59
53
  prerelease: false
60
54
  version_requirements: !ruby/object:Gem::Requirement
@@ -64,7 +58,7 @@ dependencies:
64
58
  version: '2.13'
65
59
  - - ">="
66
60
  - !ruby/object:Gem::Version
67
- version: 2.13.2
61
+ version: 2.13.4
68
62
  - !ruby/object:Gem::Dependency
69
63
  name: faraday-retry
70
64
  requirement: !ruby/object:Gem::Requirement
@@ -99,10 +93,10 @@ licenses:
99
93
  - MIT
100
94
  metadata:
101
95
  bug_tracker_uri: https://github.com/block/elasticgraph/issues
102
- changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.0.0.rc3
103
- documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.0.0.rc3/
96
+ changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.0.0.rc4
97
+ documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.0.0.rc4/
104
98
  homepage_uri: https://block.github.io/elasticgraph/
105
- source_code_uri: https://github.com/block/elasticgraph/tree/v1.0.0.rc3/elasticgraph-elasticsearch
99
+ source_code_uri: https://github.com/block/elasticgraph/tree/v1.0.0.rc4/elasticgraph-elasticsearch
106
100
  gem_category: datastore_adapter
107
101
  rdoc_options: []
108
102
  require_paths:
@@ -121,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
121
115
  - !ruby/object:Gem::Version
122
116
  version: '0'
123
117
  requirements: []
124
- rubygems_version: 3.6.7
118
+ rubygems_version: 3.6.9
125
119
  specification_version: 4
126
120
  summary: Wraps the Elasticsearch client for use by ElasticGraph.
127
121
  test_files: []