intergrate opensearch v2 (#5044)
intergrate opensearch Signed-off-by: chengdehao <dehaocheng@kubesphere.io> Co-authored-by: chengdehao <dehaocheng@kubesphere.io>
This commit is contained in:
106
vendor/github.com/opensearch-project/opensearch-go/v2/opensearchapi/doc.go
generated
vendored
Normal file
106
vendor/github.com/opensearch-project/opensearch-go/v2/opensearchapi/doc.go
generated
vendored
Normal file
@@ -0,0 +1,106 @@
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
//
|
||||
// The OpenSearch Contributors require contributions made to
|
||||
// this file be licensed under the Apache-2.0 license or a
|
||||
// compatible open source license.
|
||||
//
|
||||
// Modifications Copyright OpenSearch Contributors. See
|
||||
// GitHub history for details.
|
||||
|
||||
// Licensed to Elasticsearch B.V. under one or more contributor
|
||||
// license agreements. See the NOTICE file distributed with
|
||||
// this work for additional information regarding copyright
|
||||
// ownership. Elasticsearch B.V. licenses this file to you under
|
||||
// the Apache License, Version 2.0 (the "License"); you may
|
||||
// not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing,
|
||||
// software distributed under the License is distributed on an
|
||||
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
// KIND, either express or implied. See the License for the
|
||||
// specific language governing permissions and limitations
|
||||
// under the License.
|
||||
|
||||
/*
|
||||
Package opensearchapi provides the Go API for OpenSearch.
|
||||
|
||||
It is automatically included in the client provided by the
|
||||
github.com/opensearch-project/opensearch-go package:
|
||||
|
||||
client, _ := opensearch.NewDefaultClient()
|
||||
res, _ := client.Info()
|
||||
log.Println(res)
|
||||
|
||||
For each OpenSearch API, such as "Index", the package exports two corresponding types:
|
||||
a function and a struct.
|
||||
|
||||
The function type allows you to call the OpenSearch API as a method on the client,
|
||||
passing the parameters as arguments:
|
||||
|
||||
res, err := client.Index(
|
||||
"test", // Index name
|
||||
strings.NewReader(`{"title" : "Test"}`), // Document body
|
||||
client.Index.WithDocumentID("1"), // Document ID
|
||||
client.Index.WithRefresh("true"), // Refresh
|
||||
)
|
||||
if err != nil {
|
||||
log.Fatalf("ERROR: %s", err)
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
log.Println(res)
|
||||
|
||||
// => [201 Created] {"_index":"test","_type":"_doc","_id":"1" ...
|
||||
|
||||
The struct type allows for a more hands-on approach, where you create a new struct, with the
|
||||
request configuration as fields, and call the Do() method
|
||||
with a context and the client as arguments:
|
||||
|
||||
req := opensearchapi.IndexRequest{
|
||||
Index: "test", // Index name
|
||||
Body: strings.NewReader(`{"title" : "Test"}`), // Document body
|
||||
DocumentID: "1", // Document ID
|
||||
Refresh: "true", // Refresh
|
||||
}
|
||||
|
||||
res, err := req.Do(context.Background(), client)
|
||||
if err != nil {
|
||||
log.Fatalf("Error getting response: %s", err)
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
log.Println(res)
|
||||
|
||||
// => [200 OK] {"_index":"test","_type":"_doc","_id":"1","_version":2 ...
|
||||
|
||||
The function type is a wrapper around the struct, and allows
|
||||
to configure and perform the request in a more expressive way.
|
||||
It has a minor overhead compared to using a struct directly;
|
||||
refer to the opensearchapi_benchmark_test.go suite for concrete numbers.
|
||||
|
||||
See the documentation for each API function or struct at
|
||||
https://godoc.org/github.com/opensearch-project/opensearch-go,
|
||||
or locally by:
|
||||
|
||||
go doc github.com/opensearch-project/opensearch-go/opensearchapi Index
|
||||
go doc github.com/opensearch-project/opensearch-go/opensearchapi IndexRequest
|
||||
|
||||
Response
|
||||
|
||||
The opensearchapi.Response type is a lightweight wrapper around http.Response.
|
||||
|
||||
The res.Body field is an io.ReadCloser, leaving the JSON parsing to the
|
||||
calling code, in the interest of performance and flexibility
|
||||
(eg. to allow using a custom JSON parser).
|
||||
|
||||
It is imperative to close the response body for a non-nil response.
|
||||
|
||||
The Response type implements a couple of convenience methods for accessing
|
||||
the status, checking an error status code or printing
|
||||
the response body for debugging purposes.
|
||||
|
||||
*/
|
||||
package opensearchapi
|
||||
Reference in New Issue
Block a user