Skip to main content Skip to complementary content

Create an Apache Phoenix connection

To access your data stored on an Apache Phoenix database, you will need to know the server and database name that you want to connect to, and you must have access credentials. Once you have created a connection to an Apache Phoenix database, you can select data from the available tables and then load that data into your app or document.

In Qlik Sense, you connect to an Apache Phoenix database through the Add data dialog or the Data load editor.

In QlikView you connect to an Apache Phoenix database through the Edit Script dialog.

Setting up the database properties

Database properties that can be configured
Field Description Required
Host name Host name to identify the location of the Apache Phoenix database. yes
Port Server port for the Apache Phoenix database. yes
HTTP Path

The partial URL corresponding to the Apache Phoenix database.

The connector forms the HTTP address to connect to by appending the HTTP Path value to the host and port values. For example, to connect to the HTTP address http://localhost:8765/gateway/sandbox/phoenix/version, you would set HTTP Path to /gateway/sandbox/phoenix/version.

yes

Authenticating the driver

Qlik Sense: Apache Phoenix authentication properties

Authentication properties that can be configured
Property Description
Mechanism The authentication method can be No Authentication or User Name And Password. Selecting User Name And Password gives you the option to set up Account properties.
Username User name for the Apache Phoenix connection. Required if User Name And Password mechanism is selected.
Password Password for the Apache Phoenix connection. Required if User Name And Password mechanism is selected.
Name

Name of the Apache Phoenix connection. The default name will be used if you do not enter a name.

QlikView: Apache Phoenix authentication properties

Authentication properties that can be configured
Property Description
Mechanism The authentication method can be No Authentication or User Name And Password.
Username User name for the Apache Phoenix connection. Required if User Name And Password mechanism is selected.
Password Password for the Apache Phoenix connection. Required if User Name And Password mechanism is selected.

Account properties

Credentials

Credentials are used to prove that a user is allowed to access the data in a connection.

There are two types of credentials that can be used when making a connection in Qlik Sense SaaS. If you leave the User defined credentials check box deselected, then only one set of credentials will be used for the connection. These credentials belong to the connection and will be used by anyone who can access it. For example, if the connection is in a shared space, every user in the space will be able to use these credentials. This one-to-one mapping is the default setting.

If you select User defined credentials, then every user who wants to access this connection will need to input their own credentials before selecting tables or loading data. These credentials belong to a user, not a connection. User defined credentials can be saved and used in multiple connections of the same connector type.

In the Data load editor, you can click the Primary key underneath the connection to edit your credentials. In the hub or Data manager, you can edit credentials by right-clicking on the connection and selecting Edit Credentials.

See which authentication type applies on each connector's page.

Account properties that can be configured
Account property Description
User defined credentials Select this check box if you want users that access this connection to have to input their own credentials. Deselect this check box if credentials can be shared with anyone who has access to this connection.
New credentials Drop-down menu item that appears if User defined credentials is selected.
Existing credentials Drop-down menu item that appears if User defined credentials is selected.
User User name for the connection.
Password Password for the connection.
Credentials name Name given to a set of user defined credentials.

Setting SSL options

SSL options that can be configured
Property Description Required
Enable SSL Require SSL authentication on the connection the Apache Phoenix server. No
Use System Trust Store Use the SSL certificate located in the standard system location used for storing trusted certificates. Yes, if certificate is stored in the standard system location. Available only when SSL is enabled.
Trusted Certificate The full path to the SSL certificate if it is not stored in the standard system location. No. Available only when SSL is enabled.
Allow Self-signed Server Certificate Accept an SSL certificate from the server that is self-signed and not verified by a trusted authority. No. Available only when SSL is enabled.
Allow Common Name Host Name Mismatch Allow a mismatch between the SSL certificate's common name and the name provided in Host name field. No

Miscellaneous properties

Miscellaneous properties and options that can be configured
Property Description
Query timeout Amount of time before a data load query times out. Can be set from 30 seconds to 65535 seconds. Default is 30 seconds.

Load optimization settings

Load properties that can be configured
Property Description Required
Max String Length

Maximum length of string fields. This can be set from 256 to 16384 characters. The default value is 4096. Setting this value close to the maximum length may improve load times, as it limits the need to allocate unnecessary resources. If a string is longer than the set value, it will be truncated, and the exceeding characters will not be loaded.

No

Advanced options

Information noteThis section is for advanced users who want to add their own custom connection parameters that are not displayed above.
Advanced options that can be configured
Property Description Required

Name

Name of the custom property. You can add additional properties by clicking the Plus sign icon.

No
Value

Value of the property.

No
Information noteWhen you connect to an Apache Phoenix database with the Data load editor or the Edit Script dialog, Test Connection enables you to test the connection before you attempt to create it.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!