Skip to main content
Get a VillageSQL Server instance running, connect to it, and try out the extension system.

Step 1: Install VillageSQL

Run VillageSQL in a container with no host-side installation:

Option B: Shell Script

Install VillageSQL directly on your machine using the official installation script. It downloads and configures the server binary for your platform.
To inspect the script before running it: curl https://villagesql.com/shell | less

Option C: Build from Source

For development or custom builds, follow the Clone and Build from Source Guide to compile from the latest code.

Step 2: Connect to the Server

Once your server is running, connect using any standard MySQL client:

Step 3: Install Your First Extension

VillageSQL ships with example extensions you can install immediately. Install the vsql_complex extension to add support for complex numbers:
Verify installation:
You should see vsql_complex listed. For more details, see Installing Extensions.

Step 4: Use Extended Data Types

Now that the extension is active, you can use the COMPLEX data type in your tables just like native types.
To uninstall an extension:

Next Steps

Now that you have VillageSQL running and have verified the extension system, explore more:

Managing Extensions

Learn how to install and manage other extensions.

Create an Extension

Learn how to build your own extensions for VillageSQL.

Upgrade Guide

Upgrading from a prior version or migrating from MySQL.

Troubleshooting

Server Won’t Start

Common issues:
  • Port 3306 already in use: configure your server to use a different port
  • Permissions: Ensure files are readable/executable