未验证 提交 4e9b0278 编写于 作者: sangshuduo's avatar sangshuduo 提交者: GitHub

docs: fix format of connector en (#12514)

* docs: connector in English

[TD-15544]

* docs: connector doc in English

[TD-15544]

* fix format issues
上级 1f313ba6
......@@ -18,7 +18,9 @@ import PkgList from "/components/PkgList";
- _ taos.tar.gz_: application driver package
- _ driver_: TDengine application driver
- _examples_: some example programs of different programming languages (C/C#/go/JDBC/MATLAB/python/R)
You can run `install_client.sh` to install it.
4. Edit taos.cfg
Edit `taos.cfg` file (full path is `/etc/taos/taos.cfg` by default), modify `firstEP` with actual TDengine server's End Point, for example `h1.tdengine.com:6030`
......
Execute `taos` directly under the Linux shell to connect to the TDengine service and enter the TDengine CLI interface, as shown in the following example.
Execute `taos` directly from the Linux shell to connect to the TDengine service and enter the TDengine CLI interface, as shown in the following example.
```text
$ taos
......
Go to the C:\TDengine directory under cmd and execute `taos.exe` directly to connect to the TDengine service and enter the TDengine CLI interface, for example, as follows:
Go to the C:\TDengine directory from `cmd` and execute `taos.exe` directly to connect to the TDengine service and enter the TDengine CLI interface, for example, as follows:
```text
C:\TDengine>taos
......
......@@ -4,7 +4,11 @@ import PkgList from "/components/PkgList";
<PkgList type={1} sys="Windows" />
<<<<<<< HEAD
[All downloads](https://www.taosdata.com/cn/all-downloads/)
=======
[all downloads](https://www.taosdata.com/cn/all-downloads/)
>>>>>>> develop
2. Execute the installer, select the default value as prompted, and complete the installation
3. Installation path
......@@ -25,7 +29,11 @@ import PkgList from "/components/PkgList";
:::tip
<<<<<<< HEAD
1. If you use FQDN to connect to the server, you must ensure the local network environment DNS is configured, or add FQDN addressing records in the `hosts` file, e.g., edit C:\Windows\system32\drivers\etc\hosts and add a record like the following: `192.168.1.99 h1.tados.com`..
=======
1. If you use FQDN to connect to the server, you must ensure the local network environment DNS is configured, or add FQDN addressing records in the `hosts` file, e.g., edit C:\Windows\system32\drivers\etc\hosts and add a record like the following: `192.168.1.99 h1.tados.com`. 2.
>>>>>>> develop
2. Uninstall: Run unins000.exe to uninstall the TDengine application driver.
:::
......@@ -66,7 +66,7 @@ This section shows sample code for standard access methods to TDengine clusters
### Synchronous query example
<details
<details>
<summary>Synchronous query</summary>
```c
......
......@@ -61,7 +61,7 @@ You can reference the `TDengine.Connector` published in Nuget to the current pro
dotnet add package TDengine.Connector
```
</TabItem
</TabItem>
<TabItem value="source" label="Use source code to get C# driver">
You can download TDengine's source code and directly reference the latest version of the TDengine.Connector library
......
......@@ -145,7 +145,7 @@ func main() {
}
```
</TabItem
</TabItem>
<TabItem value="rest" label="REST connection">
_taosRestful_ implements Go's `database/sql/driver` interface via `http client`. You can use the [`database/sql`](https://golang.org/pkg/database/sql/) interface by simply introducing the driver.
......@@ -408,4 +408,4 @@ The `af` package encapsulates TDengine advanced functions such as connection man
## API Reference
Full API see [driver-go documentation](https://pkg.go.dev/github.com/taosdata/driver-go/v2)
\ No newline at end of file
Full API see [driver-go documentation](https://pkg.go.dev/github.com/taosdata/driver-go/v2)
......@@ -55,11 +55,21 @@ TDengine currently supports timestamp, number, character, Boolean type, and the
| NCHAR | java.lang.String | java.lang.String |
| JSON | - | java.lang.String |
In the above example, JDBC uses the client's configuration file to establish a connection to a hostname of cluster_node1, port 6030, and a database named test. When the firstEp node fails, JDBC attempts to connect to the cluster using secondEp.
**Note**: Only TAG supports JSON types
In TDengine, as long as one node in firstEp and secondEp is valid, the connection to the cluster can be established and worked.
## Installation steps
> **Note**: The configuration file here refers to the configuration file on the machine where the application that calls the JDBC Connector is located, the default value of /etc/taos/taos .cfg on Linux OS, and the default value of C://TDengine/cfg/taos.cfg on Windows OS.
### Pre-installation preparation
Before using Java Connector to connect to the database, the following conditions are required.
- Java 1.8 or above runtime environment and Maven 3.6 or above installed
- TDengine client driver installed (required for native connections, not required for REST connections), please refer to [Installing Client Driver](/reference/connector#Install Client Driver)
### Install the connectors
<Tabs defaultValue="maven">
<TabItem value="maven" label="install via Maven">
- [sonatype](https://search.maven.org/artifact/com.taosdata.jdbc/taos-jdbcdriver)
- [mvnrepository](https://mvnrepository.com/artifact/com.taosdata.jdbc/taos-jdbcdriver)
......
......@@ -69,7 +69,7 @@ You can also specify a specific version to install.
pip3 install taospy==2.3.0
```
</TabItem
</TabItem>
<TabItem label="Install from GitHub" value="github">
```
......@@ -119,7 +119,7 @@ Requirement already satisfied: taospy in c:\users\username\appdata\local\program
Before establishing a connection with the connector, we recommend testing the connectivity of the local TDengine CLI to the TDengine cluster.
<Tabs
<Tabs>
<TabItem value="native" label="native connection">
Ensure that the TDengine cluster is up and that the FQDN of the machines in the cluster (the FQDN defaults to hostname if you are starting a standalone version) can be resolved locally, by testing with the ping command.
......@@ -136,7 +136,7 @@ taos -h <FQDN> -p <PORT>
The FQDN above can be the FQDN of any dnode in the cluster, and the PORT is the serverPort corresponding to this dnode.
</TabItem
</TabItem>
<TabItem value="rest" label="REST connection" groupId="connect">
For REST connections and making sure the cluster is up, make sure the taosAdapter component is up. This can be tested using the following `curl ` command.
......@@ -165,7 +165,7 @@ If the test is successful, it will output the server version information, e.g.
The following example code assumes that TDengine is installed locally and that the default configuration is used for both FQDN and serverPort.
<Tabs
<Tabs>
<TabItem value="native" label="native connection" groupId="connect">
```python
......@@ -255,7 +255,7 @@ The TaosCursor class uses native connections for write and query operations. In
:::
</TabItem
</TabItem>
<TabItem value="rest" label="REST connection">
##### Use of TaosRestCursor class
......@@ -279,8 +279,6 @@ The `RestClient` class is a direct wrapper for the [REST API](/reference/rest-ap
For a more detailed description of the `sql()` method, please refer to [RestClient](https://docs.taosdata.com/api/taospy/taosrest/restclient.html).
</TabItem>
</Tabs>
......@@ -293,7 +291,7 @@ For a more detailed description of the `sql()` method, please refer to [RestClie
{{#include docs-examples/python/conn_native_pandas.py}}
```
</TabItem
</TabItem>
<TabItem value="rest" label="REST connection">
```python
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册