[API-274] SQL for Map ([API-617], [API-616], [API-431], [API-619], [API-620], [API-432], [API-659], [API-660], [API-661])

Hazelcast.Net.sln.DotSettings

@@ -1,4 +1,13 @@
 <wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+	<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/EMPTY_BLOCK_STYLE/@EntryValue">TOGETHER</s:String>
+	<s:Boolean x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/LINE_FEED_AT_FILE_END/@EntryValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/SPACE_BEFORE_EXTENDS_COLON/@EntryValue">True</s:Boolean>
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=CN/@EntryIndexedValue">CN</s:String>
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=CP/@EntryIndexedValue">CP</s:String>
+	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpKeepExistingMigration/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpPlaceEmbeddedOnSameLineMigration/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpUseContinuousIndentInsideBracesMigration/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EMigrateBlankLinesAroundFieldToBlankLinesAroundProperty/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/PatternsAndTemplates/Todo/TodoPatterns/=438E8320080FDC46904A18FD18FF4DCD/@KeyIndexDefined">True</s:Boolean>
 	<s:String x:Key="/Default/PatternsAndTemplates/Todo/TodoPatterns/=438E8320080FDC46904A18FD18FF4DCD/Color/@EntryValue">207, 157, 50</s:String>
 	<s:Boolean x:Key="/Default/PatternsAndTemplates/Todo/TodoPatterns/=438E8320080FDC46904A18FD18FF4DCD/MatchComments/@EntryValue">True</s:Boolean>
@@ -13,6 +22,7 @@
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=endianness/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=expirations/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=multicast/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=nano/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=partitioner/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=retryable/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=hzconsole/@EntryIndexedValue">True</s:Boolean>

hz.ps1

@@ -58,7 +58,7 @@ $params = @(
        desc = "whether to run enterprise tests";
        info = "Running enterprise tests require an enterprise key, which can be supplied either via the HAZELCAST_ENTERPRISE_KEY environment variable, or the build/enterprise.key file."
     },
-    @{ name = "server";          type = [string];  default = "4.1-SNAPSHOT"  # -SNAPSHOT to avoid obsolete certs in JARs
+    @{ name = "server";          type = [string];  default = "5.0-SNAPSHOT"  # -SNAPSHOT to avoid obsolete certs in JARs
        parm = "<version>";
        desc = "the server version when running tests, the remote controller, or a server";
        note = "The server <version> must match a released Hazelcast IMDG server version, e.g. 4.0 or 4.1-SNAPSHOT. Server JARs are automatically downloaded."

src/Hazelcast.Net.Examples/Sql/SqlBasicQueryExample.cs

@@ -0,0 +1,78 @@
+// Copyright (c) 2008-2021, Hazelcast, Inc. All Rights Reserved.
+//
+// Licensed 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.
+
+using System.Linq;
+using System.Threading.Tasks;
+using Hazelcast.Models;
+using Hazelcast.Sql;
+using Microsoft.Extensions.Logging;
+
+namespace Hazelcast.Examples.Sql
+{
+    // ReSharper disable once UnusedMember.Global
+    public class SqlBasicQueryExample
+    {
+        public static async Task Main(params string[] args)
+        {
+            var options = new HazelcastOptionsBuilder()
+                .With(args)
+                .WithConsoleLogger()
+                .With("Logging:LogLevel:Hazelcast.Examples", "Information")
+                .Build();
+
+            var logger = options.LoggerFactory.Service.CreateLogger<SqlBasicQueryExample>();
+
+            // create a Hazelcast client and connect to a server running on localhost
+            await using var client = await HazelcastClientFactory.StartNewClientAsync(options);
+
+            // get the distributed map from the cluster and populate it
+            await using var map = await client.GetMapAsync<int, string>(nameof(SqlBasicQueryExample));
+            await map.SetAllAsync(Enumerable.Range(1, 10).ToDictionary(v => v, v => $"Value #{v}"));
+
+            // query and print all rows
+            {
+                await using var result = client.Sql.ExecuteQuery($"SELECT __key, this FROM {map.Name}");
+
+                var count = 1;
+                await foreach (var row in result.EnumerateOnceAsync())
+                    logger.LogInformation("Row #{RowCount}: {RowKey}, {RowValue}", count++, row.GetKey<int>(), row.GetValue<string>());
+            }
+
+            // query and print all rows sorted by key descending
+            {
+                // index must be added to be able to sort by attribute
+                await map.AddIndexAsync(IndexType.Sorted, "__key");
+
+                await using var result = client.Sql.ExecuteQuery($"SELECT __key, this FROM {map.Name} ORDER BY __key DESC");
+
+                var count = 1;
+                await foreach (var row in result.EnumerateOnceAsync())
+                    logger.LogInformation("Row (sorted) #{RowCount}: {RowKey}, {RowValue}", count++, row.GetKey<int>(), row.GetValue<string>());
+            }
+
+            // query and print rows filtered via parameters
+            {
+                var (min, max) = (3, 7);
+                await using var result = client.Sql.ExecuteQuery(
+                    $"SELECT __key, this FROM {map.Name} WHERE __key >= ? and __key <= ?",
+                    min, max
+                );
+
+                var count = 1;
+                await foreach (var row in result.EnumerateOnceAsync())
+                    logger.LogInformation("Row (filtered) #{RowCount}: {RowKey}, {RowValue}", count++, row.GetKey<int>(), row.GetValue<string>());
+            }
+        }
+    }
+}

src/Hazelcast.Net.Examples/Sql/SqlCancellationExample.cs

@@ -0,0 +1,108 @@
+// Copyright (c) 2008-2021, Hazelcast, Inc. All Rights Reserved.
+//
+// Licensed 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.
+
+using System;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Logging;
+
+namespace Hazelcast.Examples.Sql
+{
+    // ReSharper disable once UnusedMember.Global
+    public class SqlCancellationExample
+    {
+        public static async Task Main(params string[] args)
+        {
+            var options = new HazelcastOptionsBuilder()
+                .With(args)
+                .WithConsoleLogger()
+                .With("Logging:LogLevel:Hazelcast.Examples", "Information")
+                .Build();
+
+            var logger = options.LoggerFactory.Service.CreateLogger<SqlBasicQueryExample>();
+
+            // create a Hazelcast client and connect to a server running on localhost
+            await using var client = await HazelcastClientFactory.StartNewClientAsync(options);
+
+            // FIXME? [Oleksii] clarify if below is correct and OK
+            // We will use Jet to emulate long-running query.
+            // To run this example you will need to enable Jet in the cluster configuration via '<jet enabled="true"></jet>'.
+            // Below is a simple example of such setup:
+            // "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" +
+            // <hazelcast xmlns="http://www.hazelcast.com/schema/config
+            //   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance
+            //   xsi:schemaLocation="http://www.hazelcast.com/schema/config http://www.hazelcast.com/schema/config/hazelcast-config-5.0.xsd">
+            //   <jet enabled="true"></jet>" +
+            // </hazelcast>;
+
+            // cancel after timeout
+            {
+                var timeout = TimeSpan.FromSeconds(10);
+                logger.LogInformation("Generating values for {Timeout}", timeout);
+
+                // infinite stream that will generate 1 sequential long value about every second
+                await using var result = client.Sql.ExecuteQuery("SELECT * from TABLE(generate_stream(1))");
+
+                var cancellationTask = Task.Delay(timeout);
+
+                while (!cancellationTask.IsCompleted)
+                {
+                    var moveNext = result.MoveNextAsync().AsTask();
+
+                    if (await Task.WhenAny(moveNext, cancellationTask) == cancellationTask)
+                        break;
+
+                    if (await moveNext)
+                        logger.LogInformation("{Value}", result.Current.GetColumn<long>(0));
+                    else
+                        break;
+                }
+            } // result will dispose here, leading to executing query being cancelled
+
+            // cancel after user action
+            {
+                var timeout = TimeSpan.FromSeconds(10);
+                logger.LogInformation("Generating values until user action", timeout);
+
+                // infinite stream that will generate 1 sequential long value about every second
+                await using var result = client.Sql.ExecuteQuery("SELECT * from TABLE(generate_stream(1))");
+
+                var cancellationSource = new TaskCompletionSource<object>();
+                var cancellationTask = cancellationSource.Task;
+
+                // listening for console input to emulate action, but any other event can be used
+                _ = Task.Run(() =>
+                {
+                    logger.LogInformation("Press Enter to stop");
+                    Console.ReadLine();
+                    cancellationSource.SetResult(null);
+                });
+
+                while (!cancellationTask.IsCompleted)
+                {
+                    var moveNext = result.MoveNextAsync().AsTask();
+
+                    if (await Task.WhenAny(moveNext, cancellationTask) == cancellationTask)
+                        break;
+
+                    if (await moveNext)
+                        logger.LogInformation("{Value}", result.Current.GetColumn<long>(0));
+                    else
+                        break;
+                }
+            } // result will dispose here, leading to executing query being cancelled
+
+            logger.LogInformation("Finished");
+        }
+    }
+}

src/Hazelcast.Net.Testing/Accessors/AccessorBase.cs

@@ -0,0 +1,54 @@
+using System;
+using System.Reflection;
+
+namespace Hazelcast.Testing.Accessors
+{
+    // TODO [Oleksii] consider adding some caching/delegates
+    public abstract class AccessorBase<T>
+    {
+        public T Instance { get; }
+
+        protected AccessorBase(T instance)
+        {
+            Instance = instance ?? throw new ArgumentNullException(nameof(instance));
+        }
+
+        protected void SetField<TField>(string fieldName, TField value)
+        {
+            var member = GetFieldInfoOrThrow(fieldName);
+            member.SetValue(Instance, value);
+        }
+
+        protected TField GetField<TField>(string fieldName)
+        {
+            var member = GetFieldInfoOrThrow(fieldName);
+            return (TField)member.GetValue(Instance);
+        }
+
+        protected void SetProperty<TField>(string fieldName, TField value)
+        {
+            var member = GetPropertyInfoOrThrow(fieldName);
+            member.SetValue(Instance, value);
+        }
+
+        protected TField GetProperty<TField>(string fieldName)
+        {
+            var member = GetPropertyInfoOrThrow(fieldName);
+            return (TField)member.GetValue(Instance);
+        }
+
+        private FieldInfo GetFieldInfoOrThrow(string fieldName)
+        {
+            var type = Instance.GetType();
+            return type.GetField(fieldName, BindingFlags.GetField | BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.Public)
+                ?? throw new MissingFieldException(type.FullName, fieldName);
+        }
+
+        private PropertyInfo GetPropertyInfoOrThrow(string fieldName)
+        {
+            var type = Instance.GetType();
+            return type.GetProperty(fieldName, BindingFlags.GetProperty | BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.Public)
+                ?? throw new MissingFieldException(type.FullName, fieldName);
+        }
+    }
+}

src/Hazelcast.Net.Testing/Accessors/AccessorExtensions.cs

@@ -0,0 +1,24 @@
+// Copyright (c) 2008-2021, Hazelcast, Inc. All Rights Reserved.
+//
+// Licensed 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.
+
+using Hazelcast.Clustering;
+
+namespace Hazelcast.Testing.Accessors
+{
+    internal static class AccessorExtensions
+    {
+        public static ClusterMembersAccessor Accessor(this ClusterMembers instance) => new ClusterMembersAccessor(instance);
+        public static MemberConnectionAccessor Accessor(this MemberConnection instance) => new MemberConnectionAccessor(instance);
+    }
+}

src/Hazelcast.Net.Testing/Accessors/ClusterMembersAccessor.cs

@@ -0,0 +1,24 @@
+using System;
+using System.Collections.Generic;
+using Hazelcast.Clustering;
+
+namespace Hazelcast.Testing.Accessors
+{
+    internal class ClusterMembersAccessor: AccessorBase<ClusterMembers>
+    {
+        internal ClusterMembersAccessor(ClusterMembers clusterMembers): base(clusterMembers)
+        { }
+
+        internal MemberTable Members
+        {
+            get => GetField<MemberTable>("_members");
+            set => SetField("_members", value);
+        }
+
+        internal Dictionary<Guid, MemberConnection> Connections
+        {
+            get => GetField<Dictionary<Guid, MemberConnection>>("_connections");
+            set => SetField("_connections", value);
+        }
+    }
+}

src/Hazelcast.Net.Testing/Accessors/MemberConnectionAccessor.cs

@@ -0,0 +1,37 @@
+// Copyright (c) 2008-2021, Hazelcast, Inc. All Rights Reserved.
+//
+// Licensed 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.
+
+using System;
+using Hazelcast.Clustering;
+
+namespace Hazelcast.Testing.Accessors
+{
+    internal class MemberConnectionAccessor: AccessorBase<MemberConnection>
+    {
+        public MemberConnectionAccessor(MemberConnection instance): base(instance)
+        { }
+
+        public bool Active
+        {
+            get => GetField<bool>("_active");
+            set => SetField("_active", value);
+        }
+
+        public Guid MemberId
+        {
+            get => GetProperty<Guid>(nameof(MemberConnection.MemberId));
+            set => SetProperty(nameof(MemberConnection.MemberId), value);
+        }
+    }
+}

src/Hazelcast.Net.Testing/CollectionExtensions.cs

@@ -0,0 +1,11 @@
+using System.Collections.Generic;
+
+namespace Hazelcast.Testing
+{
+    public static class CollectionExtensions
+    {
+        public static T GetOrDefault<T>(this IList<T> source, int index) => (source.Count > index || index < 0)
+            ? source[index]
+            : default;
+    }
+}