Connect to SerpApi Data in DBeaver
NOTE: The Legacy ODBC driver was removed in DBeaver Community Edition 23.1. As an alternative, you can use a CData JDBC Driver (learn how here: How to Connect DBeaver to SerpApi via JDBC). If you need to use ODBC Drivers, refer to the DBeaver Documentation.
The CData API Driver for ODBC enables access to live data from SerpApi under the ODBC standard, allowing you work with SerpApi data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to manage SerpApi data with visual tools in DBeaver like the query browser.
The CData ODBC drivers offer unmatched performance for interacting with live SerpApi data in DBeaver due to optimized data processing built into the driver. When you issue complex SQL queries from DBeaver to SerpApi, the driver pushes supported SQL operations, like filters and aggregations, directly to SerpApi and utilizes the embedded SQL engine to process unsupported operations (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can manage and analyze SerpApi data.
Connect to SerpApi
If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can configure the DSN using the Microsoft ODBC Data Source Administrator. This is also the last step of the driver installation. See the "Getting Started" chapter in the Help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.
Start by setting the Profile connection property to the location of the SerpAPI Profile on disk (e.g. C:\profiles\SerpAPI.apip). Next, set the ProfileSettings connection property to the connection string for SerpAPI (see below).
SerpAPI API Profile Settings
SerpAPI uses API key authentication. To obtain an API key:
- Sign in to your SerpAPI account at https://serpapi.com
- Navigate to the API Key page at https://serpapi.com/manage-api-key
- Copy your private API key
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 SerpAPI private API key.
Finally, set the "Map To WVarchar connection property to False in the DSN Configuration window for the driver. This configuration will allow string types to be mapped to SQL_VARCHAR and prevent SQL_WVARCHAR types from being displayed as NULL.
Connecting to the SerpApi ODBC Data Source in DBeaver
- Open the DBeaver application and in the Database menu, select the New Database Connection option.
- In the 'Connect to a database' window, select ODBC and click Next.
- In the Database/Schema field, enter the DSN name (CData SerpApi Source by default). It will be automatically added to the JDBC URL as well.
- Click the Test Connection button. You should receive a 'Connected' message after DBeaver has detected the DSN, along with details about the driver if the connection is successful.
Query SerpApi Data
You can now query information from the tables exposed by the data source connection. You can expand the database structure in order to view all the tables. You can retrieve the table's data by right-clicking on a table name and selecting View data. The data will then be available in the Data tab.
Free Trial & More Information
At this point, you have connected to live SerpApi data from DBeaver. For more information, visit the CData ODBC Driver page. Download a free, 30-day trial and start working live SerpApi data DBeaver today.