Initial commit
This commit is contained in:
Zhongwei Li
@@ -0,0 +1,202 @@
|
||||
---
|
||||
|
||||
slug: /deploy-by-systemd
|
||||
---
|
||||
|
||||
# Deploy seekdb by using yum install
|
||||
|
||||
This topic describes how to deploy seekdb by using yum install.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before performing the operations in this topic, you need to confirm the following information:
|
||||
|
||||
* Your environment is an RPM platform system. The currently verified supported systems are as follows:
|
||||
|
||||
* Anolis OS 8.X (Linux kernel 4.19 or later)
|
||||
|
||||
* Anolis OS 23.X (Linux kernel 6.6 or later)
|
||||
|
||||
* CentOS Linux 7.X, 9.X (Linux kernel 4.19 or later)
|
||||
|
||||
* Debian 11, 12, and 13 (Linux kernel 4.19 or later)
|
||||
|
||||
* openEuler 22.03 and 24.03 (Linux kernel 5.10.0 or later)
|
||||
|
||||
* Ubuntu 20.04, 22.04, and 24.04 (Linux kernel 4.19 or later)
|
||||
|
||||
* The minimum CPU requirement in the current environment is 1 core.
|
||||
|
||||
* The minimum available memory in the current environment is 2 GB.
|
||||
|
||||
* The jq command-line tool is installed in your environment, and systemd is correctly configured as the system and service manager.
|
||||
|
||||
* Database connection tools (MySQL client or OBClient) are installed in your environment.
|
||||
|
||||
* The user you are using has permission to execute sudo commands.
|
||||
|
||||
## Deploy seekdb
|
||||
|
||||
### Step 1: Install seekdb
|
||||
|
||||
Depending on whether the environment can connect to an external network, there are two installation methods: online installation and offline installation.
|
||||
|
||||
#### Online installation
|
||||
|
||||
1. Add the seekdb repository
|
||||
|
||||
```shell
|
||||
[admin@test001 ~]$ sudo yum-config-manager --add-repo https://mirrors.aliyun.com/oceanbase/OceanBase.repo
|
||||
```
|
||||
|
||||
2. Install seekdb
|
||||
|
||||
```shell
|
||||
[admin@test001 ~]$ sudo yum install seekdb obclient
|
||||
```
|
||||
|
||||
#### Offline installation
|
||||
|
||||
1. You can download the required version of seekdb from the [OceanBase Software Download Center](https://en.oceanbase.com/softwarecenter). After downloading, copy the installation package to your machine. It is recommended that you use the latest version of the installation package.
|
||||
|
||||
2. In the directory where the installation package is located, run the rpm command to install seekdb.
|
||||
|
||||
```shell
|
||||
[admin@test001 ~]$ sudo rpm -ivh seekdb-*.rpm
|
||||
```
|
||||
|
||||
### Step 2: Start seekdb
|
||||
|
||||
After installing seekdb, you can start seekdb by following these steps.
|
||||
|
||||
1. (Optional) Modify the configuration file.
|
||||
|
||||
You can modify the configuration file in this step. If not modified, the default configuration in the configuration file will be used for deployment.
|
||||
|
||||
```shell
|
||||
[admin@test001 ~]$ sudo vim /etc/oceanbase/seekdb.cnf
|
||||
```
|
||||
|
||||
The configuration items in this file are as follows:
|
||||
|
||||
```shell
|
||||
port=2881
|
||||
data-dir=/var/lib/oceanbase/store
|
||||
redo-dir=/var/lib/oceanbase/store/redo
|
||||
datafile_size=2G
|
||||
datafile_next=2G
|
||||
datafile_maxsize=50G
|
||||
cpu_count=4
|
||||
memory_limit=2G
|
||||
log_disk_size=2G
|
||||
```
|
||||
|
||||
The configuration items in the configuration file are described in the following table:
|
||||
|
||||
| Configuration item | Required | Default value | Description |
|
||||
|----------|-----------|----------|----------|
|
||||
| port | Optional | 2881 | The SQL service protocol port number of seekdb. |
|
||||
| redo_dir | Optional | /var/lib/oceanbase/store/redo | Directory for clog, ilog, and slog. It is recommended to configure it as an independent disk.<main id="notice" type='explain'><h4>Note</h4><p>The available disk space of the data disk (default: <code>/var/lib/oceanbase/</code>) should be greater than 15 GB.</p></main> |
|
||||
| data_dir | Optional | /var/lib/oceanbase/store | Directory for storing SSTable and other data. It is recommended to configure it as an independent disk.<main id="notice" type='explain'><h4>Note</h4><p>The available disk space of the data disk (default: <code>/var/lib/oceanbase/</code>) should be greater than 15 GB.</p></main> |
|
||||
| datafile_size | Optional | 2G | Specifies the size of data files (block_file). If not configured, the `datafile_disk_percentage` configuration item is used. For details, see [datafile_size](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001971955) and [datafile_disk_percentage](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001971961). |
|
||||
| datafile_next | Optional | 2G | Specifies the growth step size of data files. |
|
||||
| datafile_maxsize | Optional | 50G | Specifies the maximum size of data files. |
|
||||
| cpu_count | Optional | 4 | Total number of CPUs that seekdb can use. If set to 0, it will be automatically detected. |
|
||||
| memory_limit | Optional | 2G | Maximum memory that seekdb can obtain from the environment. |
|
||||
| log_disk_size | Optional | 2G | Used to set the size of the Redo log disk. If not configured, the `log_disk_percentage` configuration item is used. For details, see [log_disk_size](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001971764) and [log_disk_percentage](https://en.oceanbase.com/docs/common-oceanbase-database-10000000001971945). |
|
||||
|
||||
2. Start seekdb.
|
||||
|
||||
```shell
|
||||
[admin@test001 ~]$ sudo systemctl start seekdb
|
||||
```
|
||||
|
||||
3. Check the startup status of seekdb.
|
||||
|
||||
```shell
|
||||
[admin@test001 ~]$ sudo systemctl status seekdb
|
||||
```
|
||||
|
||||
When the status displays `Service is ready`, it indicates that seekdb has started successfully.
|
||||
|
||||
### Step 3: Connect to seekdb
|
||||
|
||||
Here, connecting to seekdb through OBClient is used as an example. The command is as follows:
|
||||
|
||||
```shell
|
||||
[admin@test001 ~]$ obclient -h<IP> -uroot -P<Port> -p<Passwd> -A oceanbase
|
||||
```
|
||||
|
||||
Parameter description:
|
||||
|
||||
* -h: Provides the seekdb connection IP. The default IP for seekdb started with systemd is `127.0.0.1`.
|
||||
|
||||
* -u: Provides the seekdb connection account in the format: `username`. The default username for seekdb instances is `root`.
|
||||
|
||||
* -P: Provides the seekdb connection port, which is the value of `port` in `/etc/oceanbase/seekdb.cnf`.
|
||||
|
||||
* -p: Provides the seekdb connection password. The default is empty.
|
||||
|
||||
* -A: Indicates that OBClient does not automatically obtain statistics when connecting to the database.
|
||||
|
||||
* oceanbase: The name of the database to access, which can be changed to a business database name.
|
||||
|
||||
## Manage seekdb
|
||||
|
||||
Currently, only start, stop, and status operations are supported for seekdb through systemd.
|
||||
|
||||
### Check seekdb status
|
||||
|
||||
You can run the following command to check the seekdb status.
|
||||
|
||||
```shell
|
||||
[admin@test001 ~]$ sudo systemctl status seekdb
|
||||
```
|
||||
|
||||
The seekdb status has the following scenarios:
|
||||
|
||||
* `Active` displays `active (running)`, and `Status` displays `seekdb is ready and running`, indicating that seekdb has started successfully.
|
||||
|
||||
* `Active` displays `inactive (dead)`, indicating that the service has stopped, that is, seekdb has stopped.
|
||||
|
||||
* `Active` displays `failed`, indicating that an error occurred in the service. You need to check the logs for troubleshooting.
|
||||
|
||||
### Clear seekdb
|
||||
|
||||
You can clear seekdb started with systemd by following these steps.
|
||||
|
||||
1. Stop seekdb.
|
||||
|
||||
```shell
|
||||
[admin@test001 ~]$ sudo systemctl stop seekdb
|
||||
```
|
||||
|
||||
2. Uninstall seekdb.
|
||||
|
||||
1. Delete the seekdb database package
|
||||
|
||||
For online installation, you can run the following command:
|
||||
|
||||
```shell
|
||||
[admin@test001 ~]$ sudo yum erase seekdb
|
||||
```
|
||||
|
||||
`package` needs to be replaced with the name of the package to be deleted. You can check the package name using the `yum list | grep seekdb` command.
|
||||
|
||||
For offline installation, you can run the following command:
|
||||
|
||||
```shell
|
||||
[admin@test001 ~]$ sudo rpm -e seekdb
|
||||
```
|
||||
|
||||
`package` needs to be replaced with the name of the package to be deleted. You can check the package name using the `rpm -qa | grep seekdb` command.
|
||||
|
||||
2. Delete seekdb data.
|
||||
|
||||
After executing the first step, the return result will display `To clean OceanBase : bash /var/lib/oceanbase/oceanbase_clean.sh`. You can use this command to completely delete seekdb.
|
||||
|
||||
After executing this step to delete seekdb data, your deployed seekdb will be completely uninstalled.
|
||||
|
||||
```shell
|
||||
[admin@test001 ~]$ sudo bash /var/lib/oceanbase/oceanbase_clean.sh
|
||||
```
|
||||
@@ -0,0 +1,145 @@
|
||||
---
|
||||
|
||||
slug: /deploy-by-docker
|
||||
---
|
||||
|
||||
# Deploy seekdb in a container environment
|
||||
|
||||
This topic describes how to deploy seekdb through Docker containers.
|
||||
|
||||
## Overview
|
||||
|
||||
The `seekdb` Docker image is available from [dockerhub](https://hub.docker.com/r/oceanbase/seekdb), [quay.io](https://quay.io/repository/oceanbase/seekdb), and [ghcr.io](https://ghcr.io/oceanbase/seekdb), and is designed to help users quickly set up a seekdb environment for testing.
|
||||
|
||||
:::tip
|
||||
<ul><li>When running this image on macOS with Intel chips, there is a known issue if the Docker version is higher than 4.9.0. You can download the required version of <a href="https://desktop.docker.com/mac/main/amd64/81317/Docker.dmg?_gl=17jelfd_gcl_auOTk5Nzk0MDUwLjE3MTE4ODMyNzM._gaNDQyMjE1MDE5LjE3MTE4ODMyNzQ._ga_XJWPQMJYHQ*MTcxOTIxOTEwMy4xMS4xLjE3MTkyMjEwMTAuNjAuMC4w">Docker</a> here.</li>
|
||||
<li>This image is for testing only; do not use it in production environments.</li></ul>
|
||||
:::
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before deploying `seekdb`, ensure that the following requirements are met:
|
||||
|
||||
* Docker is installed and the Docker service is started. For details, see [Docker documentation](https://docs.docker.com/get-docker/).
|
||||
|
||||
* Your machine has at least 1 physical core and 2 GB of memory.
|
||||
|
||||
## Start a seekdb instance
|
||||
|
||||
To start a seekdb instance, use the following command:
|
||||
|
||||
```shell
|
||||
docker run -d -p 2881:2881 oceanbase/seekdb
|
||||
```
|
||||
|
||||
:::info
|
||||
<ul>
|
||||
<li>
|
||||
If pulling the Docker image fails, you can also pull the image from the quay.io or ghcr.io repository by replacing <code>oceanbase/seekdb</code> in the above command with <code>quay.io/oceanbase/seekdb</code> or <code>ghcr.io/oceanbase/seekdb</code>, for example, run <code>sudo docker run -d -p 2881:2881 quay.io/oceanbase/seekdb</code> to pull the image from quay.io.
|
||||
</li>
|
||||
<li>
|
||||
The above command pulls the latest version by default. You can select a version from <a href="https://hub.docker.com/r/oceanbase/seekdb">dockerhub</a>, <a href="https://quay.io/repository/oceanbase/seekdb">quay.io</a>, or <a href="https://ghcr.io/oceanbase/seekdb">ghcr.io</a> according to your actual needs.
|
||||
</li>
|
||||
</ul>
|
||||
:::
|
||||
|
||||
If you want to execute initialization SQL scripts after startup, you need to mount a directory containing initialization scripts and then specify the mounted directory in the container through the environment variable `INIT_SCRIPTS_PATH`. Example command:
|
||||
|
||||
```shell
|
||||
docker run -d -p 2881:2881 -v {init_sql_folder_path}:/root/boot/init.d -e INIT_SCRIPTS_PATH=/root/boot/init.d oceanbase/seekdb
|
||||
```
|
||||
In the command, `{init_sql_folder_path}` is the path to the initialization SQL scripts on the host machine.
|
||||
|
||||
:::tip
|
||||
Do not change the root user password in SQL scripts. If you want to change the root user password, use the environment variable <code>ROOT_PASSWORD</code>, for example: <code>docker run -d -p 2881:2881 -e ROOT_PASSWORD="******" oceanbase/seekdb</code>.
|
||||
:::
|
||||
|
||||
The supported environment variables are as follows:
|
||||
|
||||
| Variable name | Description | Default value |
|
||||
|-----------|--------------------|----------|
|
||||
| ROOT_PASSWORD | Password for the root user. | Empty by default |
|
||||
| CPU_COUNT | Value of cpu_count.| 4 |
|
||||
| MEMORY_LIMIT | Value of memory_limit.| 2G |
|
||||
| LOG_DISK_SIZE | Value of log_disk_size.| 2G |
|
||||
| DATAFILE_SIZE | Value of datafile_size.| 2G |
|
||||
| DATAFILE_NEXT | Value of datafile_next.| 2G |
|
||||
| DATAFILE_MAXSIZE | Value of datafile_maxsize.| 50G |
|
||||
| INIT_SCRIPTS_PATH | Path to initialization scripts in the container.| \ |
|
||||
|
||||
|
||||
If you want to modify more seekdb parameters, you can deploy seekdb using a configuration file.
|
||||
|
||||
You can mount the configuration file to `/etc/oceanbase/seekdb.cnf` in the container.
|
||||
|
||||
1. Create a configuration file on the host server. The default configuration file is as follows:
|
||||
|
||||
```shell
|
||||
datafile_size=2G
|
||||
datafile_next=2G
|
||||
datafile_maxsize=50G
|
||||
cpu_count=4
|
||||
memory_limit=8G
|
||||
log_disk_size=2G
|
||||
# config the parameter in the following format
|
||||
# key=value
|
||||
```
|
||||
|
||||
2. Start seekdb.
|
||||
|
||||
```shell
|
||||
docker run -d -p 2881:2881 -v {config_file}:/etc/oceanbase/seekdb.cnf oceanbase/seekdb
|
||||
```
|
||||
|
||||
In the command, `{config_file}` is the path to the configuration file on the host machine.
|
||||
|
||||
:::tip
|
||||
If you decide to use a configuration file, do not specify resource-related environment variables.
|
||||
:::
|
||||
|
||||
|
||||
## Data persistence
|
||||
|
||||
seekdb is deployed in the `/var/lib/oceanbase` directory. If you want to persist data to the host server, mount an empty directory on the host server to this path.
|
||||
|
||||
```shell
|
||||
mkdir -p seekdb
|
||||
docker run -d -p 2881:2881 -v $PWD/seekdb:/var/lib/oceanbase --name seekdb oceanbase/seekdb
|
||||
```
|
||||
|
||||
## Connect to a seekdb instance
|
||||
|
||||
You can use the OBClient or MySQL client on the host to connect to the seekdb instance.
|
||||
|
||||
```shell
|
||||
[admin@test001 ~]$ mysql -uroot -h127.0.0.1 -P2881 -p
|
||||
```
|
||||
|
||||
:::info
|
||||
If the password is not configured through environment variables when starting the seekdb instance, users created in the instance use empty passwords by default.
|
||||
:::
|
||||
|
||||
After a successful connection, the terminal displays the following content:
|
||||
|
||||
```shell
|
||||
Welcome to the MariaDB monitor. Commands end with ; or \g.
|
||||
Your MySQL connection id is 3221628904
|
||||
Server version: 5.7.25 OceanBase 4.3.5.3 seekdb (r1.0.0.0) (Built 102025110516-83ac0ad994286047a3e713e82e9541383f6df531 Nov 5 2025)
|
||||
|
||||
Copyright (c) 2000, 2018, Oracle, MariaDB Corporation Ab and others.
|
||||
|
||||
Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
|
||||
|
||||
MySQL [(none)]>
|
||||
```
|
||||
|
||||
## Access the obshell dashboard
|
||||
|
||||
The container also starts obshell, which provides a user-friendly web interface. If you want to access the obshell dashboard, you can also map the obshell dashboard port.
|
||||
|
||||
```shell
|
||||
# 2886 is the port for the obshell dashboard
|
||||
docker run -d -p 2881:2881 -p 2886:2886 oceanbase/seekdb
|
||||
```
|
||||
|
||||
You can access `http://${server_ip}:2886` through a browser. The login password is the same as the root user password. If `ROOT_PASSWORD` is not set, leave the password field empty.
|
||||
@@ -0,0 +1,249 @@
|
||||
---
|
||||
|
||||
slug: /deploy-oceanbase-desktop
|
||||
---
|
||||
|
||||
# Deploy OceanBase Desktop
|
||||
|
||||
This topic describes how to deploy OceanBase Desktop on Windows or macOS.
|
||||
|
||||
## Overview
|
||||
|
||||
OceanBase Desktop is a desktop application for managing and operating seekdb. It provides a graphical interface that enables users to easily perform database management, query execution, data import and export, and other operations.
|
||||
|
||||
OceanBase Desktop has the following features:
|
||||
|
||||
* **Graphical interface:** An intuitive and easy-to-use graphical interface that simplifies database management tasks.
|
||||
|
||||
* **Database management:** Supports creating and managing database instances.
|
||||
|
||||
* **Query execution:** Provides an SQL query command line.
|
||||
|
||||
* **Monitoring and logs:** Real-time monitoring of database status.
|
||||
|
||||
## Check configuration
|
||||
### Windows
|
||||
|
||||
Before installing OceanBase Desktop on Windows, ensure that your machine meets the following requirements:
|
||||
|
||||
* The operating system is Windows (x86-64 chip). WSL 2 requires Windows 10 version 1903 or later (build 18362 or later), or Windows 11.
|
||||
|
||||
* At least 1 vCPU, 2 GB memory, and 5 GB disk space are available.
|
||||
|
||||
You can check whether your machine meets the requirements as follows:
|
||||
|
||||
* Check the Windows version
|
||||
|
||||
Press [Win] + [Q] on your keyboard, search for **Settings**, and click **Settings**. On the **Settings** page, click **System**, scroll down to find **About**, and you can view the Windows operating system build number.
|
||||
|
||||
<!---->
|
||||
|
||||
* Check memory and CPU
|
||||
|
||||
Press [Win] + [Q] on your keyboard, search for **Task Manager**, and click to open it. Go to the **Performance** interface. Switch to the **CPU** tab to view the number of CPU cores. Switch to the **Memory** tab to view memory usage.
|
||||
|
||||
<!---->
|
||||
|
||||
* Check disk
|
||||
|
||||
Press [Win] + [Q] on your keyboard, search for **File Explorer**, and click to open it. In **File Explorer**, click **This PC** on the left to view the disk information displayed under **Devices and drives**.
|
||||
|
||||
### macOS
|
||||
|
||||
Before installing OceanBase Desktop on macOS, ensure that your machine meets the following requirements:
|
||||
|
||||
* The operating system is macOS (Apple Silicon chip and Intel chip).
|
||||
|
||||
* At least 1 vCPU, 2 GB memory, and 5 GB disk space are available.
|
||||
|
||||
You can check whether your machine meets the requirements as follows:
|
||||
|
||||
* Check CPU and memory
|
||||
|
||||
Open Finder, click **Applications**, select the **Utilities** folder in the **Applications** module, and then double-click to open **Activity Monitor**. You can view CPU usage in the **CPU** tab of Activity Monitor. Switch to the **Memory** tab to view memory usage.
|
||||
|
||||
<!---->
|
||||
|
||||
* Check disk
|
||||
|
||||
Click the Apple icon in the upper-left corner of your computer, then click **About This Mac**. In the window that appears, click **More Info** to view the disk information displayed under **Storage**.
|
||||
|
||||
<!---->
|
||||
|
||||
## Procedure
|
||||
|
||||
### Windows
|
||||
|
||||
1. Install dependencies
|
||||
|
||||
Installing OceanBase Desktop on Windows requires WSL (Windows Subsystem for Linux). WSL is a feature released by Microsoft in 2016 on the Windows 10 platform that enables users to run Linux executables in ELF format on Windows.
|
||||
|
||||
WSL has released two generations: WSL 1 and WSL 2. WSL 1 implements a Linux compatibility layer that converts Linux system calls to Windows NT system calls. WSL 2 uses Windows Hyper-V functionality to run Linux virtual machines directly through virtualization technology, providing an experience closer to native Linux.
|
||||
|
||||
:::tip
|
||||
WSL 2 is not an upgrade of WSL 1, so you do not need to install WSL 1 before installing WSL 2. OceanBase Desktop images can only use WSL 2.
|
||||
:::
|
||||
|
||||
1. Check whether virtualization is enabled.
|
||||
|
||||
Press [Win] + [Q] on your keyboard, search for **Task Manager**, and click to open it. Go to the **Performance** interface and view **CPU**. As shown in the following figure, if virtualization is enabled, the **Virtualization** field displays **Enabled**. If the **Virtualization** field displays **Disabled**, refer to the following steps to enable virtualization in BIOS.
|
||||
|
||||
<!---->
|
||||
|
||||
2. Enable motherboard virtualization.
|
||||
|
||||
This section uses ThinkPad (a Lenovo brand) as an example to describe how to enter BIOS and enable motherboard virtualization. The operations for entering BIOS and enabling motherboard virtualization vary slightly for different computer brands. You can visit the official websites of your brand to view specific operations, such as [Dell](https://www.dell.com/support/kbdoc/zh-cn/000195978/how-to-enable-or-disable-hardware-virtualization-on-dell-systems?lang=en), [Lenovo](https://support.lenovo.com/us/en/solutions/ht500006-how-to-enable-virtualization-technology-on-lenovo-computers), [ThinkPad (a Lenovo brand)](https://support.lenovo.com/us/en/solutions/ht500006-how-to-enable-virtualization-technology-on-lenovo-computers), [HP](https://support.hp.com/us-en/search?q=enable%20virtualization), or search for your computer model in a browser.
|
||||
|
||||
1. Open the **Start** menu, click the **Power** button, and click **Restart**.
|
||||
|
||||
2. After the computer restarts, immediately press the **F1** key on your keyboard to access BIOS settings.
|
||||
|
||||
3. On the BIOS page, click the **Security** option, and then click **Security Virtualization** on the **Security** page.
|
||||
|
||||
4. After entering the corresponding settings page, set the button after **Virtualization Technology** to **no**.
|
||||
|
||||
5. After adjustment, click **Save and Exit** to save the changes and exit BIOS settings, and wait for the system to restart.
|
||||
|
||||
:::info
|
||||
After enabling, you can refer to the previous step to verify again whether virtualization is enabled.
|
||||
:::
|
||||
|
||||
2. Install OceanBase Desktop
|
||||
|
||||
1. Download the installation package.
|
||||
|
||||
Visit the [OceanBase Software Download Center](https://en.oceanbase.com/softwarecenter), find **OceanBase Desktop One-Click Deployment Installation Package**, and click to download **Windows Version-1.3**.
|
||||
|
||||
2. Install the application.
|
||||
|
||||
1. Double-click the downloaded `OceanBase-Desktop-Setup-x.x.x.exe` file.
|
||||
|
||||
2. In the **User Account Control** window that appears, click **Yes** to allow the application to make changes to the device.
|
||||
|
||||
3. On the `Installer Language` page that appears, select the installation language. The default is Chinese (Simplified).
|
||||
|
||||
<!---->
|
||||
|
||||
4. Select the application installation location. By default, it is installed on drive C. You can click **Browse** to select another folder for installation. After confirmation, click **Install**.
|
||||
|
||||
<!---->
|
||||
|
||||
5. After installation is complete, click **Finish**. OceanBase Desktop will automatically run.
|
||||
|
||||
<!---->
|
||||
|
||||
3. Start OceanBase Desktop.
|
||||
|
||||
After installation is complete, open the desktop version. A login interface for obshell Dashboard appears. The default login password is empty. Click **Login** to enter.
|
||||
|
||||
<!---->
|
||||
|
||||
After entering the obshell Dashboard page, the instance starts automatically. You can view instance information and manage instances on this page.
|
||||
|
||||
<!---->
|
||||
|
||||
3. Connect to OceanBase Desktop
|
||||
|
||||
After OceanBase Desktop starts successfully, you can connect to OceanBase Desktop through the command line interface. The connection string example is as follows:
|
||||
|
||||
```shell
|
||||
wsl.exe -d oceanbase-desktop --exec bash -c "obclient -h127.0.0.1 -P2881 -uroot -Doceanbase -A"
|
||||
```
|
||||
|
||||
### macOS
|
||||
|
||||
Two installation methods are available on macOS: installation through Homebrew and installation through a dmg installation package. This section describes both methods.
|
||||
|
||||
* Install through Homebrew
|
||||
|
||||
1. Install Homebrew
|
||||
|
||||
If Homebrew is not installed in the current environment, run the following command to install it.
|
||||
|
||||
```shell
|
||||
/bin/bash -c "$(curl -fsSL https://gitee.com/cunkai/HomebrewCN/raw/master/Homebrew.sh)"
|
||||
```
|
||||
|
||||
2. Add the OceanBase Desktop Tap.
|
||||
|
||||
After adding the OceanBase Desktop Tap to Homebrew, you can install the official package provided by seekdb using the `brew install` command.
|
||||
|
||||
```shell
|
||||
brew tap oceanbase/homebrew-oceanbase-desktop https://gitee.com/oceanbase/homebrew-oceanbase-desktop.git
|
||||
```
|
||||
|
||||
3. Install OceanBase Desktop.
|
||||
|
||||
```shell
|
||||
brew install --cask oceanbase-desktop
|
||||
```
|
||||
|
||||
After the command is executed, the latest version of OceanBase Desktop will be automatically downloaded, and OrbStack will be installed as a dependency (if not already installed in the environment). After successful installation, the application will be placed in the Applications folder.
|
||||
|
||||
4. Start the application.
|
||||
|
||||
Find `OceanBase Desktop` in the Applications folder, or use Spotlight to search for `OceanBase Desktop`, and double-click to start it. Please wait patiently when starting the application for the first time, as the program will complete initialization in the background. After entering the application, click the **Start** button on the page to start seekdb.
|
||||
|
||||
:::info
|
||||
To uninstall OceanBase Desktop, run the <code>brew uninstall --cask oceanbase-desktop</code> command. This command will also clean up application files, application support data, saved application state, and application virtual machines.
|
||||
:::
|
||||
|
||||
* Install through a dmg installation package
|
||||
|
||||
1. Install dependencies
|
||||
|
||||
Installing OceanBase Desktop on macOS requires OrbStack. OrbStack is a modern container and virtual machine management tool designed for macOS users, aiming to provide efficient container runtime (such as Docker containers) and lightweight virtual machine support. Its goal is to replace Docker Desktop and other cumbersome virtualization tools while significantly improving performance, saving system resources, and simplifying the developer experience.
|
||||
|
||||
:::info
|
||||
There are two installation methods in the OrbStack official tutorial: downloading the installation package and running the brew command. This section uses downloading the installation package as an example. For other methods, see the <a href="https://docs.orbstack.dev/quick-start">official tutorial</a>.
|
||||
:::
|
||||
|
||||
1. Download the installation package.
|
||||
|
||||
You can visit the [official download link](https://orbstack.dev/download) to download the installation package. The link provides two installation packages based on the chip used by the operating system (Apple Silicon chip and Intel chip). You can click the Apple icon in the upper-left corner of your computer, then click **About This Mac** to view the chip type used by your computer.
|
||||
|
||||
|
||||
|
||||
2. Install.
|
||||
|
||||
Double-click the corresponding dmg installation package and drag the icon to the Applications folder for installation.
|
||||
|
||||
:::tip
|
||||
If this is the first installation, be sure to complete the OrbStack initial setup process; otherwise, images cannot be imported normally.
|
||||
:::
|
||||
|
||||
<!---->
|
||||
|
||||
3. (Optional) Verify whether the installation is successful.
|
||||
|
||||
Select the Machines (Virtual Machines) section and install the latest Ubuntu image. This process may take a long time. Please wait patiently.
|
||||
|
||||
<!---->
|
||||
|
||||
After installation is complete, double-click the corresponding virtual machine. If you can enter the command line connection interface, it means OrbStack has been successfully installed.
|
||||
|
||||
<!---->
|
||||
|
||||
2. Install OceanBase Desktop
|
||||
|
||||
1. Download the installation package.
|
||||
|
||||
Visit the [OceanBase Software Download Center](https://en.oceanbase.com/softwarecenter), find **OceanBase Desktop One-Click Deployment Installation Package**, and click to download **Mac Version-1.3**.
|
||||
|
||||
|
||||
2. Install the application.
|
||||
|
||||
Click the corresponding installation package and drag the icon to the Applications folder for installation.
|
||||
|
||||
3. Start OceanBase Desktop.
|
||||
|
||||
After installation is complete, a seekdb instance in the `Stopped` state will be automatically deployed. Click the **Start** button on the graphical page to start seekdb.
|
||||
|
||||
|
||||
### Connect to OceanBase Desktop
|
||||
|
||||
After seekdb starts successfully, click the **Connect** button in OceanBase Desktop to automatically connect to seekdb. You can also manually connect to seekdb. The connection string example is as follows:
|
||||
|
||||
```shell
|
||||
mysql -h127.0.0.1 -P2881 -uroot -Doceanbase -A
|
||||
```
|
||||
Reference in New Issue
Block a user