versipellis

Versipellis Configuration Reference

[collector.sql] Sub-Section

type - driver type of the SQL-based database to connect to

• Required
• Options (case insensitive):
  • "cockroachdb" (CockroachDB)
  • "mssql" or "sqlserver" (Microsoft SQL Server)
  • "mariadb" (MariaDB)
  • "mysql" (MySQL)
  • "odbc" (Open Database Connectivity - see additional setup instructions)
  • "oracle" (Oracle Database - see additional setup instructions)
  • "postgres" or "postgresql" (PostgreSQL)
  • "sap_hana" (SAP HANA)
  • "snowflake" (Snowflake)
  • "sqlite" (SQLite)

connection - database connection string for the SQL client

• Required
• More details here: formats and documentation links

query or query_file - SQL query to execute

• Required, but…
• Use only one of them, not both (they’re mutually exclusive):
  • Inline (e.g., "SELECT * FROM table") - usually when the query is short and simple
  • Relative or absolute path to a file containing the query (e.g., "config/query.sql" or "/path/query.sql") - when it’s long, complex, or sensitive

timeout - maximum amount of time for each SQL client query to complete

• Optional
• Default: "1m" (1 minute)
• Format: string containing decimal numbers, each with a unit suffix, e.g., h (hours), m (minutes), and s (seconds)
• Special case: "0" and negative values (e.g., "-1s") = no client-side timeout

format - preferred downstream format for the results

• Optional
• Default: "ndjson"
• Options:
  • "json" (an array if the result contains multiple rows, otherwise an object)
  • "json_array" (always an array, even when there are fewer than 2 rows)
  • "ndjson" (NDJSON, a.k.a. JSONL)
• The configured sender may override this

[collector.sql.batch] Sub-Section

• Optional
• Default: up to 500 rows within a 1-second window
• See this page

This site is open source. Improve this page.