> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sync.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Apache Phoenix

export const CommonAuthSchemeNegotiate = ({siteNameShort = "Sync", datasource = "the data source"}) => {
  return <>
      <p>To connect with Kerberos credentials, specify the following properties:</p>
      <ul>
        <li><strong>Auth Scheme:</strong> Select <strong>Negotiate</strong>.</li>
        <li><strong>Kerberos KDC:</strong> Enter the Kerberos Key Distribution Center (KDC) service that you use to authenticate.</li>
        <li><strong>Kerberos Realm:</strong> Enter the Kerberos realm that you use to authenticate.</li>
        <li><strong>Kerberos SPN:</strong> Enter the service principal name (SPN) for the Kerberos domain controller.</li>
        <li>(Optional) <strong>Kerberos Keytab File:</strong> Enter the path to the keytab file that contains your pairs of the Kerberos principals and encrypted keys.</li>
        <li>(Optional) <strong>Kerberos Ticket Cache:</strong> Enter the full path to an MIT Kerberos credential cache file. {siteNameShort} uses the specified cache file to obtain the Kerberos ticket that is required to connect to {datasource}.</li>
      </ul>
    </>;
};

export const CommonAuthSchemeBasic = ({siteName = "CData Sync", siteNameShort = "Sync", datasource = "the data source"}) => {
  return <>
      <p>To connect with your user credentials, set the following properties:</p>
      <ul>
        <li><strong>Auth Scheme:</strong> Select <strong>Basic</strong>.</li>
        <li><strong>User:</strong> Enter the username that you use to authenticate to your {datasource} account.</li>
        <li><strong>Password:</strong> Enter the password that you use to authenticate to your {datasource} account.</li>
      </ul>
    </>;
};

export const CommonAuthSchemeNone = ({siteName = "CData Sync", siteNameShort = "Sync", datasource = "the data source"}) => {
  return <>
      <p>To connect without authentication, select <strong>None</strong> for <strong>Auth Scheme</strong>. No additional properties are required.</p>
    </>;
};

export const CommonDatasourceMoreInformation = ({datasource = "the data source", advancedurl = "", siteName = "CData Sync", driverVersion = ""}) => {
  return <>
      <p>
        For more information about interactions between {siteName} and {datasource}, see{' '}
        <a href={`https://cdn.cdata.com/help/${advancedurl}${driverVersion}/synch/default.htm`}>
          {datasource} Connector for {siteName}
        </a>.
      </p>
    </>;
};

export const CommonDatasourceAddConnector = ({datasource = "the data source", title = "the connector", destination = false, siteNameShort = "Sync"}) => {
  return <>
      <p>
        To enable {siteNameShort} to use data from {datasource}, you first must add the
        connector, as follows:
      </p>
      <ol>
        <li>Open the <strong>Connections</strong> page of the {siteNameShort} dashboard.</li>
        <li>Click <strong>Add Connection</strong> to open the <strong>Select Connectors</strong> page.</li>
        <li>
          Click the <strong>{destination ? "Destinations" : "Sources"}</strong> tab and locate
          the <strong>{title}</strong> row.
        </li>
        <li>
          Click the <strong>Configure Connection</strong> icon at the end of that row to open
          the <strong>New Connection</strong> page. This action opens the{' '}
          <strong>Add Connection</strong> dialog box.
          <br />
          <strong>Note:</strong> If the <strong>Configure Connection</strong> icon is not
          available, click the <strong>Download Connector</strong> icon to install
          the {title} connector.
        </li>
        <li>Enter a name for your connection in the <strong>Add Connection</strong> dialog box.</li>
        <li>Click <strong>Add</strong> to open the <strong>Settings</strong> tab for your connector.</li>
      </ol>
      <p>
        For more information about installing new connectors, see{' '}
        <a href="../connections">Connections</a>.
      </p>
    </>;
};

export const CommonDatasourceIntroSource = ({datasource = "the data source", siteName = "CData Sync"}) => {
  return <p>
      You can use the {datasource} connector from the {siteName} application to capture data
      from {datasource} and move it to any supported destination. To do so, you need to add
      the connector, authenticate to the connector, and complete your connection.
    </p>;
};

export const driverVersion = "M";

export const siteNameShort = "Sync";

export const siteName = "CData Sync";

export const datasource = "Apache Phoenix";
export const pageTitle = "Apache Phoenix";
export const advancedurl = "UA";

<CommonDatasourceIntroSource datasource={datasource} siteName={siteName} />

## Add the Apache Phoenix Connector

<CommonDatasourceAddConnector datasource={datasource} title={pageTitle} destination={false} siteNameShort={siteNameShort} />

## Start the Apache Phoenix Query Server

Before you connect, you need to ensure that the Apache Phoenix Query Server is running. Different versions of the server contain different interfaces, different means of starting and stopping the server, and different default port settings. In most distributions, you can start the server in the background by submitting the following command:

`queryserver.py start`

This method requires that you are running an instance of Apache HBase and, possibly, Apache ZooKeeper as well. For more details, see the documentation for your server version.

## Authenticate to Apache Phoenix

After you add the connector, you need to set the required properties.

**URL:** Enter the URL to your instance of Apache Phoenix (for example, [http://localhost:8765](http://localhost:8765)).

{siteName} supports authenticating to {pageTitle} in several ways. Select your authentication method below to proceed to the relevant section that contains the authentication details.

* [**None**](#none)
* [**Basic**](#basic) (default)
* [**Negotiate**](#negotiate)
* [**Azure HDInsight**](#azure-hdinsight)

### None

<CommonAuthSchemeNone siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

### Basic

<CommonAuthSchemeBasic siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

### Negotiate

<CommonAuthSchemeNegotiate siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

### Azure HDInsight

To connect with Azure HDInsight, specify the following properties:

* **Auth Scheme:** Select **AzureHDInsight**.
* **User:** Enter the username that you use to authenticate to your {pageTitle} account.
* **Password:** Enter the password that you use to authenticate to your {pageTitle} account.
* **Cluster Name:** Enter the name of the cluster that contains your Azure HDInsight instance.

## Complete Your Connection

To complete your connection:

1. For **Version** (optional), enter the version of your Apache Phoenix instance. The default version is **4.9.0**.
2. Define advanced connection settings on the **Advanced** tab. (In most cases, though, you should not need these settings.)
3. Click **Create & Test** to create your connection.

## More Information

<CommonDatasourceMoreInformation datasource={datasource} advancedurl={advancedurl} siteName={siteName} driverVersion={driverVersion} />
