VillageSQL
An open-source tracking fork of MySQL 8.4 LTS that introduces an extension framework for custom data types and functions.
What is VillageSQL?
VillageSQL Server is an open-source, drop-in compatible fork of MySQL 8.4.8 LTS designed as an innovation platform for the agentic AI era. It introduces the VillageSQL Extension Framework (VEF), which allows developers to extend the database with custom, high-performance logic and domain-specific data types directly within SQL. This solves the problem of MySQL's limited extensibility for modern, data-intensive applications.
Database engineers and developers building data-intensive or AI-driven applications who need to embed custom logic and domain-specific data types directly into MySQL. It is also for teams seeking a MySQL-compatible database that can be extended without forking the core server.
Developers choose VillageSQL over standard MySQL because it offers native extensibility through a framework for building and loading custom extensions, enabling high-performance, server-side logic and specialized data types while maintaining full compatibility with the existing MySQL 8.4 ecosystem and tooling.
Overview
VillageSQL - a drop-in replacement for MySQL with extensions
Use Cases
Best For
- Extending MySQL with custom, high-performance C++ functions that run directly in the database server.
- Adding domain-specific data types (e.g., complex numbers, network addresses, UUIDs) to MySQL schemas and queries.
- Building AI-powered applications that require custom SQL functions for agentic workflows or data processing.
- Developing specialized database extensions as modular bundles (.veb files) that can be installed and managed via SQL commands.
- Migrating existing MySQL 8.4 applications to a more extensible platform without changing client code or tools.
- Experimenting with embedded analytical engines or cryptographic functions within a MySQL-compatible environment.
Not Ideal For
- Production deployments requiring stable, battle-tested databases
- Teams needing quick setup with Docker or pre-built binaries for rapid prototyping
- Projects that rely on indexing custom data types for performance optimization
- Windows-based development environments or cross-platform teams
Pros & Cons
Pros
Acts as a full replacement for MySQL 8.4 LTS, ensuring existing applications, tools, and queries work without modification, as emphasized in the README's key features.
Introduces the VillageSQL Extension Framework for building and loading .veb bundles, enabling high-performance C++ logic and custom data types directly in SQL, solving MySQL's extensibility limits.
Allows defining domain-specific types like complex numbers and network addresses, with built-in extensions such as vsql_complex, facilitating specialized operations without external processing.
Clear roadmap includes planned features like custom indexes, Docker support, and analytical engines, showing commitment to addressing current limitations and expanding capabilities.
Cons
Project is explicitly in alpha, not recommended for production, and may have bugs or breaking changes as it evolves, per the README warning.
Requires building from source with multiple dependencies like CMake and OpenSSL, and manual initialization steps, lacking Docker or binary packages for easy installation.
Custom data types cannot be indexed, and aggregate function support is partial (e.g., no SUM or AVG), restricting advanced querying and performance optimizations.
Frequently Asked Questions
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.