Phoenix connector#

The Phoenix connector allows querying data stored in Apache HBase using Apache Phoenix.

Requirements#

To query HBase data through Phoenix, you need:

Network access from the Trino coordinator and workers to the ZooKeeper servers. The default port is 2181.
A compatible version of Phoenix. There are two versions of this connector to support different Phoenix versions:
- The phoenix connector is compatible with all Phoenix 4.x versions starting from 4.14.1.
- The phoenix5 connector is compatible with all Phoenix 5.x versions starting from 5.1.0.

Configuration#

To configure the Phoenix connector, create a catalog properties file etc/catalog/phoenix.properties with the following contents, replacing host1,host2,host3 with a comma-separated list of the ZooKeeper nodes used for discovery of the HBase cluster:

connector.name=phoenix
phoenix.connection-url=jdbc:phoenix:host1,host2,host3:2181:/hbase
phoenix.config.resources=/path/to/hbase-site.xml

The optional paths to Hadoop resource files, such as hbase-site.xml are used to load custom Phoenix client connection properties.

For HBase 2.x and Phoenix 5.x (5.1.0 or later) use:

connector.name=phoenix5

The following Phoenix-specific configuration properties are available:

Property Name	Required	Description
`phoenix.connection-url`	Yes	`jdbc:phoenix[:zk_quorum][:zk_port][:zk_hbase_path]`. The `zk_quorum` is a comma separated list of ZooKeeper servers. The `zk_port` is the ZooKeeper port. The `zk_hbase_path` is the HBase root znode path, that is configurable using `hbase-site.xml`. By default the location is `/hbase`
`phoenix.config.resources`	No	Comma-separated list of configuration files (e.g. `hbase-site.xml`) to use for connection properties. These files must exist on the machines running Trino.

General configuration properties#

The following table describes general configuration properties for the connector:

Property name	Description	Default value
`case-insensitive-name-matching`	Match schema and table names case insensitively	False
`case-insensitive-name-matching.cache-ttl`		1 minute
`metadata.cache-ttl`	Duration for which metadata, including table and column statistics, is cached	0 (disabled caching)
`metadata.cache-missing`	Cache the fact that metadata, including table and column statistics, is not available	False
`metadata.cache-maximum-size`	Maximum number of objects stored in the metadata cache	10000
`write.batch-size`	Maximum number of statements in a batched execution. Do not change this setting from the default. Non-default values may negatively impact performance.	1000
`join-pushdown.enabled`	Enable join pushdown. Equivalent catalog session property is `join_pushdown_enabled`. Enabling this may negatively impact performance for some queries.	False

Non-transactional INSERT#

The connector supports adding rows using INSERT statements. By default, data insertion is performed by writing data to a temporary table. You can skip this step to improve performance and write directly to the target table. Set the insert.non-transactional-insert.enabled catalog property or the corresponding non_transactional_insert catalog session property to true.

Note that with this property enabled, data can be corrupted in rare cases where exceptions occur during the insert operation. With transactions disabled, no rollback can be performed.

Querying Phoenix tables#

The default empty schema in Phoenix maps to a schema named default in Trino. You can see the available Phoenix schemas by running SHOW SCHEMAS:

SHOW SCHEMAS FROM phoenix;

If you have a Phoenix schema named web, you can view the tables in this schema by running SHOW TABLES:

SHOW TABLES FROM phoenix.web;

You can see a list of the columns in the clicks table in the web schema using either of the following:

DESCRIBE phoenix.web.clicks;
SHOW COLUMNS FROM phoenix.web.clicks;

Finally, you can access the clicks table in the web schema:

SELECT * FROM phoenix.web.clicks;

If you used a different name for your catalog properties file, use that catalog name instead of phoenix in the above examples.

Type mapping#

The data type mappings are as follows:

Phoenix	Trino
`BOOLEAN`	(same)
`BIGINT`	(same)
`INTEGER`	(same)
`SMALLINT`	(same)
`TINYINT`	(same)
`DOUBLE`	(same)
`FLOAT`	`REAL`
`DECIMAL`	(same)
`BINARY`	`VARBINARY`
`VARBINARY`	(same)
`DATE`	(same)
`TIME`	(same)
`VARCHAR`	(same)
`CHAR`	(same)

The Phoenix fixed length BINARY data type is mapped to the Trino variable length VARBINARY data type. There is no way to create a Phoenix table in Trino that uses the BINARY data type, as Trino does not have an equivalent type.

General configuration properties#

The following properties can be used to configure how data types from the connected data source are mapped to Trino data types and how the metadata is cached in Trino.

Property name

Description

Default value

unsupported-type-handling

Configure how unsupported column data types are handled:

IGNORE, column is not accessible.
CONVERT_TO_VARCHAR, column is converted to unbounded VARCHAR.

The respective catalog session property is unsupported_type_handling.

IGNORE

jdbc-types-mapped-to-varchar

Allow forced mapping of comma separated lists of data types to convert to unbounded VARCHAR

Table properties - Phoenix#

Table property usage example:

CREATE TABLE myschema.scientists (
  recordkey VARCHAR,
  birthday DATE,
  name VARCHAR,
  age BIGINT
)
WITH (
  rowkeys = 'recordkey,birthday',
  salt_buckets = 10
);

The following are supported Phoenix table properties from https://phoenix.apache.org/language/index.html#options

Property Name	Default Value	Description
`rowkeys`	`ROWKEY`	Comma-separated list of primary key columns. See further description below
`split_on`	(none)	List of keys to presplit the table on. See Split Point.
`salt_buckets`	(none)	Number of salt buckets for this table.
`disable_wal`	false	Whether to disable WAL writes in HBase for this table.
`immutable_rows`	false	Declares whether this table has rows which are write-once, append-only.
`default_column_family`	`0`	Default column family name to use for this table.

`rowkeys`#

This is a comma-separated list of columns to be used as the table’s primary key. If not specified, a BIGINT primary key column named ROWKEY is generated , as well as a sequence with the same name as the table suffixed with _seq (i.e. <schema>.<table>_seq) , which is used to automatically populate the ROWKEY for each row during insertion.

Table properties - HBase#

The following are the supported HBase table properties that are passed through by Phoenix during table creation. Use them in the same way as above: in the WITH clause of the CREATE TABLE statement.

Property Name	Default Value	Description
`versions`	`1`	The maximum number of versions of each cell to keep.
`min_versions`	`0`	The minimum number of cell versions to keep.
`compression`	`NONE`	Compression algorithm to use. Valid values are `NONE` (default), `SNAPPY`, `LZO`, `LZ4`, or `GZ`.
`data_block_encoding`	`FAST_DIFF`	Block encoding algorithm to use. Valid values are: `NONE`, `PREFIX`, `DIFF`, `FAST_DIFF` (default), or `ROW_INDEX_V1`.
`ttl`	`FOREVER`	Time To Live for each cell.
`bloomfilter`	`NONE`	Bloomfilter to use. Valid values are `NONE` (default), `ROW`, or `ROWCOL`.

SQL support#

The connector provides read and write access to data and metadata in Phoenix. In addition to the globally available and read operation statements, the connector supports the following features:

SQL DELETE#

If a WHERE clause is specified, the DELETE operation only works if the predicate in the clause can be fully pushed down to the data source.

Phoenix connector#

Requirements#

Configuration#

General configuration properties#

Non-transactional INSERT#

Querying Phoenix tables#

Type mapping#

General configuration properties#

Table properties - Phoenix#

rowkeys#

Table properties - HBase#

SQL support#

SQL DELETE#

`rowkeys`#