Added GET Index API #7234

colings86 · 2014-08-12T13:03:34Z

Returns information about settings, aliases, warmers, and mappings. Basically returns the IndexMetadata.

colings86 · 2014-08-12T13:05:36Z

@jpountz Comment from @clintongormley was that it would be good to move the logic for the /{index}/_warmers|_mappings|_settings|_alaises/{name} etc into the same action. I think this is a good idea but I am wondering if it should be done in this change or in another ticket?

jpountz · 2014-08-12T14:05:14Z

The idea sounds good to me as well but this code is not the one I know best, maybe @javanna can comment?

javanna · 2014-08-12T14:47:10Z

docs/reference/indices/get-index.asciidoc

+
+[source,js]
+--------------------------------------------------
+$ curl -XGET 'http://localhost:9200/twitter/_settings,_mapping'


not too sure about the _ prefix, also mapping might need to be plural, @clintongormley can you have a look as well please?

Grrrr singular vs plural again... Elsewhere we have _mapping, _warmer, _alias/_aliases, _settings

I think, for ease of use, we should support singular and plural varieties of everything.

Actually both are support but i was only going to document the plural form since its the one that makes most sense here. This instance of the singular was a typo

javanna · 2014-08-12T15:02:58Z

Looks good, I left some comments and summoned @clintongormley to have a look api-wise :) I think we should isolate the breaking changes (removal of REST endpoints in favour of the new ones) to another PR and discuss them there.

colings86 · 2014-08-13T14:10:58Z

@javanna implemented the changes you suggested and left a few comment too

javanna · 2014-08-13T14:49:10Z

rest-api-spec/api/indices.get.json

+          "type":"boolean",
+          "description":"Whether aliases pointing to multiple indices are allowed (default: false)"
+        },
+        "forbid_closed_indices":{


I think you exposed too many options :) these two are not exposed to the REST layer, are kinda hidden options that we use internally... look here: https://github.com/elasticsearch/elasticsearch/blob/master/src/main/java/org/elasticsearch/action/support/IndicesOptions.java#L147

javanna · 2014-08-13T15:31:57Z

Done another review round, the main thought is that this should become a proper java api given that the goal is to replace get settings and co. Most of the code that currently is in RestIndicesGetAction should move to a TransportAction and the api should be added to the Client. Left other few comments, looks good in general though!

rashidkpc · 2014-08-27T22:55:37Z

I wonder if we should rationalize the responses between /_all/_whatever and /_whatever? I'm not totally clear how they're related, but we have a corresponding root endpoint for all of these. Some are pluralized, some are not, some return the same data in the same format (_mapping, _settings), others return in a different format. (_aliases, _warmer)

I noticed this doesn't remove /_aliases, however /index/_aliases returns a different format when no aliases are present than /_aliases. I wonder if we should return a key with an empty object for things that the user requests but don't exist, like _/aliases does:

/_aliases

   "logstash-2014.08.22": {
      "aliases": {}
   }

/_all/_aliases

   "logstash-2014.08.22": {}

There's also this difference between /_warmer and /_all/_warmer

/_warmer

{}

/_all/_warmer/

"logstash-2014.08.22": {}

Thoughts?

spinscale · 2014-08-28T09:48:05Z

src/main/java/org/elasticsearch/client/IndicesAdminClient.java

@@ -521,6 +525,26 @@
    void aliasesExist(GetAliasesRequest request, ActionListener<AliasesExistResponse> listener);

    /**
+     * Get specific index aliases that exists in particular indices and / or by name.


copy paste error?

javanna · 2014-09-10T09:03:26Z

docs/reference/indices/get-index.asciidoc

+$ curl -XGET 'http://localhost:9200/twitter/_settings,_mappings'
+--------------------------------------------------
+
+The above commend will only return the settings and mappings for the index called `twitter`.


s/commend/command

javanna · 2014-09-10T09:43:09Z

rest-api-spec/test/indices.put_mapping/all_path_options.yaml

@@ -142,7 +142,7 @@ setup:
  - match: {test_index2.mappings.test_type.properties.text.type:     string}
  - match: {test_index2.mappings.test_type.properties.text.analyzer: whitespace}

-  - is_false: foo
+  - match: { foo.mappings: {} }


Are these breaking changes properly documented?

Added notes to the relevant pages and to the breaking changes in 1.4 page. This required me to rebase on master as the breaking changes page is new

javanna · 2014-09-10T09:44:19Z

This is very close, left a few minor comments. One more thing, we have quite some coverage through REST tests but now that the api is a proper client action I would love to see also some java integration tests for it.

javanna · 2014-09-11T09:13:21Z

src/main/java/org/elasticsearch/action/admin/indices/get/GetIndexResponse.java

+    private ImmutableOpenMap<String, ImmutableList<IndexWarmersMetaData.Entry>> warmers = ImmutableOpenMap.of();
+    private ImmutableOpenMap<String, ImmutableOpenMap<String, MappingMetaData>> mappings = ImmutableOpenMap.of();
+    private ImmutableOpenMap<String, ImmutableList<AliasMetaData>> aliases = ImmutableOpenMap.of();
+    private ImmutableOpenMap<String, Settings> settings = null;


why are settings null by default? What's the difference between settings and the other features?

javanna · 2014-09-11T10:12:13Z

LGTM thanks @colings86 !

Returns information about settings, aliases, warmers, and mappings. Basically returns the IndexMetadata. This new endpoint replaces the /{index}/_alias|_aliases|_mapping|_mappings|_settings|_warmer|_warmers and /_alias|_aliases|_mapping|_mappings|_settings|_warmer|_warmers endpoints whilst maintaining the same response formats. The only exception to this is on the /_alias|_aliases|_warmer|_warmers endpoint which will now return a section for 'aliases' or 'warmers' even if no aliases or warmers exist. This backwards compatibility change is documented in the reference docs. Closes #4069

Related: elastic/elasticsearch#7234, elasticsearch/elasticsearch/#4069

rashidkpc · 2014-09-17T19:40:16Z

Potentially major issue, the new API doesn't appear to support ignore_missing

Elasticsearch 1.3.2

curl -XGET  http://localhost:9200/logstash-2014.09.16,logstash-2014.09.17/_aliases?ignore_missing=true;echo
{"logstash-2014.09.16":{"aliases":{}}}

Elasticsearch 1.4 branch

$ curl -XGET  http://localhost:9200/logstash-2014.09.16,logstash-2014.09.17/_aliases?ignore_missing=true;echo
{"error":"IndexMissingException[[logstash-2014.09.17] missing]","status":404}

colings86 · 2014-09-18T13:56:24Z

@rashidkpc the ignore_missing was replaced in 1.x by the parameters described in [1]. The aliases api performs a cluster state request which doesn't allow setting indices options and is lenient (i.e. doesn't error on missing indices) so the ignore_missing option actually had no effect in 1.3.2. The difference now is that the GET Index API does support indices options and defaults to strictExpandOpen which is in line with the other APIs and so will error on missing indices. I will add the change to the breaking changes documentation but if you add the ignore_unavailable query parameter instead you should get the desired functionality.

[1] http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/_parameters.html#_parameters

javanna reviewed Aug 12, 2014
View reviewed changes

colings86 added the review label Aug 13, 2014

javanna reviewed Aug 13, 2014
View reviewed changes

javanna removed the review label Aug 13, 2014

colings86 self-assigned this Aug 13, 2014

kevinkluge added v1.4.0 labels Aug 20, 2014

colings86 added the review label Aug 27, 2014

spinscale reviewed Aug 28, 2014
View reviewed changes

clintongormley added the release highlight label Sep 8, 2014

colings86 added v1.4.0.Beta1 and removed v1.5.0 labels Sep 8, 2014

javanna reviewed Sep 10, 2014
View reviewed changes

javanna removed the review label Sep 10, 2014

javanna reviewed Sep 10, 2014
View reviewed changes

colings86 added review >feature labels Sep 10, 2014

javanna reviewed Sep 11, 2014
View reviewed changes

colings86 merged commit 5fe782b into elastic:master Sep 11, 2014

karmi added a commit to elastic/elasticsearch-ruby that referenced this pull request Sep 15, 2014

[API] Added the "Get Indices Info" API

b2f0825

Related: elastic/elasticsearch#7234, elasticsearch/elasticsearch/#4069

colings86 deleted the feature/getIndexAPI branch September 15, 2014 10:52

javanna removed the review label Sep 18, 2014

rashidkpc mentioned this pull request Sep 18, 2014

ignore_missing removed from _aliases #7793

Closed

Mpdreamz mentioned this pull request Dec 8, 2014

Support get index API elastic/elasticsearch-net#1083

Closed

clintongormley added the :Data Management/Indices APIs APIs to create and manage indices and templates label Jun 6, 2015

clintongormley changed the title ~~Indices API: Added GET Index API~~ Added GET Index API Jun 6, 2015

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added GET Index API #7234

Added GET Index API #7234

colings86 commented Aug 12, 2014

colings86 commented Aug 12, 2014

jpountz commented Aug 12, 2014

javanna Aug 12, 2014

clintongormley Aug 12, 2014

colings86 Aug 12, 2014

javanna commented Aug 12, 2014

colings86 commented Aug 13, 2014

javanna Aug 13, 2014

javanna commented Aug 13, 2014

rashidkpc commented Aug 27, 2014

spinscale Aug 28, 2014

javanna Sep 10, 2014

javanna Sep 10, 2014

colings86 Sep 10, 2014

javanna commented Sep 10, 2014

javanna Sep 11, 2014

javanna commented Sep 11, 2014

rashidkpc commented Sep 17, 2014

colings86 commented Sep 18, 2014

Added GET Index API #7234

Added GET Index API #7234

Conversation

colings86 commented Aug 12, 2014

colings86 commented Aug 12, 2014

jpountz commented Aug 12, 2014

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

javanna commented Aug 12, 2014

colings86 commented Aug 13, 2014

Choose a reason for hiding this comment

javanna commented Aug 13, 2014

rashidkpc commented Aug 27, 2014

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

javanna commented Sep 10, 2014

Choose a reason for hiding this comment

javanna commented Sep 11, 2014

rashidkpc commented Sep 17, 2014

colings86 commented Sep 18, 2014