Connect to Live API Data in PostGresSQL Interface through CData Connect AI

There are a vast number of PostgreSQL clients available on the Internet. PostgreSQL is a popular interface for data access. When you pair PostgreSQL with CData Connect AI, you gain database-like access to live API data from PostgreSQL. In this article, we walk through the process of connecting to API data in Connect AI and establishing a connection between Connect AI and PostgreSQL using a TDS foreign data wrapper (FDW).

CData Connect AI provides a pure SQL Server interface for API, allowing you to query data from API without replicating the data to a natively supported database. Using optimized data processing out of the box, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc.) directly to API, leveraging server-side processing to return the requested API data quickly.

Connect to API in Connect AI

CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.

1. Log into Connect AI, click Sources, and then click Add Connection
👁 Adding a Connection

2. Select "API" from the Add Connection panel
👁 Selecting a data source

3. Enter the necessary authentication properties to connect to your API.

   To connect to your API, configure the following properties on the Global Settings page:

   • In Authentication, select the Type and fill in the required properties
   • In Headers, add the required HTTP headers for your API
   • In Pagination, select the Type and fill in the required properties

   After the configuring the global settings, navigate to the Tables to add tables. For each table you wish to add:

   1. Click "+ Add"
   2. Set the Name for the table
   3. Set Request URL to the API endpoint you wish to work with 👁 Setting the Request URL (Harvest is shown)
      
   4. (Optional) In Parameters, add the required URL Parameters for your API endpoint
   5. (Optional) In Headers, add the required HTTP headers for the API endpoint
   6. In Table Data click " Configure"
   7. Review the response from the API and click "Next" 👁 Reviewing the API response (Harvest is shown)
      
   8. Select which element to use as the Repeated Elements and which elements to use as Columns and click "Next" 👁 Configuring the schema based on the API response(Harvest is shown)
      
   9. Preview the tabular model of the API response and click "Confirm" 👁 Previewing the tabular model of the API response (Harvest is shown)
      
4. Click Save & Test
5. Navigate to the Permissions tab in the Add your API Connection page and update the User-based permissions. 👁 Updating permissions
   

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create. 👁 Creating a new PAT
   
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to API data from PostgreSQL.

Build the TDS Foreign Data Wrapper

The Foreign Data Wrapper can be installed as an extension to PostgreSQL, without recompiling PostgreSQL. The tds_fdw extension is used as an example (https://github.com/tds-fdw/tds_fdw).

1. You can clone and build the git repository via something like the following view source:

   sudo apt-get install git
   git clone https://github.com/tds-fdw/tds_fdw.git
   cd tds_fdw
   make USE_PGXS=1
   sudo make USE_PGXS=1 install
   

   Note: If you have several PostgreSQL versions and you do not want to build for the default one, first locate where the binary for pg_config is, take note of the full path, and then append PG_CONFIG=
2. After you finish the installation, then start the server:

   sudo service postgresql start
   

3. Then go inside the Postgres database

   psql -h localhost -U postgres -d postgres
   

   Note: Instead of localhost you can put the IP where your PostgreSQL is hosted.

Connect to API data as a PostgreSQL Database and query the data!

After you have installed the extension, follow the steps below to start executing queries to API data:

1. Log into your database.
2. Load the extension for the database:

   CREATE EXTENSION tds_fdw;
   

3. Create a server object for API data:

   CREATE SERVER "API1" FOREIGN DATA WRAPPER tds_fdw OPTIONS (servername'tds.cdata.com', port '14333', database 'API1');
   

4. Configure user mapping with your email and Personal Access Token from your Connect AI account:

   CREATE USER MAPPING for postgres SERVER "API1" OPTIONS (username '[email protected]', password 'your_personal_access_token' );
   

5. Create the local schema:

   CREATE SCHEMA "API1";
   

6. Create a foreign table in your local database:

   #Using a table_name definition:
   
   CREATE FOREIGN TABLE "API1".posts ( 
   id varchar, 
   body varchar) 
   SERVER "API1"
   OPTIONS(table_name 'API.posts', row_estimate_method 'showplan_all');
   
   #Or using a schema_name and table_name definition:
   
   CREATE FOREIGN TABLE "API1".posts ( 
   id varchar, 
   body varchar) 
   SERVER "API1"
   OPTIONS (schema_name 'API', table_name 'posts', row_estimate_method 'showplan_all');
   
   #Or using a query definition:
   
   CREATE FOREIGN TABLE "API1".posts (
   id varchar, 
   body varchar) 
   SERVER "API1"
   OPTIONS (query 'SELECT * FROM API.posts', row_estimate_method 'showplan_all');
   
   #Or setting a remote column name:
   
   CREATE FOREIGN TABLE "API1".posts (
   id varchar,
   col2 varchar OPTIONS (column_name 'body'))
   SERVER "API1"
   OPTIONS (schema_name 'API', table_name 'posts', row_estimate_method 'showplan_all');
   

7. You can now execute read/write commands to API:

   SELECT id, body
   FROM "API1".posts;
   

More Information & Free Trial

Now, you have created a simple query from live API data. For more information on connecting to API (and more than 200 other data sources), visit the Connect AI page. Sign up for a free trial and start working with live API data in PostgreSQL.