Connect to Carbone Data in DBArtisan

The CData ODBC Driver for Carbone seamlessly integrates Carbone data into database management tools like DBArtisan by enabling you to access Carbone data as a database. This article shows how to create an data source for Carbone in DBArtisan and execute queries. You can then edit data visually and execute standard SQL.

Integrate Carbone 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 Carbone Profile on disk (e.g. C:\profiles\Carbone.apip). Next, set the ProfileSettings connection property to the connection string for Carbone (see below).

Carbone API Profile Settings

Carbone uses API key authentication via a Bearer token in the Authorization header. To obtain an API key:

1. Log in to your Carbone account at https://account.carbone.io
2. Copy the API key shown on the account home page

After obtaining your API key, set the following connection properties:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Carbone API key (Bearer token).
• CarboneVersion: (Optional) The major version of the Carbone API to target via the carbone-version request header. Defaults to 5. Accepted values: 5, 4, 3, staging.

You can then follow the steps below to register Carbone data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic ODBC.
3. Enter a name for the data source and select the DSN.
4. Finish the wizard to connect to Carbone data. Carbone entities are displayed in the Datasource Explorer.

You can now work with Carbone data as you work with any other database. See the driver help documentation for more information on the queries supported by the Carbone API.