Skip to content
Merged
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 @@ -179,8 +179,16 @@ Set the following parameters in `./conf/iotdb-system.properties`. Refer to `./co
1. Start the first ConfigNode (`iotdb-1`) as the seed node

```Bash
# Unix/OS X
cd sbin
./start-confignode.sh -d # The "-d" flag starts the process in the background.

# Windows
# Before version V2.0.4.x
.\start-confignode.bat

# V2.0.4.x and later versions
.\windows\start-confignode.bat
```

2. Start the remaining ConfigNodes (`iotdb-2` and `iotdb-3`) in sequence.
Expand All @@ -192,8 +200,16 @@ If the startup fails, refer to the [Common Issues](#5-common-issues) section bel
On each server, navigate to the `sbin` directory and start the DataNode:

```Bash
# Unix/OS X
cd sbin
./start-datanode.sh -d # The "-d" flag starts the process in the background.

# Windows
# Before version V2.0.4.x
.\start-datanode.bat

# V2.0.4.x and later versions
.\windows\start-datanode.bat
```

### 3.6 Start CLI
Expand All @@ -205,7 +221,11 @@ On each server, navigate to the `sbin` directory and start the DataNode:
./start-cli.sh -sql_dialect table

# For Windows
./start-cli.bat -sql_dialect table
# Before version V2.0.4.x
.\start-cli.bat -sql_dialect table

# V2.0.4.x and later versions
.\windows\start-cli-table.bat
```

### 3.7 One-click Cluster Start and Stop
Expand Down Expand Up @@ -522,4 +542,4 @@ For more details on cluster maintenance, please refer to: [Cluster Maintenance](
| -E | Specifies the file for JVM error logs. | No |
| -D | Defines system properties in the format `key=value`. | No |
| -X | Passes `-XX` options directly to the JVM. | No |
| -h | Displays the help instructions. | No |
| -h | Displays the help instructions. | No |
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,16 @@ Set the following parameters in `./conf/iotdb-system.properties`. Refer to `./co
1. Start the first ConfigNode (`iotdb-1`) as the seed node

```Bash
# Unix/OS X
cd sbin
./start-confignode.sh -d # The "-d" flag starts the process in the background.

# Windows
# Before version V2.0.4.x
.\start-confignode.bat

# V2.0.4.x and later versions
.\windows\start-confignode.bat
```

2. Start the remaining ConfigNodes (`iotdb-2` and `iotdb-3`) in sequence.
Expand All @@ -192,8 +200,16 @@ If the startup fails, refer to the [Common Issues](#5-common-issues) section bel
On each server, navigate to the `sbin` directory and start the DataNode:

```Bash
# Unix/OS X
cd sbin
./start-datanode.sh -d # The "-d" flag starts the process in the background.

# Windows
# Before version V2.0.4.x
.\start-datanode.bat

# V2.0.4.x and later versions
.\windows\start-datanode.bat
```

### 3.6 Activate the Database
Expand Down Expand Up @@ -605,4 +621,4 @@ For more details on cluster maintenance, please refer to: [Cluster Maintenance](
| -E | Specifies the file for JVM error logs. | No |
| -D | Defines system properties in the format `key=value`. | No |
| -X | Passes `-XX` options directly to the JVM. | No |
| -h | Displays the help instructions. | No |
| -h | Displays the help instructions. | No |
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,15 @@ Ensure that configurations for A and B are consistent for optimal dual-active pe
- Connect to the database on Machine A using the CLI tool from the `sbin` directory:

```Bash
# Unix/OS X
./sbin/start-cli.sh -h iotdb-1

# Windows
# Before version V2.0.4.x
.\sbin\start-cli.bat -h iotdb-1

# V2.0.4.x and later versions
.\sbin\windows\start-cli.bat -h iotdb-1
```

- Then create and start a data synchronization process. Use the following SQL command:
Expand All @@ -90,7 +98,15 @@ with sink (
- Connect to the database on Machine B:

```Bash
# Unix/OS X
./sbin/start-cli.sh -h iotdb-2

# Windows
# Before version V2.0.4.x
.\sbin\start-cli.bat -h iotdb-2

# V2.0.4.x and later versions
.\sbin\windows\start-cli.bat -h iotdb-2
```

- Then create and start the synchronization process with the following SQL command:
Expand Down Expand Up @@ -154,15 +170,39 @@ To stop the dual-active instances:
On machine A:

```SQL
# Unix/OS X
./sbin/start-cli.sh -h iotdb-1 # Log in to CLI
IoTDB> stop pipe AB # Stop data synchronization
./sbin/stop-standalone.sh # Stop database service

# Windows
# Before version V2.0.4.x
.\sbin\start-cli.bat -h iotdb-1
IoTDB> stop pipe AB
.\sbin\stop-standalone.bat

# V2.0.4.x and later versions
.\sbin\windows\start-cli.bat -h iotdb-1
IoTDB> stop pipe AB
.\sbin\windows\stop-standalone.bat
```

On machine B:

```SQL
# Unix/OS X
./sbin/start-cli.sh -h iotdb-2 # Log in to CLI
IoTDB> stop pipe BA # Stop data synchronization
./sbin/stop-standalone.sh # Stop database service
```

# Windows
# Before version V2.0.4.x
.\sbin\start-cli.bat -h iotdb-2
IoTDB> stop pipe BA
.\sbin\stop-standalone.bat

# V2.0.4.x and later versions
.\sbin\windows\start-cli.bat -h iotdb-2
IoTDB> stop pipe BA
.\sbin\windows\stop-standalone.bat
```
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,21 @@ Taking the 3C3D cluster as an example, the monitoring configuration that needs t
2. Restart all nodes. After modifying the monitoring configurations on all 3 nodes, restart the ConfigNode and DataNode services:

```Bash
# Unix/OS X
./sbin/stop-standalone.sh #Stop confignode and datanode first
./sbin/start-confignode.sh -d #Start confignode
./sbin/start-datanode.sh -d #Start datanode

# Windows
# Before version V2.0.4.x
.\sbin\stop-standalone.bat
.\sbin\start-confignode.bat
.\sbin\start-datanode.bat

# V2.0.4.x and later versions
.\sbin\windows\stop-standalone.bat
.\sbin\windows\start-confignode.bat
.\sbin\windows\start-datanode.bat
```

3. After restarting, confirm the running status of each node through the client. If all nodes are running, the configuration is successful.
Expand Down Expand Up @@ -679,4 +691,4 @@ The data exchange for the query is time-consuming.
- Ratis Log Write Latency: The time consumption for writing logs at each stage of node Ratis
- Remote / Local Write Latency: The time it takes for node Ratis to write locally or remotelyThe time it takes for node Ratis to write locally or remotely
- Remote / Local Write Throughput(QPS): QPS written by node Ratis locally or remotely
- RatisConsensus Memory Usage: Node Ratis Memory Usage
- RatisConsensus Memory Usage: Node Ratis Memory Usage
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,15 @@ Set the following parameters in `conf/iotdb-system.properties`. Refer to `conf/i
Navigate to the `sbin` directory and start ConfigNode:

```Bash
# Unix/OS X
./sbin/start-confignode.sh -d # The "-d" flag starts the process in the background.

# Windows
# Before version V2.0.4.x
.\sbin\start-confignode.bat

# V2.0.4.x and later versions
.\sbin\windows\start-confignode.bat
```

If the startup fails, refer to the [Common Issues](#3-common-issues)。 section below for troubleshooting.
Expand All @@ -163,7 +171,15 @@ If the startup fails, refer to the [Common Issues](#3-common-issues)。 section
Navigate to the `sbin` directory of IoTDB and start the DataNode:

```Bash
# Unix/OS X
./sbin/start-datanode.sh -d # The "-d" flag starts the process in the background.

# Windows
# Before version V2.0.4.x
.\sbin\start-datanode.bat

# V2.0.4.x and later versions
.\sbin\windows\start-datanode.bat
```

### 2.6 Start CLI
Expand All @@ -175,7 +191,11 @@ Navigate to the `sbin` directory of IoTDB and start the DataNode:
./start-cli.sh -sql_dialect table

# For Windows
./start-cli.bat -sql_dialect table
# Before version V2.0.4.x
.\start-cli.bat -sql_dialect table

# V2.0.4.x and later versions
.\windows\start-cli-table.bat
```

## 3. Common Issues
Expand Down Expand Up @@ -236,4 +256,4 @@ Navigate to the `sbin` directory of IoTDB and start the DataNode:
| -E | Specifies the file for JVM error logs. | No |
| -D | Defines system properties in the format `key=value`. | No |
| -X | Passes `-XX` options directly to the JVM. | No |
| -h | Displays the help instructions. | No |
| -h | Displays the help instructions. | No |
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,15 @@ Set the following parameters in `conf/iotdb-system.properties`. Refer to `conf/i
Navigate to the `sbin` directory and start ConfigNode:

```Bash
# Unix/OS X
./sbin/start-confignode.sh -d # The "-d" flag starts the process in the background.

# Windows
# Before version V2.0.4.x
.\sbin\start-confignode.bat

# V2.0.4.x and later versions
.\sbin\windows\start-confignode.bat
```

If the startup fails, refer to the [Common Issues](#3-common-issues)。 section below for troubleshooting.
Expand All @@ -160,7 +168,15 @@ If the startup fails, refer to the [Common Issues](#3-common-issues)。 section
Navigate to the `sbin` directory of IoTDB and start the DataNode:

```Bash
# Unix/OS X
./sbin/start-datanode.sh -d # The "-d" flag starts the process in the background.

# Windows
# Before version V2.0.4.x
.\sbin\start-datanode.bat

# V2.0.4.x and later versions
.\sbin\windows\start-datanode.bat
```

### 2.6 Activate the Database
Expand Down Expand Up @@ -300,4 +316,4 @@ In the CLI, you can check the activation status by running the `show activation`
| -E | Specifies the file for JVM error logs. | No |
| -D | Defines system properties in the format `key=value`. | No |
| -X | Passes `-XX` options directly to the JVM. | No |
| -h | Displays the help instructions. | No |
| -h | Displays the help instructions. | No |
22 changes: 22 additions & 0 deletions src/UserGuide/Master/Table/FAQ/Frequently-asked-questions.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ There are several ways to identify the version of IoTDB that you are using:
* Launch IoTDB's Command Line Interface:

```
# Unix/OS X
> ./start-cli.sh -p 6667 -pw root -u root -h localhost
_____ _________ ______ ______
|_ _| | _ _ ||_ _ `.|_ _ \
Expand All @@ -39,6 +40,16 @@ There are several ways to identify the version of IoTDB that you are using:
|_____|'.__.' |_____| |______.'|_______/ version x.x.x
```

Windows startup command examples:

```
# Before version V2.0.4.x
> .\sbin\start-cli.bat -p 6667 -pw root -u root -h localhost

# V2.0.4.x and later versions
> .\sbin\windows\start-cli.bat -p 6667 -pw root -u root -h localhost
```

* Check pom.xml file:

```
Expand Down Expand Up @@ -100,9 +111,20 @@ Yes. IoTDB has intense integration with Open Source Ecosystem. IoTDB supports [S
The default IoTDB's Cli time display format is readable (e.g. ```1970-01-01T08:00:00.001```), if you want to display time in timestamp type or other readable format, add parameter ```-disableISO8601``` in start command:

```
# Unix/OS X
> $IOTDB_CLI_HOME/sbin/start-cli.sh -h 127.0.0.1 -p 6667 -u root -pw root -disableISO8601
```

Windows startup command examples:

```
# Before version V2.0.4.x
> %IOTDB_CLI_HOME%\sbin\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root -disableISO8601

# V2.0.4.x and later versions
> %IOTDB_CLI_HOME%\sbin\windows\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root -disableISO8601
```

### 1.6 How to handle error `IndexOutOfBoundsException` from `org.apache.ratis.grpc.server.GrpcLogAppender`?

This is an internal error log from Ratis 2.4.1, our dependency, and no impact on data writes or reads is expected.
Expand Down
16 changes: 14 additions & 2 deletions src/UserGuide/Master/Table/User-Manual/Load-Balance.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,15 @@ vim iotdb-system.properties
Navigate to the `sbin`directory under IoTDB and start the datanode:

```
# Unix/OS X
./sbin/start-datanode.sh -d # The "-d" parameter starts the process in the background.

# Windows
# Before version V2.0.4.x
.\sbin\start-datanode.bat

# V2.0.4.x and later versions
.\sbin\windows\start-datanode.bat
```

5. Connect to the original cluster via CLI command for post-scaling verification.
Expand All @@ -178,7 +186,11 @@ Navigate to the `sbin`directory under IoTDB and start the datanode:
./apache-iotdb-{version}-bin/sbin/start-cli.sh

# Windows
# Before version V2.0.4.x
.\apache-iotdb-{version}-bin\sbin\start-cli.bat

# V2.0.4.x and later versions
.\apache-iotdb-{version}-bin\sbin\windows\start-cli.bat
```

6. Execute commands for verification.
Expand Down Expand Up @@ -316,7 +328,7 @@ sbin/start-datanode.sh
sbin\start-datanode.bat

# V2.0.4.x and later
tools\windows\start-datanode.bat
sbin\windows\start-datanode.bat
```

**Parameter description:**
Expand Down Expand Up @@ -442,4 +454,4 @@ Here is a schematic diagram of the region migration process :
```plain
IoTDB> set configuration "wal_throttle_threshold_in_byte"="536870912000"
Msg: The statement is executed successfully.
```
```
Loading
Loading