This repository contains the official documentation for VillageSQL Server for MySQL - a community-driven, extensible fork of MySQL that is a drop-in replacement.
VillageSQL is the innovation platform for MySQL and a new path for MySQL in the agentic AI era. VillageSQL Server for MySQL is an open-source, drop-in replacement, and extensible tracking fork of MySQL. It introduces a robust extension framework that supports custom data types and custom functions (with custom indexes coming soon). VillageSQL's mission is to empower the MySQL community by enabling permissionless innovation. We have built a few extensions to showcase the framework, including:
- Network Address data types
- UUID
- Cryptographic functions
- SQL-based LLM prompting
- HTTP client functions
- N-dimensional cube type
- A real boolean type
- An embedded REST API server
View the documentation at villagesql.com/docs
We welcome suggestions. The documentation pages are built using Mintlify. Install the Mintlify CLI to preview your documentation changes locally. To install, use the following command:
npm i -g mint
Run the following command at the root of your documentation, where your docs.json is located:
mint dev
View your local preview at http://localhost:3000.
We welcome contributions to improve our documentation! Please see our contributing guidelines for more information.
- GitHub Issues - Report bugs or request new features
- Discussions - Join the discussion on GitHub Discussions
- Discord - Chat with the community on Discord
- If your dev environment isn't running: Run
mint updateto ensure you have the most recent version of the CLI. - If a page loads as a 404: Make sure you are running in a folder with a valid
docs.json.