VOOZH about

URL: https://www.cdata.com/kb/tech/mailersend-jdbc-datagrip.rst

⇱ Query MailerSend Data in DataGrip


Query MailerSend Data in DataGrip

πŸ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Create a Data Source for MailerSend in DataGrip and use SQL to query live MailerSend data.

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData API Driver for JDBC, DataGrip can work with live MailerSend data. This article shows how to establish a connection to MailerSend data in DataGrip.

Create a New Driver Definition for MailerSend

The steps below describe how to create a new Data Source in DataGrip for MailerSend.

  1. In DataGrip, click File -> New > Project and name the project πŸ‘ Creating a new DataGrip project.
  2. In the Database Explorer, click the plus icon () and select Driver. πŸ‘ Adding a new Driver.
  3. In the Driver tab:
    • Set Name to a user-friendly name (e.g. "CData MailerSend Driver")
    • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.api.jar).
    • Set Class to cdata.jdbc.api.API.jar
  4. Click "Apply" then "OK" to save the Connection πŸ‘ A configured Driver (Salesforce is shown).

Configure a Connection to MailerSend

  1. Once the connection is saved, click the plus (), then "Data Source" then "CData MailerSend Driver" to create a new MailerSend Data Source.
  2. In the new window, configure the connection to MailerSend with a JDBC URL.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the MailerSend 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.

    The MailerSend API uses API Key authentication via a Bearer token in the Authorization request header.

    Using API Key Authentication

    Your MailerSend API token is required to create a connection. To obtain your API token:

    1. Log into your MailerSend account at app.mailersend.com.
    2. Navigate to Settings > API Tokens in your account dashboard.
    3. Click Generate new token, provide a name and select the appropriate permissions.
    4. Copy the generated API token.

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

    • AuthScheme: Set this to APIKey.
    • APIKey: Set this to your MailerSend API token.

    Example connection string:

    Profile=C:\profiles\Mailersend.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_token';
    
    πŸ‘ Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
  3. Set URL to the connection string, e.g.,
    jdbc:api:Profile=C:\profiles\Mailersend.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_token';
  4. Click "Apply" and "OK" to save the connection string πŸ‘ A configured Data Source (Salesforce is shown).

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against MailerSend

To browse through the MailerSend entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

πŸ‘ Exploring the data (Salesforce is shown.)

To execute queries, right click on any table and select "New" -> "Query Console."

πŸ‘ Opening a new Query Console.

In the Console, write the SQL query you wish to execute. For example:

SELECT , FROM Activity WHERE DomainId = 'domain123'
πŸ‘ Querying with SQL (Salesforce is shown.)

Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live MailerSend data in DataGrip. Reach out to our Support Team if you have any questions.