Natively Connect to AlloyDB Data in PHP

Drop the CData ODBC Driver for AlloyDB into your LAMP or WAMP stack to build AlloyDB-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to AlloyDB data, execute queries, and output the results.

Configure a DSN

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.

Establish a Connection

Open the connection to AlloyDB by calling the or methods. To close connections, use or .

$conn = odbc_connect("CData ODBC AlloyDB Source","user","password");

Connections opened with are closed when the script ends. Connections opened with the method are still open after the script ends. This enables other scripts to share that connection when they connect with the same credentials. By sharing connections among your scripts, you can save system resources, and queries execute faster.

$conn = odbc_pconnect("CData ODBC AlloyDB Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the function.

$query = odbc_prepare($conn, "SELECT * FROM Orders WHERE ShipCountry = ?");

Execute Queries

Execute prepared statements with .

$conn = odbc_connect("CData ODBC AlloyDB Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Orders WHERE ShipCountry = ?");
$success = odbc_execute($query, array('USA'));
 

Execute nonparameterized queries with .

$conn = odbc_connect("CData ODBC AlloyDB Source","user","password");
$query = odbc_exec($conn, "SELECT ShipName, ShipCity FROM Orders WHERE ShipCountry = 'USA'");
 

Process Results

Access a row in the result set as an array with the function.

$conn = odbc_connect("CData ODBC AlloyDB data Source","user","password");
$query = odbc_exec($conn, "SELECT ShipName, ShipCity FROM Orders WHERE ShipCountry = 'USA'");
while($row = odbc_fetch_array($query)){
 echo $row["ShipName"] . "\n";
}

Display the result set in an HTML table with the function.

$conn = odbc_connect("CData ODBC AlloyDB data Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Orders WHERE ShipCountry = ?");
$success = odbc_execute($query, array('USA'));
if($success)
 odbc_result_all($query);

More Example Queries

You will find complete information on the driver's supported SQL in the help documentation. The code examples above are AlloyDB-specific adaptations of the PHP community documentation for all ODBC functions.