Skip to main content

Core Concepts

Before you dive in, it helps to understand the handful of building blocks that make up Kvery. Everything else is built on top of these.

Group​

A group is your workspace. It is the top-level container that owns:

  • Database connections — the credentials Kvery uses to reach your databases.
  • Members — the people who can access the group, each with their own permissions.
  • Queries — every saved SQL query in the workspace.
  • Dashboards — visual layouts built from query results.
  • Settings — group name, slow-query and rate-limit thresholds, an IP whitelist, snippets, tags, and log retention.

You can be a member of multiple groups and switch between them from the group switcher. Each group has its own plan and limits.

Database connection​

A connection stores how Kvery reaches one of your databases: driver (MySQL, PostgreSQL, or MSSQL), host, port, credentials, and optional SSL/SSH security. Queries are always run against a connection, so you set one up first.

Query​

A query is the central object in Kvery. At minimum it is a piece of SQL bound to a connection, but a saved query can also carry:

  • A name, tags, and an internal note for organisation.
  • Form variables that turn parameters into input fields.
  • A layout describing how its results are displayed (table, cards, or chart).
  • A share hash that makes it accessible as a link or a REST API endpoint.
  • A schedule that runs it automatically and emails the results.
  • A full history of previous versions you can compare and roll back to.

The Editor​

The editor is where you write and test SQL. It is a Monaco-based code editor with autocomplete for your schema, snippets, and Kvery's own directives (such as error handling and webhooks). You can open several queries side by side and run them against any connection in the group.

Result layouts​

When a query returns rows, Kvery can render them as a table (sortable, searchable, paginated), as cards (one card per row), or as a chart (bar, line, mixed, pie, or doughnut). The chosen layout is saved with the query and reused everywhere it appears, including on dashboards.

Dashboard​

A dashboard arranges the results of several queries into a single view. Each tile runs its query (optionally on demand or in the background) and shows the result with its saved layout. Dashboards can be shared by link and cloned.

Board​

The board is a lightweight Kanban-style space inside a group for organising work visually. See Board overview.

With these concepts in mind, the Quick start shows how they fit together end to end.