Merge pull request #16810 from taosdata/docs/xiaolei/TD-18914-csharp-cloud-supplement

docs(cloud):C# supply in&out example code and doc.

Merge pull request #16810 from taosdata/docs/xiaolei/TD-18914-csharp-cloud-supplement
docs(cloud):C# supply in&out example code and doc.
2d9d7a32 · Bo Ding · GitHub · dde9cccc · d5b30724 · 2d9d7a32
12 changed file
--- a/Jenkinsfile2
+++ b/Jenkinsfile2
@@ -162,6 +162,5 @@ pipeline {
        LOGDIR = '/var/data/jenkins/workspace/log'
    }
    stages {
    }
 }
--- a/docs/en/07-data-in/01-insert-data.md
+++ b/docs/en/07-data-in/01-insert-data.md
@@ -86,8 +86,17 @@ In this example, we use `exec` method to execute SQL. `exec` is designed for som
 ```
 </TabItem>
+<TabItem value="C#" label="C#">
+```C#
+{{#include docs/examples/csharp/cloud-example/inout/Program.cs:insert}}
+```
+</TabItem>
 </Tabs>
-:::note 
+:::note
 `Use` statement is not applicable for cloud service since REST API is stateless.
 :::
\ No newline at end of file
--- a/docs/en/09-data-out/01-query-data.md
+++ b/docs/en/09-data-out/01-query-data.md
@@ -226,4 +226,15 @@ Get all rows and print each row:
 ```
 </TabItem>
-</Tabs>
\ No newline at end of file
+<TabItem value="C#" label="C#">
+In this example, we use query method to execute SQL and get a result object.
+```C#
+{{#include docs/examples/csharp/cloud-example/inout/Program.cs:query}}
+```
+</TabItem>
+</Tabs>
--- a/docs/en/09-data-out/_sub_cs.mdx
+++ b/docs/en/09-data-out/_sub_cs.mdx
 ```csharp
-// {{#include docs/examples/csharp/SubscribeDemo.cs}}
+{{#include docs/examples/csharp/native-example/SubscribeDemo.cs}}
 ```
\ No newline at end of file
--- a/docs/examples/csharp/.gitignore
+++ b/docs/examples/csharp/.gitignore
@@ -4,4 +4,6 @@ cloud-example/usage/bin
 cloud-example/usage/obj
 cloud-example/stmt/bin
 cloud-example/stmt/obj
+cloud-example/inout/bin
+cloud-example/inout/obj
 .vs
\ No newline at end of file
--- a/docs/examples/csharp/cloud-example/cloud-example.sln
+++ b/docs/examples/csharp/cloud-example/cloud-example.sln
 Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 16
 VisualStudioVersion = 16.0.30114.105
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "connect", "connect\connect.csproj", "{4006CF0C-17BE-4508-9682-A85298F8C92D}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "usage", "usage\usage.csproj", "{243C420F-FC47-4F21-B81E-83CDE91F2D47}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "stmt", "stmt\stmt.csproj", "{B6907CB6-41CB-4644-AEE1-551456EADE12}"
 EndProject
-Global
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "inout", "inout\inout.csproj", "{058C3864-CF33-459D-B1A7-F7E1C6AED452}"
-	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+EndProject
-		Debug|Any CPU = Debug|Any CPU
+Global
-		Release|Any CPU = Release|Any CPU
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
-	EndGlobalSection
+		Debug|Any CPU = Debug|Any CPU
-	GlobalSection(SolutionProperties) = preSolution
+		Release|Any CPU = Release|Any CPU
-		HideSolutionNode = FALSE
+	EndGlobalSection
-	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
-	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		HideSolutionNode = FALSE
-		{4006CF0C-17BE-4508-9682-A85298F8C92D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+	EndGlobalSection
-		{4006CF0C-17BE-4508-9682-A85298F8C92D}.Debug|Any CPU.Build.0 = Debug|Any CPU
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
-		{4006CF0C-17BE-4508-9682-A85298F8C92D}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{4006CF0C-17BE-4508-9682-A85298F8C92D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{4006CF0C-17BE-4508-9682-A85298F8C92D}.Release|Any CPU.Build.0 = Release|Any CPU
+		{4006CF0C-17BE-4508-9682-A85298F8C92D}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{243C420F-FC47-4F21-B81E-83CDE91F2D47}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{4006CF0C-17BE-4508-9682-A85298F8C92D}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{243C420F-FC47-4F21-B81E-83CDE91F2D47}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{4006CF0C-17BE-4508-9682-A85298F8C92D}.Release|Any CPU.Build.0 = Release|Any CPU
-		{243C420F-FC47-4F21-B81E-83CDE91F2D47}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{243C420F-FC47-4F21-B81E-83CDE91F2D47}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{243C420F-FC47-4F21-B81E-83CDE91F2D47}.Release|Any CPU.Build.0 = Release|Any CPU
+		{243C420F-FC47-4F21-B81E-83CDE91F2D47}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{B6907CB6-41CB-4644-AEE1-551456EADE12}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{243C420F-FC47-4F21-B81E-83CDE91F2D47}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{B6907CB6-41CB-4644-AEE1-551456EADE12}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{243C420F-FC47-4F21-B81E-83CDE91F2D47}.Release|Any CPU.Build.0 = Release|Any CPU
-		{B6907CB6-41CB-4644-AEE1-551456EADE12}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{B6907CB6-41CB-4644-AEE1-551456EADE12}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{B6907CB6-41CB-4644-AEE1-551456EADE12}.Release|Any CPU.Build.0 = Release|Any CPU
+		{B6907CB6-41CB-4644-AEE1-551456EADE12}.Debug|Any CPU.Build.0 = Debug|Any CPU
-	EndGlobalSection
+		{B6907CB6-41CB-4644-AEE1-551456EADE12}.Release|Any CPU.ActiveCfg = Release|Any CPU
-EndGlobal
+		{B6907CB6-41CB-4644-AEE1-551456EADE12}.Release|Any CPU.Build.0 = Release|Any CPU
+		{058C3864-CF33-459D-B1A7-F7E1C6AED452}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{058C3864-CF33-459D-B1A7-F7E1C6AED452}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{058C3864-CF33-459D-B1A7-F7E1C6AED452}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{058C3864-CF33-459D-B1A7-F7E1C6AED452}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+EndGlobal
--- a/docs/examples/csharp/cloud-example/inout/Program.cs
+++ b/docs/examples/csharp/cloud-example/inout/Program.cs
+using System;
+using TDengineDriver;
+using TDengineWS.Impl;
+using System.Collections.Generic;
+namespace Cloud.Examples
+{
+    public class InOutExample
+    {
+        static void Main(string[] args)
+        {
+            string dsn = Environment.GetEnvironmentVariable("TDENGINE_CLOUD_DSN");
+            IntPtr conn = LibTaosWS.WSConnectWithDSN(dsn);
+            if (conn != IntPtr.Zero)
+            {
+                try
+                {
+                    // ANCHOR: insert
+                    string createTable = "CREATE STABLE if not exists test.meters (ts TIMESTAMP, current FLOAT, voltage INT, phase FLOAT) TAGS (location BINARY(64), groupId INT)";
+                    string insertData = "INSERT INTO test.d1001 USING test.meters TAGS('California.SanFrancisco', 1) VALUES ('2018-10-03 14:38:05.000', 10.30000, 219, 0.31000)" +
+                                        "test.d1002 USING test.meters TAGS('California.SanFrancisco', 2) VALUES ('2018-10-03 14:38:16.650', 10.30000, 218, 0.25000)" +
+                                        "test.d1003 USING test.meters TAGS('California.LosAngeles', 3) VALUES ('2018-10-03 14:38:05.500', 11.80000, 221, 0.28000)" +
+                                        "test.d1004 USING test.meters TAGS('California.LosAngeles', 4) VALUES ('2018-10-03 14:38:05.000', 10.80000, 223, 0.29000) ";
+                    // create database under database named 'test'
+                    IntPtr res = LibTaosWS.WSQuery(conn, createTable);
+                    ValidUpdateExecution(res);
+                    // Free the query result every time when used up it.
+                    LibTaosWS.WSFreeResult(res);
+                    // insert data into the table created in previous step.
+                    res = LibTaosWS.WSQuery(conn, insertData);
+                    ValidUpdateExecution(res);
+                    // Free the query result every time when used up it.
+                    LibTaosWS.WSFreeResult(res);
+                    void ValidUpdateExecution(IntPtr res)
+                    {
+                        int code = LibTaosWS.WSErrorNo(res);
+                        if (code != 0)
+                        {
+                            throw new Exception($"execute SQL failed: reason: {LibTaosWS.WSErrorStr(res)}, code:{code}");
+                        }
+                    }
+                    // ANCHOR_END: insert
+                    // ANCHOR: query
+                    string selectTable = "select * from test.meters";
+                    res = LibTaosWS.WSQueryTimeout(conn, selectTable, 5000);
+                    ValidQueryExecution(res);
+                    // get meta info of the retrieved data as List
+                    List<TDengineMeta> metas = LibTaosWS.WSGetFields(res);
+                    Console.WriteLine(metas.Count);
+                    // get data of the retrieved data as List.
+                    List<object> dataSet = LibTaosWS.WSGetData(res);
+                    Console.WriteLine(dataSet.Count);
+                    // Free the query result every time when used up it.
+                    LibTaosWS.WSFreeResult(res);
+                    void ValidQueryExecution(IntPtr res)
+                    {
+                        int code = LibTaosWS.WSErrorNo(res);
+                        if (code != 0)
+                        {
+                            throw new Exception($"execute SQL failed: reason: {LibTaosWS.WSErrorStr(res)}, code:{code}");
+                        }
+                    }
+                    // ANCHOR_END: query
+                }
+                finally
+                {
+                    // close connect
+                    LibTaosWS.WSClose(conn);
+                }
+            }
+            else
+            {
+                throw new Exception($"get connection failed,reason:{LibTaosWS.WSErrorStr(conn)},code:{LibTaosWS.WSErrorNo(conn)}");
+            }
+        }
+    }
+}
\ No newline at end of file
--- a/docs/examples/csharp/cloud-example/inout/inout.csproj
+++ b/docs/examples/csharp/cloud-example/inout/inout.csproj
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net5.0</TargetFramework>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+  <ItemGroup>
+    <PackageReference Include="TDengine.Connector" Version="3.0.1" />
+  </ItemGroup>
+</Project>
--- a/docs/examples/node/insert.js
+++ b/docs/examples/node/insert.js
-const { options, connect } = require("td2.0-rest-connector");
+const { options, connect } = require("@tdengine/rest");
 function checkError(result) {
  if (result.getErrCode() !== undefined) {
@@ -19,7 +19,7 @@ async function test() {
    checkError(result);
    result = await cursor.query("CREATE STABLE power.meters (ts TIMESTAMP, current FLOAT, voltage INT, phase FLOAT) TAGS (location BINARY(64), groupId INT)");
    checkError(result);
-    result = await cursor.query("INSERT INTO power.d1001 USING power.meters TAGS(California.SanFrancisco, 2) VALUES ('2018-10-03 14:38:05.000', 10.30000, 219, 0.31000) ('2018-10-03 14:38:15.000', 12.60000, 218, 0.33000) ('2018-10-03 14:38:16.800', 12.30000, 221, 0.31000) power.d1002 USING power.meters TAGS(California.SanFrancisco, 3) VALUES ('2018-10-03 14:38:16.650', 10.30000, 218, 0.25000)");
+    result = await cursor.query("INSERT INTO power.d1001 USING power.meters TAGS('California.SanFrancisco', 2) VALUES ('2018-10-03 14:38:05.000', 10.30000, 219, 0.31000) ('2018-10-03 14:38:15.000', 12.60000, 218, 0.33000) ('2018-10-03 14:38:16.800', 12.30000, 221, 0.31000) power.d1002 USING power.meters TAGS('California.SanFrancisco', 3) VALUES ('2018-10-03 14:38:16.650', 10.30000, 218, 0.25000)");
    checkError(result);
    console.log("AffectedRows:", result.getAffectRows())
  } catch (err) {

--- a/docs/examples/node/package.json
+++ b/docs/examples/node/package.json
@@ -5,6 +5,6 @@
  "license": "MIT",
  "dependencies": {
    "@tdengine/client": "^3.0.1",
-    "@tdengine/rest": "^3.0.0"
+    "@tdengine/rest": "^3.0.1"
  }
 }
--- a/docs/examples/node/query.js
+++ b/docs/examples/node/query.js
-const { options, connect } = require("td2.0-rest-connector");
+const { options, connect } = require("@tdengine/rest");
 function checkError(result) {
  if (result.getErrCode() !== undefined) {

--- a/docs/examples/node/reference_example.js
+++ b/docs/examples/node/reference_example.js
-const { options, connect } = require("td2.0-rest-connector");
+const { options, connect } = require("@tdengine/rest");
 options.url = process.env.TDENGINE_CLOUD_URL;
 options.query = { token: process.env.TDENGINE_CLOUD_TOKEN };