Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Latest commit

 

History

History
History

README.md

Outline

LogSQL JDBC Driver

This module provides a JDBC 4.0 compatible driver for the VictoriaLogs (via sql-to-logsql service). The driver interacts http(s) with sql-to-logsql API and exposes query results as regular JDBC result sets, making it possible to integrate VictoriaLogs with the broader JVM ecosystem (BI tools, JDBC-based frameworks, etc.).

Connection URL

jdbc:logsql://host[:port][/basePath]?property=value&...

Supported properties:

  • schemehttp (default) or https.
  • endpoint – optional VictoriaLogs endpoint URL override.
  • bearerToken – optional bearer token sent to the translation service.
  • timeout – request timeout in milliseconds (default 60000).
  • verify – when false, TLS certificate validation is disabled.
  • header.<name> – additional HTTP headers to include with every request.

Example:

jdbc:logsql://localhost:8080?scheme=https&endpoint=https%3A%2F%2Fvictorialogs.example.com&bearerToken=secret

Properties provided through java.util.Properties when creating the connection are merged with the URL query parameters (query parameters take precedence).

Building

mvn -DskipTests package

The standard artifact is placed in target/logsql-jdbc-<version>.jar, and a fat jar with all dependencies is available as target/logsql-jdbc-<version>-all.jar.

Testing

mvn test

These integration tests connect to https://play-sql.victoriametrics.com. They will be marked as skipped automatically if the playground cannot be reached (for example, when outbound network access is disabled).

Notes

  • The driver performs a health check against /healthz when establishing a connection.
  • Result sets are fully buffered in memory to simplify cursor navigation and metadata reporting. Avoid query patterns that return unbounded result sets.
  • HTTPS certificate verification can be disabled for testing by setting verify=false, but this is not recommended for production use.

Integrations

DBeaver

  1. Add maven repo for sql-to-logsql:
  • 1.1. Menu -> Settings -> Connections -> Drivers -> Maven -> Add -> https://maven.pkg.github.com/victoriametrics/sql-to-logsql:

    Add Maven repo to DBeaver

  • 1.2. Set username and password according to these docs (username - your github username, password - personal access token with "read packages" permission):

    Set repo auth in DBEaver

  1. Menu -> Database -> Driver Manager -> New:
  • 2.1. Tabs -> Libraries -> Add artifact:

    Add maven artifactor to DBEaver

    <dependency>
        <groupId>com.victoriametrics</groupId>
        <artifactId>logsql-jdbc</artifactId>
        <version>0.9.0</version>
    </dependency>
  • 2.2. Click "Download/Update" and Click "Find class":

    Download artifact

  • 2.3. Fill in the form on "Settings" tab:

    Fill in settings

    • Driver name: LogsQL
    • Driver type: Generic
    • Class name: com.victoriametrics.logsql.jdbc.LogsqlDriver
    • URL template: jdbc:logsql://{host}[:{port}]
    • Default port: 8080
    • No authentication: true
  1. Add a new connection - for example, you can check it out with our playground:

Add new connection

URL: jdbc:logsql://play-sql.victoriametrics.com:443?scheme=https

Set playgorund URL

After that you can explore the database via DBeaver UI:

Explore data

JetBrains IDEs

  1. Download logsql-jdbc-0.9.0-all.jar file from maven package: download file

  2. "Database" panel -> Create Data Source -> Driver:

  • 2.1.

    Add driver

  • 2.2. Add logsql-jdbc-0.9.0-all.jar file as "Custom JAR" and select driver class

    Add driver

  • 2.3. Add "default" URL template: jdbc:logsql://host[:port]

  1. Create a new data source - for example, you can check it out with our playground:

Create data source

URL: jdbc:logsql://play-sql.victoriametrics.com:443?scheme=https

  1. Now you can explore the database via JetBrains IDEs:

Explore data

Tableau

  1. Download logsql-jdbc-0.9.0-all.jar file from maven package: download file

  2. Put the logsql-jdbc-0.9.0-all.jar file into the Tableau Drivers folder

  3. Connect -> To a Server -> Other databases (JDBC):

Connect to server

  1. Set the URL, for example, you can check it out with our playground:

Connect to server

URL: jdbc:logsql://play-sql.victoriametrics.com:443?scheme=https

  1. Now you can explore the database via Tableau:

Explore data

Morty Proxy This is a proxified and sanitized view of the page, visit original site.