elasticgraph-opensearch 1.0.0.rc3 → 1.0.0
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.
- checksums.yaml +4 -4
- data/README.md +51 -1
- metadata +9 -9
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 13a502a1b18a6e9b4a0bec524cd3faa33df1d1af883636f3f1387bf5958ac36a
|
|
4
|
+
data.tar.gz: 744f717b6b5a1ab9d66aa1d67bcf050e143e340e9fb79b51afe831efe5aa822a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b7ebae6f77a377afb3a255453b6c5bc840f4217e4681b64ffb53f9a17381f34e9acfcef78e048dde79cde5859400c1b2173d734b82a510d77418620010b68c38
|
|
7
|
+
data.tar.gz: 2f6e87fa79d646b0df27e24837704f6ed7d63a499ac74d330d9299dffc3bf0276e5dc384793e8031d583a7a50a53c16ff06d06280e6d385c26909a58b19356dc
|
data/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# ElasticGraph::OpenSearch
|
|
2
2
|
|
|
3
|
-
Wraps the official OpenSearch client for use by ElasticGraph.
|
|
3
|
+
Wraps the official [OpenSearch client](https://github.com/opensearch-project/opensearch-ruby/) for use by ElasticGraph.
|
|
4
4
|
|
|
5
5
|
## Dependency Diagram
|
|
6
6
|
|
|
@@ -30,3 +30,53 @@ graph LR;
|
|
|
30
30
|
click faraday-retry href "https://rubygems.org/gems/faraday-retry" "Open on RubyGems.org" _blank;
|
|
31
31
|
click opensearch-ruby href "https://rubygems.org/gems/opensearch-ruby" "Open on RubyGems.org" _blank;
|
|
32
32
|
```
|
|
33
|
+
|
|
34
|
+
## Usage
|
|
35
|
+
|
|
36
|
+
ElasticGraph projects are configured to use this gem or `elasticgraph-elasticsearch`, based on which datastore is being used.
|
|
37
|
+
|
|
38
|
+
To use an ElasticGraph project with OpenSearch, bootstrap an ElasticGraph project with `--datastore opensearch`:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
gem exec elasticgraph new path/to/project --datastore opensearch
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### Migrate from Elasticsearch to OpenSearch
|
|
45
|
+
|
|
46
|
+
If you need to convert an existing project to use OpenSearch instead of Elasticsearch, here's how to do that.
|
|
47
|
+
|
|
48
|
+
First, replace `elasticgraph-elasticsearch` with `elasticgraph-opensearch` in the `Gemfile`:
|
|
49
|
+
|
|
50
|
+
```diff
|
|
51
|
+
diff --git a/Gemfile b/Gemfile
|
|
52
|
+
index 4a5ef1e..cc0e1fb 100644
|
|
53
|
+
--- a/Gemfile
|
|
54
|
+
+++ b/Gemfile
|
|
55
|
+
@@ -7,7 +7,7 @@ gem "elasticgraph-local", *elasticgraph_details
|
|
56
|
+
gem "elasticgraph-query_registry", *elasticgraph_details
|
|
57
|
+
|
|
58
|
+
# Can be elasticgraph-elasticsearch or elasticgraph-opensearch based on the datastore you want to use.
|
|
59
|
+
-gem "elasticgraph-elasticsearch", *elasticgraph_details
|
|
60
|
+
+gem "elasticgraph-opensearch", *elasticgraph_details
|
|
61
|
+
|
|
62
|
+
gem "httpx", "~> 1.3"
|
|
63
|
+
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Then, update the settings YAML file to configure `opensearch` as the cluster backend:
|
|
67
|
+
|
|
68
|
+
```diff
|
|
69
|
+
diff --git a/config/settings/local.yaml b/config/settings/local.yaml
|
|
70
|
+
index 963f4f9..16eb063 100644
|
|
71
|
+
--- a/config/settings/local.yaml
|
|
72
|
+
+++ b/config/settings/local.yaml
|
|
73
|
+
@@ -4,7 +4,7 @@ datastore:
|
|
74
|
+
require: httpx/adapters/faraday
|
|
75
|
+
clusters:
|
|
76
|
+
main:
|
|
77
|
+
- backend: elasticsearch
|
|
78
|
+
+ backend: opensearch
|
|
79
|
+
url: http://localhost:9200
|
|
80
|
+
settings: {}
|
|
81
|
+
index_definitions:
|
|
82
|
+
```
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: elasticgraph-opensearch
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.0.0
|
|
4
|
+
version: 1.0.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Myron Marston
|
|
@@ -17,14 +17,14 @@ dependencies:
|
|
|
17
17
|
requirements:
|
|
18
18
|
- - '='
|
|
19
19
|
- !ruby/object:Gem::Version
|
|
20
|
-
version: 1.0.0
|
|
20
|
+
version: 1.0.0
|
|
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
|
|
27
|
+
version: 1.0.0
|
|
28
28
|
- !ruby/object:Gem::Dependency
|
|
29
29
|
name: faraday
|
|
30
30
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -34,7 +34,7 @@ dependencies:
|
|
|
34
34
|
version: '2.13'
|
|
35
35
|
- - ">="
|
|
36
36
|
- !ruby/object:Gem::Version
|
|
37
|
-
version: 2.13.
|
|
37
|
+
version: 2.13.4
|
|
38
38
|
type: :runtime
|
|
39
39
|
prerelease: false
|
|
40
40
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -44,7 +44,7 @@ dependencies:
|
|
|
44
44
|
version: '2.13'
|
|
45
45
|
- - ">="
|
|
46
46
|
- !ruby/object:Gem::Version
|
|
47
|
-
version: 2.13.
|
|
47
|
+
version: 2.13.4
|
|
48
48
|
- !ruby/object:Gem::Dependency
|
|
49
49
|
name: faraday-retry
|
|
50
50
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -93,10 +93,10 @@ licenses:
|
|
|
93
93
|
- MIT
|
|
94
94
|
metadata:
|
|
95
95
|
bug_tracker_uri: https://github.com/block/elasticgraph/issues
|
|
96
|
-
changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.0.0
|
|
97
|
-
documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.0.0
|
|
96
|
+
changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.0.0
|
|
97
|
+
documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.0.0/
|
|
98
98
|
homepage_uri: https://block.github.io/elasticgraph/
|
|
99
|
-
source_code_uri: https://github.com/block/elasticgraph/tree/v1.0.0
|
|
99
|
+
source_code_uri: https://github.com/block/elasticgraph/tree/v1.0.0/elasticgraph-opensearch
|
|
100
100
|
gem_category: datastore_adapter
|
|
101
101
|
rdoc_options: []
|
|
102
102
|
require_paths:
|
|
@@ -115,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
115
115
|
- !ruby/object:Gem::Version
|
|
116
116
|
version: '0'
|
|
117
117
|
requirements: []
|
|
118
|
-
rubygems_version: 3.6.
|
|
118
|
+
rubygems_version: 3.6.9
|
|
119
119
|
specification_version: 4
|
|
120
120
|
summary: Wraps the OpenSearch client for use by ElasticGraph.
|
|
121
121
|
test_files: []
|