管理索引

索引管理

索引管理操作可以让你管理集群中的索引,例如创建、删除和更新索引和索引的映射/配置。

创建一个索引

索引操作包含在一个特定的命名空间内,与其它直接从属于客户端对象的方法隔离开来。让我们创建一个索引作为示例:

  1. $client = ClientBuilder::create()->build();
  2. $params = [
  3. 'index' => 'my_index'
  4. ];
  5. // Create the index
  6. $response = $client->indices()->create($params);

你可以在一个创建索引 API 中指定任何参数。所有的参数通常会注入请求体中的 body 参数下:

  1. $client = ClientBuilder::create()->build();
  2. $params = [
  3. 'index' => 'my_index',
  4. 'body' => [
  5. 'settings' => [
  6. 'number_of_shards' => 3,
  7. 'number_of_replicas' => 2
  8. ],
  9. 'mappings' => [
  10. 'my_type' => [
  11. '_source' => [
  12. 'enabled' => true
  13. ],
  14. 'properties' => [
  15. 'first_name' => [
  16. 'type' => 'keyword',
  17. 'analyzer' => 'standard'
  18. ],
  19. 'age' => [
  20. 'type' => 'integer'
  21. ]
  22. ]
  23. ]
  24. ]
  25. ]
  26. ];
  27. // 创建带有配置信息和映射的索引
  28. $response = $client->indices()->create($params);

创建一个索引 (高级示例)

这是一个创建索引更复杂的示例,示例中展示了如何定义 analyzers, tokenizers,,filters 和 索引的设置。虽然创建的方式与之前的示例本质一样,但是这个复杂示例对于理解客户端的使用方法具有莫大帮助,因为这种特定的语法结构很容易被混淆。

  1. $params = [
  2. 'index' => 'reuters',
  3. 'body' => [
  4. 'settings' => [ (1)
  5. 'number_of_shards' => 1,
  6. 'number_of_replicas' => 0,
  7. 'analysis' => [ (2)
  8. 'filter' => [
  9. 'shingle' => [
  10. 'type' => 'shingle'
  11. ]
  12. ],
  13. 'char_filter' => [
  14. 'pre_negs' => [
  15. 'type' => 'pattern_replace',
  16. 'pattern' => '(\\w+)\\s+((?i:never|no|nothing|nowhere|noone|none|not|havent|hasnt|hadnt|cant|couldnt|shouldnt|wont|wouldnt|dont|doesnt|didnt|isnt|arent|aint))\\b',
  17. 'replacement' => '~$1 $2'
  18. ],
  19. 'post_negs' => [
  20. 'type' => 'pattern_replace',
  21. 'pattern' => '\\b((?i:never|no|nothing|nowhere|noone|none|not|havent|hasnt|hadnt|cant|couldnt|shouldnt|wont|wouldnt|dont|doesnt|didnt|isnt|arent|aint))\\s+(\\w+)',
  22. 'replacement' => '$1 ~$2'
  23. ]
  24. ],
  25. 'analyzer' => [
  26. 'reuters' => [
  27. 'type' => 'custom',
  28. 'tokenizer' => 'standard',
  29. 'filter' => ['lowercase', 'stop', 'kstem']
  30. ]
  31. ]
  32. ]
  33. ],
  34. 'mappings' => [ (3)
  35. '_default_' => [ (4)
  36. 'properties' => [
  37. 'title' => [
  38. 'type' => 'keyword',
  39. 'analyzer' => 'reuters',
  40. 'term_vector' => 'yes',
  41. 'copy_to' => 'combined'
  42. ],
  43. 'body' => [
  44. 'type' => 'keyword',
  45. 'analyzer' => 'reuters',
  46. 'term_vector' => 'yes',
  47. 'copy_to' => 'combined'
  48. ],
  49. 'combined' => [
  50. 'type' => 'keyword',
  51. 'analyzer' => 'reuters',
  52. 'term_vector' => 'yes'
  53. ],
  54. 'topics' => [
  55. 'type' => 'keyword',
  56. 'index' => 'not_analyzed'
  57. ],
  58. 'places' => [
  59. 'type' => 'keyword',
  60. 'index' => 'not_analyzed'
  61. ]
  62. ]
  63. ],
  64. 'my_type' => [ (5)
  65. 'properties' => [
  66. 'my_field' => [
  67. 'type' => 'keyword'
  68. ]
  69. ]
  70. ]
  71. ]
  72. ]
  73. ];
  74. $client->indices()->create($params);
  1. 顶级 settings 包含有关索引(分片数量等)以及分析器的配置
  2. analysis 嵌套在 settings 中,并包含标记器,过滤器,字符过滤器和分析器
  3. mappings 是嵌套在 settings 中的另一个元素,并且包含各种类型的映射
  4. *default* 是一个动态模板,应用于没有显式映射的所有字段
  5. my_type 类型是一个用户定义的类型示例,它拥有一个字段 my_field

删除索引

删除索引非常简单:

  1. $params = ['index' => 'my_index'];
  2. $response = $client->indices()->delete($params);

设置 API

Put Settings API 允许您修改任何动态的索引设置:

  1. $params = [
  2. 'index' => 'my_index',
  3. 'body' => [
  4. 'settings' => [
  5. 'number_of_replicas' => 0,
  6. 'refresh_interval' => -1
  7. ]
  8. ]
  9. ];
  10. $response = $client->indices()->putSettings($params);

获取设置 API

Get Settings API 将会显示一个或多个当前索引的配置

  1. // 获取一个索引的配置信息
  2. $params = ['index' => 'my_index'];
  3. $response = $client->indices()->getSettings($params);
  4. // 获取多个索引的配置信息
  5. $params = [
  6. 'index' => [ 'my_index', 'my_index2' ]
  7. ];
  8. $response = $client->indices()->getSettings($params);

映射 API

Put Mappings API允许您修改或添加现有索引的映射。

  1. // 设置索引和类型
  2. $params = [
  3. 'index' => 'my_index',
  4. 'type' => 'my_type2',
  5. 'body' => [
  6. 'my_type2' => [
  7. '_source' => [
  8. 'enabled' => true
  9. ],
  10. 'properties' => [
  11. 'first_name' => [
  12. 'type' => 'keyword',
  13. 'analyzer' => 'standard'
  14. ],
  15. 'age' => [
  16. 'type' => 'integer'
  17. ]
  18. ]
  19. ]
  20. ]
  21. ];
  22. // 更新索引映射
  23. $client->indices()->putMapping($params);

获取映射 API

Get Mappings API 将返回有关索引和类型映射的详细信息。 根据您要检索的映射,您可以指定索引和类型的多种组合:

  1. // 获取所有索引和类型的映射
  2. $response = $client->indices()->getMapping();
  3. // 获取 'my_index' 中的所有类型的映射
  4. $params = ['index' => 'my_index'];
  5. $response = $client->indices()->getMapping($params);
  6. // 获取所有名为 'my_type' 的类型映射, 而不考虑索引
  7. $params = ['type' => 'my_type' ];
  8. $response = $client->indices()->getMapping($params);
  9. // 获取 'my_index' 中的 'my_type' 的映射
  10. $params = [
  11. 'index' => 'my_index'
  12. 'type' => 'my_type'
  13. ];
  14. $response = $client->indices()->getMapping($params);
  15. // 获取两个索引的映射
  16. $params = [
  17. 'index' => [ 'my_index', 'my_index2' ]
  18. ];
  19. $response = $client->indices()->getMapping($params);

Indices 命名空间中的其他 API

indices 命名空间中有许多 API,允许您管理 elasticsearch 索引 (添加/删除模板,刷新,关闭索引, 等).

如果您使用自动完成功能的 IDE ,则应该可以通过键入以下内容轻松浏览 indices 命名空间:

  1. $client->indices()->

仔细阅读可用方法列表。 或者, 浏览 \Elasticsearch\Namespaces\Indices.php 文件将显示可用方法调用的完整列表(以及每个方法的注释中的参数列表)。