Natively Connect to HubDB Data in PHP

Drop the CData ODBC Driver for HubDB into your LAMP or WAMP stack to build HubDB-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to HubDB 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.

There are two authentication methods available for connecting to HubDB data source: OAuth Authentication with a public HubSpot application and authentication with a Private application token.

Using a Custom OAuth App

AuthScheme must be set to "OAuth" in all OAuth flows. Be sure to review the Help documentation for the required connection properties for you specific authentication needs (desktop applications, web applications, and headless machines).

Follow the steps below to register an application and obtain the OAuth client credentials:

1. Log into your HubSpot app developer account.
   • Note that it must be an app developer account. Standard HubSpot accounts cannot create public apps.
2. On the developer account home page, click the Apps tab.
3. Click Create app.
4. On the App info tab, enter and optionally modify values that are displayed to users when they connect. These values include the public application name, application logo, and a description of the application.
5. On the Auth tab, supply a callback URL in the "Redirect URLs" box.
   • If you're creating a desktop application, set this to a locally accessible URL like http://localhost:33333.
   • If you are creating a Web application, set this to a trusted URL where you want users to be redirected to when they authorize your application.
6. Click Create App. HubSpot then generates the application, along with its associated credentials.
7. On the Auth tab, note the Client ID and Client secret. You will use these later to configure the driver.

8. Under Scopes, select any scopes you need for your application's intended functionality.

   A minimum of the following scopes is required to access tables:

   • hubdb
   • oauth
   • crm.objects.owners.read
9. Click Save changes.
10. Install the application into a production portal with access to the features that are required by the integration.
    • Under "Install URL (OAuth)", click Copy full URL to copy the installation URL for your application.
    • Navigate to the copied link in your browser. Select a standard account in which to install the application.
    • Click Connect app. You can close the resulting tab.

Using a Private App

To connect using a HubSpot private application token, set the AuthScheme property to "PrivateApp."

You can generate a private application token by following the steps below:

1. In your HubDB account, click the settings icon (the gear) in the main navigation bar.
2. In the left sidebar menu, navigate to Integrations > Private Apps.
3. Click Create private app.
4. On the Basic Info tab, configure the details of your application (name, logo, and description).
5. On the Scopes tab, select Read or Write for each scope you want your private application to be able to access.
6. A minimum of hubdb and crm.objects.owners.read is required to access tables.
7. After you are done configuring your application, click Create app in the top right.
8. Review the info about your application's access token, click Continue creating, and then Show token.
9. Click Copy to copy the private application token.

To connect, set PrivateAppToken to the private application token you retrieved.

Establish a Connection

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

$conn = odbc_connect("CData ODBC HubDB 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 HubDB 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 NorthwindProducts WHERE Id = ?");

Execute Queries

Execute prepared statements with .

$conn = odbc_connect("CData ODBC HubDB Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM NorthwindProducts WHERE Id = ?");
$success = odbc_execute($query, array('1'));
 

Execute nonparameterized queries with .

$conn = odbc_connect("CData ODBC HubDB Source","user","password");
$query = odbc_exec($conn, "SELECT PartitionKey, Name FROM NorthwindProducts WHERE Id = '1'");
 

Process Results

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

$conn = odbc_connect("CData ODBC HubDB data Source","user","password");
$query = odbc_exec($conn, "SELECT PartitionKey, Name FROM NorthwindProducts WHERE Id = '1'");
while($row = odbc_fetch_array($query)){
 echo $row["PartitionKey"] . "\n";
}

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

$conn = odbc_connect("CData ODBC HubDB data Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM NorthwindProducts WHERE Id = ?");
$success = odbc_execute($query, array('1'));
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 HubDB-specific adaptations of the PHP community documentation for all ODBC functions.