The highest tagged major version isv9.
create
package
This package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
- Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
- Tagged version
Modules with tagged versions give importers more predictable builds.
- Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Open Source Insights
Documentation¶
Overview¶
Create an index.You can use the create index API to add a new index to an Elasticsearchcluster.When creating an index, you can specify the following:
* Settings for the index.* Mappings for fields in the index.* Index aliases
**Wait for active shards**
By default, index creation will only return a response to the client when theprimary copies of each shard have been started, or the request times out.The index creation response will indicate what happened.For example, `acknowledged` indicates whether the index was successfullycreated in the cluster, `while shards_acknowledged` indicates whether therequisite number of shard copies were started for each shard in the indexbefore timing out.Note that it is still possible for either `acknowledged` or`shards_acknowledged` to be `false`, but for the index creation to besuccessful.These values simply indicate whether the operation completed before thetimeout.If `acknowledged` is false, the request timed out before the cluster statewas updated with the newly created index, but it probably will be createdsometime soon.If `shards_acknowledged` is false, then the request timed out before therequisite number of shards were started (by default just the primaries), evenif the cluster state was successfully updated to reflect the newly createdindex (that is to say, `acknowledged` is `true`).
You can change the default of only waiting for the primary shards to startthrough the index setting `index.write.wait_for_active_shards`.Note that changing this setting will also affect the `wait_for_active_shards`value on all subsequent write operations.
Index¶
- Variables
- type Create
- func (r *Create) Aliases(aliases map[string]types.Alias) *Create
- func (r Create) Do(providedCtx context.Context) (*Response, error)
- func (r *Create) ErrorTrace(errortrace bool) *Create
- func (r *Create) FilterPath(filterpaths ...string) *Create
- func (r *Create) Header(key, value string) *Create
- func (r *Create) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Create) Human(human bool) *Create
- func (r *Create) Mappings(mappings *types.TypeMapping) *Create
- func (r *Create) MasterTimeout(duration string) *Create
- func (r Create) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Create) Pretty(pretty bool) *Create
- func (r *Create) Raw(raw io.Reader) *Create
- func (r *Create) Request(req *Request) *Create
- func (r *Create) Settings(settings *types.IndexSettings) *Create
- func (r *Create) Timeout(duration string) *Create
- func (r *Create) WaitForActiveShards(waitforactiveshards string) *Create
- type NewCreate
- type Request
- type Response
Constants¶
This section is empty.
Variables¶
var ErrBuildPath =errors.New("cannot build path, check for missing path parameters")ErrBuildPath is returned in case of missing parameters within the build of the request.
Functions¶
This section is empty.
Types¶
typeCreate¶
type Create struct {// contains filtered or unexported fields}funcNew¶
func New(tpelastictransport.Interface) *Create
Create an index.You can use the create index API to add a new index to an Elasticsearchcluster.When creating an index, you can specify the following:
* Settings for the index.* Mappings for fields in the index.* Index aliases
**Wait for active shards**
By default, index creation will only return a response to the client when theprimary copies of each shard have been started, or the request times out.The index creation response will indicate what happened.For example, `acknowledged` indicates whether the index was successfullycreated in the cluster, `while shards_acknowledged` indicates whether therequisite number of shard copies were started for each shard in the indexbefore timing out.Note that it is still possible for either `acknowledged` or`shards_acknowledged` to be `false`, but for the index creation to besuccessful.These values simply indicate whether the operation completed before thetimeout.If `acknowledged` is false, the request timed out before the cluster statewas updated with the newly created index, but it probably will be createdsometime soon.If `shards_acknowledged` is false, then the request timed out before therequisite number of shards were started (by default just the primaries), evenif the cluster state was successfully updated to reflect the newly createdindex (that is to say, `acknowledged` is `true`).
You can change the default of only waiting for the primary shards to startthrough the index setting `index.write.wait_for_active_shards`.Note that changing this setting will also affect the `wait_for_active_shards`value on all subsequent write operations.
https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html
func (Create)Do¶
Do runs the request through the transport, handle the response and returns a create.Response
func (*Create)ErrorTrace¶added inv8.14.0
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errorswhen they occur.API name: error_trace
func (*Create)FilterPath¶added inv8.14.0
FilterPath Comma-separated list of filters in dot notation which reduce the responsereturned by Elasticsearch.API name: filter_path
func (*Create)HttpRequest¶
HttpRequest returns the http.Request object built from thegiven parameters.
func (*Create)Human¶added inv8.14.0
Human When set to `true` will return statistics in a format suitable for humans.For example `"exists_time": "1h"` for humans and`"eixsts_time_in_millis": 3600000` for computers. When disabled the humanreadable values will be omitted. This makes sense for responses beingconsumedonly by machines.API name: human
func (*Create)Mappings¶added inv8.9.0
func (r *Create) Mappings(mappings *types.TypeMapping) *Create
Mappings Mapping for fields in the index. If specified, this mapping can include:- Field names- Field data types- Mapping parametersAPI name: mappings
func (*Create)MasterTimeout¶
MasterTimeout Period to wait for a connection to the master node.If no response is received before the timeout expires, the request fails andreturns an error.API name: master_timeout
func (Create)Perform¶added inv8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*Create)Pretty¶added inv8.14.0
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only usethis option for debugging only.API name: pretty
func (*Create)Raw¶
Raw takes a json payload as input which is then passed to the http.RequestIf specified Raw takes precedence on Request method.
func (*Create)Settings¶added inv8.9.0
func (r *Create) Settings(settings *types.IndexSettings) *Create
Settings Configuration options for the index.API name: settings
func (*Create)Timeout¶
Timeout Period to wait for a response.If no response is received before the timeout expires, the request fails andreturns an error.API name: timeout
func (*Create)WaitForActiveShards¶
WaitForActiveShards The number of shard copies that must be active before proceeding with theoperation.Set to `all` or any positive integer up to the total number of shards in theindex (`number_of_replicas+1`).API name: wait_for_active_shards
typeNewCreate¶
NewCreate type alias for index.
funcNewCreateFunc¶
func NewCreateFunc(tpelastictransport.Interface)NewCreate
NewCreateFunc returns a new instance of Create with the provided transport.Used in the index of the library this allows to retrieve every apis in once place.
typeRequest¶
type Request struct {// Aliases Aliases for the index.Aliases map[string]types.Alias `json:"aliases,omitempty"`// Mappings Mapping for fields in the index. If specified, this mapping can include:// - Field names// - Field data types// - Mapping parametersMappings *types.TypeMapping `json:"mappings,omitempty"`// Settings Configuration options for the index.Settings *types.IndexSettings `json:"settings,omitempty"`}Request holds the request body struct for the package create
Source Files