Comdb2 is a clustered RDBMS built on Optimistic Concurrency Control techniques. It provides multiple isolation levels, including Snapshot and Serializable Isolation. Read/Write transactions run on any node, with the client library transparently negotiating connections to lowest cost (latency) node which is available. The client library provides transparent reconnect.
Work on Comdb2 was started at Bloomberg LP in 2004 and it has been under heavy development since. More information about the architecture of the project can be found in our VLDB 2016 paper and for more information on usage please look in the Docs.
Comdb2 documentation is included in the docs directory.
It can be hosted locally with jekyll by running jekyll serve from the docs directory.
Please refer to our contribution guide for instructions. We welcome code and idea contributions.
On every machine in the cluster:
-
Make sure all machines in the cluster can talk to each other via ssh.
Copy keys around if needed. -
Install prerequisites:
** Ubuntu 16.04, 16.10, 17.04, Windows Subsystem for Linux (WSL) **
sudo apt-get install -y build-essential cmake bison flex libprotobuf-c-dev libreadline-dev libsqlite3-dev libssl-dev libunwind-dev libz1 libz-dev make gawk protobuf-c-compiler uuid-dev liblz4-tool liblz4-dev libprotobuf-c1 libsqlite3-0 libuuid1 libz1 tzdata ncurses-dev tcl bc** CentOS 7 **
sudo yum install -y gcc gcc-c++ cmake3 protobuf-c libunwind libunwind-devel protobuf-c-devel byacc flex openssl openssl-devel openssl-libs readline-devel sqlite sqlite-devel libuuid libuuid-devel zlib-devel zlib lz4-devel gawk tcl epel-release lz4 rpm-build which** macOS High Sierra (experimental) **
Install Xcode and Homebrew. Then install required libraries:
brew install cmake lz4 openssl protobuf-c readlineTo run tests, install following:
brew install coreutils bash export PATH="/usr/local/opt/coreutils/libexec/gnubin:$PATH"It is recommended to increase the open file limits, at least in the sessions which start pmux and server.
-
Build and Install Comdb2:
mkdir build && cd build && cmake .. && make && sudo make install -
Add /opt/bb/bin to your PATH
export PATH=$PATH:/opt/bb/bin -
Start pmux:
pmux -nNote: on WSL this needs to be run elevated, such as:
sudo /opt/bb/bin/pmux -n -
(optional) Comdb2 nodes identify each other by their hostnames. If the hostname of each node isn't resolvable from other nodes, we should tell Comdb2 the full domain name to use for the current node. Most setups won't have this issue.
Tell comdb2 our FQDN.
vi /opt/bb/etc/cdb2/config/comdb2.d/hostname.lrl add current machine's name, e.g. hostname machine-1.comdb2.example.com
-
On one machine (say machine-1), create a database - this example creates a database called testdb stored in ~/db.
comdb2 --create --dir ~/db testdbNote: the
--dir PATHparameter is optional, and if it is omitted comdb2 uses a default root of /opt/bb/var/cdb2/ for creating a database directory to contain the database files, which is named as per the database name parameter; hence in this case /opt/bb/var/cdb2/testdb.
The default root will have to be created explicitly with the desired permissions before invokingcomdb2 --createfor a database.
In this quick start, we use the home directory to avoid obfuscating the key steps of the process. -
Configure the nodes in the cluster:
vi ~/db/testdb.lrl add cluster nodes machine-1.comdb2.example.com machine-2.comdb2.example.com -
On other nodes, copy the database over:
copycomdb2 mptest-1.comdb2.example.com:${HOME}/db/testdb.lrl -
On all nodes, start the database.
comdb2 --lrl ~/db/testdb.lrl testdbAll nodes will say 'I AM READY.' when ready.
Note: the log dir comdb2 uses by default is /opt/bb/var/log/cdb2/ If this directory does not have permissions allowing the user to create file, there will be diagnostics output such as:
[ERROR] error opening '/opt/bb/var/log/cdb2/testdb.longreqs' for logging: 13 Permission denied
This condition will not impact operation of the database for the purposes of this quick start.
-
On any node, start using the database. You don't have any tables yet. You can add them with cdb2sql Example -
cdb2sql testdb local 'CREATE TABLE t1 { schema { int a } }'
Database can be queried/updated with cdb2sql:
cdb2sql testdb local 'insert into t1(a) values(1)' (rows inserted=1) cdb2sql testdb local 'select * from t1' (a=1)
| Directory | Description |
|---|---|
| bb/ | Useful generic modules |
| bbinc/ | Header & Generic include files |
| bdb/ | Table layer |
| berkdb/ | Btrees layer |
| cdb2api/ | Client code |
| cdb2jdbc/ | JDBC driver |
| comdb2rle/ | Run length encoding |
| comdb2tests/ | Contains all the tests that will be run for this version |
| config/ | lrl config files |
| contrib/ | Misc useful programs that aren't part of core Comdb2 |
| crc32c/ | Checksum component |
| csc2/ | csc2 processing |
| csc2files/ | csc2 config files |
| cson/ | JSON library |
| datetime/ | Datetime component |
| db/ | Types layer and overall glue |
| deb/ | Sample debian package config |
| dfp/ | Decimal number component |
| dlmalloc/ | Local malloc version |
| docs/ | Documentation |
| lua/ | All things pertaining to lua VM used for stored procedures |
| net/ | Network component |
| protobuf/ | API to communicate with the server |
| schemachange | Code for table create/alter/truncate/etc |
| sqlite/ | Sqlite VM SQL engine |
| tests/ | Comdb2 test suite |
| tools/ | Tools that are part of Comdb2 core |