Get data stream accepts single search parameter #54530

danhermann · 2020-03-31T19:54:39Z

Changes the GET /_data_streams endpoint to accept a single search parameter.

If the search parameter contains wildcards, a list of matching data streams will be returned or the empty list if there are no matches. If the search parameter does not contain wildcards, the single matching data stream, if any, will be returned. If there are no matches, the response code of 404 will be returned.

The GET /_data_streams request without an explicit search parameter will be treated as GET /_data_streams/*.

Relates to #53100

elasticmachine · 2020-03-31T19:54:42Z

Pinging @elastic/es-core-features (:Core/Features/Data streams)

danhermann · 2020-03-31T19:56:16Z

@elasticmachine update branch

elasticmachine · 2020-03-31T19:56:18Z

merge conflict between base and head

martijnvg

Looks good. I left some comments.

martijnvg · 2020-04-01T05:56:35Z

...er/src/main/java/org/elasticsearch/action/admin/indices/datastream/GetDataStreamsAction.java

@@ -72,26 +73,26 @@ public ActionRequestValidationException validate() {

        public Request(StreamInput in) throws IOException {
            super(in);
-            this.names = in.readStringArray();
+            this.name = in.readString();


This should be readOptionalString() instead of readString(), since the name maybe null.
This is also why I think the test fails.

martijnvg · 2020-04-01T05:57:07Z

...er/src/main/java/org/elasticsearch/action/admin/indices/datastream/GetDataStreamsAction.java

        }

        @Override
        public void writeTo(StreamOutput out) throws IOException {
            super.writeTo(out);
-            out.writeStringArray(names);
+            out.writeString(name);


This should be writeOptionalString() instead of writeString()

martijnvg · 2020-04-01T05:57:51Z

...er/src/main/java/org/elasticsearch/action/admin/indices/datastream/GetDataStreamsAction.java

        }

        @Override
        public boolean equals(Object o) {
            if (this == o) return true;
            if (o == null || getClass() != o.getClass()) return false;
            Request request = (Request) o;
-            return Arrays.equals(names, request.names);
+            return name.equals(request.name);


Objects.equals(...) should be used here.

martijnvg · 2020-04-01T05:58:08Z

...er/src/main/java/org/elasticsearch/action/admin/indices/datastream/GetDataStreamsAction.java

        }

        @Override
        public int hashCode() {
-            return Arrays.hashCode(names);
+            return name.hashCode();


Objects.hashCode(...) should be used here.

martijnvg · 2020-04-01T06:00:48Z

.../test/java/org/elasticsearch/action/admin/indices/datastream/GetDataStreamsRequestTests.java

-        GetDataStreamsAction.Request req = new GetDataStreamsAction.Request(new String[]{});
-        ActionRequestValidationException e = req.validate();
-        assertNull(e);
+        return new Request(randomAlphaOfLength(8) + (randomBoolean() ? "*" : ""));


maybe also specify null as a value here?

maybe also randomly specify just "*" here?

henningandersen

LGTM. I left a few comments to address, but no need for another round.

henningandersen · 2020-04-01T06:47:00Z

rest-api-spec/src/main/resources/rest-api-spec/test/indices.data_stream/10_basic.yml

+
+  - do:
+      indices.get_data_streams:
+        name: null


I should think it works without this line too? I think I prefer to remove that line, we normally do not specify optional parameters as null in rest tests.

henningandersen · 2020-04-01T06:48:10Z

rest-api-spec/src/main/resources/rest-api-spec/test/indices.data_stream/10_basic.yml

+
+  - do:
+      indices.get_data_streams:
+        name: get-data-stream1


Would be nice to also test that GET _data_stream/get-data-stream* works and returns both streams?

henningandersen · 2020-04-01T09:05:41Z

...er/src/main/java/org/elasticsearch/action/admin/indices/datastream/GetDataStreamsAction.java

        }

        @Override
        public void writeTo(StreamOutput out) throws IOException {
            super.writeTo(out);
-            out.writeStringArray(names);
+            out.writeString(name);


I think there is a BWC issue here since the original code is in the 7.7 branch? Probably easiest to just make it 7.7 compatible here (and in the read above) rather than other workarounds.

henningandersen · 2020-04-01T09:11:20Z

.../test/java/org/elasticsearch/action/admin/indices/datastream/GetDataStreamsRequestTests.java

-        GetDataStreamsAction.Request req = new GetDataStreamsAction.Request(new String[]{});
-        ActionRequestValidationException e = req.validate();
-        assertNull(e);
+        return new Request(randomAlphaOfLength(8) + (randomBoolean() ? "*" : ""));
    }

    public void testGetDataStreams() {


nit:

Suggested change

public void testGetDataStreams() {

public void testGetDataStream() {

henningandersen · 2020-04-01T09:13:04Z

.../test/java/org/elasticsearch/action/admin/indices/datastream/GetDataStreamsRequestTests.java

-        GetDataStreamsAction.Request req = new GetDataStreamsAction.Request(new String[]{});
-        ActionRequestValidationException e = req.validate();
-        assertNull(e);
+        return new Request(randomAlphaOfLength(8) + (randomBoolean() ? "*" : ""));


maybe also randomly specify just "*" here?

henningandersen · 2020-04-01T09:15:43Z

.../test/java/org/elasticsearch/action/admin/indices/datastream/GetDataStreamsRequestTests.java

@@ -65,8 +60,9 @@ public void testGetDataStreams() {
    public void testGetNonexistentDataStream() {


I think we should add a bit more tests:

Get non existent data stream based on wildcard (which should return empty array).

Get data stream based on wildcard, returning multiple.

danhermann · 2020-04-01T17:11:21Z

@elasticmachine update branch

danhermann · 2020-04-02T16:00:03Z

@elasticmachine update branch

danhermann · 2020-04-02T17:17:48Z

@elasticmachine update branch

danhermann added 2 commits March 31, 2020 12:43

wip

1007d1b

get data stream with single search parameter

4295de2

danhermann added >non-issue v8.0.0 :Data Management/Data streams Data streams and their lifecycles v7.8.0 labels Mar 31, 2020

danhermann requested review from martijnvg and henningandersen March 31, 2020 19:54

Merge branch 'master' into get_single_data_stream

c68d0b3

martijnvg reviewed Apr 1, 2020

View reviewed changes

henningandersen approved these changes Apr 1, 2020

View reviewed changes

review comments

4adb826

elasticmachine and others added 2 commits April 1, 2020 13:11

Merge branch 'master' into get_single_data_stream

4aae22e

fix test

2ee21ec

elasticmachine and others added 2 commits April 2, 2020 12:00

Merge branch 'master' into get_single_data_stream

8a12c75

fix test

f37811e

elasticmachine and others added 2 commits April 2, 2020 13:17

Merge branch 'master' into get_single_data_stream

a2b7ff4

remove explicit null

6e8b8b3

danhermann merged commit 959f41e into elastic:master Apr 3, 2020

danhermann added the backport pending label Apr 3, 2020

danhermann deleted the get_single_data_stream branch April 3, 2020 14:33

danhermann added a commit to danhermann/elasticsearch that referenced this pull request Apr 3, 2020

Get data stream accepts single search parameter (elastic#54530)

6ed32a9

danhermann mentioned this pull request Apr 3, 2020

[7.x] Get data stream accepts single search parameter #54721

Merged

danhermann removed the backport pending label Apr 3, 2020

jakelandis added v8.0.0-alpha1 and removed v8.0.0 labels Jul 26, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Get data stream accepts single search parameter #54530

Get data stream accepts single search parameter #54530

danhermann commented Mar 31, 2020

elasticmachine commented Mar 31, 2020

danhermann commented Mar 31, 2020

elasticmachine commented Mar 31, 2020

martijnvg left a comment

martijnvg Apr 1, 2020

martijnvg Apr 1, 2020

martijnvg Apr 1, 2020

martijnvg Apr 1, 2020

martijnvg Apr 1, 2020

henningandersen Apr 1, 2020

henningandersen left a comment

henningandersen Apr 1, 2020

henningandersen Apr 1, 2020

henningandersen Apr 1, 2020

henningandersen Apr 1, 2020

henningandersen Apr 1, 2020

henningandersen Apr 1, 2020

danhermann commented Apr 1, 2020

danhermann commented Apr 2, 2020

danhermann commented Apr 2, 2020

	public void testGetDataStreams() {
	public void testGetDataStream() {

		@@ -65,8 +60,9 @@ public void testGetDataStreams() {
		public void testGetNonexistentDataStream() {

Get data stream accepts single search parameter #54530

Get data stream accepts single search parameter #54530

Conversation

danhermann commented Mar 31, 2020

elasticmachine commented Mar 31, 2020

danhermann commented Mar 31, 2020

elasticmachine commented Mar 31, 2020

martijnvg left a comment

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

henningandersen left a comment

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

danhermann commented Apr 1, 2020

danhermann commented Apr 2, 2020

danhermann commented Apr 2, 2020