forked from opensearch-project/OpenSearch
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Backport: initial data stream commit (#53959)
This commits adds a data stream feature flag, initial definition of a data stream and the stubs for the data stream create, delete and get APIs. Also simple serialization tests are added and a rest test to thest the data stream API stubs. This is a large amount of code and mainly mechanical, but this commit should be straightforward to review, because there isn't any real logic. The data stream transport and rest action are behind the data stream feature flag and are only intialized if the feature flag is enabled. The feature flag is enabled if elasticsearch is build as snapshot or a release build and the 'es.datastreams_feature_flag_registered' is enabled. The integ-test-zip sets the feature flag if building a release build, otherwise rest tests would fail. Relates to #53100
- Loading branch information
Showing
22 changed files
with
1,141 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
31 changes: 31 additions & 0 deletions
31
rest-api-spec/src/main/resources/rest-api-spec/api/indices.create_data_stream.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| { | ||
| "indices.create_data_stream":{ | ||
| "documentation":{ | ||
| "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", | ||
| "description":"Creates or updates a data stream" | ||
| }, | ||
| "stability":"experimental", | ||
| "url":{ | ||
| "paths":[ | ||
| { | ||
| "path":"/_data_stream/{name}", | ||
| "methods":[ | ||
| "PUT" | ||
| ], | ||
| "parts":{ | ||
| "name":{ | ||
| "type":"string", | ||
| "description":"The name of the data stream" | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| }, | ||
| "params":{ | ||
| }, | ||
| "body":{ | ||
| "description":"The data stream definition", | ||
| "required":true | ||
| } | ||
| } | ||
| } |
26 changes: 26 additions & 0 deletions
26
rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete_data_stream.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| { | ||
| "indices.delete_data_stream":{ | ||
| "documentation":{ | ||
| "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", | ||
| "description":"Deletes a data stream." | ||
| }, | ||
| "stability":"experimental", | ||
| "url":{ | ||
| "paths":[ | ||
| { | ||
| "path":"/_data_stream/{name}", | ||
| "methods":[ | ||
| "DELETE" | ||
| ], | ||
| "parts":{ | ||
| "name":{ | ||
| "type":"string", | ||
| "description":"The name of the data stream" | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| }, | ||
| "params":{} | ||
| } | ||
| } |
33 changes: 33 additions & 0 deletions
33
rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_streams.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| { | ||
| "indices.get_data_streams":{ | ||
| "documentation":{ | ||
| "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", | ||
| "description":"Returns data streams." | ||
| }, | ||
| "stability":"experimental", | ||
| "url":{ | ||
| "paths":[ | ||
| { | ||
| "path":"/_data_streams", | ||
| "methods":[ | ||
| "GET" | ||
| ] | ||
| }, | ||
| { | ||
| "path":"/_data_streams/{name}", | ||
| "methods":[ | ||
| "GET" | ||
| ], | ||
| "parts":{ | ||
| "name":{ | ||
| "type":"list", | ||
| "description":"The comma separated names of data streams" | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| }, | ||
| "params":{ | ||
| } | ||
| } | ||
| } |
26 changes: 26 additions & 0 deletions
26
rest-api-spec/src/main/resources/rest-api-spec/test/indices.data_stream/10_basic.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| --- | ||
| "Test stubs": | ||
| - skip: | ||
| version: " - 7.6.99" | ||
| reason: only available in 7.7+ | ||
|
|
||
| - do: | ||
| indices.create_data_stream: | ||
| name: data-stream2 | ||
| body: | ||
| timestamp_field: "@timestamp" | ||
| - is_true: acknowledged | ||
|
|
||
| - do: | ||
| indices.get_data_streams: {} | ||
| - match: { 0.name: my_data_stream1 } | ||
| - match: { 0.timestamp_field: '@timestamp' } | ||
| - match: { 0.indices: ['my_data_stream1-000000'] } | ||
| - match: { 1.name: my_data_stream2 } | ||
| - match: { 1.timestamp_field: '@timestamp' } | ||
| - match: { 1.indices: [] } | ||
|
|
||
| - do: | ||
| indices.delete_data_stream: | ||
| name: data-stream2 | ||
| - is_true: acknowledged |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
127 changes: 127 additions & 0 deletions
127
...c/main/java/org/elasticsearch/action/admin/indices/datastream/CreateDataStreamAction.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.elasticsearch.action.admin.indices.datastream; | ||
|
|
||
| import org.elasticsearch.action.ActionListener; | ||
| import org.elasticsearch.action.ActionRequestValidationException; | ||
| import org.elasticsearch.action.ActionType; | ||
| import org.elasticsearch.action.support.ActionFilters; | ||
| import org.elasticsearch.action.support.master.AcknowledgedResponse; | ||
| import org.elasticsearch.action.support.master.MasterNodeRequest; | ||
| import org.elasticsearch.action.support.master.TransportMasterNodeAction; | ||
| import org.elasticsearch.cluster.ClusterState; | ||
| import org.elasticsearch.cluster.block.ClusterBlockException; | ||
| import org.elasticsearch.cluster.block.ClusterBlockLevel; | ||
| import org.elasticsearch.cluster.metadata.IndexNameExpressionResolver; | ||
| import org.elasticsearch.cluster.service.ClusterService; | ||
| import org.elasticsearch.common.inject.Inject; | ||
| import org.elasticsearch.common.io.stream.StreamInput; | ||
| import org.elasticsearch.common.io.stream.StreamOutput; | ||
| import org.elasticsearch.threadpool.ThreadPool; | ||
| import org.elasticsearch.transport.TransportService; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Objects; | ||
|
|
||
| public class CreateDataStreamAction extends ActionType<AcknowledgedResponse> { | ||
|
|
||
| public static final CreateDataStreamAction INSTANCE = new CreateDataStreamAction(); | ||
| public static final String NAME = "indices:admin/data_stream/create"; | ||
|
|
||
| private CreateDataStreamAction() { | ||
| super(NAME, AcknowledgedResponse::new); | ||
| } | ||
|
|
||
| public static class Request extends MasterNodeRequest<Request> { | ||
|
|
||
| private final String name; | ||
| private String timestampFieldName; | ||
|
|
||
| public Request(String name) { | ||
| this.name = name; | ||
| } | ||
|
|
||
| public void setTimestampFieldName(String timestampFieldName) { | ||
| this.timestampFieldName = timestampFieldName; | ||
| } | ||
|
|
||
| @Override | ||
| public ActionRequestValidationException validate() { | ||
| return null; | ||
| } | ||
|
|
||
| public Request(StreamInput in) throws IOException { | ||
| super(in); | ||
| this.name = in.readString(); | ||
| this.timestampFieldName = in.readString(); | ||
| } | ||
|
|
||
| @Override | ||
| public void writeTo(StreamOutput out) throws IOException { | ||
| super.writeTo(out); | ||
| out.writeString(name); | ||
| out.writeString(timestampFieldName); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (this == o) return true; | ||
| if (o == null || getClass() != o.getClass()) return false; | ||
| Request request = (Request) o; | ||
| return name.equals(request.name) && | ||
| timestampFieldName.equals(request.timestampFieldName); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(name, timestampFieldName); | ||
| } | ||
| } | ||
|
|
||
| public static class TransportAction extends TransportMasterNodeAction<Request, AcknowledgedResponse> { | ||
|
|
||
| @Inject | ||
| public TransportAction(TransportService transportService, ClusterService clusterService, ThreadPool threadPool, | ||
| ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver) { | ||
| super(NAME, transportService, clusterService, threadPool, actionFilters, Request::new, indexNameExpressionResolver); | ||
| } | ||
|
|
||
| @Override | ||
| protected String executor() { | ||
| return ThreadPool.Names.SAME; | ||
| } | ||
|
|
||
| @Override | ||
| protected AcknowledgedResponse read(StreamInput in) throws IOException { | ||
| return new AcknowledgedResponse(in); | ||
| } | ||
|
|
||
| @Override | ||
| protected void masterOperation(Request request, ClusterState state, | ||
| ActionListener<AcknowledgedResponse> listener) throws Exception { | ||
| listener.onResponse(new AcknowledgedResponse(true)); | ||
| } | ||
|
|
||
| @Override | ||
| protected ClusterBlockException checkBlock(Request request, ClusterState state) { | ||
| return state.blocks().globalBlockedException(ClusterBlockLevel.METADATA_WRITE); | ||
| } | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.