Manage Alchemy Data in DBArtisan as a JDBC Source

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

Integrate Alchemy Data into DBArtisan Projects

Follow the steps below to register Alchemy data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   Start by setting the Profile connection property to the location of the Alchemy Profile on disk (e.g. C:\profiles\Alchemy.apip). Next, set the ProfileSettings connection property to the connection string for Alchemy (see below).

   Alchemy API Profile Settings

   Alchemy uses API key authentication. The API key is supplied in the request URL path. To obtain an API key:

   1. Sign in to your Alchemy account at https://dashboard.alchemy.com.
   2. Open an existing app or create a new one.
   3. Copy the app's API key from the API Key dialog.

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

   • AuthScheme: Set this to APIKey.
   • Network: Optional. The blockchain network slug for NFT API requests (for example, eth-mainnet, base-mainnet, polygon-mainnet). Defaults to eth-mainnet.

   Set the following in the ProfileSettings connection property:

   • APIKey: Set this to your Alchemy app API key.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Alchemy JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   
   java -jar cdata.jdbc.api.jar
   

   Fill in the connection properties and copy the connection string to the clipboard.

   

   Below is a typical connection string:

   jdbc:api:Profile=C:\profiles\Alchemy.apip;AuthScheme=APIKey;Network=eth-mainnet;ProfileSettings='APIKey=your_api_key';

6. Finish the wizard to connect to Alchemy data. Alchemy entities are displayed in the Datasource Explorer.

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