Skip to content

feat(linq): add support for TakeLast expression #308

New issue

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

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

Already on GitHub? # to your account

Merged
merged 6 commits into from
Apr 13, 2022
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
3 changes: 1 addition & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,10 @@

### Features
1. [#304](https://github.com/influxdata/influxdb-client-csharp/pull/304): Add `InvocableScriptsApi` to create, update, list, delete and invoke scripts by seamless way
1. [#308](https://github.com/influxdata/influxdb-client-csharp/pull/308): Add support for `TakeLast` expression [LINQ]

### Bug Fixes
1. [#305](https://github.com/influxdata/influxdb-client-csharp/pull/305): Authentication Cookies follow redirects

### Bug Fixes
1. [#309](https://github.com/influxdata/influxdb-client-csharp/pull/309): Query expression for joins of binary operators [LINQ]

## 4.0.0 [2022-03-18]
Expand Down
25 changes: 20 additions & 5 deletions Client.Linq.Test/InfluxDBQueryVisitorTest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
using NUnit.Framework;
using Remotion.Linq;
using Remotion.Linq.Parsing.ExpressionVisitors;
using Remotion.Linq.Parsing.Structure;
using Expression = System.Linq.Expressions.Expression;

namespace Client.Linq.Test
Expand Down Expand Up @@ -100,17 +99,32 @@ public void ResultOperatorTake()
}

[Test]
public void ResultOperatorSkip()
public void ResultOperatorTakeLast()
{
var query = from s in InfluxDBQueryable<Sensor>.Queryable("my-bucket", "my-org", _queryApi)
select s;
var visitor = BuildQueryVisitor(query, MakeExpression(query, q => q.Skip(5)));

const string expected = FluxStart;
var visitor = BuildQueryVisitor(query, MakeExpression(query, q => q.TakeLast(10)));

var expected = FluxStart + " " + "|> tail(n: p3)";
Assert.AreEqual(expected, visitor.BuildFluxQuery());

visitor = BuildQueryVisitor(query, MakeExpression(query, q => q.TakeLast(10).Skip(5)));

expected = FluxStart + " " + "|> tail(n: p3, offset: p4)";
Assert.AreEqual(expected, visitor.BuildFluxQuery());
}

[Test]
public void ResultOperatorSkip()
{
var query = from s in InfluxDBQueryable<Sensor>.Queryable("my-bucket", "my-org", _queryApi)
select s;
var visitor = BuildQueryVisitor(query, MakeExpression(query, q => q.Skip(5)));

Assert.AreEqual(FluxStart, visitor.BuildFluxQuery());
}

[Test]
public void ResultOperatorTakeSkip()
{
Expand Down Expand Up @@ -1097,7 +1111,8 @@ public void FilterByTimeAndTagWithAnds()
private InfluxDBQueryVisitor BuildQueryVisitor(IQueryable queryable, Expression expression = null)
{
var queryExecutor = (InfluxDBQueryExecutor)((DefaultQueryProvider)queryable.Provider).Executor;
var queryModel = QueryParser.CreateDefault().GetParsedQuery(expression ?? queryable.Expression);
var queryModel = InfluxDBQueryable<Sensor>.CreateQueryParser()
.GetParsedQuery(expression ?? queryable.Expression);
return queryExecutor.QueryVisitor(queryModel);
}

Expand Down
11 changes: 8 additions & 3 deletions Client.Linq/InfluxDBQueryable.cs
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Linq.Expressions;
using System.Threading;
using InfluxDB.Client.Core;
using InfluxDB.Client.Linq.Internal;
using InfluxDB.Client.Linq.Internal.NodeTypes;
using Remotion.Linq;
using Remotion.Linq.Parsing.Structure;
using Remotion.Linq.Parsing.Structure.NodeTypeProviders;
using Expression = System.Linq.Expressions.Expression;

namespace InfluxDB.Client.Linq
{
Expand Down Expand Up @@ -213,9 +215,12 @@ private static IQueryExecutor CreateExecutor(string bucket, string org, QueryApi
queryableOptimizerSettings ?? new QueryableOptimizerSettings());
}

private static QueryParser CreateQueryParser()
internal static QueryParser CreateQueryParser()
{
return QueryParser.CreateDefault();
var queryParser = QueryParser.CreateDefault();
var compoundNodeTypeProvider = queryParser.NodeTypeProvider as CompoundNodeTypeProvider;
compoundNodeTypeProvider?.InnerProviders.Add(new InfluxDBNodeTypeProvider());
return queryParser;
}

public IAsyncEnumerable<T> GetAsyncEnumerator(CancellationToken cancellationToken = default)
Expand Down
27 changes: 27 additions & 0 deletions Client.Linq/Internal/NodeTypes/InfluxDBNodeTypeProvider.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
using System;
using System.Reflection;
using Remotion.Linq.Parsing.Structure;
using Remotion.Linq.Parsing.Structure.NodeTypeProviders;

namespace InfluxDB.Client.Linq.Internal.NodeTypes
{
internal class InfluxDBNodeTypeProvider : INodeTypeProvider
{
private readonly MethodInfoBasedNodeTypeRegistry _methodInfoRegistry = new MethodInfoBasedNodeTypeRegistry();

internal InfluxDBNodeTypeProvider()
{
_methodInfoRegistry.Register(TakeLastExpressionNode.GetSupportedMethods, typeof(TakeLastExpressionNode));
}

public bool IsRegistered(MethodInfo method)
{
return _methodInfoRegistry.IsRegistered(method);
}

public Type GetNodeType(MethodInfo method)
{
return _methodInfoRegistry.GetNodeType(method);
}
}
}
101 changes: 101 additions & 0 deletions Client.Linq/Internal/NodeTypes/TakeLastNodeType.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Linq;
using System.Linq.Expressions;
using System.Reflection;
using InfluxDB.Client.Core;
using Remotion.Linq.Clauses;
using Remotion.Linq.Clauses.ResultOperators;
using Remotion.Linq.Clauses.StreamedData;
using Remotion.Linq.Parsing.Structure.IntermediateModel;

namespace InfluxDB.Client.Linq.Internal.NodeTypes
{
internal class TakeLastExpressionNode : ResultOperatorExpressionNodeBase
{
private readonly Expression _count;

internal static readonly IEnumerable<MethodInfo> GetSupportedMethods =
new ReadOnlyCollection<MethodInfo>(typeof(Enumerable).GetRuntimeMethods()
.Concat(typeof(Queryable).GetRuntimeMethods()).ToList())
.Where(mi => mi.Name == "TakeLast");

public TakeLastExpressionNode(MethodCallExpressionParseInfo parseInfo, Expression count)
: base(parseInfo, null, null)
{
_count = count;
}

public override Expression Resolve(
ParameterExpression inputParameter,
Expression expressionToBeResolved,
ClauseGenerationContext clauseGenerationContext)
{
Arguments.CheckNotNull(inputParameter, nameof(inputParameter));
Arguments.CheckNotNull(expressionToBeResolved, nameof(expressionToBeResolved));
return Source.Resolve(inputParameter, expressionToBeResolved, clauseGenerationContext);
}

protected override ResultOperatorBase CreateResultOperator(ClauseGenerationContext clauseGenerationContext)
{
return new TakeLastResultOperator(_count);
}
}

internal class TakeLastResultOperator : SequenceTypePreservingResultOperatorBase
{
private Expression _count;

internal TakeLastResultOperator(Expression count)
{
Arguments.CheckNotNull(count, nameof(count));
Count = count;
}

public Expression Count
{
get => _count;
private set
{
Arguments.CheckNotNull(value, nameof(value));
_count = ReferenceEquals(value.Type, typeof(int))
? value
: throw new ArgumentException(string.Format(
"The value expression returns '{0}', an expression returning 'System.Int32' was expected.",
new object[]
{
value.Type
}), nameof(value));
}
}

public override ResultOperatorBase Clone(CloneContext cloneContext)
{
return new TakeResultOperator(Count);
}

public override StreamedSequence ExecuteInMemory<T>(StreamedSequence input)
{
return new StreamedSequence(
input.GetTypedSequence<T>().Take(GetConstantCount()).AsQueryable(),
GetOutputDataInfo(input.DataInfo));
}

public override void TransformExpressions(Func<Expression, Expression> transformation)
{
Arguments.CheckNotNull(transformation, nameof(transformation));
Count = transformation(Count);
}

public override string ToString()
{
return $"TakeLast({Count})";
}

private int GetConstantCount()
{
return GetConstantValueFromExpression<int>("count", Count);
}
}
}
27 changes: 15 additions & 12 deletions Client.Linq/Internal/QueryAggregator.cs
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ internal enum RangeExpressionType

internal class LimitOffsetAssignment
{
internal string FluxFunction;
internal string N;
internal string Offset;
}
Expand All @@ -60,7 +61,7 @@ internal class QueryAggregator
private RangeExpressionType _rangeStartExpression;
private string _rangeStopAssignment;
private RangeExpressionType _rangeStopExpression;
private readonly List<LimitOffsetAssignment> _limitNOffsetAssignments;
private readonly List<LimitOffsetAssignment> _limitTailNOffsetAssignments;
private ResultFunction _resultFunction;
private readonly List<string> _filterByTags;
private readonly List<string> _filterByFields;
Expand All @@ -70,7 +71,7 @@ internal class QueryAggregator
internal QueryAggregator()
{
_resultFunction = ResultFunction.None;
_limitNOffsetAssignments = new List<LimitOffsetAssignment>();
_limitTailNOffsetAssignments = new List<LimitOffsetAssignment>();
_filterByTags = new List<string>();
_filterByFields = new List<string>();
_orders = new List<(string, string, bool, string)>();
Expand Down Expand Up @@ -100,27 +101,29 @@ internal void AddAggregateWindow(string everyVariable, string periodVariable, st
}


internal void AddLimitN(string limitNAssignment)
internal void AddLimitTailN(string limitNAssignment, string fluxFunction)
{
if (_limitNOffsetAssignments.Count > 0 && _limitNOffsetAssignments.Last().N == null)
if (_limitTailNOffsetAssignments.Count > 0 && _limitTailNOffsetAssignments.Last().N == null)
{
_limitNOffsetAssignments.Last().N = limitNAssignment;
_limitTailNOffsetAssignments.Last().FluxFunction = fluxFunction;
_limitTailNOffsetAssignments.Last().N = limitNAssignment;
}
else
{
_limitNOffsetAssignments.Add(new LimitOffsetAssignment { N = limitNAssignment });
_limitTailNOffsetAssignments.Add(new LimitOffsetAssignment
{ FluxFunction = fluxFunction, N = limitNAssignment });
}
}

internal void AddLimitOffset(string limitOffsetAssignment)
internal void AddLimitTailOffset(string limitOffsetAssignment)
{
if (_limitNOffsetAssignments.Count > 0)
if (_limitTailNOffsetAssignments.Count > 0)
{
_limitNOffsetAssignments.Last().Offset = limitOffsetAssignment;
_limitTailNOffsetAssignments.Last().Offset = limitOffsetAssignment;
}
else
{
_limitNOffsetAssignments.Add(new LimitOffsetAssignment { Offset = limitOffsetAssignment });
_limitTailNOffsetAssignments.Add(new LimitOffsetAssignment { Offset = limitOffsetAssignment });
}
}

Expand Down Expand Up @@ -193,10 +196,10 @@ internal string BuildFluxQuery(QueryableOptimizerSettings settings)
}

// https://docs.influxdata.com/flux/v0.x/stdlib/universe/limit/
foreach (var limitNOffsetAssignment in _limitNOffsetAssignments)
foreach (var limitNOffsetAssignment in _limitTailNOffsetAssignments)
if (limitNOffsetAssignment.N != null)
{
parts.Add(BuildOperator("limit",
parts.Add(BuildOperator(limitNOffsetAssignment.FluxFunction,
"n", limitNOffsetAssignment.N,
"offset", limitNOffsetAssignment.Offset));
}
Expand Down
10 changes: 8 additions & 2 deletions Client.Linq/Internal/QueryVisitor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
using System.Text;
using InfluxDB.Client.Api.Domain;
using InfluxDB.Client.Linq.Internal.Expressions;
using InfluxDB.Client.Linq.Internal.NodeTypes;
using Remotion.Linq;
using Remotion.Linq.Clauses;
using Remotion.Linq.Clauses.ResultOperators;
Expand Down Expand Up @@ -135,12 +136,17 @@ public override void VisitResultOperator(ResultOperatorBase resultOperator, Quer
{
case TakeResultOperator takeResultOperator:
var takeVariable = GetFluxExpression(takeResultOperator.Count, takeResultOperator);
_context.QueryAggregator.AddLimitN(takeVariable);
_context.QueryAggregator.AddLimitTailN(takeVariable, "limit");
break;

case TakeLastResultOperator takeLastResultOperator:
var takeLastVariable = GetFluxExpression(takeLastResultOperator.Count, takeLastResultOperator);
_context.QueryAggregator.AddLimitTailN(takeLastVariable, "tail");
break;

case SkipResultOperator skipResultOperator:
var skipVariable = GetFluxExpression(skipResultOperator.Count, skipResultOperator);
_context.QueryAggregator.AddLimitOffset(skipVariable);
_context.QueryAggregator.AddLimitTailOffset(skipVariable);
break;

case AnyResultOperator _:
Expand Down
19 changes: 19 additions & 0 deletions Client.Linq/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ This section contains links to the client library documentation.
- [Or](#or)
- [Any](#any)
- [Take](#take)
- [TakeLast](#takelast)
- [Skip](#skip)
- [OrderBy](#orderby)
- [Count](#count)
Expand Down Expand Up @@ -850,6 +851,24 @@ from(bucket: "my-bucket")
|> limit(n: 10)
```

### TakeLast

```c#
var query = (from s in InfluxDBQueryable<Sensor>.Queryable("my-bucket", "my-org", queryApi)
select s)
.TakeLast(10);
```

Flux Query:

```flux
from(bucket: "my-bucket")
|> range(start: 0)
|> pivot(rowKey:["_time"], columnKey: ["_field"], valueColumn: "_value")
|> drop(columns: ["_start", "_stop", "_measurement"])
|> tail(n: 10)
```

### Skip

```c#
Expand Down