Go client

The OpenSearch Go client lets you connect your Go application with the data in your OpenSearch cluster. This getting started guide illustrates how to connect to OpenSearch, index documents, and run queries. For the client’s complete API documentation and additional examples, see the Go client API documentation.

For the client source code, see the opensearch-go repo.

Setup

If you’re starting a new project, create a new module by running the following command:

  1. go mod init <mymodulename>

copy

To add the Go client to your project, import it like any other module:

  1. go get github.com/opensearch-project/opensearch-go

copy

Connecting to OpenSearch

To connect to the default OpenSearch host, create a client object with the address https://localhost:9200 if you are using the Security plugin:

  1. client, err := opensearch.NewClient(opensearch.Config{
  2.         Transport: &http.Transport{
  3.             TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
  4.         },
  5.         Addresses: []string{"https://localhost:9200"},
  6.         Username:  "admin", // For testing only. Don't store credentials in code.
  7.         Password:  "admin",
  8.     })

copy

If you are not using the Security plugin, create a client object with the address http://localhost:9200:

  1. client, err := opensearch.NewClient(opensearch.Config{
  2.         Transport: &http.Transport{
  3.             TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
  4.         },
  5.         Addresses: []string{"http://localhost:9200"},
  6.     })

copy

Connecting to Amazon OpenSearch Service

The following example illustrates connecting to Amazon OpenSearch Service:

  1. package main
  3. import (
  4.     "context"
  5.     "log"
  7.     "github.com/aws/aws-sdk-go-v2/aws"
  8.     "github.com/aws/aws-sdk-go-v2/config"
  9.     opensearch "github.com/opensearch-project/opensearch-go/v2"
  10.     opensearchapi "github.com/opensearch-project/opensearch-go/v2/opensearchapi"
  11.     requestsigner "github.com/opensearch-project/opensearch-go/v2/signer/awsv2"
  12. )
  14. const endpoint = "" // e.g. https://opensearch-domain.region.com or Amazon OpenSearch Serverless endpoint
  16. func main() {
  17.     ctx := context.Background()
  19.     awsCfg, err := config.LoadDefaultConfig(ctx,
  20.         config.WithRegion("<AWS_REGION>"),
  21.         config.WithCredentialsProvider(
  22.             getCredentialProvider("<AWS_ACCESS_KEY>", "<AWS_SECRET_ACCESS_KEY>", "<AWS_SESSION_TOKEN>"),
  23.         ),
  24.     )
  25.     if err != nil {
  26.         log.Fatal(err) // Do not log.fatal in a production ready app.
  27.     }
  29.     // Create an AWS request Signer and load AWS configuration using default config folder or env vars.
  30.     signer, err := requestsigner.NewSignerWithService(awsCfg, "es")
  31.     if err != nil {
  32.         log.Fatal(err) // Do not log.fatal in a production ready app.
  33.     }
  35.     // Create an opensearch client and use the request-signer
  36.     client, err := opensearch.NewClient(opensearch.Config{
  37.         Addresses: []string{endpoint},
  38.         Signer:    signer,
  39.     })
  40.     if err != nil {
  41.         log.Fatal("client creation err", err)
  42.     }
  43. }
  45. func getCredentialProvider(accessKey, secretAccessKey, token string) aws.CredentialsProviderFunc {
  46.     return func(ctx context.Context) (aws.Credentials, error) {
  47.         c := &aws.Credentials{
  48.             AccessKeyID:     accessKey,
  49.             SecretAccessKey: secretAccessKey,
  50.             SessionToken:    token,
  51.         }
  52.         return *c, nil
  53.     }
  54. }

copy

Connecting to Amazon OpenSearch Serverless

The following example illustrates connecting to Amazon OpenSearch Serverless Service:

  1. package main
  3. import (
  4.     "context"
  5.     "log"
  7.     "github.com/aws/aws-sdk-go-v2/aws"
  8.     "github.com/aws/aws-sdk-go-v2/config"
  9.     opensearch "github.com/opensearch-project/opensearch-go/v2"
  10.     opensearchapi "github.com/opensearch-project/opensearch-go/v2/opensearchapi"
  11.     requestsigner "github.com/opensearch-project/opensearch-go/v2/signer/awsv2"
  12. )
  14. const endpoint = "" // e.g. https://opensearch-domain.region.com or Amazon OpenSearch Serverless endpoint
  16. func main() {
  17.     ctx := context.Background()
  19.     awsCfg, err := config.LoadDefaultConfig(ctx,
  20.         config.WithRegion("<AWS_REGION>"),
  21.         config.WithCredentialsProvider(
  22.             getCredentialProvider("<AWS_ACCESS_KEY>", "<AWS_SECRET_ACCESS_KEY>", "<AWS_SESSION_TOKEN>"),
  23.         ),
  24.     )
  25.     if err != nil {
  26.         log.Fatal(err) // Do not log.fatal in a production ready app.
  27.     }
  29.     // Create an AWS request Signer and load AWS configuration using default config folder or env vars.
  30.     signer, err := requestsigner.NewSignerWithService(awsCfg, "aoss")
  31.     if err != nil {
  32.         log.Fatal(err) // Do not log.fatal in a production ready app.
  33.     }
  35.     // Create an opensearch client and use the request-signer
  36.     client, err := opensearch.NewClient(opensearch.Config{
  37.         Addresses: []string{endpoint},
  38.         Signer:    signer,
  39.     })
  40.     if err != nil {
  41.         log.Fatal("client creation err", err)
  42.     }
  43. }
  45. func getCredentialProvider(accessKey, secretAccessKey, token string) aws.CredentialsProviderFunc {
  46.     return func(ctx context.Context) (aws.Credentials, error) {
  47.         c := &aws.Credentials{
  48.             AccessKeyID:     accessKey,
  49.             SecretAccessKey: secretAccessKey,
  50.             SessionToken:    token,
  51.         }
  52.         return *c, nil
  53.     }
  54. }

copy

The Go client constructor takes an opensearch.Config{} type, which can be customized using options such as a list of OpenSearch node addresses or a username and password combination.

To connect to multiple OpenSearch nodes, specify them in the Addresses parameter:

  1. var (
  2.     urls = []string{"http://localhost:9200", "http://localhost:9201", "http://localhost:9202"}
  3. )
  5. client, err := opensearch.NewClient(opensearch.Config{
  6.         Transport: &http.Transport{
  7.             TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
  8.         },
  9.         Addresses: urls,
  10. })

copy

The Go client retries requests for a maximum of three times by default. To customize the number of retries, set the MaxRetries parameter. Additionally, you can change the list of response codes for which a request is retried by setting the RetryOnStatus parameter. The following code snippet creates a new Go client with custom MaxRetries and RetryOnStatus values:

  1. client, err := opensearch.NewClient(opensearch.Config{
  2.         Transport: &http.Transport{
  3.             TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
  4.         },
  5.         Addresses: []string{"http://localhost:9200"},
  6.         MaxRetries: 5,
  7.         RetryOnStatus: []int{502, 503, 504},
  8.     })

copy

Creating an index

To create an OpenSearch index, use the IndicesCreateRequest method. You can use the following code to construct a JSON object with custom settings :

  1. settings := strings.NewReader(`{
  2.     'settings': {
  3.         'index': {
  4.             'number_of_shards': 1,
  5.             'number_of_replicas': 0
  6.             }
  7.         }
  8.     }`)
  10. res := opensearchapi.IndicesCreateRequest{
  11.     Index: "go-test-index1", 
  12.     Body:  settings,
  13. }

copy

Indexing a document

You can index a document into OpenSearch using the IndexRequest method:

  1. document := strings.NewReader(`{
  2.     "title": "Moneyball",
  3.     "director": "Bennett Miller",
  4.     "year": "2011"
  5. }`)
  7. docId := "1"
  8. req := opensearchapi.IndexRequest{
  9.     Index:      "go-test-index1",
  10.     DocumentID: docId,
  11.     Body:       document,
  12. }
  13. insertResponse, err := req.Do(context.Background(), client)

copy

Performing bulk operations

You can perform several operations at the same time by using the Bulk method of the client. The operations may be of the same type or of different types.

  1. blk, err := client.Bulk(
  2.         strings.NewReader(`
  3.     { "index" : { "_index" : "go-test-index1", "_id" : "2" } }
  4.     { "title" : "Interstellar", "director" : "Christopher Nolan", "year" : "2014"}
  5.     { "create" : { "_index" : "go-test-index1", "_id" : "3" } }
  6.     { "title" : "Star Trek Beyond", "director" : "Justin Lin", "year" : "2015"}
  7.     { "update" : {"_id" : "3", "_index" : "go-test-index1" } }
  8.     { "doc" : {"year" : "2016"} }
  9. `),
  10.     )

copy

Searching for documents

The easiest way to search for documents is to construct a query string. The following code uses a multi_match query to search for “miller” in the title and director fields. It boosts the documents where “miller” appears in the title field:

  1. content := strings.NewReader(`{
  2.     "size": 5,
  3.     "query": {
  4.         "multi_match": {
  5.         "query": "miller",
  6.         "fields": ["title^2", "director"]
  7.         }
  8.     }
  9. }`)
  11. search := opensearchapi.SearchRequest{
  12.     Index: []string{"go-test-index1"},
  13.     Body: content,
  14. }
  16. searchResponse, err := search.Do(context.Background(), client)

copy

Deleting a document

You can delete a document using the DeleteRequest method:

  1. delete := opensearchapi.DeleteRequest{
  2.     Index:      "go-test-index1",
  3.     DocumentID: "1",
  4. }
  6. deleteResponse, err := delete.Do(context.Background(), client)

copy

Deleting an index

You can delete an index using the IndicesDeleteRequest method:

  1. deleteIndex := opensearchapi.IndicesDeleteRequest{
  2.     Index: []string{"go-test-index1"},
  3. }
  5. deleteIndexResponse, err := deleteIndex.Do(context.Background(), client)

copy

Sample program

The following sample program creates a client, adds an index with non-default settings, inserts a document, performs bulk operations, searches for the document, deletes the document, and then deletes the index:

  1. package main
  2. import (
  3.     "os"
  4.     "context"
  5.     "crypto/tls"
  6.     "fmt"
  7.     opensearch "github.com/opensearch-project/opensearch-go"
  8.     opensearchapi "github.com/opensearch-project/opensearch-go/opensearchapi"
  9.     "net/http"
  10.     "strings"
  11. )
  12. const IndexName = "go-test-index1"
  13. func main() {
  14.     // Initialize the client with SSL/TLS enabled.
  15.     client, err := opensearch.NewClient(opensearch.Config{
  16.         Transport: &http.Transport{
  17.             TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
  18.         },
  19.         Addresses: []string{"https://localhost:9200"},
  20.         Username:  "admin", // For testing only. Don't store credentials in code.
  21.         Password:  "admin",
  22.     })
  23.     if err != nil {
  24.         fmt.Println("cannot initialize", err)
  25.         os.Exit(1)
  26.     }
  28.     // Print OpenSearch version information on console.
  29.     fmt.Println(client.Info())
  31.     // Define index settings.
  32.     settings := strings.NewReader(`{
  33.      'settings': {
  34.        'index': {
  35.             'number_of_shards': 1,
  36.             'number_of_replicas': 2
  37.             }
  38.           }
  39.      }`)
  41.     // Create an index with non-default settings.
  42.     res := opensearchapi.IndicesCreateRequest{
  43.         Index: IndexName, 
  44.         Body:  settings,
  45.     }
  46.     fmt.Println("Creating index")
  47.     fmt.Println(res)
  49.     // Add a document to the index.
  50.     document := strings.NewReader(`{
  51.         "title": "Moneyball",
  52.         "director": "Bennett Miller",
  53.         "year": "2011"
  54.     }`)
  56.     docId := "1"
  57.     req := opensearchapi.IndexRequest{
  58.         Index:      IndexName,
  59.         DocumentID: docId,
  60.         Body:       document,
  61.     }
  62.     insertResponse, err := req.Do(context.Background(), client)
  63.     if err != nil {
  64.         fmt.Println("failed to insert document ", err)
  65.         os.Exit(1)
  66.     }
  67.     fmt.Println("Inserting a document")
  68.     fmt.Println(insertResponse)
  69.     defer insertResponse.Body.Close()
  71.     // Perform bulk operations.
  72.     blk, err := client.Bulk(
  73.         strings.NewReader(`
  74.     { "index" : { "_index" : "go-test-index1", "_id" : "2" } }
  75.     { "title" : "Interstellar", "director" : "Christopher Nolan", "year" : "2014"}
  76.     { "create" : { "_index" : "go-test-index1", "_id" : "3" } }
  77.     { "title" : "Star Trek Beyond", "director" : "Justin Lin", "year" : "2015"}
  78.     { "update" : {"_id" : "3", "_index" : "go-test-index1" } }
  79.     { "doc" : {"year" : "2016"} }
  80. `),
  81.     )
  83.     if err != nil {
  84.         fmt.Println("failed to perform bulk operations", err)
  85.         os.Exit(1)
  86.     }
  87.     fmt.Println("Performing bulk operations")
  88.     fmt.Println(blk)
  90.     // Search for the document.
  91.     content := strings.NewReader(`{
  92.        "size": 5,
  93.        "query": {
  94.            "multi_match": {
  95.            "query": "miller",
  96.            "fields": ["title^2", "director"]
  97.            }
  98.       }
  99.     }`)
  101.     search := opensearchapi.SearchRequest{
  102.         Index: []string{IndexName},
  103.         Body: content,
  104.     }
  106.     searchResponse, err := search.Do(context.Background(), client)
  107.     if err != nil {
  108.         fmt.Println("failed to search document ", err)
  109.         os.Exit(1)
  110.     }
  111.     fmt.Println("Searching for a document")
  112.     fmt.Println(searchResponse)
  113.     defer searchResponse.Body.Close()
  115.     // Delete the document.
  116.     delete := opensearchapi.DeleteRequest{
  117.         Index:      IndexName,
  118.         DocumentID: docId,
  119.     }
  121.     deleteResponse, err := delete.Do(context.Background(), client)
  122.     if err != nil {
  123.         fmt.Println("failed to delete document ", err)
  124.         os.Exit(1)
  125.     }
  126.     fmt.Println("Deleting a document")
  127.     fmt.Println(deleteResponse)
  128.     defer deleteResponse.Body.Close()
  130.     // Delete the previously created index.
  131.     deleteIndex := opensearchapi.IndicesDeleteRequest{
  132.         Index: []string{IndexName},
  133.     }
  135.     deleteIndexResponse, err := deleteIndex.Do(context.Background(), client)
  136.     if err != nil {
  137.         fmt.Println("failed to delete index ", err)
  138.         os.Exit(1)
  139.     }
  140.     fmt.Println("Deleting the index")
  141.     fmt.Println(deleteIndexResponse)
  142.     defer deleteIndexResponse.Body.Close()
  143. }

copy