Connect to Databox Data in DBArtisan
The CData ODBC Driver for Databox seamlessly integrates Databox data into database management tools like DBArtisan by enabling you to access Databox data as a database. This article shows how to create an data source for Databox in DBArtisan and execute queries. You can then edit data visually and execute standard SQL.
Integrate Databox 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 Databox Profile on disk (e.g. C:\profiles\Databox.apip). Next, set the ProfileSettings connection property to the connection string for Databox (see below).
Databox API Profile Settings
To use the Databox API, you need to generate a personal access key from your Databox account. Navigate to the Databox account settings under Data Manager and generate an API key (prefixed with pak_).
After setting the following connection properties, you are ready to connect:
- AuthScheme: Set this to APIKey.
- APIKey: Set this to your Databox personal access key.
You can then follow the steps below to register Databox 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 Databox data. Databox entities are displayed in the Datasource Explorer.
You can now work with Databox data as you work with any other database. See the driver help documentation for more information on the queries supported by the Databox API.