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.18.0	gopkg.in/disaster37/opensearch.v2 (source doc)	Last version

Example:

You have installed Opensearchsearch 2.18.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

• Index API
• Get API
• Delete API
• Delete By Query API
• Update API
• Update By Query API
• Multi Get API
• Bulk API
• Reindex API
• Term Vectors
• Multi termvectors API

Search APIs

• Search
• Search Template
• Multi Search Template
• Search Shards API
• Suggesters
  • Term Suggester
  • Phrase Suggester
  • Completion Suggester
  • Context Suggester
• Multi Search API
• Count API
• Validate API
• Explain API
• Profile API
• Field Capabilities API

Aggregations

• Metrics Aggregations
  • Avg
  • Cardinality
  • Extended Stats
  • Geo Bounds
  • Geo Centroid
  • Matrix stats
  • Max
  • Median absolute deviation
  • Min
  • Percentile Ranks
  • Percentiles
  • Scripted Metric
  • Stats
  • Sum
  • Top Hits
  • Value Count
  • Weighted avg
• Bucket Aggregations
  • Adjacency Matrix
  • Auto-interval Date Histogram
  • Children
  • Composite
  • Date Histogram
  • Date Range
  • Diversified Sampler
  • Filter
  • Filters
  • Geo Distance
  • Geohash Grid
  • Geotile grid
  • Global
  • Histogram
  • IP Range
  • Missing
  • Nested
  • Parent
  • Range
  • Rare terms
  • Reverse Nested
  • Sampler
  • Significant Terms
  • Significant Text
  • Terms
  • Variable width histogram
• Pipeline Aggregations
  • Avg Bucket
  • Bucket Script
  • Bucket Selector
  • Bucket Sort
  • Cumulative Sum
  • Derivative
  • Extended Stats Bucket
  • Max Bucket
  • Min Bucket
  • Moving Average
  • Moving function
  • Percentiles Bucket
  • Serial Differencing
  • Stats Bucket
  • Sum Bucket
• Aggregation Metadata

Indices APIs

• Create Index
• Delete Index
• Get Index
• Indices Exists
• Open / Close Index
• Shrink Index
• Rollover Index
• Put Mapping
• Get Mapping
• Get Field Mapping
• Types Exists
• Index Aliases
• Update Indices Settings
• Get Settings
• Analyze
  • Explain Analyze
• Index Templates
• Indices Stats
• Indices Segments
• Indices Recovery
• Indices Shard Stores
• Clear Cache
• Flush
  • Synced Flush
• Refresh
• Force Merge

cat APIs

• cat aliases
• cat allocation
• cat count
• cat fielddata
• cat health
• cat indices
• cat master
• cat nodeattrs
• cat nodes
• cat pending tasks
• cat plugins
• cat recovery
• cat repositories
• cat thread pool
• cat shards
• cat segments
• cat snapshots
• cat templates

Cluster APIs

• Cluster Health
• Cluster State
• Cluster Stats
• Pending Cluster Tasks
• Cluster Reroute
• Cluster Settings
• Nodes Stats
• Nodes Info
• Nodes Feature Usage
• Remote Cluster Info
• Task Management API
• Nodes hot_threads
• Cluster Allocation Explain API

Rollup APIs (XPack)

• Create Job
• Delete Job
• Get Job
• Start Job
• Stop Job

Query DSL

• Match All Query
• Inner hits
• Full text queries
  • Match Query
  • Match Boolean Prefix Query
  • Match Phrase Query
  • Match Phrase Prefix Query
  • Multi Match Query
  • Common Terms Query
  • Query String Query
  • Simple Query String Query
  • Combined Fields Query
  • Intervals Query
• Term level queries
  • Term Query
  • Terms Query
  • Terms Set Query
  • Range Query
  • Exists Query
  • Prefix Query
  • Wildcard Query
  • Regexp Query
  • Fuzzy Query
  • Type Query
  • Ids Query
• Compound queries
  • Constant Score Query
  • Bool Query
  • Dis Max Query
  • Function Score Query
  • Boosting Query
• Joining queries
  • Nested Query
  • Has Child Query
  • Has Parent Query
  • Parent Id Query
• Geo queries
  • GeoShape Query
  • Geo Bounding Box Query
  • Geo Distance Query
  • Geo Polygon Query
• Specialized queries
  • Distance Feature Query
  • More Like This Query
  • Script Query
  • Script Score Query
  • Percolate Query
• Span queries
  • Span Term Query
  • Span Multi Term Query
  • Span First Query
  • Span Near Query
  • Span Or Query
  • Span Not Query
  • Span Containing Query
  • Span Within Query
  • Span Field Masking Query
• Minimum Should Match
• Multi Term Query Rewrite

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

• Sort by score
• Sort by field
• Sort by geo distance
• Sort by script
• Sort by doc

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.