Compilar a Partir do Código-Fonte

Visão geral

Compilar o VillageSQL a partir do código-fonte oferece a você os recursos mais recentes e permite personalizar a compilação para o seu ambiente específico.

Pré-requisitos

Antes de começar, certifique-se de ter os seguintes itens instalados:

Git - Para clonar o repositório
CMake 3.16 ou superior - Gerador de sistema de compilação
Compilador C++ - GCC 8+, Clang 8+ ou MSVC 2019+
Ferramentas de compilação - make, ninja ou equivalente
Bibliotecas de desenvolvimento - OpenSSL, ncurses, pkg-config, bison e outras dependências do MySQL

Instalar dependências

Ubuntu/Debian:

sudo apt install cmake libssl-dev libncurses5-dev pkg-config bison \
                 libtirpc-dev rpcsvc-proto build-essential zlib1g-dev

macOS (usando Homebrew): Primeiro, instale o Homebrew caso ainda não o tenha:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Em seguida, instale as dependências:

brew install cmake openssl pkgconf bison libtirpc rpcsvc-proto

Passo 1: Clonar o repositório

Clone o repositório do VillageSQL Server a partir do GitHub. Clone para o seu diretório pessoal (home) para que os passos do CMake abaixo funcionem sem modificações:

cd $HOME
git clone --depth 1 https://github.com/villagesql/villagesql-server.git
cd villagesql-server

O repositório ocupa vários GB por conta da base de código do MySQL.

Passo 2: Configurar com o CMake

Crie um diretório de compilação fora do repositório e configure o projeto: Linux:

# Create build directory (outside the repo)
mkdir -p $HOME/build/villagesql
cd $HOME/build/villagesql

# Configure with CMake
cmake $HOME/villagesql-server -DWITH_DEBUG=1 -DCMAKE_INSTALL_PREFIX=$HOME/mysql

macOS:

# Create build directory (outside the repo)
mkdir -p ~/build/villagesql
cd ~/build/villagesql

# Configure with CMake
cmake ~/villagesql-server -DWITH_DEBUG=1 -DCMAKE_INSTALL_PREFIX=~/mysql -DWITH_SSL=system

Usuários de Linux: Use $HOME para caminhos absolutos. Usuários de macOS: Use ~ (til). Substitua o caminho do repositório pela localização real do seu clone, se for diferente.

Opções do CMake explicadas

<path-to-repo> - Caminho para o repositório clonado do VillageSQL (use $HOME no Linux, ~ no macOS)
-DWITH_DEBUG=1 - Habilita símbolos de depuração (recomendado para desenvolvimento)
-DCMAKE_INSTALL_PREFIX=~/mysql - Define o diretório de instalação
-DWITH_SSL=system - Usa a biblioteca OpenSSL do sistema (obrigatório no macOS)

Opções adicionais do CMake

Compilação de produção sem símbolos de depuração: Linux:

cmake $HOME/villagesql-server -DCMAKE_INSTALL_PREFIX=/usr/local/mysql

macOS:

cmake ~/villagesql-server -DCMAKE_INSTALL_PREFIX=/usr/local/mysql

Com comentário de compilação personalizado: Linux:

cmake $HOME/villagesql-server -DWITH_DEBUG=1 \
      -DCMAKE_INSTALL_PREFIX=$HOME/mysql \
      -DCOMPILATION_COMMENT="VillageSQL Version of MySQL"

macOS:

cmake ~/villagesql-server -DWITH_DEBUG=1 \
      -DCMAKE_INSTALL_PREFIX=~/mysql \
      -DCOMPILATION_COMMENT="VillageSQL Version of MySQL"

Modo de desenvolvedor com avisos mais rigorosos: Linux:

cmake $HOME/villagesql-server -DMYSQL_MAINTAINER_MODE=ON -DWITH_DEBUG=1

macOS:

cmake ~/villagesql-server -DMYSQL_MAINTAINER_MODE=ON -DWITH_DEBUG=1

Se precisar reconfigurar, limpe primeiro o cache do CMake (execute a partir do diretório de compilação):

rm CMakeCache.txt

Passo 3: Compilar o código

Compile o VillageSQL usando make com compilação paralela. A partir do diretório de compilação: Compilar somente o servidor (recomendado para desenvolvimento):

make -j10 mysqld

Compilar tudo:

make -j10

Ajuste o paralelismo (-j10) de acordo com os núcleos da sua CPU. Subtraia de 2 a 4 do total de núcleos para manter o sistema responsivo. Por exemplo, em uma máquina de 12 núcleos, use -j10.

Quando concluir, verifique se o binário do servidor foi compilado: Linux:

ls $HOME/build/villagesql/bin/mysqld

macOS:

ls ~/build/villagesql/bin/mysqld

Passo 4: Inicializar o banco de dados

Antes de iniciar o servidor pela primeira vez, inicialize o diretório de dados: Linux: Produção (com senha gerada - recomendado):

mkdir -p $HOME/mysql-data/data
$HOME/build/villagesql/bin/mysqld --initialize --datadir=$HOME/mysql-data/data --basedir=$HOME/build/villagesql

Desenvolvimento (sem senha - opcional):

mkdir -p $HOME/mysql-data/data
$HOME/build/villagesql/bin/mysqld --initialize-insecure --datadir=$HOME/mysql-data/data --basedir=$HOME/build/villagesql

Executando como root (Docker ou sudo): Se estiver executando como root (por exemplo, no Docker), o MySQL exige a flag --user=root:

# Initialize as root
$HOME/build/villagesql/bin/mysqld --user=root --initialize-insecure --datadir=$HOME/mysql-data/data --basedir=$HOME/build/villagesql

macOS: Produção (com senha gerada - recomendado):

mkdir -p ~/mysql-data/data
~/build/villagesql/bin/mysqld --initialize --datadir=~/mysql-data/data --basedir=~/build/villagesql

Desenvolvimento (sem senha - opcional):

mkdir -p ~/mysql-data/data
~/build/villagesql/bin/mysqld --initialize-insecure --datadir=~/mysql-data/data --basedir=~/build/villagesql

Use --initialize (com senha) para configurações semelhantes às de produção. Use --initialize-insecure (sem senha) apenas para desenvolvimento e testes locais. Ao usar --initialize, uma senha temporária será gerada e exibida no console: A temporary password is generated for root@localhost: <password>

Verifique se a inicialização foi bem-sucedida conferindo se os bancos de dados de sistema foram criados: Linux:

ls $HOME/mysql-data/data/mysql

macOS:

ls ~/mysql-data/data/mysql

Passo 5: Iniciar o servidor

Inicie o servidor VillageSQL: Linux:

$HOME/build/villagesql/bin/mysqld --gdb --datadir=$HOME/mysql-data/data --basedir=$HOME/build/villagesql

Executando como root (Docker ou sudo):

$HOME/build/villagesql/bin/mysqld --user=root --gdb --datadir=$HOME/mysql-data/data --basedir=$HOME/build/villagesql

macOS:

~/build/villagesql/bin/mysqld --gdb --datadir=~/mysql-data/data --basedir=~/build/villagesql

A flag --gdb instala um manipulador de SIGINT para que Ctrl-C interrompa o servidor de forma limpa, o que é útil ao executá-lo interativamente a partir de um terminal. Para executar em segundo plano, adicione --daemonize ao comando mysqld.

Passo 6: Conectar com o cliente MySQL

Abra um novo terminal e conecte-se ao servidor usando o cliente MySQL: Linux: Se estiver usando —initialize-insecure (sem senha):

$HOME/build/villagesql/bin/mysql -u root

Se estiver usando —initialize (com senha gerada):

$HOME/build/villagesql/bin/mysql -u root -p
# Enter the temporary password printed during initialization

macOS: Se estiver usando —initialize-insecure (sem senha):

~/build/villagesql/bin/mysql -u root

Se estiver usando —initialize (com senha gerada):

~/build/villagesql/bin/mysql -u root -p
# Enter the temporary password printed during initialization

Você deverá ver o prompt do MySQL:

Welcome to the VillageSQL Server for MySQL monitor.
Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

mysql>

Verificar a instalação

Verifique se você está executando o VillageSQL:

SELECT VERSION();

As compilações de desenvolvimento incluem o hash do commit do git na string de versão:

8.4.10-villagesql-0.0.5

Passo 7: Configurar usuários e banco de dados

Alterar a senha do root

Se você usou --initialize, altere a senha temporária:

SET PASSWORD = 'your-secure-password';

Criar um usuário de desenvolvimento

Para o desenvolvimento diário, crie um usuário que não seja root:

-- Create user
CREATE USER developer IDENTIFIED BY 'dev-password';

-- Grant all privileges
GRANT ALL PRIVILEGES ON *.* TO developer;

Saia e reconecte-se como o seu novo usuário: Linux:

# Ctrl-D to exit
$HOME/build/villagesql/bin/mysql -u developer -p

macOS:

# Ctrl-D to exit
~/build/villagesql/bin/mysql -u developer -p

Criar um banco de dados

CREATE DATABASE my_database;
USE my_database;

Conecte-se a um banco de dados específico: mysql -u developer -p -D my_database

Para depuração com GDB, execução de testes e contribuição para a base de código do servidor, consulte o Guia de Desenvolvimento do Servidor.

Solução de problemas

A compilação falha por dependências ausentes

Instale os pacotes de desenvolvimento necessários para a sua plataforma. Verifique a mensagem de erro para identificar bibliotecas ausentes específicas.

O servidor não inicia

Verifique se o diretório de dados foi inicializado: ls ~/mysql-data/data/
Verifique se outra instância do MySQL/VillageSQL está usando a porta 3306
Consulte os logs de erro em ~/mysql-data/data/*.err

A instalação da extensão falha

Certifique-se de que a biblioteca da extensão (.so ou .dll) existe na saída da compilação
Verifique se o VillageSQL tem as permissões necessárias para carregar extensões
Verifique se o nome da extensão e o nome do arquivo .veb estão corretos

Próximos passos

Instalando Extensões

Aprenda a instalar, atualizar e gerenciar extensões do VillageSQL.

Criando Extensões em C++

Crie suas próprias extensões personalizadas para o VillageSQL.

Introdução

Guia de início rápido para o VillageSQL.

Getting Started

Server Development

Extensions

Using Extensions

Creating Extensions

Visão geral

Pré-requisitos

Instalar dependências

Passo 1: Clonar o repositório

Passo 2: Configurar com o CMake

Opções do CMake explicadas

Opções adicionais do CMake

Passo 3: Compilar o código

Passo 4: Inicializar o banco de dados

Passo 5: Iniciar o servidor

Passo 6: Conectar com o cliente MySQL

Verificar a instalação

Passo 7: Configurar usuários e banco de dados

Alterar a senha do root

Criar um usuário de desenvolvimento

Criar um banco de dados

Solução de problemas

A compilação falha por dependências ausentes

O servidor não inicia

A instalação da extensão falha

Próximos passos

Instalando Extensões

Criando Extensões em C++

Introdução

​Visão geral

​Pré-requisitos

​Instalar dependências

​Passo 1: Clonar o repositório

​Passo 2: Configurar com o CMake

​Opções do CMake explicadas

​Opções adicionais do CMake

​Passo 3: Compilar o código

​Passo 4: Inicializar o banco de dados

​Passo 5: Iniciar o servidor

​Passo 6: Conectar com o cliente MySQL

​Verificar a instalação

​Passo 7: Configurar usuários e banco de dados

​Alterar a senha do root

​Criar um usuário de desenvolvimento

​Criar um banco de dados

​Solução de problemas

​A compilação falha por dependências ausentes

​O servidor não inicia

​A instalação da extensão falha

​Próximos passos

Instalando Extensões

Criando Extensões em C++

Introdução

Visão geral

Pré-requisitos

Instalar dependências

Passo 1: Clonar o repositório

Passo 2: Configurar com o CMake

Opções do CMake explicadas

Opções adicionais do CMake

Passo 3: Compilar o código

Passo 4: Inicializar o banco de dados

Passo 5: Iniciar o servidor

Passo 6: Conectar com o cliente MySQL

Verificar a instalação

Passo 7: Configurar usuários e banco de dados

Alterar a senha do root

Criar um usuário de desenvolvimento

Criar um banco de dados

Solução de problemas

A compilação falha por dependências ausentes

O servidor não inicia

A instalação da extensão falha

Próximos passos