Opensearch

This is a development branch that is actively being worked on. DO NOT USE IN PRODUCTION! If you want to use stable versions of Opensearch, please use Go modules for the 2.x release (or later) or a dependency manager like dep for earlier releases.

Opensearch is an Opensearch client for the Go programming language.

Releases

The release branches (e.g. release-branch.v2) are actively being worked on and can break at any time. If you want to use stable versions of Opensearch, please use Go modules.

Here's the version matrix:

Opensearch version	Opensearch version	Package URL	Remarks
2.x	2.12.0	`gopkg.in/disaster37/opensearch.v2` (source doc)	Last version

Example:

You have installed Opensearchsearch 2.12.0 and want to use Opensearch. As listed above, you should use Opensearch v2 (code is in release-branch.v2).

To use the required version of Opensearch in your application, you should use Go modules to manage dependencies. Make sure to use a version such as 2.0.0 or later.

To use Opensearch, import:

import "github.com/disaster37/opensearch/v2"

Opensearch 2.0

Opensearch 2.0 targets Opensearch 2.x.

Status

We use Opensearch in production since 2024. Opensearch is stable but the API changes now and then. We strive for API compatibility. However, Opensearchsearch sometimes introduces and we sometimes have to adapt.

Having said that, there have been no big API changes that required you to rewrite your application big time. More often than not it's renaming APIs and adding/removing features so that Opensearch is in sync with Opensearch cluster.

Opensearch has quite a few features. Most of them are implemented by Opensearch. I add features and APIs as required. It's straightforward to implement missing pieces. I'm accepting pull requests :-)

Having said that, I hope you find the project useful.

Getting Started

The first thing you do is to create a Client. The client connects to Opensearchsearch on http://127.0.0.1:9200 by default.

You typically create one client for your app. Here's a complete example of creating a client, creating an index, adding a document, executing a search etc.

An example is available here.

Here's a link to a complete working example for v2.

API Status

Document APIs

Search APIs

Aggregations

Indices APIs

cat APIs

Cluster APIs

Rollup APIs (XPack)

Query DSL

Modules

Snapshot and Restore
- Repositories
- Snapshot get
- Snapshot create
- Snapshot delete
- Restore
- Snapshot status
- Monitoring snapshot/restore status
- Stopping currently running snapshot and restore
Scripting
- GetScript
- PutScript
- DeleteScript

Sorting

Security

Security plugin
- Internal user
- Role
- Role mapping
- Action group
- Tenant
- Distinguished name (DN)
- Flush cache
- Security config
- Security audit

Index Management State

ISM plugin
- Index Management State

Snapshot Management

SM plugin
- Snapshot Management

Alerting Management

Alerting plugin
- Monitor

Transform

Transform plugin
- Transform job

Scrolling

Scrolling is supported via a ScrollService. It supports an iterator-like interface. The ClearScroll API is implemented as well.

A pattern for efficiently scrolling in parallel is described in the Wiki.

How to contribute

Read the contribution guidelines.

Credits

Thanks a lot for the great folks working hard on Opensearch and Go.

Opensearch uses portions of the uritemplates library by Joshua Tacoma, backoff by Cenk Altı and leaktest by Ian Chiles.

LICENSE

MIT-LICENSE.

Name		Name	Last commit message	Last commit date
Latest commit History 1,518 Commits
.github/workflows		.github/workflows
cluster-test		cluster-test
config		config
recipes		recipes
trace		trace
uritemplates		uritemplates
.gitignore		.gitignore
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
CONTRIBUTORS		CONTRIBUTORS
ISSUE_TEMPLATE.md		ISSUE_TEMPLATE.md
LICENSE		LICENSE
Makefile		Makefile
README.md		README.md
acknowledged_response.go		acknowledged_response.go
alerting_delete_monitor.go		alerting_delete_monitor.go
alerting_delete_monitor_test.go		alerting_delete_monitor_test.go
alerting_get_monitor.go		alerting_get_monitor.go
alerting_get_monitor_test.go		alerting_get_monitor_test.go
alerting_monitor_test.go		alerting_monitor_test.go
alerting_post_monitor.go		alerting_post_monitor.go
alerting_post_monitor_test.go		alerting_post_monitor_test.go
alerting_put_monitor.go		alerting_put_monitor.go
alerting_put_monitor_test.go		alerting_put_monitor_test.go
alerting_search_monitor.go		alerting_search_monitor.go
alerting_search_monitor_test.go		alerting_search_monitor_test.go
backoff.go		backoff.go
backoff_test.go		backoff_test.go
bulk.go		bulk.go
bulk_create_request.go		bulk_create_request.go
bulk_create_request_easyjson.go		bulk_create_request_easyjson.go
bulk_create_request_test.go		bulk_create_request_test.go
bulk_delete_request.go		bulk_delete_request.go
bulk_delete_request_easyjson.go		bulk_delete_request_easyjson.go
bulk_delete_request_test.go		bulk_delete_request_test.go
bulk_index_request.go		bulk_index_request.go
bulk_index_request_easyjson.go		bulk_index_request_easyjson.go
bulk_index_request_test.go		bulk_index_request_test.go
bulk_processor.go		bulk_processor.go
bulk_processor_test.go		bulk_processor_test.go
bulk_request.go		bulk_request.go
bulk_test.go		bulk_test.go
bulk_update_request.go		bulk_update_request.go
bulk_update_request_easyjson.go		bulk_update_request_easyjson.go
bulk_update_request_test.go		bulk_update_request_test.go
canonicalize.go		canonicalize.go
canonicalize_test.go		canonicalize_test.go
cat_aliases.go		cat_aliases.go
cat_aliases_test.go		cat_aliases_test.go
cat_allocation.go		cat_allocation.go
cat_allocation_test.go		cat_allocation_test.go
cat_count.go		cat_count.go
cat_count_integration_test.go		cat_count_integration_test.go
cat_count_test.go		cat_count_test.go
cat_fielddata.go		cat_fielddata.go
cat_fielddata_test.go		cat_fielddata_test.go
cat_health.go		cat_health.go
cat_health_test.go		cat_health_test.go
cat_indices.go		cat_indices.go
cat_indices_test.go		cat_indices_test.go
cat_master.go		cat_master.go
cat_master_test.go		cat_master_test.go
cat_shards.go		cat_shards.go
cat_shards_test.go		cat_shards_test.go
cat_snapshots.go		cat_snapshots.go
cat_snapshots_integration_test.go		cat_snapshots_integration_test.go
cat_snapshots_test.go		cat_snapshots_test.go
clear_scroll.go		clear_scroll.go
clear_scroll_test.go		clear_scroll_test.go
client.go		client.go
client_test.go		client_test.go
cluster_get_setting.go		cluster_get_setting.go
cluster_get_settings_test.go		cluster_get_settings_test.go
cluster_health.go		cluster_health.go
cluster_health_test.go		cluster_health_test.go
cluster_put_setting.go		cluster_put_setting.go
cluster_put_settings_test.go		cluster_put_settings_test.go
cluster_reroute.go		cluster_reroute.go
cluster_reroute_test.go		cluster_reroute_test.go
cluster_setting_test.go		cluster_setting_test.go
cluster_state.go		cluster_state.go
cluster_state_test.go		cluster_state_test.go
cluster_stats.go		cluster_stats.go
cluster_stats_integration_test.go		cluster_stats_integration_test.go
cluster_stats_test.go		cluster_stats_test.go
connection.go		connection.go
count.go		count.go
count_test.go		count_test.go
decoder.go		decoder.go
decoder_test.go		decoder_test.go
delete.go		delete.go
delete_by_query.go		delete_by_query.go
delete_by_query_test.go		delete_by_query_test.go
delete_test.go		delete_test.go
doc.go		doc.go
docker-compose.yml		docker-compose.yml
docvalue_field.go		docvalue_field.go
docvalue_field_test.go		docvalue_field_test.go
errors.go		errors.go
errors_test.go		errors_test.go

License

disaster37/opensearch

Folders and files

Latest commit

History