Skip to main content

Deploying a Standalone Databend

Deploying a Standalone Databend​

Databend works with both self-hosted and cloud object storage solutions. This topic explains how to deploy Databend with your object storage. For a list of supported object storage solutions, see Understanding Deployment Modes.

Setting up Your Object Storage​

a. Follow the MinIO Quickstart Guide to download and install the MinIO package to your local machine.

b. Open a terminal window and navigate to the folder where MinIO is stored.

c. Run the command vim server.sh to create a file with the following content:

~/minio$ cat server.sh
export MINIO_ROOT_USER=minioadmin
export MINIO_ROOT_PASSWORD=minioadmin
./minio server --address :9900 ./data

d. Run the following commands to start the MinIO server:

chmod +x server.sh
./server.sh

e. In your browser, go to http://127.0.0.1:9900 and enter the credentials (minioadmin / minioadmin) to log in to the MinIO Console.

f. In the MinIO Console, create a bucket named databend.

Downloading Databend​

a. Create a folder named databend in the directory /usr/local.

b. Download and extract the latest Databend release for your platform from Github Release:

curl -LJO https://github.com/datafuselabs/databend/releases/download/${version}/databend-${version}-x86_64-unknown-linux-musl.tar.gz
tar xzvf databend-${version}-x86_64-unknown-linux-musl.tar.gz

c. Move the extracted folders bin and configs to the folder /usr/local/databend.

Deploying a Meta Node​

a. Open the file databend-meta.toml in the folder /usr/local/databend/configs, and replace 127.0.0.1 with 0.0.0.0 within the whole file.

b. Open a terminal window and navigate to the folder /usr/local/databend/bin.

c. Run the following command to start the Meta node:

./databend-meta -c ../configs/databend-meta.toml > meta.log 2>&1 &

d. Run the following command to check if the Meta node was started successfully:

curl -I  http://127.0.0.1:28101/v1/health

Deploying a Query Node​

a. Open the file databend-query.toml in the folder /usr/local/databend/configs, and replace 127.0.0.1 with 0.0.0.0 within the whole file.

b. In the file databend-query.toml, set the parameter type in [storage] block to s3 if you're using a S3 compatible object storage, or azblob if you're using Azure Blob storage.

[storage]
# fs | s3 | azblob | gcs | obs
type = "s3"

c. Comment out the [storage.fs] block first, and then uncomment the [storage.s3] block if you're using a S3 compatible object storage, or uncomment the [storage.azblob] block if you're using Azure Blob storage.

# Set a local folder to store your data.
# Comment out this block if you're NOT using local file system as storage.
#[storage.fs]
#data_path = "benddata/datas"

# To use S3-compatible object storage, uncomment this block and set your values.
[storage.s3]
bucket = "<your-bucket-name>"
endpoint_url = "<your-endpoint>"
access_key_id = "<your-key-id>"
secret_access_key = "<your-account-key>"

# To use Azure Blob storage, uncomment this block and set your values.
# [storage.azblob]
# endpoint_url = "https://<your-storage-account-name>.blob.core.windows.net"
# container = "<your-azure-storage-container-name>"
# account_name = "<your-storage-account-name>"
# account_key = "<your-account-key>"

# To use Google Cloud Storage, uncomment this block and set your values.
# [storage.gcs]
# bucket = "<your-bucket-name>"
# credential = "<your-credential>"

# To use Huawei Cloud OBS Storage, uncomment this block and set your values.
# [storage.obs]
# bucket = "<your-bucket-name>"
# endpoint_url = "<your-endpoint>"
# access_key_id = "<your-key-id>"
# secret_access_key = "<your-account-key>"

d. Set your values in the [storage.s3], [storage.azblob], [storage.gcs] or [storage.obs] block. Please note that the field endpoint_url refers to the service URL of your storage region and varies depending on the object storage solution you use:

[storage]
# s3
type = "s3"

[storage.s3]
bucket = "databend"
endpoint_url = "http://127.0.0.1:9900"
access_key_id = "minioadmin"
secret_access_key = "minioadmin"

e. Open a terminal window and navigate to the folder /usr/local/databend/bin.

f. Run the following command to start the Query node:

./databend-query -c ../configs/databend-query.toml > query.log 2>&1 &

g. Run the following command to check if the Query node was started successfully:

curl -I  http://127.0.0.1:8080/v1/health

Verifying Deployment​

In this section, we will run some queries against Databend to verify the deployment.

a. Download and install a MySQL client on your local machine.

b. Create a connection to 127.0.0.1 from your SQL client. In the connection, set the port to 3307, and set the username to root.

tip

Create new users. The root user only works when you access Databend from localhost. You will need to create new users and grant proper privileges first to connect to Databend remotely. For example, 

-- Create a user named "eric" with the password "databend"
CREATE USER eric IDENTIFIED BY 'databend';

-- Grant the ALL privilege on all existing tables in the default database to the user eric:
GRANT ALL ON default.* TO eric;

For more information about creating new users, see CREATE USER.

c. Run the following commands and check if the query is successful:

CREATE TABLE t1(a int);

INSERT INTO t1 VALUES(1), (2);

SELECT * FROM t1;