Connect to Abyssale Data in DBArtisan
The CData ODBC Driver for Abyssale seamlessly integrates Abyssale data into database management tools like DBArtisan by enabling you to access Abyssale data as a database. This article shows how to create an data source for Abyssale in DBArtisan and execute queries. You can then edit data visually and execute standard SQL.
Integrate Abyssale Data into DBArtisan Projects
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.
Start by setting the Profile connection property to the location of the Abyssale Profile on disk (e.g. C:\profiles\Abyssale.apip). Next, set the ProfileSettings connection property to the connection string for Abyssale (see below).
Abyssale API Profile Settings
Abyssale uses API Key authentication. Your Abyssale API Key is sent as the x-api-key request header. You can generate or view your API Key in the Abyssale dashboard under Settings > API.
After setting the following connection properties, you are ready to connect:
- AuthScheme: Set this to APIKey.
- APIKey: Set this to your Abyssale API Key.
You can then follow the steps below to register Abyssale data as a database instance in your project:
- In DBArtisan, click Data Source -> Register Datasource.
- Select Generic ODBC.
- Enter a name for the data source and select the DSN.
- Finish the wizard to connect to Abyssale data. Abyssale entities are displayed in the Datasource Explorer.
You can now work with Abyssale data as you work with any other database. See the driver help documentation for more information on the queries supported by the Abyssale API.
