Skip to content

Commit

Permalink
parent 1c028ce
Browse files Browse the repository at this point in the history 
author TomShawn <[email protected]> 1698735667 +0800
committer TomShawn <[email protected]> 1699607445 +0800

docs: add 4 cbdb docs

reorder sidebar

translate 2 docs into Chinese

Update create-and-manage-database.md

reorder sidebar

translate 2 docs into Chinese

Update create-and-manage-database.md

docs: add Linux compile guide (apache#46)

add 3 docs
  • Loading branch information
@TomShawn
TomShawn committed Nov 10, 2023
1 parent 1c028ce commit 4f012df
Show file tree
Hide file tree
Showing 20 changed files with 1,538 additions and 7 deletions.
66 changes: 66 additions & 0 deletions docs/basic-query-syntax.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
title: Basic Query Syntax
---

# Basic Queries of Cloudberry Database

This document introduce the basic queries of Cloudberry Database.

Cloudberry Database is a high-performance, highly parallel data warehouse developed based on PostgreSQL and Greenplum. Here are some examples of the basic query syntax.

- `SELECT`: Used to retrieve data from databases & tables.

```sql
SELECT * FROM employees; -- Queries all data in the employees table.
```

- Conditional query (`WHERE`): Used to filter result sets based on certain conditions.

```sql
SELECT * FROM employees WHERE salary > 50000; -- Queries employee information with salary exceeding 50,000.
```

- `ORDER BY`: Used to sort query results by one or more columns.

```sql
SELECT * FROM employees ORDER BY salary DESC; -- Sorts employee information in descending order by salary.
```

- Aggregation functions: such as `COUNT`, `SUM`, `AVG`, `MAX`, `MIN`, used for calculating statistics from datasets.

```sql
SELECT AVG(salary) FROM employees; -- Calculates the average salary of employees.
```

- `GROUP BY`: Used in conjunction with aggregation functions to group result sets.

```sql
SELECT department, COUNT(*) FROM employees GROUP BY department; -- Counts the number of employees by department.
```

- Limit the number of results (`LIMIT`): used to limit the number of rows returned by the query result.

```sql
SELECT * FROM employees LIMIT 10; -- Only queries the information of the first 10 employees.
```

- Join query (`JOIN`): used to combine data from two or more tables based on related columns.

```sql
SELECT employees.name, departments.name
FROM employees
JOIN departments ON employees.department_id = departments.id; -- Queries employees and their corresponding department names.
```

- Subquery: Nested queries in another SQL query.

```sql
SELECT name FROM employees
WHERE department_id IN (SELECT id FROM departments WHERE location = 'New York'); -- Queries all employees working in New York.
```

The above is just a brief overview of the basic query syntax in Cloudberry Database. Cloudberry Database also provides more advanced queries and functions to help developers perform complex data operations and analyses.

## See also

- [Insert, Update, and Delete Rows](/docs/insert-update-delete-rows.md)
265 changes: 265 additions & 0 deletions docs/cbdb-linux-compile.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,265 @@
---
title: On Linux
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Compile and Install Cloudberry Database on Linux

:::info
The source of this document is from the GitHub repository [`cloudberrydb/cloudberrydb`](https://github.com/cloudberrydb/cloudberrydb/blob/main/readmes/README.Linux.md).
:::

This document shares how to compile and install Cloudberry Database on Linux systems (CentOS 7, RHEL, and Ubuntu). Note that this document is for developers to try out Cloudberry Database in a single-node environments. DO NOT use this document for production environments.

Take the following steps to compile and install Cloudberry Database:

1. [Clone GitHub repo](#step-1-clone-github-repo).
2. [Install dependencies](#step-2-install-dependencies).
3. [Perform prerequisite platform tasks](#step-3-perform-prerequisite-platform-tasks).
4. [Build Cloudberry Database](#step-4-build-cloudberry-database).
5. [Verify the cluster](#step-5-verify-the-cluster).

## Step 1. Clone GitHub repo

Clone the GitHub repository `cloudberrydb/cloudberrydb` to the target machine:

```shell
git clone https://github.com/cloudberrydb/cloudberrydb.git
```

## Step 2. Install dependencies

Enter the repository and install dependencies according to your operating systems:

<Tabs>
<TabItem value="centos-7" label="For CentOS 7" default>

The following steps work on CentOS 7. For other CentOS versions, these steps might work but are not guaranteed to work.

1. Run the Bash script `README.CentOS.bash` in the `readmes` directory of the `cloudberrydb/cloudberrydb` repository. To run this script, password is required. Then, some required dependencies will be automatically downloaded.

```bash
cd cloudberrydb/readmes
./README.CentOS.bash
```

2. Install additional packages required for configurations.

```bash
yum -y install R apr apr-devel apr-util automake autoconf bash bison bison-devel bzip2 bzip2-devel centos-release-scl curl flex flex-devel gcc gcc-c++ git gdb iproute krb5-devel less libcurl libcurl-devel libevent libevent-devel libxml2 libxml2-devel libyaml libzstd-devel libzstd make openldap openssh openssh-clients openssh-server openssl openssl-devel openssl-libs perl python3-devel readline readline-devel rsync sed sudo tar vim wget which xerces-c-devel zip zlib && \
yum -y install epel-release
```

3. Update the GNU Compiler Collection (GCC) to version `devtoolset-10` to support C++ 14.

```bash
yum install centos-release-scl
yum -y install devtoolset-10-gcc devtoolset-10-gcc-c++ devtoolset-10-binutils
scl enable devtoolset-10 bash
source /opt/rh/devtoolset-10/enable
echo "source /opt/rh/devtoolset-10/enable" >> /etc/bashrc
source /etc/bashrc
gcc -v
```

4. Link cmake3 to cmake:

```bash
sudo ln -sf /usr/bin/cmake3 /usr/local/bin/cmake
```

</TabItem>
<TabItem value="rockey-rhel-8" label="For RHEL 8 and Rocky Linux 8" default>

1. Install Development Tools.

```bash
sudo yum group install -y "Development Tools"
```

2. Install dependencies:

```bash
sudo yum install -y epel-release
sudo yum install -y apr-devel bison bzip2-devel cmake3 flex gcc gcc-c++ krb5-devel libcurl-devel libevent-devel libkadm5 libxml2-devel libzstd-devel openssl-devel perl-ExtUtils-Embed python3-devel python3-pip readline-devel xerces-c-devel zlib-devel
```

3. Install more dependencies by running the `README.Rhel-Rocky.bash` script.

```bash
~/cloudberrydb/readmes/README.Rhel-Rocky.bash
```

</TabItem>
<TabItem value="ubuntu-18.04" label="For Ubuntu 18.04 or later" default>

1. Install dependencies by running the `README.Ubuntu.bash` script in the `readmes` directory.

```shell
## You need to enter your password to run.
sudo ~/cloudberrydb/readmes/README.Ubuntu.bash
```

:::info
- When you run the `README.Ubuntu.bash` script for dependencies, you will be asked to configure `realm` for Kerberos. You can enter any realm, because this is just for testing, and during testing, it will reconfigure a local server/client. If you want to skip this manual configuration, run `export DEBIAN_FRONTEND=noninteractive`.
- If the script fails to download packages, we recommend that you can try another one software source for Ubuntu.
:::

2. Install GCC 10. Ubuntu 18.04 and later versions should use GCC 10 or newer:

```bash
## Install gcc-10
sudo apt install software-properties-common
sudo add-apt-repository ppa:ubuntu-toolchain-r/test
sudo apt install gcc-10 g++-10
sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-10 100
```

</TabItem>
</Tabs>

## Step 3. Perform prerequisite platform tasks

After you have installed all the dependencies for your operating system, it is time to do some prerequisite platform tasks before you go on building Cloudberry Database. These operation include manually running `ldconfig` on all platforms, creating the `gpadmin` user, and setting up a password to start the Cloudberry Database and test.

1. Make sure that you add `/usr/local/lib` and `/usr/local/lib64` to the `/etc/ld.so.conf` file.

```bash
echo -e "/usr/local/lib \n/usr/local/lib64" >> /etc/ld.so.conf
ldconfig
```

2. Create the `gpadmin` user and set up the SSH key. Manually create SSH keys based on different operating systems, so that you can run `ssh localhost` without a password.

<Tabs>
<TabItem value="centos-rhel-rockey" label="For CentOS, Rocky Linux, and RHEL" default>

```bash
useradd gpadmin # Creates gpadmin user
su - gpadmin # Uses the gpadmin user
ssh-keygen # Creates SSH key
cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys
chmod 600 ~/.ssh/authorized_keys
exit
```

</TabItem>
<TabItem value="ubuntu" label="For Ubuntu" default>

```bash
useradd -r -m -s /bin/bash gpadmin # Creates gpadmin user
su - gpadmin # Uses the gpadmin user
ssh-keygen # Creates SSH key
cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys
chmod 600 ~/.ssh/authorized_keys
exit
```

</TabItem>
</Tabs>

## Step 4. Build Cloudberry Database

After you have installed all the dependencies and performed the prerequisite platform tasks, you can start to build Cloudberry Database. Run the following commands in sequence.

1. Configure the build environment. Enter the `cloudberrydb` directory and run the `configure` script.

```bash
cd cloudberrydb
./configure --with-perl --with-python --with-libxml --with-gssapi --prefix=/usr/local/cloudberrydb
```

:::info
Cloudberry Database is built with GPORCA by default. If you want to build CBDB without GPORCA, add the `--disable-orca` flag in the `./configure` command.

```bash
./configure --disable-orca --with-perl --with-python --with-libxml --prefix=/usr/local/cloudberrydb
```

:::

2. Compile the code and install the database.

```bash
make -j8
make -j8 install
```

3. Bring in the Greenplum environment for your running shell.

```bash
cd ..
cp -r cloudberrydb/ /home/gpadmin/
cd /home/gpadmin/
chown -R gpadmin:gpadmin cloudberrydb/
su - gpadmin
cd cloudberrydb/
source /usr/local/cloudberrydb/greenplum_path.sh
```

4. Start the demo cluster.

<Tabs>
<TabItem value="centos" label="For CentOS 7" default>

```bash
scl enable devtoolset-10 bash
source /opt/rh/devtoolset-10/enable
make create-demo-cluster
```

</TabItem>
<TabItem value="ubuntu-rocky-rhel" label="For Ubuntu, Rocky Linux, and RHEL" default>

```bash
make create-demo-cluster
```

</TabItem>
</Tabs>

5. Prepare the test by running the following command. This command will configure the port and environment variables for the test.

Environment variables such as `PGPORT` and `COORDINATOR_DATA_DIRECTORY` will be configured, which are the default port and the data directory of the coordinator node.

```bash
source gpAux/gpdemo/gpdemo-env.sh
```

## Step 5. Verify the cluster

1. You can verify whether the cluster has started successfully by running the following command. If successful, you might see multiple active `postgres` processes with ports ranging from `7000` to `7007`.

```bash
ps -ef | grep postgres
```

2. Connect to the Cloudberry Database and see the active segment information by querying the system table `gp_segement_configuration`. For detailed description of this table, see the Greenplum document [here](https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-system_catalogs-gp_segment_configuration.html).

```sql
$ psql -p 7000 postgres
psql (14.4, server 14.4)
Type "help" for help.
postgres=# select version();
version
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
PostgreSQL 14.4 (Cloudberry Database 1.0.0+1c0d6e2224 build dev) on x86_64( GCC 13.2.0) 13.2.0, 64-bit compiled on Sep 22 2023 10:56:01
(1 row)
postgres=# select * from gp_segment_configuration;
dbid | content | role | preferred_role | mode | status | port | hostname | address | datadir | warehouseid
------+---------+------+----------------+------+--------+------+------------+------------+------------------------------------------------------------------------------+-------------
1 | -1 | p | p | n | u | 7000 | i-6wvpa9wt | i-6wvpa9wt | /home/gpadmin/cloudberrydb/gpAux/gpdemo/datadirs/qddir/demoDataDir-1 | 0
8 | -1 | m | m | s | u | 7001 | i-6wvpa9wt | i-6wvpa9wt | /home/gpadmin/cloudberrydb/gpAux/gpdemo/datadirs/standby | 0
3 | 1 | p | p | s | u | 7003 | i-6wvpa9wt | i-6wvpa9wt | /home/gpadmin/cloudberrydb/gpAux/gpdemo/datadirs/dbfast2/demoDataDir1 | 0
6 | 1 | m | m | s | u | 7006 | i-6wvpa9wt | i-6wvpa9wt | /home/gpadmin/cloudberrydb/gpAux/gpdemo/datadirs/dbfast_mirror2/demoDataDir1 | 0
2 | 0 | p | p | s | u | 7002 | i-6wvpa9wt | i-6wvpa9wt | /home/gpadmin/cloudberrydb/gpAux/gpdemo/datadirs/dbfast1/demoDataDir0 | 0
5 | 0 | m | m | s | u | 7005 | i-6wvpa9wt | i-6wvpa9wt | /home/gpadmin/cloudberrydb/gpAux/gpdemo/datadirs/dbfast_mirror1/demoDataDir0 | 0
4 | 2 | p | p | s | u | 7004 | i-6wvpa9wt | i-6wvpa9wt | /home/gpadmin/cloudberrydb/gpAux/gpdemo/datadirs/dbfast3/demoDataDir2 | 0
7 | 2 | m | m | s | u | 7007 | i-6wvpa9wt | i-6wvpa9wt | /home/gpadmin/cloudberrydb/gpAux/gpdemo/datadirs/dbfast_mirror3/demoDataDir2 | 0
(8 rows)
```
2 changes: 1 addition & 1 deletion docs/cbdb-macos-compile.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: On macOS
# Compile and Install Cloudberry Database on macOS

:::info
The source of this document is from [the document](https://github.com/cloudberrydb/cloudberrydb/blob/main/readmes/README.macOS.md) in the GitHub repository `cloudberrydb/cloudberrydb`.
The source of this document is from the GitHub repository [`cloudberrydb/cloudberrydb`](https://github.com/cloudberrydb/cloudberrydb/blob/main/readmes/README.macOS.md).
:::

This document shares how to build, compile, and install Cloudberry Database on macOS (single node) for development and trial purposes. Follow the steps below.
Expand Down
Loading

0 comments on commit 4f012df

Please sign in to comment.