Query ScrapingBee Data in ColdFusion

The CData JDBC driver for ScrapingBee seamlessly integrates connectivity to ScrapingBee data with the rapid development tools in ColdFusion. This article shows how to connect to ScrapingBee data in ColdFusion and query ScrapingBee tables.

Create a JDBC Data Source for ScrapingBee in ColdFusion

The JDBC data source enables you to execute SQL from standard ColdFusion tags like cfquery and CFScript like executeQuery.

1. Copy the driver JAR and .lic file from the installation directory onto the ColdFusion classpath. For example, copy the files into C:\MyColdFusionDirectory\cfusion\wwwroot\WEB-INF\lib. Or, open the Java and JVM page in the ColdFusion Administrator and enter the path to the files in the ColdFusion Class Path box.

   The JAR and license for the driver are located in the lib subfolder of the installation directory.

   Restart the server after this step.

2. Add the driver as a data source:

   From the ColdFusion administrator interface, expand the Data & Services node and click Data Sources. In the Add New Data Source section, enter a name for the data source and select Other in the Driver menu.

   

3. Populate the driver properties:

   • JDBC URL: Enter connection properties in the JDBC URL. The JDBC URL begins with jdbc:api: and is followed by the connection properties in a semicolon-separated list of name=value pairs.

     Using API Key Authentication

     ScrapingBee uses API key authentication. To obtain an API key:

     1. Sign in to your ScrapingBee account at https://app.scrapingbee.com
     2. Navigate to the Dashboard and locate your API key in the top section.
     3. Copy the API key for use in the connection string.

     After obtaining your API key, set the following connection properties:

     • AuthScheme: Set this to APIKey.
     Set the following in the ProfileSettings connection property:
     • APIKey: Set this to your ScrapingBee API key.

     Example Connection String

     Profile=C:\profiles\ScrapingBee.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";
     

     Connecting to ScrapingBee

     Once the authentication is configured, you can connect to ScrapingBee and query data from any of the available tables. All tables require at least one input parameter (such as a search query or product ID) to retrieve data.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the ScrapingBee JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.api.jar
     

     Fill in the connection properties and copy the connection string to the clipboard.

     

     A typical JDBC URL is below:

     jdbc:api:Profile=C:\profiles\ScrapingBee.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";

   • Driver Class: Enter the driver class. The driver class is cdata.jdbc.api.APIDriver.
   • Driver Name: Enter a user-defined name for the driver.
   • Username: Enter the username used to authenticate.
   • Password: Enter the password used to authenticate.

You can now test the connection by enabling the CData ScrapingBee data source in the Actions column. After reporting a status of OK, the ScrapingBee data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to ScrapingBee. Use the cfqueryparam tag to create parameterized queries and prevent SQL injection through the query string.

Note: To use the cfquery and cfscript, create a .cfm file. Inside the .cfm file, write the code to execute the query (see below). Place the file directly in the root directory of your web server (e.g., wwwroot in Adobe ColdFusion). Restart the service after placing the file for the changes to take effect.

<cfquery name="APIQuery" dataSource="CDataAPI">
  SELECT * FROM GoogleSearchResults WHERE SearchQuery = <cfqueryparam value="#SearchQuery#" cfsqltype="cf_sql_varchar">
</cfquery>
<cfdump var="#APIQuery#">

Below is the equivalent in CFScript:

<cfscript>
result = queryExecute(
  "SELECT * FROM GoogleSearchResults WHERE SearchQuery = ?", 
  [
    { value="cdata drivers", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataAPI" }
);

writeDump( var= result );
</cfscript> 

You can then make requests to your .cfm like the following:

http://MyServer:8500/query.cfm?SearchQuery=cdata drivers