create-index.asciidoc 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  1. [[indices-create-index]]
  2. == Create Index
  3. The create index API allows to instantiate an index. Elasticsearch
  4. provides support for multiple indices, including executing operations
  5. across several indices.
  6. [float]
  7. [[create-index-settings]]
  8. === Index Settings
  9. Each index created can have specific settings
  10. associated with it.
  11. [source,js]
  12. --------------------------------------------------
  13. $ curl -XPUT 'http://localhost:9200/twitter/' -d '{
  14. "settings" : {
  15. "index" : {
  16. "number_of_shards" : 3, <1>
  17. "number_of_replicas" : 2 <2>
  18. }
  19. }
  20. }'
  21. --------------------------------------------------
  22. <1> Default for `number_of_shards` is 5
  23. <2> Default for `number_of_replicas` is 1 (ie one replica for each primary shard)
  24. The above second curl example shows how an index called `twitter` can be
  25. created with specific settings for it using http://www.yaml.org[YAML].
  26. In this case, creating an index with 3 shards, each with 2 replicas. The
  27. index settings can also be defined with http://www.json.org[JSON]:
  28. [source,js]
  29. --------------------------------------------------
  30. $ curl -XPUT 'http://localhost:9200/twitter/' -d '{
  31. "settings" : {
  32. "index" : {
  33. "number_of_shards" : 3,
  34. "number_of_replicas" : 2
  35. }
  36. }
  37. }'
  38. --------------------------------------------------
  39. or more simplified
  40. [source,js]
  41. --------------------------------------------------
  42. $ curl -XPUT 'http://localhost:9200/twitter/' -d '{
  43. "settings" : {
  44. "number_of_shards" : 3,
  45. "number_of_replicas" : 2
  46. }
  47. }'
  48. --------------------------------------------------
  49. [NOTE]
  50. You do not have to explicitly specify `index` section inside the
  51. `settings` section.
  52. For more information regarding all the different index level settings
  53. that can be set when creating an index, please check the
  54. <<index-modules,index modules>> section.
  55. [float]
  56. [[mappings]]
  57. === Mappings
  58. The create index API allows to provide a set of one or more mappings:
  59. [source,js]
  60. --------------------------------------------------
  61. curl -XPOST localhost:9200/test -d '{
  62. "settings" : {
  63. "number_of_shards" : 1
  64. },
  65. "mappings" : {
  66. "type1" : {
  67. "properties" : {
  68. "field1" : { "type" : "text" }
  69. }
  70. }
  71. }
  72. }'
  73. --------------------------------------------------
  74. [float]
  75. [[create-index-aliases]]
  76. === Aliases
  77. The create index API allows also to provide a set of <<indices-aliases,aliases>>:
  78. [source,js]
  79. --------------------------------------------------
  80. curl -XPUT localhost:9200/test -d '{
  81. "aliases" : {
  82. "alias_1" : {},
  83. "alias_2" : {
  84. "filter" : {
  85. "term" : {"user" : "kimchy" }
  86. },
  87. "routing" : "kimchy"
  88. }
  89. }
  90. }'
  91. --------------------------------------------------
  92. [float]
  93. === Creation Date
  94. When an index is created, a timestamp is stored in the index metadata for the creation date. By
  95. default this is automatically generated but it can also be specified using the
  96. `creation_date` parameter on the create index API:
  97. [source,js]
  98. --------------------------------------------------
  99. curl -XPUT localhost:9200/test -d '{
  100. "creation_date" : 1407751337000 <1>
  101. }'
  102. --------------------------------------------------
  103. <1> `creation_date` is set using epoch time in milliseconds.