Skip to content

Add migrate to data stream API in NEST #5633

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 26, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions src/Nest/Descriptors.Indices.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1000,6 +1000,27 @@ public GetIndexTemplateDescriptor(Names name): base(r => r.Optional("name", name
public GetIndexTemplateDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout);
}

///<summary>Descriptor for MigrateToDataStream <para>https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html</para></summary>
public partial class MigrateToDataStreamDescriptor : RequestDescriptorBase<MigrateToDataStreamDescriptor, MigrateToDataStreamRequestParameters, IMigrateToDataStreamRequest>, IMigrateToDataStreamRequest
{
internal override ApiUrls ApiUrls => ApiUrlsLookups.IndicesMigrateToDataStream;
///<summary>/_data_stream/_migrate/{name}</summary>
///<param name = "name">this parameter is required</param>
public MigrateToDataStreamDescriptor(Name name): base(r => r.Required("name", name))
{
}

///<summary>Used for serialization purposes, making sure we have a parameterless constructor</summary>
[SerializationConstructor]
protected MigrateToDataStreamDescriptor(): base()
{
}

// values part of the url path
Name IMigrateToDataStreamRequest.Name => Self.RouteValues.Get<Name>("name");
// Request parameters
}

///<summary>Descriptor for Open <para>https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html</para></summary>
public partial class OpenIndexDescriptor : RequestDescriptorBase<OpenIndexDescriptor, OpenIndexRequestParameters, IOpenIndexRequest>, IOpenIndexRequest
{
Expand Down
24 changes: 24 additions & 0 deletions src/Nest/ElasticClient.Indices.cs
Original file line number Diff line number Diff line change
Expand Up @@ -689,6 +689,30 @@ public Task<GetMappingResponse> GetMappingAsync<TDocument>(Func<GetMappingDescri
/// </summary>
public Task<GetIndexTemplateResponse> GetTemplateAsync(IGetIndexTemplateRequest request, CancellationToken ct = default) => DoRequestAsync<IGetIndexTemplateRequest, GetIndexTemplateResponse>(request, request.RequestParameters, ct);
/// <summary>
/// <c>POST</c> request to the <c>indices.migrate_to_data_stream</c> API, read more about this API online:
/// <para></para>
/// <a href = "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html">https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html</a>
/// </summary>
public MigrateToDataStreamResponse MigrateToDataStream(Name name, Func<MigrateToDataStreamDescriptor, IMigrateToDataStreamRequest> selector = null) => MigrateToDataStream(selector.InvokeOrDefault(new MigrateToDataStreamDescriptor(name: name)));
/// <summary>
/// <c>POST</c> request to the <c>indices.migrate_to_data_stream</c> API, read more about this API online:
/// <para></para>
/// <a href = "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html">https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html</a>
/// </summary>
public Task<MigrateToDataStreamResponse> MigrateToDataStreamAsync(Name name, Func<MigrateToDataStreamDescriptor, IMigrateToDataStreamRequest> selector = null, CancellationToken ct = default) => MigrateToDataStreamAsync(selector.InvokeOrDefault(new MigrateToDataStreamDescriptor(name: name)), ct);
/// <summary>
/// <c>POST</c> request to the <c>indices.migrate_to_data_stream</c> API, read more about this API online:
/// <para></para>
/// <a href = "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html">https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html</a>
/// </summary>
public MigrateToDataStreamResponse MigrateToDataStream(IMigrateToDataStreamRequest request) => DoRequest<IMigrateToDataStreamRequest, MigrateToDataStreamResponse>(request, request.RequestParameters);
/// <summary>
/// <c>POST</c> request to the <c>indices.migrate_to_data_stream</c> API, read more about this API online:
/// <para></para>
/// <a href = "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html">https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html</a>
/// </summary>
public Task<MigrateToDataStreamResponse> MigrateToDataStreamAsync(IMigrateToDataStreamRequest request, CancellationToken ct = default) => DoRequestAsync<IMigrateToDataStreamRequest, MigrateToDataStreamResponse>(request, request.RequestParameters, ct);
/// <summary>
/// <c>POST</c> request to the <c>indices.open</c> API, read more about this API online:
/// <para></para>
/// <a href = "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html">https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html</a>
Expand Down
33 changes: 33 additions & 0 deletions src/Nest/Requests.Indices.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1800,6 +1800,39 @@ public Time MasterTimeout
}
}

[InterfaceDataContract]
public partial interface IMigrateToDataStreamRequest : IRequest<MigrateToDataStreamRequestParameters>
{
[IgnoreDataMember]
Name Name
{
get;
}
}

///<summary>Request for MigrateToDataStream <para>https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html</para></summary>
public partial class MigrateToDataStreamRequest : PlainRequestBase<MigrateToDataStreamRequestParameters>, IMigrateToDataStreamRequest
{
protected IMigrateToDataStreamRequest Self => this;
internal override ApiUrls ApiUrls => ApiUrlsLookups.IndicesMigrateToDataStream;
///<summary>/_data_stream/_migrate/{name}</summary>
///<param name = "name">this parameter is required</param>
public MigrateToDataStreamRequest(Name name): base(r => r.Required("name", name))
{
}

///<summary>Used for serialization purposes, making sure we have a parameterless constructor</summary>
[SerializationConstructor]
protected MigrateToDataStreamRequest(): base()
{
}

// values part of the url path
[IgnoreDataMember]
Name IMigrateToDataStreamRequest.Name => Self.RouteValues.Get<Name>("name");
// Request parameters
}

[InterfaceDataContract]
public partial interface IOpenIndexRequest : IRequest<OpenIndexRequestParameters>
{
Expand Down
25 changes: 25 additions & 0 deletions src/Nest/XPack/DataStreams/Migrate/MigrateToDataStreamRequest.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// Licensed to Elasticsearch B.V under one or more agreements.
// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
// See the LICENSE file in the project root for more information

namespace Nest
{
/// <summary>
/// Converts an index alias to a data stream.
/// </summary>
[MapsApi("indices.migrate_to_data_stream.json")]
[ReadAs(typeof(MigrateToDataStreamRequest))]
public partial interface IMigrateToDataStreamRequest
{
}

/// <inheritdoc cref="IMigrateToDataStreamRequest"/>
public partial class MigrateToDataStreamRequest : IMigrateToDataStreamRequest
{
}

/// <inheritdoc cref="IMigrateToDataStreamRequest"/>
public partial class MigrateToDataStreamDescriptor
{
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
// Licensed to Elasticsearch B.V under one or more agreements.
// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
// See the LICENSE file in the project root for more information

namespace Nest
{
public class MigrateToDataStreamResponse : AcknowledgedResponseBase { }
}
1 change: 1 addition & 0 deletions src/Nest/_Generated/ApiUrlsLookup.generated.cs
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ internal static class ApiUrlsLookups
internal static ApiUrls IndicesGetMapping = new ApiUrls(new[]{"_mapping", "{index}/_mapping"});
internal static ApiUrls IndicesGetSettings = new ApiUrls(new[]{"_settings", "{index}/_settings", "{index}/_settings/{name}", "_settings/{name}"});
internal static ApiUrls IndicesGetTemplate = new ApiUrls(new[]{"_template", "_template/{name}"});
internal static ApiUrls IndicesMigrateToDataStream = new ApiUrls(new[]{"_data_stream/_migrate/{name}"});
internal static ApiUrls IndicesOpen = new ApiUrls(new[]{"{index}/_open"});
internal static ApiUrls IndicesPutAlias = new ApiUrls(new[]{"{index}/_alias/{name}"});
internal static ApiUrls IndicesPutMapping = new ApiUrls(new[]{"{index}/_mapping"});
Expand Down
63 changes: 57 additions & 6 deletions tests/Tests/XPack/DataStreams/DataStreamsApiTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ namespace Tests.XPack.DataStreams
[SkipVersion("<7.9.0", "Introduced in 7.9.0")]
public class DataStreamsApiTests : CoordinatedIntegrationTestBase<WritableCluster>
{
private static readonly Metric Document = new Metric
private static readonly Metric Document = new()
{
Timestamp = new DateTime(2020, 8, 3, 14, 0, 0, DateTimeKind.Utc),
Accept = 3,
Expand All @@ -27,13 +27,16 @@ public class DataStreamsApiTests : CoordinatedIntegrationTestBase<WritableCluste
Response = 300,
Total = 3
};

private const string CreateDataStreamStep = nameof(CreateDataStreamStep);
private const string IndexStep = nameof(IndexStep);
private const string GetDataStreamStep = nameof(GetDataStreamStep);
private const string PutIndexTemplateStep = nameof(PutIndexTemplateStep);
private const string DataStreamsStatsStep = nameof(DataStreamsStatsStep);
private const string DeleteDataStreamStep = nameof(DeleteDataStreamStep);
private const string PrepareIndexStep = nameof(PrepareIndexStep);
private const string PrepareAliasStep = nameof(PrepareAliasStep);
private const string MigrateToDataStreamStep = nameof(MigrateToDataStreamStep);

public DataStreamsApiTests(WritableCluster cluster, EndpointUsage usage) : base(new CoordinatedUsage(cluster, usage, testOnlyOne: true)
{
Expand Down Expand Up @@ -89,10 +92,10 @@ public DataStreamsApiTests(WritableCluster cluster, EndpointUsage usage) : base(
Refresh = Refresh.WaitFor
},
(v, d) => d.Index(v).Refresh(Refresh.WaitFor),
(v, c, f) => c.Index<Metric>(Document, f),
(v, c, f) => c.IndexAsync<Metric>(Document, f),
(v, c, r) => c.Index<Metric>(r),
(v, c, r) => c.IndexAsync<Metric>(r)
(v, c, f) => c.Index(Document, f),
(v, c, f) => c.IndexAsync(Document, f),
(v, c, r) => c.Index(r),
(v, c, r) => c.IndexAsync(r)
)
},
{GetDataStreamStep, u =>
Expand Down Expand Up @@ -125,6 +128,48 @@ public DataStreamsApiTests(WritableCluster cluster, EndpointUsage usage) : base(
(v, c, r) => c.Indices.DeleteDataStreamAsync(r)
)
},
// Used for migrate step
{PrepareIndexStep, ">= 7.13.0", u =>
u.Calls<CreateIndexDescriptor, CreateIndexRequest, ICreateIndexRequest, CreateIndexResponse>(
v => new CreateIndexRequest($"my-index{v}-test")
{
Mappings = new TypeMapping
{
Properties = new Properties
{
{ "@timestamp", new DateNanosProperty() }
}
}
},
(v, d) => d.Map(m=> m.Properties(p=> p.DateNanos(dn => dn.Name("@timestamp")))),
(v, c, f) => c.Indices.Create($"my-index{v}-test", f),
(v, c, f) => c.Indices.CreateAsync($"my-index{v}-test", f),
(v, c, r) => c.Indices.Create(r),
(v, c, r) => c.Indices.CreateAsync(r)
)
},
// Used for migrate step
{PrepareAliasStep,">= 7.13.0", u =>
u.Calls<PutAliasDescriptor, PutAliasRequest, IPutAliasRequest, PutAliasResponse>(
v => new PutAliasRequest($"my-index{v}-test", $"{v}-alias"),
(v, d) => d,
(v, c, f) => c.Indices.PutAlias($"my-index{v}-test", $"{v}-alias", f),
(v, c, f) => c.Indices.PutAliasAsync($"my-index{v}-test", $"{v}-alias", f),
(v, c, r) => c.Indices.PutAlias(r),
(v, c, r) => c.Indices.PutAliasAsync(r)
)
},
// Migrate to data stream added in 7.13.0
{MigrateToDataStreamStep,">= 7.13.0", u =>
u.Calls<MigrateToDataStreamDescriptor, MigrateToDataStreamRequest, IMigrateToDataStreamRequest, MigrateToDataStreamResponse>(
v => new MigrateToDataStreamRequest($"{v}-alias"),
(v, d) => d,
(v, c, f) => c.Indices.MigrateToDataStream($"{v}-alias", f),
(v, c, f) => c.Indices.MigrateToDataStreamAsync($"{v}-alias", f),
(v, c, r) => c.Indices.MigrateToDataStream(r),
(v, c, r) => c.Indices.MigrateToDataStreamAsync(r)
)
},
}) { }

[I] public async Task CreateDataStreamResponse() => await Assert<CreateDataStreamResponse>(CreateDataStreamStep, (v, r) =>
Expand Down Expand Up @@ -179,5 +224,11 @@ [I] public async Task DeleteDataStreamResponse() => await Assert<DeleteDataStrea
r.ShouldBeValid();
r.Acknowledged.Should().BeTrue();
});

[I] public async Task MigrateToDataStreamResponse() => await Assert<MigrateToDataStreamResponse>(MigrateToDataStreamStep, r =>
{
r.ShouldBeValid();
r.Acknowledged.Should().BeTrue();
});
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
using System.Threading.Tasks;
using Elastic.Elasticsearch.Xunit.XunitPlumbing;
using Nest;
using Tests.Framework.EndpointTests;
using static Tests.Framework.EndpointTests.UrlTester;

namespace Tests.XPack.DataStreams.Migrate
{
public class MigrateToDataStreamUrlTests : UrlTestsBase
{
[U]
public override async Task Urls() => await POST("/_data_stream/_migrate/stream")
.Fluent(c => c.Indices.MigrateToDataStream("stream", f => f))
.Request(c => c.Indices.MigrateToDataStream(new MigrateToDataStreamRequest("stream")))
.FluentAsync(c => c.Indices.MigrateToDataStreamAsync("stream", f => f))
.RequestAsync(c => c.Indices.MigrateToDataStreamAsync(new MigrateToDataStreamRequest("stream")));
}
}