Documentation

Everything you need to know about Tabularis, from your first connection to advanced plugin development.

Getting Started

Introduction

Welcome to the Tabularis Wiki. Learn how to get started with the most modern database management tool.

Installation

Install Tabularis on macOS, Windows or Linux, or self-host it and use it from a browser.

Get Started

Connect to your first database, explore the schema, and run your first query.

Self-Hosting

Tabularis Web

Run Tabularis in a browser with `tabularis web`, locally or on a server, with the same interface and Rust services as the desktop app.

Docker & Helm

Run Tabularis Web from the official container image with Docker, Docker Compose or the Helm chart, and keep its credentials safe.

Remote Access & Reverse Proxy

Expose Tabularis Web beyond localhost safely: HTTPS reverse proxy, password or proxy authentication, allowed origins and the high-risk policy.

Core Features

SQL Editor

How to use the modern SQL editor in Tabularis with syntax highlighting, autocomplete, and multi-tab support.

Command Palette

Search actions and database objects together with Cmd+K / Ctrl+K, jump to any table, view, routine, or trigger with Cmd+P / Ctrl+P, or run editor, result and connection actions from the action palette on Cmd+Shift+A / Ctrl+Shift+A.

SQL Notebooks

Create interactive multi-cell workspaces that combine SQL queries, Markdown documentation, charts, and cross-cell variables in a single document.

Saved Queries

Save, organize, and reuse your most frequent SQL queries per connection.

Visual EXPLAIN

Inspect execution plans as interactive graphs, tables, and AI-powered analyses. Works with PostgreSQL, MySQL, MariaDB, and SQLite.

Visual Query Builder

Construct complex SQL queries visually by dragging tables and drawing JOINs.

Split View

Work with multiple database connections simultaneously in a side-by-side layout.

Data Grid

Browse, edit, filter, and export table data with a high-performance virtualized grid.

Database Objects

Connection Management

Learn how to manage your database connections securely with SSH tunneling and keychain integration.

Schema Management & ER Diagrams

Modify your database schema without writing DDL. Create tables, edit columns, and manage indexes.

View Management

Create, edit, and drop database views with a visual editor and live SQL preview.

Dump & Import

Export a full database snapshot to SQL and restore it — with progress tracking and cancellation support.

Data Import (Clipboard and Files)

Import CSV, TSV, JSON, or Markdown table data from the clipboard or from a file into any database table, with automatic type inference and a schema editor.

Stored Procedures & Routines

Browse, run, create, edit, and drop stored procedures and functions from the Explorer sidebar.

Triggers

Browse, create, edit, and drop triggers on PostgreSQL, MySQL/MariaDB, and SQLite.

Users & Privileges

List server accounts, create and drop users, change passwords, and edit grants scope by scope on MySQL and MariaDB.

ER Diagram

Visualize your database schema as an interactive entity-relationship diagram using the Dagre layout engine.

Security & Networking

Security & Credentials

How Tabularis stores passwords and secrets, and how to keep them in your OS keychain instead of on disk.

SSH Tunneling

Connect to remote databases through SSH tunnels with password or key-based authentication.

Kubernetes Tunneling

Connect to databases running inside Kubernetes clusters through managed kubectl port-forward tunnels.

AWS SSM Tunneling

Connect to databases behind AWS Systems Manager managed nodes through Session Manager port-forwarding sessions opened with the AWS CLI.

AI & MCP

AI Assistant & Context Engine

Use AI to generate SQL from natural language and explain complex queries.

MCP Server

Use Tabularis as an MCP server to let Claude Desktop, Claude Code, Cursor, Windsurf, Antigravity, and other AI agents query your local databases.

AI Audit Log

Local-only log of every MCP tool call your AI agent makes. Filter, export, group into sessions, replay as a notebook, jump straight into Visual Explain.

MCP Read-only Mode

The bluntest MCP safety knob: block any non-SELECT statement reaching specific connections — or all of them by default.

MCP Approval Gates

Pause MCP writes (or every query) and require explicit user approval — with a pre-flight EXPLAIN plan rendered inside the modal.

Integration

Installing Plugins

Find, install, update and configure Tabularis plugins from the Plugin Center and the connection catalogue.

Plugin System & Custom Drivers

How Tabularis plugins are structured and loaded: architecture, directory layout, the .tabularium manifest and plugin settings.

Plugin Protocol

JSON-RPC reference for Tabularis plugins: request and response format, required and optional methods, cancellation and connection-specific metadata.

Building Your First Plugin

Scaffold a working database driver in minutes using @tabularis/create-plugin and @tabularis/plugin-api.

UI Extensions

Add React components to the Tabularis interface from a plugin: slots, manifest declaration, IIFE bundles, @tabularis/plugin-api hooks and translations.

Publishing Plugins

Package a Tabularis plugin, publish it to the Tabularium registry and point the app at a custom registry — manifest, release assets, submission, validation.

Plugin Kinds

Manifest extension fields and example manifests for every Tabularium plugin kind.

Customization

Configuration

Adjust Tabularis to your workflow: language settings, AI providers, and general application behavior.

Keyboard Shortcuts

Full reference of keyboard shortcuts available in Tabularis, with instructions for customizing your own bindings.

Themes & Customization

Personalize your workspace with 12 built-in themes, installable theme packages and full typography control.

Reference

Technical Architecture

A deep dive into the Tabularis core: Tauri, Rust drivers, and the React frontend bridge.

Task Manager

Monitor and control plugin processes in real time — CPU, RAM, disk I/O, kill, and restart.

Updates

Keep Tabularis up to date — automatic checks on startup, manual check from settings, and package-manager-managed installs.

Command Line Interface

Launch Tabularis from the terminal: serve it to a browser with `web`, open Visual EXPLAIN files, run the MCP server, and debug.

Troubleshooting & FAQ

Solutions to common problems — connection errors, SSH failures, performance tips, and more.