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. Estes passos compilam o VillageSQL sobre o MySQL 8.4 upstream. O VillageSQL também é compilado sobre o Percona Server como base de código alternativa — consulte a página Compilação Percona.

Pré-requisitos

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

Git - Para clonar o repositório
Uma plataforma compatível - Debian ou Ubuntu Linux, ou macOS com Homebrew

O repositório inclui um script que instala o CMake e as bibliotecas de desenvolvimento necessárias para a compilação. No Linux, ele também instala o compilador; no macOS, as Xcode Command Line Tools o fornecem. O Passo 2 executa esse script, portanto você não precisa instalar esses pacotes por conta própria.

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

Para compilar exatamente o código que uma release entregou, clone a tag que a marca em vez do branch: -b publish/mysql-8.4_0.0.7.

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

Passo 2: Instalar as dependências de compilação

Execute o script de configuração a partir do repositório que você acabou de clonar. O script detecta o seu sistema operacional e instala os pacotes necessários para a compilação:

cd "$HOME/villagesql-server"
villagesql/bld_tools/setup_build_env.sh

No Linux, o script usa o apt-get e solicita sudo. No macOS, ele usa o Homebrew. A CI do VillageSQL instala as suas dependências de compilação com o mesmo script, portanto a lista de pacotes permanece atualizada em relação à compilação.

O script é compatível com Debian ou Ubuntu Linux e com macOS. Em outra distribuição Linux, leia villagesql/bld_tools/setup_linux_build_env.sh e instale os pacotes equivalentes com o seu próprio gerenciador de pacotes.

Passo 3: Configurar com o CMake

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

# 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"

No macOS, informe também o diretório do OpenSSL 3. O openssl sem versão do Homebrew agora é o OpenSSL 4, e o servidor não compila com ele:

cmake "$HOME/villagesql-server" -DWITH_DEBUG=1 -DCMAKE_INSTALL_PREFIX="$HOME/mysql" \
  -DWITH_SSL="$(brew --prefix openssl@3)"

Os caminhos usam $HOME em vez de ~ em todo o documento, nas duas plataformas. O shell só expande ~ no início de uma palavra, portanto --datadir=~/mysql-data/data chega ao mysqld como um diretório literalmente chamado ~ e o servidor é abortado. As aspas em "$HOME/..." também mantêm o caminho íntegro caso o nome do seu diretório pessoal contenha um espaço. Substitua o caminho do repositório pela localização real do seu clone, se for diferente.

Opções do CMake explicadas

"$HOME/villagesql-server" - Caminho para o repositório clonado do VillageSQL
-DWITH_DEBUG=1 - Compila com o mecanismo DBUG e as asserções ativados, sem otimização (recomendado para desenvolvimento)
-DCMAKE_INSTALL_PREFIX="$HOME/mysql" - Define o diretório de instalação
-DWITH_SSL="$(brew --prefix openssl@3)" - Aponta o cmake para o OpenSSL 3. O Passo 2 instala o openssl@3. Se você pulou o Passo 2, execute brew install openssl@3 antes, porque brew --prefix openssl@3 imprime um caminho mesmo quando o pacote não está instalado, e o cmake então para com Wrong option or path for WITH_SSL=.

Opções adicionais do CMake

Compilação de produção:

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

Com comentário de compilação personalizado:

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

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

rm CMakeCache.txt

Passo 4: Compilar o código

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

make -j10

Isso compila o servidor, o cliente mysql usado no Passo 7, o SDK de Extensões e os arquivos .veb das extensões de exemplo. Compilar somente o servidor e o cliente:

make -j10 mysqld mysql

Esse par é mais rápido e não compila o SDK de Extensões nem os arquivos .veb de exemplo, portanto INSTALL EXTENSION vsql_complex não encontra nenhum pacote para instalar e uma compilação de extensão que passa -DVillageSQL_BUILD_DIR não encontra o SDK.

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 os binários do servidor e do cliente foram compilados:

ls "$HOME/build/villagesql/bin/mysqld" "$HOME/build/villagesql/bin/mysql"

Passo 5: Inicializar o banco de dados

Antes de iniciar o servidor pela primeira vez, inicialize o diretório de dados: 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"

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:

ls "$HOME/mysql-data/data/mysql"

Passo 6: Iniciar o servidor

Inicie o servidor VillageSQL:

"$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"

A flag --gdb desbloqueia o SIGINT, então Ctrl-C interrompe o servidor quando você o executa a partir de um terminal. Ela também suprime o backtrace de falha e anula --core-file, então não a use quando precisar de um relatório de falha. Para executar em segundo plano, adicione --daemonize ao comando mysqld.

Passo 7: Conectar com o cliente MySQL

Abra um novo terminal e conecte-se ao servidor usando o cliente MySQL: 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

Você deverá ver o prompt do MySQL:

Welcome to the MySQL monitor.  Commands end with ; or \g.
Your MySQL connection id is 8
Server version: <version> Source distribution

mysql>

Alterar a senha do root

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

SET PASSWORD = 'your-secure-password';

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.11-villagesql-0.0.7-dev-689c74a9-debug

Passo 8: Configurar usuários e banco de dados

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:

# Ctrl-D to exit
"$HOME/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

Passo 9: Executar os testes

Verifique a compilação com a suíte de testes do VillageSQL, a partir do diretório de compilação:

cd "$HOME/build/villagesql"
mysql-test/mysql-test-run.pl --do-suite=villagesql --nounit-tests --parallel=auto

--nounit-tests pula os testes de unidade do MySQL upstream, que incluem falhas conhecidas. Execute os testes de unidade do VillageSQL separadamente:

make -j10 villagesql-unit-tests && ctest -L villagesql

Um teste com falha faz qualquer um dos dois comandos sair com código diferente de zero. Para depuração com GDB, execução de testes individuais, regravação dos resultados esperados e contribuição para a base de código do servidor, consulte o Guia de Desenvolvimento do Servidor.

Compilar pacotes nativos (RPM/DEB)

villagesql/bld_tools/build_deb.sh e build_rpm.sh compilam um pacote Debian ou RPM diretamente da árvore de código-fonte, para instalar com o seu gerenciador de pacotes em vez de seguir os passos manuais acima. Nenhum dos dois precisa de uma configuração prévia do CMake — ambos derivam a versão do pacote dos arquivos VSQL_VERSION e MYSQL_VERSION na raiz do repositório. Com os Passos 1-2 já concluídos, instale as ferramentas de empacotamento e as dependências de compilação que o Passo 2 deixa de fora — no Debian/Ubuntu, dpkg-dev, debhelper, libcurl4-openssl-dev, libsystemd-dev e systemd-dev; no Enterprise Linux, rpm-build — e então execute um deles a partir da raiz do repositório:

cd "$HOME/villagesql-server"
villagesql/bld_tools/build_deb.sh   # writes to ./debs
# or
villagesql/bld_tools/build_rpm.sh   # writes to ./rpms

De acordo com villagesql-server#931, que adicionou essas ferramentas, o pacote resultante substitui uma instalação existente do MySQL no host de destino em vez de ser instalado ao lado dela.

Solução de problemas

A compilação falha por dependências ausentes

Execute o script de configuração novamente. O Passo 3 deixa você no diretório de compilação, portanto informe o caminho absoluto do script:

"$HOME/villagesql-server/villagesql/bld_tools/setup_build_env.sh"

Verifique a mensagem de erro para identificar a biblioteca ausente específica.

O servidor não inicia

Verifique se o diretório de dados foi inicializado: ls "$HOME/mysql-data/data/"
Verifique se outra instância do MySQL/VillageSQL está usando a porta 3306
Leia as mensagens que o mysqld exibe no seu terminal, ou inicie-o com --log-error="$HOME/mysql-data/error.log" e leia esse arquivo

A instalação da extensão falha

Certifique-se de que o arquivo .veb da extensão existe no diretório veb_dir ($HOME/build/villagesql/lib/veb para uma compilação a partir do código-fonte) e de que sua biblioteca se chama <extension_name>.so no Linux e no macOS
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

Usando Extensões

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

Criando Extensões

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

Using Extensions

Creating Extensions

Visão geral

Pré-requisitos

Passo 1: Clonar o repositório

Passo 2: Instalar as dependências de compilação

Passo 3: Configurar com o CMake

Opções do CMake explicadas

Opções adicionais do CMake

Passo 4: Compilar o código

Passo 5: Inicializar o banco de dados

Passo 6: Iniciar o servidor

Passo 7: Conectar com o cliente MySQL

Alterar a senha do root

Verificar a instalação

Passo 8: Configurar usuários e banco de dados

Criar um usuário de desenvolvimento

Criar um banco de dados

Passo 9: Executar os testes

Compilar pacotes nativos (RPM/DEB)

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

Usando Extensões

Criando Extensões

Introdução

​Visão geral

​Pré-requisitos

​Passo 1: Clonar o repositório

​Passo 2: Instalar as dependências de compilação

​Passo 3: Configurar com o CMake

​Opções do CMake explicadas

​Opções adicionais do CMake

​Passo 4: Compilar o código

​Passo 5: Inicializar o banco de dados

​Passo 6: Iniciar o servidor

​Passo 7: Conectar com o cliente MySQL

​Alterar a senha do root

​Verificar a instalação

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

​Criar um usuário de desenvolvimento

​Criar um banco de dados

​Passo 9: Executar os testes

​Compilar pacotes nativos (RPM/DEB)

​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

Usando Extensões

Criando Extensões

Introdução

Visão geral

Pré-requisitos

Passo 1: Clonar o repositório

Passo 2: Instalar as dependências de compilação

Passo 3: Configurar com o CMake

Opções do CMake explicadas

Opções adicionais do CMake

Passo 4: Compilar o código

Passo 5: Inicializar o banco de dados

Passo 6: Iniciar o servidor

Passo 7: Conectar com o cliente MySQL

Alterar a senha do root

Verificar a instalação

Passo 8: Configurar usuários e banco de dados

Criar um usuário de desenvolvimento

Criar um banco de dados

Passo 9: Executar os testes

Compilar pacotes nativos (RPM/DEB)

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