Learn more
 

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.

In this article

Related articles

DataBind Controls to AlloyDB Data in C++Builder


DataBind to AlloyDB data in C++Builder with standard components and controls.

The CData ODBC Driver for AlloyDB makes it easy to integrate connectivity to live AlloyDB data with standard data access components in C++Builder. This article shows how to create a simple visual component library (VCL) application in C++Builder that connects to AlloyDB data, executes queries, and displays the results in a grid. An additional section shows how to use FireDAC components to execute commands from code.

Create a Connection to AlloyDB Data

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

You can then follow the steps below to use the Data Explorer to create a FireDAC connection to AlloyDB.

  1. In a new VCL Forms application, expand the FireDAC node in the Data Explorer.
  2. Right-click the ODBC Data Source node in the Data Explorer.
  3. Click Add New Connection.
  4. Enter a name for the connection.
  5. In the FireDAC Connection Editor that appears, set the DataSource property to the name of the ODBC DSN for AlloyDB.

Create VCL Applications with Connectivity to AlloyDB Data

Follow the procedure below to start querying AlloyDB data from a simple VCL application that displays the results of a query in a grid.

  1. Drop a TFDConnection component onto the form and set the following properties:

    • ConnectionDefName: Select the FireDAC connection to AlloyDB.
    • Connected: Select True from the menu and, in the dialog that appears, enter your credentials.

  2. Drop a TFDQuery component onto the form and set the properties below:

    • Connection: Set this property to the TFDConnection component, if this component is not already specified.

    • SQL: Click the button in the SQL property and enter a query. For example:

      SELECT ShipName, ShipCity FROM Orders WHERE ShipCountry = 'USA'
    • Active: Set this property to true.

  3. Drop a TDataSource component onto the form and set the following property:

    • DataSet: In the menu for this property, select the name of the TFDQuery component.

  4. Drop a TDBGrid control onto the form and set the following property:

    • DataSource: Select the name of the TDataSource.
  5. Drop a TFDGUIxWaitCursor onto the form — this is required to avoid a run-time error.

Execute Commands to AlloyDB with FireDAC Components

You can use the TFDConnection and TFQuery components to execute queries to AlloyDB data. This section provides AlloyDB-specific examples of executing queries with the TFQuery component.

Connect to AlloyDB Data

To connect to the data source, set the Connected property of the TFDConnection component to true. You can set the same properties from code:

FDConnection1->ConnectionDefName = "CData AlloyDB ODBC Source"; FDConnection1->Connected = true;

To connect the TFDQuery component to AlloyDB data, set the Connection property of the component. When a TFDQuery component is added at design time, its Connection property is automatically set to point to a TFDConnection on the form, as in the application above.

Create Parameterized Queries

To create a parameterized query, use the following syntax below:

FDQuery1->SQL->Text = "select * from Orders where shipcountry = :ShipCountry"; FDQuery1->ParamByName("shipcountry")->AsString = "USA"; query->Open();

The example above binds a string-type input parameter by name and then opens the dataset that results.

Prepare the Statement

Preparing statements is costly in system resources and time. The connection must be active and open while a statement is prepared. By default, FireDAC prepares the query to avoid recompiling the same query over and over. To disable statement preparation, set ResourceOptions.DirectExecute to True; for example, when you need to execute a query only once.

Execute a Query

To execute a query that returns a result set, such as a select query, use the Open method. The Open method executes the query, returns the result set, and opens it. The Open method will return an error if the query does not produce a result set.

FDQuery1->SQL->Text := "select * from Orders where shipcountry = :ShipCountry"; FDQuery1.ParamByName("shipcountry")->AsString = "USA"; FDQuery1->Open();

To execute a query that does not return a result set, use the ExecSQL method. The ExecSQL method will return an error if the query returns a result set. To retrieve the count of affected rows use the TFD.RowsAffected property.

FDQ.SQL.Text := "delete from Orders where Id = :Id"; FDQuery1->Params->Items[0]->AsString = "x12345"; FDQuery1->ExecSQL(); AnsiString i = FDQuery1->RowsAffected;