Connect to Superchat Data in DBeaver

The CData API Driver for ODBC enables access to live data from Superchat under the ODBC standard, allowing you work with Superchat data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to manage Superchat data with visual tools in DBeaver like the query browser.

The CData ODBC drivers offer unmatched performance for interacting with live Superchat data in DBeaver due to optimized data processing built into the driver. When you issue complex SQL queries from DBeaver to Superchat, the driver pushes supported SQL operations, like filters and aggregations, directly to Superchat 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 Superchat data.

Connect to Superchat

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.

Superchat uses API Key authentication. The API key is passed via the X-API-KEY request header on every call.

Authentication

To authenticate to Superchat, you need to obtain your API key from the Superchat workspace settings.

Using API Key Authentication

You can obtain your API key from Settings > Integrations > API Key in your Superchat workspace.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Superchat API key.

Example connection string:

Profile=C:\profiles\Superchat.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_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 Superchat ODBC Data Source in DBeaver

1. Open the DBeaver application and in the Database menu, select the New Database Connection option. 👁 Creating a new Database Connection
   
2. In the 'Connect to a database' window, select ODBC and click Next. 👁 Creating a new Database Connection
   
3. In the Database/Schema field, enter the DSN name (CData Superchat Source by default). It will be automatically added to the JDBC URL as well.
4. 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. 👁 Successfully tested connection
   

Query Superchat 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 Superchat data from DBeaver. For more information, visit the CData ODBC Driver page. Download a free, 30-day trial and start working live Superchat data DBeaver today.