Phoenix Connection
See the Connector Marketplace topic. Please request your administrator to start a trial or subscribe to the Premium Phoenix connector.
Apache Phoenix is a powerful open-source relational database engine, enables seamless SQL access to Apache HBase, emphasizing speed and scalability for big data processing.
This topic describes how to authenticate to Phoenix and configure any necessary connection properties in the Phoenix connection connector.
Connection Configuration
Each connection property available in the Phoenix connector is explained below.
Connection Name
The name of the connection to be created should be provided. This is the name that will display on the list of available connections.
Auth Scheme
The type of authentication to use when connecting to Phoenix.
None: No authentication is performed.
Basic: Basic authentication is performed. Properties User and Password need to be set to perform Basic authentication.
AzureHDInsight: If AuthScheme is set to AzureHDInsight, connection will be made to Azure HDInsight. Properties User, Password, and ClusterName need to be set for this to work.
URL
The URL to your Apache Phoenix instance.
This property overrides the Server/Port/UseSSL connection properties.
For example, http://localhost:8765.
Server Configurations
A list of server configuration variables to override the server defaults.
This property takes a comma-separated list of Apache Phoenix configuration variables. Each value in the comma-separated list will be sent as specified to override the server default values.
Example: phoenix.stats.updateFrequency=30000,phoenix.query.maxGlobalMemoryPercentage=30
Enable Schemas
Set to true if the Apache Phoenix instance you are authenticating against supports multiple schemas.
Schema
The schema which will be used by default.
The property ‘phoenix.schema.isNamespaceMappingEnabled’ must be enabled on the server for this to work. Once the property is enabled, all queries will be run against this schema.
Version
The version of the Apache Phoenix instance.
Impersonation User
The user to impersonate while sending requests to the Phoenix Query Server.
User
The Apache Phoenix user account used to authenticate.
Password
The password used to authenticate the user.
Cluster Name
The name of the cluster containing your Azure HDInsight instance.
Enable SSL
Option to enable SSL. This field sets whether the connector will attempt to negotiate TLS/SSL connections to the server. By default, the connector checks the server’s certificate against the system’s trusted certificate store.
SSL Client Certificate
The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
The name of the certificate store for the client certificate.
If the store is password protected, specify the password in the SSL Client Cert Password field.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
| Certificate Designation | Description |
|---|---|
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
| SPC | Software publisher certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file.
When the type is PFXBlob, the property must be set to the binary contents of a PFX file (for example, PKCS12 certificate store).
SSL Client Cert Type
The type of key store containing the TLS/SSL client certificate.
This property can be set to one of the following values:
| Property Value | Description |
|---|---|
| USER - default | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note that this store type is not available in Java. |
| MACHINE | For Windows, this specifies that the certificate store is a machine store. Note that this store type is not available in Java. |
| PFXFILE | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
| PFXBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
| JKSFILE | The certificate store is the name of a Java key store (JKS) file containing certificates. Note that this store type is only available in Java. |
| JKSBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in JKS format. Note that this store type is only available in Java. |
| PEMKEY_FILE | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| PEMKEY_BLOB | The certificate store is a string (base64-encoded) that contains a private key and an optional certificate. |
| PUBLIC_KEY_FILE | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| PUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| SSHPUBLIC_KEY_FILE | The certificate store is the name of a file that contains an SSH-style public key. |
| SSHPUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains an SSH-style public key. |
| P7BFILE | The certificate store is the name of a PKCS7 file containing certificates. |
| PPKFILE | The certificate store is the name of a file that contains a PuTTY Private Key (PPK). |
| XMLFILE | The certificate store is the name of a file that contains a certificate in XML format. |
| XMLBLOB | The certificate store is a string that contains a certificate in XML format. |
SSL Client Cert Password
If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.
SSL Client Cert Subject
The subject of the TLS/SSL client certificate.
When loading a certificate the subject is used to locate the certificate in the store.
If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value “*” picks the first certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For example, “CN=www.server.com, OU=test, C=US, E=support@company.com”.
The common fields and their meanings are shown below.
| Field | Meaning |
|---|---|
| CN | Common Name. This is commonly a host name like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
Upload Keystore File
If SSL is enabled, a keystore file has to be uploaded using this option.
Add Configuration: Additional properties can be added using this option as key-value pairs.
After entering all the details, click on the TEST button.
If the connection service identification and authentication details are provided correctly, a success message stating “connection available” is generated.
Click on the CREATE button to save the changes.
If the details are incorrect or the server is down, you will get a message “Connection unavailable”.
If you have any feedback on Gathr documentation, please email us!