Ready to get started?

Learn more about the CData ODBC Driver for EDGAR Online or download a free trial:

Download Now

Connect to EDGAR Online as an External Data Source using PolyBase

Use the CData ODBC Driver for EDGAR Online and PolyBase to create an external data source in SQL Server 2019 with access to live EDGAR Online data.

PolyBase for SQL Server allows you to query external data by using the same Transact-SQL syntax used to query a database table. When paired with the CData ODBC Driver for EDGAR Online, you get access to your EDGAR Online data directly alongside your SQL Server data. This article walks through creating an external data source and external tables to grant access to live EDGAR Online data using T-SQL queries.

The CData ODBC drivers offer unmatched performance for interacting with live EDGAR Online data using PolyBase due to optimized data processing built into the driver. When you issue complex SQL queries from SQL Server to EDGAR Online, the driver pushes down supported SQL operations, like filters and aggregations, directly to EDGAR Online and utilizes the embedded SQL engine to process unsupported operations (often SQL functions and JOIN operations) client-side. And with PolyBase, you can also join SQL Server data with EDGAR Online data, using a single query to pull data from distributed sources.

Connect to EDGAR Online

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. To create an external data source in SQL Server using PolyBase, configure a System DSN (CData EDGAR Online Sys is created automatically).

  1. Navigate to https://developer.edgar-online.com/ and create an account.
  2. Register a new application and retrieve the AppKey. You should select one of the available Web APIs this application will use like HackPack, Insider Trades or Institutional Ownership.
    Note: HackPack is the most important Web API that an application can use since it supports a large number of endpoints. If you are getting the "Access Denied" error you must create a new app and select the correct Web API which supports the resource you are querying.
  3. After successfully creating a new app, you can access your keys through your "my account" area. Set the AppKey connection property value equal to the Key of your application.

Click "Test Connection" to ensure that the DSN is connected to EDGAR Online properly. Navigate to the Tables tab to review the table definitions for EDGAR Online.

Create an External Data Source for EDGAR Online Data

After configuring the connection, you need to create a master encryption key and a credential database for the external data source.

Creating a Master Encryption Key

Execute the following SQL command to create a new master key, 'ENCRYPTION,' to encrypt the credentials for the external data source.

CREATE MASTER KEY ENCRYPTION BY PASSWORD = 'password';

Creating a Credential Database

Execute the following SQL command to create credentials for the external data source connected to EDGAR Online data.

NOTE: Since EDGAR Online does not require a User or Password to authenticate, you may use whatever values you wish for IDENTITY and SECRET.

CREATE DATABASE SCOPED CREDENTIAL edgaronline_creds
WITH IDENTITY = 'username', SECRET = 'password';

Create an External Data Source for EDGAR Online

Execute the following SQL command to create an external data source for EDGAR Online with PolyBase, using the DSN and credentials configured earlier.

For EDGAR Online, set SERVERNAME to 'localhost' or '127.0.0.1' and leave PORT empty. PUSHDOWN is set to ON by default, meaning the ODBC Driver can leverage server-side processing for complex queries.

CREATE EXTERNAL DATA SOURCE cdata_edgaronline_source
WITH ( 
  LOCATION = 'odbc://SERVERNAME[:PORT]',
  CONNECTION_OPTIONS = 'DSN=CData EDGAR Online Sys',
  -- PUSHDOWN = ON | OFF,
  CREDENTIAL = edgaronline_creds
);

Create External Tables for EDGAR Online

After creating the external data source, use CREATE EXTERNAL TABLE statements to link to EDGAR Online data from your SQL Server instance. The table column definitions must match those exposed by the CData ODBC Driver for EDGAR Online. You can refer to the Tables tab of the DSN Configuration Wizard to see the table definition.

Sample CREATE TABLE Statement

The statement to create an external table based on a EDGAR Online Subscriptions would look similar to the following:

CREATE EXTERNAL TABLE Subscriptions(
  Id [nvarchar](255) NULL,
  Name [nvarchar](255) NULL,
  ...
) WITH ( 
  LOCATION='Subscriptions',
  DATA_SOURCE=cdata_edgaronline_source
);

Having created external tables for EDGAR Online in your SQL Server instance, you are now able to query local and remote data simultaneously. Thanks to built-in query processing in the CData ODBC Driver, you know that as much query processing as possible is being pushed to EDGAR Online, freeing up local resources and computing power. Download a free, 30-day trial of the ODBC Driver for EDGAR Online and start working with live EDGAR Online data alongside your SQL Server data today.