Manage GitLab Data in DBArtisan as a JDBC Source

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use wizards in DBArtisan to create a JDBC data source for GitLab.

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

Integrate GitLab Data into DBArtisan Projects

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

    GitLab API Profile Settings

    Create a Personal Access Token in GitLab under User Settings > Access Tokens, selecting the required scopes (e.g.,

    read_api
    ,
    api
    ).

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the GitLab 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\GitLab.apip;ProfileSettings='APIKey=your_personal_access_token';
  6. Finish the wizard to connect to GitLab data. GitLab entities are displayed in the Datasource Explorer.

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

Ready to get started?

Connect to live data from GitLab with the API Driver

Connect to GitLab