What is PolarDB for PostgreSQL?
PolarDB for PostgreSQL (PolarDB for short) is an open source database system based on PostgreSQL. It extends PostgreSQL to become a share-nothing distributed database, which supports global data consistency and ACID across database nodes, distributed SQL processing, and data redundancy and high availability through Paxos based replication. PolarDB is designed to add values and new features to PostgreSQL in dimensions of high performance, scalability, high availability, and elasticity. At the same time, PolarDB remains SQL compatibility to single-node PostgreSQL with best effort.
PolarDB will evolve and offer its functions and features in two major parts: an extension and a patch to Postgres. The extension part includes components implemented outside PostgreSQL kernel, such as distributed transaction management, global or distributed time service, distributed SQL processing, additional metadata and internal functions, and tools to manage database clusters and conduct fault tolerance or recovery. Having most of its functions in a Postgres extension, PolarDB targets easy upgrading, easy migration, and fast adoption. The patch part includes the changes necessary to the kernel, such as distributed MVCC for different isolation levels. We expect functions and codes in the patch part is limited. As a result, PolarDB can be easily upgraded with newer PostgreSQL versions and maintain full compatible to PostgreSQL.
- Quick start with PolarDB
- Architecture & Roadmap
Quick start with PolarDB
Three approaches are offered to quickly try out PolarDB: Alibaba Cloud service, deployment using Docker images, and deployment from source codes.
Alibaba Cloud Service
Deployment Using Docker Images
onekey.sh can be used to build, configure, deploy, start, and init a cluster of PolarDB.
before executing onekey.sh
- set up environment variables (LD_LIBRARY_PATH and PATH)
- install dependent packages
- set up ssh login without password
run onekey.sh script
- check running processes (leader, follower, logger), their replica roles and status:
ps -ef|grep polardb psql -p 10001 -d postgres -c "select * from pg_stat_replication;" psql -p 10001 -d postgres -c "select * from polar_dma_cluster_status;"
Deployment from Source Code
We extend a tool named as pgxc_ctl from PG-XC/PG-XL open source project to support cluster management, such as configuration generation, configuration modification, cluster initialization, starting/stopping nodes, and switchover, etc. Its detail usage can be found deployment.
- download source code
- install dependent packages (use Centos as an example)
sudo yum install libzstd-devel libzstd zstd cmake openssl-devel protobuf-devel readline-devel libxml2-devel libxslt-devel zlib-devel bzip2-devel lz4-devel snappy-devel
- set up ssh login without password Call ssh-copy-id command to configure ssh so that no password is needed when using pgxc_ctl.
ssh-copy-id [email protected]
- build and install binary
you can just call build script to build. If you get errors, please reference deployment for detail reasons.
- set up environment variables
vi ~/.bashrc export PATH="$HOME/polardb/polardbhome/bin:$PATH" export LD_LIBRARY_PATH="$HOME/polardb/polardbhome/lib:$LD_LIBRARY_PATH"ß
- generate default configure file
pgxc_ctl -c $HOME/polardb/polardb_paxos.conf prepare standalone
- deploy binary file
pgxc_ctl -c $HOME/polardb/polardb_paxos.conf deploy all
- clean residual installation and init cluster
pgxc_ctl -c $HOME/polardb/polardb_paxos.conf clean all pgxc_ctl -c $HOME/polardb/polardb_paxos.conf init all pgxc_ctl -c $HOME/polardb/polardb_paxos.conf monitor all
- install dependent packages for cluster management
pgxc_ctl -c $HOME/polardb/polardb_paxos.conf deploy cm
- start cluster or node
pgxc_ctl -c $HOME/polardb/polardb_paxos.conf start all
- stop cluster or node
pgxc_ctl -c $HOME/polardb/polardb_paxos.conf stop all
- failover datanode
datanode_1 is node name configured in polardb_paxos.conf.
pgxc_ctl -c $HOME/polardb/polardb_paxos.conf failover datanode datanode_1
- cluster health check
check cluster status and start failed node.
pgxc_ctl -c $HOME/polardb/polardb_paxos.conf healthcheck all
- example for other command
pgxc_ctl -c $HOME/polardb/polardb_paxos.conf kill all pgxc_ctl -c $HOME/polardb/polardb_paxos.conf log var datanodeNames pgxc_ctl -c $HOME/polardb/polardb_paxos.conf show configuration all
- check and test
ps -ef | grep postgres psql -p 10001 -d postgres -c "create table t1(a int primary key, b int);" createdb test -p 10001 psql -p 10001 -d test -c "select version();"
reference deployment for detail instructions.
Regress and other test details can be found here. Some benchmarking example is here
Architecture & Roadmap
PolarDB uses a share-nothing architecture. Each node stores data and also executes queries, and they coordinate with each other through message passing. The architecture allows the database to be scaled by adding more nodes to the cluster.
PolarDB slices a table into shards by hashing its primary key. The number of shards is configurable. Shards are stored in PolarDB nodes. When a query accesses shards in multiple nodes, a distributed transaction and a transaction coordinator are used to maintain ACID across nodes.
Each shard is replicated to three nodes with each replica stored on different node. In order to save costs, we can deploy two of the replicas to store complete data. The third replica only stores write ahead log (WAL), which participates in the election but cannot be chosen as the leader.
See architecture design for more information
- Architecture design
- Features and their design in PolarDB for PostgreSQL Version 1.0
PolarDB is built on open source projects, and extends open source PostgreSQL. Your contribution is welcome and appreciated. Please refer contributing for how to start coding and submit a PR.
PolarDB code is released under the Apache Version 2.0 License and the Licenses with PostgreSQL code.
The relevant licenses can be found in the comments at the top of each file.
Reference License and NOTICE for details.
Some codes and design ideas were from other open source projects, such as PG-XC/XL(pgxc_ctl), TBase (part of timestamp-based vacuum and MVCC), and Citus (pg_cron). Thanks for their contributions.
PolarDB for PostgreSQL at Slack https://app.slack.com/client/T023NM10KGE/C023VEMKS02
Copyright © Alibaba Group, Inc.