Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ the default number of replicas is one.
./cluster0/sbin/start-cli.sh
```

+ Execute the [show cluster details](https://iotdb.apache.org/UserGuide/Master/Maintenance-Tools/Maintenance-Command.html#show-all-node-information)
+ Execute the `show cluster details`
command on the Cli. The result is shown below:

```
Expand Down Expand Up @@ -338,7 +338,7 @@ and DataNode configuration (see Chap 5.2.3).

Open the common configuration file ./conf/iotdb-common.properties,
and set the following parameters base on the
[Deployment Recommendation](https://iotdb.apache.org/UserGuide/Master/Cluster/Deployment-Recommendation.html):
[Deployment Recommendation](./Deployment-Recommendation.md):

| **Configuration** | **Description** | **Default** |
| ------------------------------------------ | ------------------------------------------------------------ | ----------------------------------------------- |
Expand Down Expand Up @@ -413,7 +413,7 @@ Before start the Seed-ConfigNode, please open the common configuration file ./co
| data\_replication\_factor | Is set to the expected data replication count |
| data\_region\_consensus\_protocol\_class | Is set to the expected consensus protocol |

**Notice:** Please set these parameters carefully based on the [Deployment Recommendation](https://iotdb.apache.org/UserGuide/Master/Cluster/Deployment-Recommendation.html).
**Notice:** Please set these parameters carefully based on the [Deployment Recommendation](./Deployment-Recommendation.md).
These parameters are not modifiable after the Node first startup.

Then open its configuration file ./conf/iotdb-confignode.properties and check the following parameters:
Expand Down Expand Up @@ -543,7 +543,7 @@ If the cluster is in local environment, you can directly run the Cli startup scr
```

If you want to use the Cli to connect to a cluster in the production environment,
Please read the [Cli manual](https://iotdb.apache.org/UserGuide/Master/QuickStart/Command-Line-Interface.html).
Please read the [Cli manual](../Tools-System/CLI.md).

#### Verify Cluster

Expand Down
2 changes: 1 addition & 1 deletion src/UserGuide/Master/User-Manual/Query-Data.md
Original file line number Diff line number Diff line change
Expand Up @@ -2880,7 +2880,7 @@ The user must have the following permissions to execute a query write-back state
* All `READ_TIMESERIES` permissions for the source series in the `select` clause.
* All `INSERT_TIMESERIES` permissions for the target series in the `into` clause.

For more user permissions related content, please refer to [Account Management Statements](../Administration-Management/Administration.md).
For more user permissions related content, please refer to [Account Management Statements](./Authority-Management.md).

### Configurable Properties

Expand Down
31 changes: 24 additions & 7 deletions src/UserGuide/Master/User-Manual/Streaming_timecho.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
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
Expand Down Expand Up @@ -455,15 +455,32 @@ AS <full class name>
USING <URI of JAR package>
```

For example, the user has implemented a data processing plugin with the full class name edu.tsinghua.iotdb.pipe.ExampleProcessor.
The packaged jar resource package is stored at https://example.com:8080/iotdb/pipe-plugin.jar. The user wants to use this plugin in the stream processing engine.
Mark the plugin as example. Then, the creation statement of this data processing plugin is as shown in the figure.
Example: If you implement a data processing plugin named edu.tsinghua.iotdb.pipe.ExampleProcessor, and the packaged jar package is pipe-plugin.jar, you want to use this plugin in the stream processing engine, and mark the plugin as example. There are two ways to use the plug-in package, one is to upload to the URI server, and the other is to upload to the local directory of the cluster.

Method 1: Upload to the URI server

Preparation: To register in this way, you need to upload the JAR package to the URI server in advance and ensure that the IoTDB instance that executes the registration statement can access the URI server. For example https://example.com:8080/iotdb/pipe-plugin.jar .

SQL:

```sql
CREATE PIPEPLUGIN example
AS 'edu.tsinghua.iotdb.pipe.ExampleProcessor'
SQL CREATE PIPEPLUGIN example
AS 'edu.tsinghua.iotdb.pipe.ExampleProcessor'
USING URI '<https://example.com:8080/iotdb/pipe-plugin.jar>'
```

Method 2: Upload the data to the local directory of the cluster

Preparation: To register in this way, you need to place the JAR package in any path on the machine where the DataNode node is located, and we recommend that you place the JAR package in the /ext/pipe directory of the IoTDB installation path (the installation package is already in the installation package, so you do not need to create a new one). For example: iotdb-1.x.x-bin/ext/pipe/pipe-plugin.jar. **(Note: If you are using a cluster, you will need to place the JAR package under the same path as the machine where each DataNode node is located)**

SQL:

```sql
SQL CREATE PIPEPLUGIN example
AS 'edu.tsinghua.iotdb.pipe.ExampleProcessor'
USING URI '<file:/IoTDB installation path/iotdb-1.x.x-bin/ext/pipe/pipe-plugin.jar>'
```

### Delete plugin statement

When the user no longer wants to use a plugin and needs to uninstall the plugin from the system, he can use the delete plugin statement as shown in the figure.
Expand Down
Loading