Phoenix-Adapters provides adapters for various NoSQL databases (e.g., DynamoDB) backed by Apache Phoenix (on HBase) as the persistent store.
It can be challenging for applications/services to maintain different codebases for different substrates/cloud providers if they use the substrate-native NoSQL databases.
This is where Phoenix-Adapters comes in. It allows developers to write new services (or port their existing services with minimal code changes) using familiar NoSQL semantics while leveraging the scalability, fault-tolerance and predictable performance of Apache Phoenix/HBase.
How to use Phoenix-Adapters to port their DynamoDB based service to Apache Phoenix?
- A RESTful API Server that accepts JSON payloads similar to DynamoDB.
By using REST Service, client applications already using any AWS SDKs to connect with DynamoDB does not need to perform any code change. The client application only needs to update the REST endpoint.
- DDL:
- CreateTable
- DeleteTable
- DescribeTable
- ListTables
- UpdateTable
- UpdateTimeToLive
- DescribeTimeToLive
- DQL:
- Query
- Scan
- BatchGetItem
- GetItem
- DML:
- PutItem
- UpdateItem
- BatchWriteItem
- DeleteItem
- Change Stream:
- ListStreams
- DescribeStreams
- GetShardIterator
- GetRecords
The Phoenix DynamoDB REST service is fully compatible with AWS SDKs. You can connect to it by simply configuring the endpoint URL to point to your Phoenix REST service instead of the standard DynamoDB endpoint.
📖 For detailed examples and configuration instructions, see the Phoenix DynamoDB REST Service README
- Bring up HBase cluster locally. Refer to https://hbase.apache.org/book.html#quickstart
- Bring up Phoenix system tables using sqlline (bin/sqlline.py). Refer to https://phoenix.apache.org/installation.html.
- Clone phoenix-adapters repo.
- Build the project with:
mvn clean install -DskipTests - Start the REST Server with:
bin/phoenix-adapters rest start -p <port> -z <zk-quorum>e.g.bin/phoenix-adapters rest start -p 8842 -z localhost:2181to start the server at port 8842 with zk-quorum localhost:2181. Alternative to-z <zk-quorum>is env variableZOO_KEEPER_QUORUM.
To build a distribution tarball that includes all components:
mvn clean package
This will generate a tarball in phoenix-ddb-assembly/target/phoenix-adapters-*-bin.tar.gz
- Extract the distribution tarball:
tar xzf phoenix-adapters-<version>-bin.tar.gz
cd phoenix-adapters-<version>- Configure the environment variables in
conf/phoenix-adapters-env.sh:
export JAVA_HOME=/path/to/java
export PHOENIX_ADAPTERS_HOME=/path/to/extracted/phoenix-adaptersThe following environment variables can be configured:
JAVA_HOME: Path to Java installationPHOENIX_ADAPTERS_HOME: Path to Phoenix Adapters installationPHOENIX_ADAPTERS_CONF_DIR: Configuration directory (default: $PHOENIX_ADAPTERS_HOME/conf)PHOENIX_ADAPTERS_LOG_DIR: Log directory (default: $PHOENIX_ADAPTERS_HOME/logs)PHOENIX_ADAPTERS_PID_DIR: PID directory (default: /var/run/phoenix-adapters)PHOENIX_REST_HEAPSIZE: Maximum heap size (e.g., "2g")PHOENIX_REST_OFFHEAPSIZE: Maximum off-heap memory size (e.g., "1g")PHOENIX_REST_OPTS: Additional JVM optionsPHOENIX_DDB_REST_OPTS: Additional JVM options for REST server
Logging can be configured in conf/log4j.properties. The default configuration includes:
- Console logging
- File logging with rotation
- GC logging
- Heap dumps on OutOfMemoryError
To start the REST server as a daemon:
bin/phoenix-adapters start restTo start in foreground mode (for debugging):
bin/phoenix-adapters restTo check if the server is running:
bin/phoenix-adapters status restTo stop the server:
bin/phoenix-adapters stop restTo restart the server:
bin/phoenix-adapters restart restLogs are stored in the following locations:
- Main log:
$PHOENIX_ADAPTERS_LOG_DIR/rest.log - GC log:
$PHOENIX_ADAPTERS_LOG_DIR/gc.log - Heap dumps:
$PHOENIX_ADAPTERS_LOG_DIR/(on OutOfMemoryError)