Pular para conteúdo

Primeiros passos

Esta página leva você do zero a um pacote implantado em dois ambientes, com o histórico registrado.

1. Instale

Pegue sua chave de download grátis em sql2devops.com/pt/download e então:

$env:SQL2DEVOPS_DOWNLOAD_KEY="s2dk_..."; irm https://sql2devops.com/install.ps1 | iex

Instala para o seu usuário (sem administrador) em %LOCALAPPDATA%\Programs\Sql2DevOps e coloca no PATH.

curl -fsSL https://sql2devops.com/install.sh | SQL2DEVOPS_DOWNLOAD_KEY=s2dk_... sh

Instala em ~/.local/share/sql2devops/<versão> e cria o link ~/.local/bin/sql2devops.

Os dois instaladores conferem o arquivo com os checksums SHA-256 publicados. Confira:

sql2devops version

2. Rode um script

A string de conexão sempre vem de uma variável de ambiente, nunca de um parâmetro da linha de comando, para não aparecer em logs nem no histórico do terminal.

export SQL2DEVOPS_DSN='postgres://usuario:senha@localhost:5432/app?sslmode=disable'
sql2devops exec -d postgres --dry-run script.sql   # mostra como o script é dividido
sql2devops exec -d postgres script.sql

3. Crie um repositório de controle

O repositório de controle guarda os pacotes enviados e o histórico. Pode ser qualquer repositório Git em que as suas pipelines consigam fazer push; um repositório privado vazio é um bom começo.

git clone [email protected]:sua-org/sql-control.git
export SQL2DEVOPS_CONTROL_DIR=$PWD/sql-control

4. Assine o histórico (recomendado)

sql2devops key generate --name ci --out ~/ci.key
export SQL2DEVOPS_SIGNING_KEY="$(cat ~/ci.key)"

Guarde o ci.key como secret da pipeline. A parte pública fica registrada no repositório de controle, para qualquer um conferir o histórico.

5. Descreva o projeto

sql2devops project init financeiro -d postgres --envs DEV,PROD

Edite projects/financeiro/project.yaml no repositório de controle (aprovadores, variáveis de ambiente com cada string de conexão) e faça o commit. Veja Projetos e ambientes.

6. Escreva um pacote

CHG-1001/
  sql2devops.yaml
  01-taxas.sql
  rollback/01-taxas.sql
# sql2devops.yaml
package: CHG-1001
project: financeiro
target: financeiro-db
steps:
  - file: 01-taxas.sql
    type: ddl
    rollback: rollback/01-taxas.sql

7. Envie e promova

sql2devops package check -d postgres ./CHG-1001
sql2devops package submit ./CHG-1001
sql2devops promote CHG-1001 --project financeiro     # roda em DEV
sql2devops approve CHG-1001 --project financeiro --env PROD
sql2devops promote CHG-1001 --project financeiro     # roda em PROD
sql2devops status --project financeiro
PACKAGE    VERSION   DEV   PROD   NEXT
CHG-1001   v1        ok    ok     done

Daqui em diante, coloque os mesmos comandos na sua pipeline.