Skip to main content
Install VillageSQL extensions to add custom types, functions, and capabilities to your database.

Command Syntax

Extensions are distributed as .veb (VillageSQL Extension Bundle) files containing compiled libraries and metadata.

Extension Naming Conventions

VillageSQL uses different naming conventions in different contexts:
  • SQL commands: Use underscores: INSTALL EXTENSION vsql_uuid
  • Repository names: Use hyphens: github.com/villagesql/vsql-uuid
  • File names: Use underscores: vsql_uuid.veb
  • manifest.json: Use underscores to match SQL: "name": "vsql_uuid"
Example:

Prerequisites

  • Running VillageSQL Server instance
  • Administrative access (root or equivalent)

Installing Built-in Extensions

Built-in extensions included with VillageSQL are already in the veb_dir. Simply enable them:

Verify Installation

Output:

Test Functionality

Installing External Extensions

For extensions downloaded or built separately:
Your server must have veb_dir configured before you can install external extensions. See Configuring veb_dir.

1. Copy the .veb File

Find your server’s extension directory, then copy the .veb file into it:

2. Install Extension

3. Verify Installation

Troubleshooting

For more troubleshooting, see Managing Extensions.

Next Steps

Managing Extensions

Monitor and troubleshoot installed extensions

Available Extensions

Browse extensions you can install

Create Extensions

Build your own extensions