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 @@ -408,37 +408,37 @@ If you have multiple servers available, you can run the `obd web` command to sta

2. Click **Try Now** to start the deployment process.

![Start](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_02_deploy_oceanbase_database/03_deploy_personal_environment/001.png)
![Start](/img/user_manual/quick_starts/en-US/chapter_02_deploy_oceanbase_database/03_deploy_personal_environment/001.png)

> **Note**
>
> To change the display language, click the **English** icon in the upper-right corner of the page and select a language as needed.

3. Select **OceanBase and supporting tools** and click **OK**.

![Select](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_02_deploy_oceanbase_database/03_deploy_personal_environment/002.png)
![Select](/img/user_manual/quick_starts/en-US/chapter_02_deploy_oceanbase_database/03_deploy_personal_environment/002.png)

4. On the **Deployment Configuration** page, modify **Cluster Name** and select the components that you want to deploy. You can also retain the default configurations. By default, all components are deployed.

![Deployment configuration](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_02_deploy_oceanbase_database/03_deploy_personal_environment/003.png)
![Deployment configuration](/img/user_manual/quick_starts/en-US/chapter_02_deploy_oceanbase_database/03_deploy_personal_environment/003.png)

Click **Next Step** to go to the **Node Configuration** page.

5. On the **Node Configuration** page, enter node IP addresses and the user password and then click **Next Step** to go to the **Cluster Configuration** page.

![Node configuration](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_02_deploy_oceanbase_database/03_deploy_personal_environment/004.png)
![Node configuration](/img/user_manual/quick_starts/en-US/chapter_02_deploy_oceanbase_database/03_deploy_personal_environment/004.png)

6. On the **Cluster Configuration** page, specify the deployment mode, password, directory, port, and other information about the cluster. You can also retain the default values.

![Cluster configuration](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_02_deploy_oceanbase_database/03_deploy_personal_environment/005.png)
![Cluster configuration](/img/user_manual/quick_starts/en-US/chapter_02_deploy_oceanbase_database/03_deploy_personal_environment/005.png)

Click **Next Step** to go to the **Pre-check** page.

7. On the **Pre-check** page, verify the configuration information and then click **Pre-check**.

![Precheck](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_02_deploy_oceanbase_database/03_deploy_personal_environment/006.png)
![Precheck](/img/user_manual/quick_starts/en-US/chapter_02_deploy_oceanbase_database/03_deploy_personal_environment/006.png)

![Precheck](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_02_deploy_oceanbase_database/03_deploy_personal_environment/007.png)
![Precheck](/img/user_manual/quick_starts/en-US/chapter_02_deploy_oceanbase_database/03_deploy_personal_environment/007.png)

If an error code is returned, you can click **Automatic Repair** to automatically repair the error, or click **Learn more** to go to the error code document and correct the error based on the reference document. After all the errors are corrected, click **Re-check** to perform a precheck again.

Expand All @@ -447,10 +447,10 @@ If you have multiple servers available, you can run the `obd web` command to sta
If the deployment is successful, the connection strings of the components are displayed. You can copy a connection string to access the corresponding component.


![Deployment](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_02_deploy_oceanbase_database/03_deploy_personal_environment/008.png)
![Deployment](/img/user_manual/quick_starts/en-US/chapter_02_deploy_oceanbase_database/03_deploy_personal_environment/008.png)

9. Click **Finish**.
![Finish](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_02_deploy_oceanbase_database/03_deploy_personal_environment/009.png)
![Finish](/img/user_manual/quick_starts/en-US/chapter_02_deploy_oceanbase_database/03_deploy_personal_environment/009.png)

10. Log on to OCP Express and create a user tenant.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ OceanBase Database is a single-process software solution. Its process is named `

As shown in the following figure, an OceanBase cluster can manage all resources allocated to the `observer` process in a centralized manner and allocate the resources to tenants. You can define the resource specifications for a tenant and adjust the resource specifications online.

![Resource allocation](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_02_deploy_oceanbase_database/05_view-resources/001.png)
![Resource allocation](/img/user_manual/quick_starts/en-US/chapter_02_deploy_oceanbase_database/05_view-resources/001.png)

The resources for an OceanBase Database tenant include CPU, memory, and IOPS. At present, OceanBase Database supports the isolation of these resources. We recommend that you set the resource parameters based on the actual situation when you create resources. For example, the value of the parameter related to the disk space should not exceed the actual available disk space. Otherwise, load balancing is affected.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,17 @@ We recommend that you create a user tenant by referring to this topic for testin

If no unit config is suitable, you can create one. After you create a unit config in OCP, it is not immediately recorded in the internal view `DBA_OB_UNIT_CONFIGS` of OceanBase Database, but rather in the `meta_database.ob_unit_spec` table of OCP. The unit config is actually created only when you create a tenant.

![Configure the tenant](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_02_deploy_oceanbase_database/06_create-tenant/001.png)
![Configure the tenant](/img/user_manual/quick_starts/en-US/chapter_02_deploy_oceanbase_database/06_create-tenant/001.png)

2. Configure the IP address allowlist and variables of the tenant.

![Configure the tenant](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_02_deploy_oceanbase_database/06_create-tenant/002.png)
![Configure the tenant](/img/user_manual/quick_starts/en-US/chapter_02_deploy_oceanbase_database/06_create-tenant/002.png)

3. View the tenant creation task.

To learn about the task execution process, you can download the logs.

![View logs](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_02_deploy_oceanbase_database/06_create-tenant/003.png)
![View logs](/img/user_manual/quick_starts/en-US/chapter_02_deploy_oceanbase_database/06_create-tenant/003.png)

You can learn from the logs that OCP will respectively name each unit and resource pool during tenant creation, which is not the case when you create a tenant in OceanBase Deployer (OBD). This practice brings the following benefits:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ The procedure for connecting to OceanBase Database by using ODC is as follows. F

1. Create a connection.

![Create a connection](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_02_deploy_oceanbase_database/07_connecting-tenants/001.png)
![Create a connection](/img/user_manual/quick_starts/en-US/chapter_02_deploy_oceanbase_database/07_connecting-tenants/001.png)

2. Save and open the connection.

![Open the connection](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_02_deploy_oceanbase_database/07_connecting-tenants/002.png)
![Open the connection](/img/user_manual/quick_starts/en-US/chapter_02_deploy_oceanbase_database/07_connecting-tenants/002.png)

## Connect to a tenant by using a MySQL client

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,17 +51,17 @@ JMeter can run in the CLI or on the GUI. This section describes how to use JMete

Run the `sh jmeter` command in the `apache-jmeter-xxx/bin/` directory to go to the GUI of JMeter. On the page shown in the following figure, create a test plan named `Oceanbase Test Plan`.

![Create a test plan](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_03_test_oceanbase_database/06_jmeter_test/001.png)
![Create a test plan](/img/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/06_jmeter_test/001.png)

In the left-side navigation pane, click **Oceanbase Test Plan** and choose **Add** > **Threads(Users)** > **Thread Group** to create a thread group. You can configure a variety of parameters when you use JMeter for testing. For more information about the parameters, see [Elements of a Test Plan](https://jmeter.apache.org/usermanual/test_plan.html) in JMeter Documentation.

![Create a thread group](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_03_test_oceanbase_database/06_jmeter_test/002.png)
![Create a thread group](/img/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/06_jmeter_test/002.png)

### Add a JDBC connection

Click **Thread Group** and choose **Add** > **Config Element** > **JDBC Connection Configuration** to create a JDBC configuration file.

![Add a JDBC connection](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_03_test_oceanbase_database/06_jmeter_test/003.png)
![Add a JDBC connection](/img/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/06_jmeter_test/003.png)

The attributes shown in the preceding figure are common parameters of a connection pool. For more information, see the experience in configuring Java connection pools shared on the Internet.

Expand All @@ -87,37 +87,37 @@ Click **Thread Group** and choose **Add** > **Logic Controller** > **Transaction

Click **Transaction Controller** and choose **Add** > **Pre Processors** > **User Parameters** to add variables as needed. This test involves three variables: `credit_id` (account A), `debit_id` (account B), and `trans_amount` (transferred amount). The account parameters and amounts are set to random numbers within the actual ranges of test data.

![Configure transaction variables](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_03_test_oceanbase_database/06_jmeter_test/004.png)
![Configure transaction variables](/img/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/06_jmeter_test/004.png)

* Start a transaction

Click **Transaction Controller** and choose **Add** > **Sampler** > **JDBC Request** to create a JDBC request. Set **Query Type** to `AutoCommit(false)` to enable explicit transactions.

![Start a transaction](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_03_test_oceanbase_database/06_jmeter_test/005.png)
![Start a transaction](/img/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/06_jmeter_test/005.png)

* Create a JDBC request to deduct the transferred amount from the balance of account A

Click **Transaction Controller** and choose **Add** > **Sampler** > **JDBC Request**, to create a JDBC request named `JDBC update credit account`. Then, add an SQL request to deduct the transferred amount from the balance of account A.

![Deduct the transferred amount from the balance of account A](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_03_test_oceanbase_database/06_jmeter_test/006.png)
![Deduct the transferred amount from the balance of account A](/img/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/06_jmeter_test/006.png)

* Add Post logic to obtain the return value of the JDBC request that deducts the transferred amount from the balance of account A

Click **JDBC update credit account** and choose **Add** > **Post Processors** > **Regular Expression Extractor** to add Post logic to obtain the return value of the JDBC request that deducts the transferred amount from the balance of account A.

![Processing logic for account A](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_03_test_oceanbase_database/06_jmeter_test/007.png)
![Processing logic for account A](/img/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/06_jmeter_test/007.png)

* Create a JDBC request to increase the balance of account B

Click **Transaction Controller** and choose **Add** > **Sampler** > **JDBC Request** to create a JDBC request named `JDBC update debit account`. Then, add an SQL request to increase the balance of account B.

![Increase the balance of account B](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_03_test_oceanbase_database/06_jmeter_test/008.png)
![Increase the balance of account B](/img/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/06_jmeter_test/008.png)

* Add Post logic to obtain the return value of the JDBC request that increases the balance of account B

Click **JDBC update debit account** and choose **Add** > **Post Processors** > **Regular Expression Extractor** to add Post logic to obtain the return result of the JDBC request that increases the balance of account B.

![Processing logic for account B](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_03_test_oceanbase_database/06_jmeter_test/009.png)
![Processing logic for account B](/img/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/06_jmeter_test/009.png)

### Judgment logic - process succeeded

Expand All @@ -127,13 +127,13 @@ If the updates for both accounts are successful, the transaction is committed.

Click **Transaction Controller** and choose **Add** > **Logic Controller** > **If Controller** to add an IF controller named `If success`. Then, add judgment conditions.

![Add an IF controller](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_03_test_oceanbase_database/06_jmeter_test/010.png)
![Add an IF controller](/img/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/06_jmeter_test/010.png)

* Add a commit action upon update success

Click **If success** and choose **Add** > **Sampler** > **JDBC Request** to create a JDBC request. Set **Query Type** to `Commit`.

![Commit a transaction](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_03_test_oceanbase_database/06_jmeter_test/011.png)
![Commit a transaction](/img/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/06_jmeter_test/011.png)

### Judgment logic - process failed

Expand All @@ -143,20 +143,20 @@ If the update for either account fails, the transaction is rolled back.

Click **Transaction Controller** and choose **Add** > **Logic Controller** > **If Controller** to create an IF controller named `If fail`. Then, add judgment conditions.

![Add an IF controller](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_03_test_oceanbase_database/06_jmeter_test/012.png)
![Add an IF controller](/img/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/06_jmeter_test/012.png)

* Add a commit action upon update failure

Click **If fail** and choose **Add** > **Sampler** > **JDBC Request** to create a JDBC request. Set **Query Type** to `Rollback`.

![Roll back a transaction](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_03_test_oceanbase_database/06_jmeter_test/013.png)
![Roll back a transaction](/img/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/06_jmeter_test/013.png)

### View the results

Click **Thread-Group** and choose **Add** > **Listener** > **View Results Tree** to create a result tree file to view the test results.

![View the results](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_03_test_oceanbase_database/06_jmeter_test/014.png)
![View the results](/img/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/06_jmeter_test/014.png)

Click **Thread Group** and choose **Add** > **Listener** > **Aggregate Report** to create an aggregated report that aggregates the results.

![View the report](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_03_test_oceanbase_database/06_jmeter_test/015.png)
![View the report](/img/user_manual/quick_starts/en-US/chapter_03_test_oceanbase_database/06_jmeter_test/015.png)
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ For more information, see the [introduction to Flink CDC](https://github.com/apa

DataX is a tool for offline synchronization between heterogeneous data sources. You can use it to stably and efficiently synchronize data between many types of heterogeneous data sources, such as relational databases (like MySQL, Oracle, and OceanBase Database), HDFS, Hive, ODPS, HBase, and FTP.

![DataX architecture](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_04_migration_and_synchronization_oceanbase/02_ecological_tools_of_migration_synchronization/001.png)
![DataX architecture](/img/user_manual/quick_starts/en-US/chapter_04_migration_and_synchronization_oceanbase/02_ecological_tools_of_migration_synchronization/001.png)

To address issues of data synchronization between heterogeneous data sources in a complex mesh topology, DataX introduces the star topology and serves as the transmission hub that connects to various data sources. This way, you can connect a new data source to DataX and start synchronizing data between the new data source and the existing data sources right away.

Expand All @@ -112,6 +112,6 @@ SeaTunnel is specifically developed for data integration and synchronization, an

The following diagram describes the workflow of SeaTunnel.

![SeaTunnel workflow](/img/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_04_migration_and_synchronization_oceanbase/02_ecological_tools_of_migration_synchronization/002.png)
![SeaTunnel workflow](/img/user_manual/quick_starts/en-US/chapter_04_migration_and_synchronization_oceanbase/02_ecological_tools_of_migration_synchronization/002.png)

For more information, see the [introduction to SeaTunnel](https://seatunnel.apache.org/docs/about/).
Loading
Loading