IGNITE-6776 .NET: Thin client: Add SQL & LINQ example
authorPavel Tupitsyn <ptupitsyn@apache.org>
Wed, 17 Jan 2018 14:05:25 +0000 (17:05 +0300)
committerPavel Tupitsyn <ptupitsyn@apache.org>
Wed, 17 Jan 2018 14:05:25 +0000 (17:05 +0300)
This closes #3390

modules/platforms/dotnet/Apache.Ignite.Core.Tests/Examples/ExamplesTest.cs
modules/platforms/dotnet/examples/Apache.Ignite.Examples/Apache.Ignite.Examples.csproj
modules/platforms/dotnet/examples/Apache.Ignite.Examples/ThinClient/ThinClientSqlExample.cs [new file with mode: 0644]

index fcae595..8483f3e 100644 (file)
@@ -51,7 +51,7 @@ namespace Apache.Ignite.Core.Tests.Examples
         private static readonly Type[] RemoteOnlyExamples =
         {
             typeof(PeerAssemblyLoadingExample), typeof(MessagingExample), typeof(NearCacheExample),
-            typeof(ThinClientPutGetExample), typeof(ThinClientQueryExample)
+            typeof(ThinClientPutGetExample), typeof(ThinClientQueryExample), typeof(ThinClientSqlExample)
         };
 
         /** */
@@ -59,7 +59,7 @@ namespace Apache.Ignite.Core.Tests.Examples
         {
             typeof(BinaryModeExample), typeof(NearCacheExample), typeof(PeerAssemblyLoadingExample),
             typeof(ThinClientPutGetExample), typeof(SqlExample), typeof(LinqExample), typeof(SqlDmlExample),
-            typeof(SqlDdlExample)
+            typeof(SqlDdlExample), typeof(ThinClientSqlExample)
         };
 
         /** Config file path. */
index 51ac5ad..08390d7 100644 (file)
@@ -83,6 +83,7 @@
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="Services\IMapService.cs" />
     <Compile Include="Services\ServicesExample.cs" />
+    <Compile Include="ThinClient\ThinClientSqlExample.cs" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\Apache.Ignite.ExamplesDll\Apache.Ignite.ExamplesDll.csproj">
diff --git a/modules/platforms/dotnet/examples/Apache.Ignite.Examples/ThinClient/ThinClientSqlExample.cs b/modules/platforms/dotnet/examples/Apache.Ignite.Examples/ThinClient/ThinClientSqlExample.cs
new file mode 100644 (file)
index 0000000..b29ccd0
--- /dev/null
@@ -0,0 +1,222 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF 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.
+ */
+
+namespace Apache.Ignite.Examples.ThinClient
+{
+    using System;
+    using System.Linq;
+    using Apache.Ignite.Core;
+    using Apache.Ignite.Core.Cache;
+    using Apache.Ignite.Core.Cache.Configuration;
+    using Apache.Ignite.Core.Cache.Query;
+    using Apache.Ignite.Core.Client;
+    using Apache.Ignite.Core.Client.Cache;
+    using Apache.Ignite.ExamplesDll.Binary;
+    using Apache.Ignite.Linq;
+
+    /// <summary>
+    /// Demonstrates Ignite.NET "thin" client SQL queries.
+    /// <para />
+    /// 1) Set this class as startup object (Apache.Ignite.Examples project -> right-click -> Properties ->
+    ///     Application -> Startup object);
+    /// 2) Start example (F5 or Ctrl+F5).
+    /// <para />
+    /// This example must be run with standalone Apache Ignite node:
+    /// 1) Run %IGNITE_HOME%/platforms/dotnet/bin/Apache.Ignite.exe:
+    /// Apache.Ignite.exe -configFileName=platforms\dotnet\examples\apache.ignite.examples\app.config
+    /// 2) Start example.
+    /// <para />
+    /// This example can also work via pure Java node started with ignite.bat/ignite.sh.
+    /// </summary>
+    public class ThinClientSqlExample
+    {
+        /// <summary> Cache name. </summary>
+        private const string CacheName = "thinClientSqlCache";
+
+        [STAThread]
+        public static void Main()
+        {
+            var cfg = new IgniteClientConfiguration
+            {
+                Host = "127.0.0.1"
+            };
+
+            using (IIgniteClient igniteClient = Ignition.StartClient(cfg))
+            {
+                Console.WriteLine();
+                Console.WriteLine(">>> Cache query client example started.");
+
+                // Configure query entities to enable SQL.
+                var cacheCfg = new CacheClientConfiguration
+                {
+                    Name = CacheName,
+                    QueryEntities = new[]
+                    {
+                        new QueryEntity(typeof(int), typeof(Employee)), 
+                    }
+                };
+
+                ICacheClient<int, Employee> cache = igniteClient.GetOrCreateCache<int, Employee>(cacheCfg);
+
+                // Populate cache with sample data entries.
+                PopulateCache(cache);
+
+                // Run SQL example.
+                SqlQueryExample(cache);
+                LinqExample(cache);
+                
+                // Run SQL fields query example.
+                SqlFieldsQueryExample(cache);
+                LinqFieldsExample(cache);
+            }
+
+            Console.WriteLine();
+            Console.WriteLine(">>> Example finished, press any key to exit ...");
+            Console.ReadKey();
+        }
+
+        /// <summary>
+        /// Queries employees that have provided ZIP code in address.
+        /// </summary>
+        /// <param name="cache">Cache.</param>
+        private static void SqlQueryExample(ICacheClient<int, Employee> cache)
+        {
+            const int zip = 94109;
+
+            var qry = cache.Query(new SqlQuery(typeof(Employee), "zip = ?", zip));
+
+            Console.WriteLine();
+            Console.WriteLine(">>> Employees with zipcode {0} (SQL):", zip);
+
+            foreach (var entry in qry)
+                Console.WriteLine(">>>    " + entry.Value);
+        }
+        
+        /// <summary>
+        /// Queries employees that have provided ZIP code in address.
+        /// </summary>
+        /// <param name="cache">Cache.</param>
+        private static void LinqExample(ICacheClient<int, Employee> cache)
+        {
+            const int zip = 94109;
+
+            IQueryable<ICacheEntry<int, Employee>> qry =
+                cache.AsCacheQueryable().Where(emp => emp.Value.Address.Zip == zip);
+
+            Console.WriteLine();
+            Console.WriteLine(">>> Employees with zipcode " + zip + " (LINQ):");
+
+            foreach (ICacheEntry<int, Employee> entry in qry)
+                Console.WriteLine(">>>    " + entry.Value);
+            
+            Console.WriteLine();
+            Console.WriteLine(">>> Generated SQL:");
+            Console.WriteLine(">>> " + qry.ToCacheQueryable().GetFieldsQuery().Sql);
+        }
+
+        
+        /// <summary>
+        /// Queries names and salaries for all employees.
+        /// </summary>
+        /// <param name="cache">Cache.</param>
+        private static void SqlFieldsQueryExample(ICacheClient<int, Employee> cache)
+        {
+            var qry = cache.Query(new SqlFieldsQuery("select name, salary from Employee"));
+
+            Console.WriteLine();
+            Console.WriteLine(">>> Employee names and their salaries (SQL):");
+
+            foreach (var row in qry)
+                Console.WriteLine(">>>     [Name=" + row[0] + ", salary=" + row[1] + ']');
+        }
+        
+        /// <summary>
+        /// Queries names and salaries for all employees.
+        /// </summary>
+        /// <param name="cache">Cache.</param>
+        private static void LinqFieldsExample(ICacheClient<int, Employee> cache)
+        {
+            var qry = cache.AsCacheQueryable().Select(entry => new {entry.Value.Name, entry.Value.Salary});
+
+            Console.WriteLine();
+            Console.WriteLine(">>> Employee names and their salaries (LINQ):");
+
+            foreach (var row in qry)
+                Console.WriteLine(">>>     [Name=" + row.Name + ", salary=" + row.Salary + ']');
+            
+            Console.WriteLine();
+            Console.WriteLine(">>> Generated SQL:");
+            Console.WriteLine(">>> " + qry.ToCacheQueryable().GetFieldsQuery().Sql);
+        }
+
+        /// <summary>
+        /// Populate cache with data for this example.
+        /// </summary>
+        /// <param name="cache">Cache.</param>
+        private static void PopulateCache(ICacheClient<int, Employee> cache)
+        {
+            cache.Put(1, new Employee(
+                "James Wilson",
+                12500,
+                new Address("1096 Eddy Street, San Francisco, CA", 94109),
+                new[] { "Human Resources", "Customer Service" },
+                1));
+
+            cache.Put(2, new Employee(
+                "Daniel Adams",
+                11000,
+                new Address("184 Fidler Drive, San Antonio, TX", 78130),
+                new[] { "Development", "QA" },
+                1));
+
+            cache.Put(3, new Employee(
+                "Cristian Moss",
+                12500,
+                new Address("667 Jerry Dove Drive, Florence, SC", 29501),
+                new[] { "Logistics" },
+                1));
+
+            cache.Put(4, new Employee(
+                "Allison Mathis",
+                25300,
+                new Address("2702 Freedom Lane, San Francisco, CA", 94109),
+                new[] { "Development" },
+                2));
+
+            cache.Put(5, new Employee(
+                "Breana Robbin",
+                6500,
+                new Address("3960 Sundown Lane, Austin, TX", 78130),
+                new[] { "Sales" },
+                2));
+
+            cache.Put(6, new Employee(
+                "Philip Horsley",
+                19800,
+                new Address("2803 Elsie Drive, Sioux Falls, SD", 57104),
+                new[] { "Sales" },
+                2));
+
+            cache.Put(7, new Employee(
+                "Brian Peters",
+                10600,
+                new Address("1407 Pearlman Avenue, Boston, MA", 12110),
+                new[] { "Development", "QA" },
+                2));
+        }
+    }
+}
\ No newline at end of file