Excel Add-In for Elasticsearch

Build 24.0.9062

CreateIndex

Submits a request to create an index with specified settings.

EXECUTE Example:

EXECUTE CreateIndex Index = 'firstindex', Alias = 'search', NumberOfShards = '3' 

Input

Name Type Description
Index String The name of the index.
Alias String The name of the alias to optionally associate the index with.
AliasFilter String Raw Query DSL object used to limit documents the alias can access.
AliasIndexRouting String Value used for the alias to route indexing operations to a specific shard. If specified, this overwrites the routing value for indexing operations.
AliasIsHidden Boolean Boolean value controlling whether or not the alias is hidden. All indices for the alias must have the same is_hidden value.
AliasIsWriteIndex Boolean Boolean value controlling whether the index is the write index for the alias.
AliasRouting String Value used for the alias to route indexing and search operations to a specific shard. May be overwritten by AliasIndexRouting or AliasSearchRouting for certain operations.
AliasSearchRouting String Value used for the alias to route search operations to a specific shard. If specified, this overwrites the routing value for search operations.
Mappings String Raw JSON object specifying explicit mapping for the index.
NumberOfShards String The number of primary shards that the created index should have.
NumberOfRoutingShards String Number used by Elasticsearch internally with the value from NumberOfShards to route documents to a primary shard.
OtherSettings String Raw JSON object of settings. Cannot be used in conjunction with NumberOfRoutingShards or NumberOfShards.

Result Set Columns

Name Type Description
CompletedBeforeTimeout String Returns True if the index was created before timeout. Note that if this value is false, the index could still be created successfully on Elasticsearch. In this case, completion of creating the index, updating the cluster state, and requisite sharding would occur after the timeout window for the request response elapsed.
ShardsAcknowledged String Boolean indicating whether the requisite number of shard copies were started for each shard in the index before timing out.
IndexName String Name in Elasticsearch of the created index.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9062