未验证 提交 895c9369 编写于 作者: X xiaolei li 提交者: GitHub

docs(driver):update C# example and content about WebSocket to include… (#17513)

* docs(driver):update C# example and content about WebSocket to include dll from nupkg

* fix: typos
Co-authored-by: sangshuduo's avatarShuduo Sang <sangshuduo@gmail.com>
上级 eeb40656
...@@ -89,7 +89,11 @@ In this example, we use `exec` method to execute SQL. `exec` is designed for som ...@@ -89,7 +89,11 @@ In this example, we use `exec` method to execute SQL. `exec` is designed for som
<TabItem value="C#" label="C#"> <TabItem value="C#" label="C#">
```C# ``` XML
{{#include docs/examples/csharp/cloud-example/inout/inout.csproj}}
```
```csharp
{{#include docs/examples/csharp/cloud-example/inout/Program.cs:insert}} {{#include docs/examples/csharp/cloud-example/inout/Program.cs:insert}}
``` ```
......
...@@ -231,6 +231,10 @@ Get all rows and print each row: ...@@ -231,6 +231,10 @@ Get all rows and print each row:
In this example, we use query method to execute SQL and get a result object. In this example, we use query method to execute SQL and get a result object.
``` XML
{{#include docs/examples/csharp/cloud-example/inout/inout.csproj}}
```
```C# ```C#
{{#include docs/examples/csharp/cloud-example/inout/Program.cs:query}} {{#include docs/examples/csharp/cloud-example/inout/Program.cs:query}}
``` ```
......
...@@ -18,7 +18,21 @@ dotnet new console -o example ...@@ -18,7 +18,21 @@ dotnet new console -o example
```bash ```bash
cd example cd example
dotnet add package TDengine.Connector vim example.csproj
```
Add following ItemGroup and Task to your project file.
```XML
<ItemGroup>
<PackageReference Include="TDengine.Connector" Version="3.0.*" GeneratePathProperty="true" />
</ItemGroup>
<Target Name="copyDLLDepency" BeforeTargets="BeforeBuild">
<ItemGroup>
<DepDLLFiles Include="$(PkgTDengine_Connector_test)\runtimes\**\*.*" />
</ItemGroup>
<Copy SourceFiles="@(DepDLLFiles)" DestinationFolder="$(OutDir)\dep_lib" />
</Target>
``` ```
## Config ## Config
...@@ -59,6 +73,9 @@ Replace <DSN\> with real TDengine cloud DSN. To obtain the real value, please l ...@@ -59,6 +73,9 @@ Replace <DSN\> with real TDengine cloud DSN. To obtain the real value, please l
## Connect ## Connect
``` XML
{{#include docs/examples/csharp/cloud-example/connect/connect.csproj}}
```
```C# ```C#
{{#include docs/examples/csharp/cloud-example/connect/Program.cs}} {{#include docs/examples/csharp/cloud-example/connect/Program.cs}}
......
...@@ -23,19 +23,7 @@ dotnet add package TDengine.Connector ...@@ -23,19 +23,7 @@ dotnet add package TDengine.Connector
## Establishing a connection ## Establishing a connection
``` XML ``` XML
<Project Sdk="Microsoft.NET.Sdk"> {{#include docs/examples/csharp/cloud-example/connect/connect.csproj}}
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net5.0</TargetFramework>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="TDengine.Connector" Version="3.0.1" />
</ItemGroup>
</Project>
``` ```
``` C# ``` C#
...@@ -47,20 +35,7 @@ dotnet add package TDengine.Connector ...@@ -47,20 +35,7 @@ dotnet add package TDengine.Connector
### Basic Insert and Query ### Basic Insert and Query
``` XML ``` XML
<Project Sdk="Microsoft.NET.Sdk"> {{#include docs/examples/csharp/cloud-example/usage/usage.csproj}}
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net5.0</TargetFramework>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="TDengine.Connector" Version="3.0.1" />
</ItemGroup>
</Project>
``` ```
```C# ```C#
...@@ -70,20 +45,7 @@ dotnet add package TDengine.Connector ...@@ -70,20 +45,7 @@ dotnet add package TDengine.Connector
### STMT Insert ### STMT Insert
``` XML ``` XML
<Project Sdk="Microsoft.NET.Sdk"> {{#include docs/examples/csharp/cloud-example/stmt/stmt.csproj}}
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net5</TargetFramework>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="TDengine.Connector" Version="3.0.1" />
</ItemGroup>
</Project>
``` ```
```C# ```C#
...@@ -94,7 +56,8 @@ dotnet add package TDengine.Connector ...@@ -94,7 +56,8 @@ dotnet add package TDengine.Connector
| TDengine.Connector | Description | | TDengine.Connector | Description |
| ------------------------- | ---------------------------------------------------------------- | | ------------------------- | ---------------------------------------------------------------- |
| 3.0.1 | Support connect to TDengine cloud service | 3.0.2 | Support .NET Framework 4.5 and above. Support .Net standard 2.0. Nuget package includes dynamic library for WebSocket.|
| 3.0.1 | Support connect to TDengine cloud service|
## API Reference ## API Reference
......
...@@ -7,7 +7,13 @@ ...@@ -7,7 +7,13 @@
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="TDengine.Connector" Version="3.0.1" /> <PackageReference Include="TDengine.Connector" Version="3.0.*" GeneratePathProperty="true" />
</ItemGroup> </ItemGroup>
<Target Name="copyDLLDependency" BeforeTargets="BeforeBuild">
<ItemGroup>
<DepDLLFiles Include="$(PkgTDengine_Connector_test)\runtimes\**\*.*" />
</ItemGroup>
<Copy SourceFiles="@(DepDLLFiles)" DestinationFolder="$(OutDir)\dep_lib" />
</Target>
</Project> </Project>
...@@ -7,7 +7,13 @@ ...@@ -7,7 +7,13 @@
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="TDengine.Connector" Version="3.0.1" /> <PackageReference Include="TDengine.Connector" Version="3.0.*" GeneratePathProperty="true" />
</ItemGroup> </ItemGroup>
<Target Name="copyDLLDependency" BeforeTargets="BeforeBuild">
<ItemGroup>
<DepDLLFiles Include="$(PkgTDengine_Connector_test)\runtimes\**\*.*" />
</ItemGroup>
<Copy SourceFiles="@(DepDLLFiles)" DestinationFolder="$(OutDir)\dep_lib" />
</Target>
</Project> </Project>
...@@ -6,8 +6,13 @@ ...@@ -6,8 +6,13 @@
<Nullable>enable</Nullable> <Nullable>enable</Nullable>
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="TDengine.Connector" Version="3.0.1" /> <PackageReference Include="TDengine.Connector" Version="3.0.*" GeneratePathProperty="true" />
</ItemGroup> </ItemGroup>
<Target Name="copyDLLDependency" BeforeTargets="BeforeBuild">
<ItemGroup>
<DepDLLFiles Include="$(PkgTDengine_Connector_test)\runtimes\**\*.*" />
</ItemGroup>
<Copy SourceFiles="@(DepDLLFiles)" DestinationFolder="$(OutDir)\dep_lib" />
</Target>
</Project> </Project>
...@@ -6,8 +6,14 @@ ...@@ -6,8 +6,14 @@
<Nullable>enable</Nullable> <Nullable>enable</Nullable>
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="TDengine.Connector" Version="3.0.1" /> <PackageReference Include="TDengine.Connector" Version="3.0.*" GeneratePathProperty="true" />
</ItemGroup> </ItemGroup>
<Target Name="copyDLLDependency" BeforeTargets="BeforeBuild">
<ItemGroup>
<DepDLLFiles Include="$(PkgTDengine_Connector_test)\runtimes\**\*.*" />
</ItemGroup>
<Copy SourceFiles="@(DepDLLFiles)" DestinationFolder="$(OutDir)\dep_lib" />
</Target>
</Project> </Project>
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册