Analyze ScrapingBee Data in R via JDBC
Access ScrapingBee data with pure R script and standard SQL on any machine where R and Java can be installed. You can use the CData JDBC Driver for ScrapingBee and the RJDBC package to work with remote ScrapingBee data in R. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular, open-source R language. This article shows how to use the driver to execute SQL queries to ScrapingBee and visualize ScrapingBee data by calling standard R functions.
Install R
You can match the driver's performance gains from multi-threading and managed code by running the multithreaded Microsoft R Open or by running open R linked with the BLAS/LAPACK libraries. This article uses Microsoft R Open 3.2.3, which is preconfigured to install packages from the Jan. 1, 2016 snapshot of the CRAN repository. This snapshot ensures reproducibility.
Load the RJDBC Package
To use the driver, download the RJDBC package. After installing the RJDBC package, the following line loads the package:
library(RJDBC)
Connect to ScrapingBee as a JDBC Data Source
You will need the following information to connect to ScrapingBee as a JDBC data source:
- Driver Class: Set this to cdata.jdbc.api.APIDriver
- Classpath: Set this to the location of the driver JAR. By default this is the lib subfolder of the installation folder.
The DBI functions, such as dbConnect and dbSendQuery, provide a unified interface for writing data access code in R. Use the following line to initialize a DBI driver that can make JDBC requests to the CData JDBC Driver for ScrapingBee:
driver <- JDBC(driverClass = "cdata.jdbc.api.APIDriver", classPath = "MyInstallationDir\lib\cdata.jdbc.api.jar", identifier.quote = "'")
You can now use DBI functions to connect to ScrapingBee and execute SQL queries. Initialize the JDBC connection with the dbConnect function.
Using API Key Authentication
ScrapingBee uses API key authentication. To obtain an API key:
- Sign in to your ScrapingBee account at https://app.scrapingbee.com
- Navigate to the Dashboard and locate your API key in the top section.
- 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.
- 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.
Below is a sample dbConnect call, including a typical JDBC connection string:
conn <- dbConnect(driver,"jdbc:api:Profile=C:\profiles\ScrapingBee.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";")
Schema Discovery
The driver models ScrapingBee APIs as relational tables, views, and stored procedures. Use the following line to retrieve the list of tables:
dbListTables(conn)
Execute SQL Queries
You can use the dbGetQuery function to execute any SQL query supported by the ScrapingBee API:
googlesearchresults <- dbGetQuery(conn,"SELECT , FROM GoogleSearchResults WHERE SearchQuery = 'cdata drivers'")
You can view the results in a data viewer window with the following command:
View(googlesearchresults)
Plot ScrapingBee Data
You can now analyze ScrapingBee data with any of the data visualization packages available in the CRAN repository. You can create simple bar plots with the built-in bar plot function:
par(las=2,ps=10,mar=c(5,15,4,2)) barplot(googlesearchresults$, main="ScrapingBee GoogleSearchResults", names.arg = googlesearchresults$, horiz=TRUE)