Ready to get started?

Download a free trial of the AlloyDB ODBC Driver to get started:

 Download Now

Learn more:

AlloyDB Icon AlloyDB ODBC Driver

The AlloyDB ODBC Driver is a powerful tool that allows you to connect with live data from AlloyDB, directly from any applications that support ODBC connectivity.

Access AlloyDB data like you would a database - read, write, and update AlloyDB 0, etc. through a standard ODBC Driver interface.

Build Dashboards with AlloyDB Data in DBxtra



Create dynamic dashboards and perform analytics based on AlloyDB data in DBxtra.

The CData ODBC Driver for AlloyDB enables access to live data from AlloyDB under the ODBC standard, allowing you work with AlloyDB data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to connect to AlloyDB data as a generic ODBC Data Provider and create charts, reports, and dashboards based on AlloyDB data in DBxtra.

Connect to AlloyDB Data

  1. If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can configure the DSN using the built-in Microsoft ODBC Data Source Administrator. This is also the last step of the driver installation. See the "Getting Started" chapter in the Help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

    The following connection properties are usually required in order to connect to AlloyDB.

    • Server: The host name or IP of the server hosting the AlloyDB database.
    • User: The user which will be used to authenticate with the AlloyDB server.
    • Password: The password which will be used to authenticate with the AlloyDB server.

    You can also optionally set the following:

    • Database: The database to connect to when connecting to the AlloyDB Server. If this is not set, the user's default database will be used.
    • Port: The port of the server hosting the AlloyDB database. This property is set to 5432 by default.

    Authenticating with Standard Authentication

    Standard authentication (using the user/password combination supplied earlier) is the default form of authentication.

    No further action is required to leverage Standard Authentication to connect.

    Authenticating with pg_hba.conf Auth Schemes

    There are additional methods of authentication available which must be enabled in the pg_hba.conf file on the AlloyDB server.

    Find instructions about authentication setup on the AlloyDB Server here.

    Authenticating with MD5 Authentication

    This authentication method must be enabled by setting the auth-method in the pg_hba.conf file to md5.

    Authenticating with SASL Authentication

    This authentication method must be enabled by setting the auth-method in the pg_hba.conf file to scram-sha-256.

    Authenticating with Kerberos

    The authentication with Kerberos is initiated by AlloyDB Server when the ∏ is trying to connect to it. You should set up Kerberos on the AlloyDB Server to activate this authentication method. Once you have Kerberos authentication set up on the AlloyDB Server, see the Kerberos section of the help documentation for details on how to authenticate with Kerberos.

    When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

  2. Open the DBxtra application and in the New menu click Project and name the Project.
  3. Select ODBC Connection as the Data Connection Type.
  4. Click the browse option () for the Data Source.
  5. In the Data Link Properties window, select Microsoft OLE DB Provider for ODBC Drivers on the Provider tab.
  6. On the Connection tab, select the Data Source Name and the initial catalog to use (CData).
  7. Name the Connection and select the appropriate User Groups.
  8. Double-click the Connection from within the Project to connect to the data.

Create a Dashboard with AlloyDB Data

You are now ready to create a dashboard with AlloyDB data.

  1. Right-click Report Objects under the Project and select New Report Object.
  2. In the new Report Object, click the link to create the Query.
  3. In the Select Data Connection window, select the newly created data connection.
  4. On the Query tab, expand the connection objects and select the Tables, Views, and specific columns you wish to include in your dashboard. You can specify search requirements and even create complex queries which include JOINs and aggregations.
  5. On the Dashboard tab, select the visualizations and features for your dashboard. Assign the data values from the query to the appropriate fields for the Dashboards items (Values, Series, etc.)

With a new Dashboard created, you are ready to begin analysis of AlloyDB data. Thanks to the ODBC Driver for AlloyDB, you can refresh the Dashboard and immediately see any changes made at the source. In the same way, you can create and view Reports with live, up-to-date AlloyDB data.