readmes

Build Cloudberry Database from Source Code

This guides describes how to build Cloudberry Database from source code.

• For building on Linux systems, see Compile and Install Cloudberry Database on Linux.
• For building on macOS system, see Compile and Install Cloudberry Database on macOS.

Build the database

# Configure build environment to install at /usr/local/cloudberrydb
./configure --with-perl --with-python --with-libxml --with-gssapi --prefix=/usr/local/cloudberrydb

# Compile and install
make -j8
make -j8 install

# Bring in greenplum environment for CBDB into your running shell
source /usr/local/cloudberrydb/greenplum_path.sh

# Start demo cluster
make create-demo-cluster
# (gpdemo-env.sh contains __PGPORT__ and __MASTER_DATA_DIRECTORY__ values)
source gpAux/gpdemo/gpdemo-env.sh

• The directory and the TCP ports for the demo cluster can be changed on the fly. Instead of make cluster, consider:

DATADIRS=/tmp/cbdb-cluster PORT_BASE=5555 make cluster

• The TCP port for the regression test can be changed on the fly:

PGPORT=5555 make installcheck-world

• To turn GPORCA off and use Postgres planner for query optimization:

set optimizer=off;

• If you want to clean all generated files

make distclean

Running tests

• The default regression tests

make installcheck-world

• The top-level target installcheck-world will run all regression tests in CBDB against the running cluster. For testing individual parts, the respective targets can be run separately.

• The PostgreSQL check target does not work. Setting up a Cloudberry Database cluster is more complicated than a single-node PostgreSQL installation, and no-one's done the work to have make check create a cluster. Create a cluster manually or use gpAux/gpdemo/ (example below) and run the toplevel make installcheck-world against that. Patches are welcome!

• The PostgreSQL installcheck target does not work either, because some tests are known to fail with Cloudberry Database. The installcheck-good schedule in src/test/regress excludes those tests.

• When adding a new test, please add it to one of the CBDB-specific tests, in greenplum_schedule, rather than the PostgreSQL tests inherited from the upstream. We try to keep the upstream tests identical to the upstream versions, to make merging with newer PostgreSQL releases easier.

Alternative Configurations

Building Cloudberry Database without GPORCA

Currently, CBDB is built with GPORCA by default. If you want to build CBDB without GPORCA, configure requires --disable-orca flag to be set.

# Clean environment
make distclean

# Configure build environment to install at /usr/local/cloudberrydb
./configure --disable-orca --with-perl --with-python --with-libxml --prefix=/usr/local/cloudberrydb

Building Cloudberry Database with PXF

PXF is an extension framework for Greenplum Database/Cloudberry Database to enable fast access to external Hadoop datasets. Refer to PXF extension for more information.

Currently, CBDB is built with PXF by default (--enable-pxf is on). In order to build CBDB without pxf, simply invoke ./configure with additional option --disable-pxf. PXF requires curl, so --enable-pxf is not compatible with the --without-libcurl option.

Building Cloudberry Database with Python3 enabled

Cloudberry Database supports Python3 with plpython3u UDF

See how to enable Python3 for details.

Development with Vagrant

There is a Vagrant-based quickstart guide for developers.