Plugin Kinds

Every plugin published to Tabularium declares a kind. On top of the core manifest fields, each kind defines its own extension fields. This page is generated from the live registry configuration, so it lists exactly the kinds the registry currently accepts.

Drivers (driver)

Database driver plugins that extend Tabularis to talk to new data stores via JSON-RPC over STDIO — any language, any database.

Browse published drivers in the registry catalogue.

Extensions

Field Type Required Description
engine string ✅ Concrete database this driver connects to (e.g. "firestore", "postgres", "qdrant"). Tabularis groups the connection catalogue by engine: every driver targeting the same database shares one engine value, so two "firestore" drivers collapse into a single Firestore entry and the user picks which driver.
paradigms array<string> ✅ Data-model families the engine supports, most representative first. Single-model drivers declare one (e.g. ["sql"]); multi-model declare several (SurrealDB: ["document","graph","relational","key-value","vector"]). The first entry is the primary model used to place the engine in the catalogue; every entry feeds the filter chips, so a multi-model engine appears when ANY of its models is selected. Allowed values come from the registry's admin-managed paradigm list (facets), not a fixed enum, so new models never need a schema release.
color string — Hex accent colour shown on the catalogue card and sidebar (e.g. "#f97316").
default_port integer — Default TCP port pre-filled in the connection modal. Omit for file-, folder-, and API-based drivers.
default_username string — Default username pre-filled in the connection modal (e.g. "postgres", "root").
is_builtin boolean — True for drivers shipped with Tabularis. External plugins should omit this or leave it false.
executable string ✅ Relative path to the plugin executable inside the plugin folder. No extension on Linux/macOS; Tabularis appends .exe on Windows automatically.
interpreter string — Optional interpreter for script-based plugins (e.g. "python3", "node"). Omit for native binaries.
capabilities object ✅ Feature flags that control which UI elements Tabularis renders for this driver.
settings array<object> — Optional list of configuration fields the plugin exposes to the user via the Tabularis settings modal.
data_types array<object> — List of data types this driver supports for column creation in the UI.
supports_ssl boolean — true to show the SSL/TLS configuration tab (mode + CA/client cert/key) in the connection modal for this network driver. Defaults to false.
ui_extensions array<object> — UI extension contributions rendered into named slots of the Tabularis interface. Only needed by plugins that ship a frontend module; driver-only plugins omit it.
type_mappings object — Optional map of generic inferred type names to driver-native types, resolved by the host during paste/import (map_inferred_type). Keys are uppercase generic names (e.g. DATETIME, JSON); values are the driver-native equivalents (e.g. TIMESTAMP, JSONB). Lookup is case-insensitive; unmapped types pass through unchanged.
explain_parsers array<object> — Plugin-owned raw EXPLAIN parser IIFE bundles loaded by Tabularis when the plugin is enabled.
connection_metadata boolean — Opt in to get_connection_metadata, which returns connection-specific capabilities, data_types and type_mappings. Static manifest values remain the fallback.
connection_fields object — Optional presentation overrides for host-owned connection fields. Omitted fields keep the standard Tabularis behavior.

Example (YAML)

name: tabularis-clickhouse-driver
description: Connect Tabularis to ClickHouse over JSON-RPC with full DDL, query, and ER-diagram support.
category: integration
kind: driver
tags:
  - clickhouse
  - analytics
  - olap
license: MIT
icon: https://raw.githubusercontent.com/example/tabularis-clickhouse/main/assets/icon.svg
homepage: https://github.com/example/tabularis-clickhouse
documentation_url: https://github.com/example/tabularis-clickhouse#readme
support:
  email: maintainers@example.com
  issues_url: https://github.com/example/tabularis-clickhouse/issues
screenshots:
  - url: https://raw.githubusercontent.com/example/tabularis-clickhouse/main/assets/screen-connect.png
    caption: Connection form with native ClickHouse fields
    alt: Tabularis connection dialog showing host, port, user, and database fields
  - url: https://raw.githubusercontent.com/example/tabularis-clickhouse/main/assets/screen-query.png
    caption: Running a SELECT against the ontime table
    alt: Tabularis data grid showing ClickHouse query results
min_runtime_version: 0.9.13
readme: |
  # ClickHouse driver for Tabularis

  Adds a native ClickHouse connection to Tabularis. Supports SELECT/INSERT/UPDATE/DELETE through execute_query, schema introspection for the explorer, DDL generation (CREATE TABLE, ALTER TABLE, DROP), and ER-diagram rendering via get_relationships.

Example (JSON)

{
  "name": "tabularis-clickhouse-driver",
  "description": "Connect Tabularis to ClickHouse over JSON-RPC with full DDL, query, and ER-diagram support.",
  "category": "integration",
  "kind": "driver",
  "tags": [
    "clickhouse",
    "analytics",
    "olap"
  ],
  "license": "MIT",
  "icon": "https://raw.githubusercontent.com/example/tabularis-clickhouse/main/assets/icon.svg",
  "homepage": "https://github.com/example/tabularis-clickhouse",
  "documentation_url": "https://github.com/example/tabularis-clickhouse#readme",
  "support": {
    "email": "maintainers@example.com",
    "issues_url": "https://github.com/example/tabularis-clickhouse/issues"
  },
  "screenshots": [
    {
      "url": "https://raw.githubusercontent.com/example/tabularis-clickhouse/main/assets/screen-connect.png",
      "caption": "Connection form with native ClickHouse fields",
      "alt": "Tabularis connection dialog showing host, port, user, and database fields"
    },
    {
      "url": "https://raw.githubusercontent.com/example/tabularis-clickhouse/main/assets/screen-query.png",
      "caption": "Running a SELECT against the ontime table",
      "alt": "Tabularis data grid showing ClickHouse query results"
    }
  ],
  "min_runtime_version": "0.9.13",
  "readme": "# ClickHouse driver for Tabularis\n\nAdds a native ClickHouse connection to Tabularis. Supports SELECT/INSERT/UPDATE/DELETE through execute_query, schema introspection for the explorer, DDL generation (CREATE TABLE, ALTER TABLE, DROP), and ER-diagram rendering via get_relationships.\n"
}

Themes (theme)

Declarative Tabularis theme packages. Registry schema preparation only; host release and package acceptance gates remain outstanding.

Extensions

Field Type Required Description
theme_schema_version integer ✅
theme_variants array<object> ✅

Example (YAML)

id: example
name: example
version: example
description: example
category: example
kind: theme
tags:
  - example
license: example
icon: example
screenshots:
  - url: example
    caption: example
    alt: example
readme: example
readmes: {}
documentation_url: example
homepage: example
support:
  email: example
  issues_url: example
min_runtime_version: example
theme_schema_version: 1
theme_variants:
  - id: example
    name: example
    file: example

Example (JSON)

{
  "id": "example",
  "name": "example",
  "version": "example",
  "description": "example",
  "category": "example",
  "kind": "theme",
  "tags": [
    "example"
  ],
  "license": "example",
  "icon": "example",
  "screenshots": [
    {
      "url": "example",
      "caption": "example",
      "alt": "example"
    }
  ],
  "readme": "example",
  "readmes": {},
  "documentation_url": "example",
  "homepage": "example",
  "support": {
    "email": "example",
    "issues_url": "example"
  },
  "min_runtime_version": "example",
  "theme_schema_version": 1,
  "theme_variants": [
    {
      "id": "example",
      "name": "example",
      "file": "example"
    }
  ]
}

Cloud (cloud)

Cloud provider integrations for databases and backend services, including account onboarding and connection-scoped management.

Browse published cloud in the registry catalogue.

Extensions

Field Type Required Description
engine string ✅ Concrete database this driver connects to (e.g. "firestore", "postgres", "qdrant"). Tabularis groups the connection catalogue by engine: every driver targeting the same database shares one engine value, so two "firestore" drivers collapse into a single Firestore entry and the user picks which driver.
paradigms array<string> ✅ Data-model families the engine supports, most representative first. Single-model drivers declare one (e.g. ["sql"]); multi-model declare several (SurrealDB: ["document","graph","relational","key-value","vector"]). The first entry is the primary model used to place the engine in the catalogue; every entry feeds the filter chips, so a multi-model engine appears when ANY of its models is selected. Allowed values come from the registry's admin-managed paradigm list (facets), not a fixed enum, so new models never need a schema release.
color string — Hex accent colour shown on the catalogue card and sidebar (e.g. "#f97316").
default_port integer — Default TCP port pre-filled in the connection modal. Omit for file-, folder-, and API-based drivers.
default_username string — Default username pre-filled in the connection modal (e.g. "postgres", "root").
is_builtin boolean — True for drivers shipped with Tabularis. External plugins should omit this or leave it false.
executable string ✅ Relative path to the plugin executable inside the plugin folder. No extension on Linux/macOS; Tabularis appends .exe on Windows automatically.
interpreter string — Optional interpreter for script-based plugins (e.g. "python3", "node"). Omit for native binaries.
capabilities object ✅ Feature flags that control which UI elements Tabularis renders for this driver.
settings array<object> — Optional list of configuration fields the plugin exposes to the user via the Tabularis settings modal.
data_types array<object> — List of data types this driver supports for column creation in the UI.
supports_ssl boolean — true to show the SSL/TLS configuration tab (mode + CA/client cert/key) in the connection modal for this network driver. Defaults to false.
ui_extensions array<object> — UI extension contributions rendered into named slots of the Tabularis interface. Only needed by plugins that ship a frontend module; driver-only plugins omit it.
type_mappings object — Optional map of generic inferred type names to driver-native types, resolved by the host during paste/import (map_inferred_type). Keys are uppercase generic names (e.g. DATETIME, JSON); values are the driver-native equivalents (e.g. TIMESTAMP, JSONB). Lookup is case-insensitive; unmapped types pass through unchanged.
explain_parsers array<object> — Plugin-owned raw EXPLAIN parser IIFE bundles loaded by Tabularis when the plugin is enabled.
connection_metadata boolean — Opt in to get_connection_metadata, which returns connection-specific capabilities, data_types and type_mappings. Static manifest values remain the fallback.
connection_fields object — Optional presentation overrides for host-owned connection fields. Omitted fields keep the standard Tabularis behavior.

Example (YAML)

id: example
name: example
version: example
description: example
category: example
kind: cloud
tags:
  - example
license: example
icon: example
screenshots:
  - url: example
    caption: example
    alt: example
readme: example
readmes: {}
documentation_url: example
homepage: example
support:
  email: example
  issues_url: example
min_runtime_version: example
engine: example
paradigms:
  - example
color: example
default_port: 1
default_username: example
is_builtin: true
executable: example
interpreter: example
capabilities:
  schemas: true
  views: true
  routines: true
  triggers: true
  file_based: true
  in_memory: true
  folder_based: true
  connection_string: true
  connection_string_example: example
  identifier_quote: '"'
  alter_primary_key: true
  auto_increment_keyword: example
  serial_type: example
  inline_pk: true
  alter_column: true
  create_foreign_keys: true
  no_connection_required: true
  single_database: true
  manage_tables: true
  readonly: true
  materialized_views: true
  routine_management: true
  explain: true
  supports_ssl: true
  sql_dialect: postgres
  connection_uri: true
  connection_uri_schemes:
    - example
  table_query_templates: true
  column_comments: true
  sql_syntax:
    extends: postgres
    quotes:
      - open: "'"
        close: "'"
        kind: string
        escape: double
    triple_quoted_strings: true
    string_prefixes:
      - example
    hash_comments: true
    nested_block_comments: true
    line_comment_requires_space: true
    script_blocks: true
    dollar_quoting: true
    string_escape: standard
    like_escape: true
    boolean_literals: keywords
    formatter: bigquery
    keywords:
      - example
    functions:
      - example
  drop_table_sql: true
settings:
  - key: example
    label: example
    type: string
    description: example
    required: true
    options:
      - example
data_types:
  - name: example
    category: numeric
    requires_length: true
    requires_precision: true
    default_length: example
supports_ssl: true
ui_extensions:
  - slot: example
    module: example
    order: 1
    driver: example
type_mappings: {}
explain_parsers:
  - engine: example
    format: example
    module: example
    label: example
connection_metadata: true
connection_fields: {}

Example (JSON)

{
  "id": "example",
  "name": "example",
  "version": "example",
  "description": "example",
  "category": "example",
  "kind": "cloud",
  "tags": [
    "example"
  ],
  "license": "example",
  "icon": "example",
  "screenshots": [
    {
      "url": "example",
      "caption": "example",
      "alt": "example"
    }
  ],
  "readme": "example",
  "readmes": {},
  "documentation_url": "example",
  "homepage": "example",
  "support": {
    "email": "example",
    "issues_url": "example"
  },
  "min_runtime_version": "example",
  "engine": "example",
  "paradigms": [
    "example"
  ],
  "color": "example",
  "default_port": 1,
  "default_username": "example",
  "is_builtin": true,
  "executable": "example",
  "interpreter": "example",
  "capabilities": {
    "schemas": true,
    "views": true,
    "routines": true,
    "triggers": true,
    "file_based": true,
    "in_memory": true,
    "folder_based": true,
    "connection_string": true,
    "connection_string_example": "example",
    "identifier_quote": "\"",
    "alter_primary_key": true,
    "auto_increment_keyword": "example",
    "serial_type": "example",
    "inline_pk": true,
    "alter_column": true,
    "create_foreign_keys": true,
    "no_connection_required": true,
    "single_database": true,
    "manage_tables": true,
    "readonly": true,
    "materialized_views": true,
    "routine_management": true,
    "explain": true,
    "supports_ssl": true,
    "sql_dialect": "postgres",
    "connection_uri": true,
    "connection_uri_schemes": [
      "example"
    ],
    "table_query_templates": true,
    "column_comments": true,
    "sql_syntax": {
      "extends": "postgres",
      "quotes": [
        {
          "open": "'",
          "close": "'",
          "kind": "string",
          "escape": "double"
        }
      ],
      "triple_quoted_strings": true,
      "string_prefixes": [
        "example"
      ],
      "hash_comments": true,
      "nested_block_comments": true,
      "line_comment_requires_space": true,
      "script_blocks": true,
      "dollar_quoting": true,
      "string_escape": "standard",
      "like_escape": true,
      "boolean_literals": "keywords",
      "formatter": "bigquery",
      "keywords": [
        "example"
      ],
      "functions": [
        "example"
      ]
    },
    "drop_table_sql": true
  },
  "settings": [
    {
      "key": "example",
      "label": "example",
      "type": "string",
      "description": "example",
      "required": true,
      "options": [
        "example"
      ]
    }
  ],
  "data_types": [
    {
      "name": "example",
      "category": "numeric",
      "requires_length": true,
      "requires_precision": true,
      "default_length": "example"
    }
  ],
  "supports_ssl": true,
  "ui_extensions": [
    {
      "slot": "example",
      "module": "example",
      "order": 1,
      "driver": "example"
    }
  ],
  "type_mappings": {},
  "explain_parsers": [
    {
      "engine": "example",
      "format": "example",
      "module": "example",
      "label": "example"
    }
  ],
  "connection_metadata": true,
  "connection_fields": {}
}

AI assistants (ai-assistant)

Declarative AI providers for Tabularis. No plugin code is executed.

Browse published ai assistants in the registry catalogue.

Extensions

Field Type Required Description
ai_assistant object ✅
settings array<object> —

Example (YAML)

id: gemini
name: Google Gemini
version: 1.0.1
kind: ai-assistant
description: Google Gemini assistant using the native generateContent API.
ai_assistant:
  api_version: 1
  authentication: api-key
  api_key_env: GEMINI_API_KEY
  api_key_header: x-goog-api-key
  api_key_prefix: ""
  default_models:
    - models/gemini-flash-latest
  generate:
    requests:
      - url: https://generativelanguage.googleapis.com/v1beta/{{model}}:generateContent
        body:
          systemInstruction:
            parts:
              - text: "{{system_prompt}}"
          contents:
            - role: user
              parts:
                - text: "{{prompt}}"
    response:
      path: /candidates/0/content/parts
      select:
        path: /thought
        equals: false
        missing_matches: true
      value_path: /text
  models:
    sources:
      - request:
          url: https://generativelanguage.googleapis.com/v1beta/models
        items_path: /models
        id_path: /name
        filters:
          - path: /supportedGenerationMethods
            contains: generateContent
    cache_seconds: 86400
settings: []
license: Apache-2.0
icon: https://raw.githubusercontent.com/TabularisDB/tabularis-gemini-plugin/main/icon.svg

Example (JSON)

{
  "id": "gemini",
  "name": "Google Gemini",
  "version": "1.0.1",
  "kind": "ai-assistant",
  "description": "Google Gemini assistant using the native generateContent API.",
  "ai_assistant": {
    "api_version": 1,
    "authentication": "api-key",
    "api_key_env": "GEMINI_API_KEY",
    "api_key_header": "x-goog-api-key",
    "api_key_prefix": "",
    "default_models": [
      "models/gemini-flash-latest"
    ],
    "generate": {
      "requests": [
        {
          "url": "https://generativelanguage.googleapis.com/v1beta/{{model}}:generateContent",
          "body": {
            "systemInstruction": {
              "parts": [
                {
                  "text": "{{system_prompt}}"
                }
              ]
            },
            "contents": [
              {
                "role": "user",
                "parts": [
                  {
                    "text": "{{prompt}}"
                  }
                ]
              }
            ]
          }
        }
      ],
      "response": {
        "path": "/candidates/0/content/parts",
        "select": {
          "path": "/thought",
          "equals": false,
          "missing_matches": true
        },
        "value_path": "/text"
      }
    },
    "models": {
      "sources": [
        {
          "request": {
            "url": "https://generativelanguage.googleapis.com/v1beta/models"
          },
          "items_path": "/models",
          "id_path": "/name",
          "filters": [
            {
              "path": "/supportedGenerationMethods",
              "contains": "generateContent"
            }
          ]
        }
      ],
      "cache_seconds": 86400
    }
  },
  "settings": [],
  "license": "Apache-2.0",
  "icon": "https://raw.githubusercontent.com/TabularisDB/tabularis-gemini-plugin/main/icon.svg"
}

Generated by Tabularium for https://registry.tabularis.dev.