SnapOtter/apps/docs/pt-BR/guide/database.md

description, i18n_source_hash, i18n_provenance, i18n_output_hash, i18n_hash_version

description	i18n_source_hash	i18n_provenance	i18n_output_hash	i18n_hash_version
Esquema do banco de dados PostgreSQL, tabelas, migrações e procedimentos de backup do SnapOtter.	a68264552836	machine	bd8d8459b7e0	2

Banco de dados

O SnapOtter usa PostgreSQL 17 com Drizzle ORM (pg-core / node-postgres) para persistência de dados. O esquema é definido em apps/api/src/db/schema.ts.

A conexão é configurada através da variável de ambiente DATABASE_URL (padrão postgres://snapotter:snapotter@postgres:5432/snapotter). No Docker Compose, o contêiner do Postgres armazena seus dados no volume nomeado SnapOtter-pgdata.

Tabelas

users

Armazena contas de usuário. Criada automaticamente na primeira execução a partir de DEFAULT_USERNAME e DEFAULT_PASSWORD.

Coluna	Tipo	Observações
id	uuid	Chave primária
username	varchar	Único, obrigatório
passwordHash	varchar	hash scrypt
role	varchar	admin, editor ou user
mustChangePassword	boolean	Flag de redefinição de senha forçada
createdAt	timestamp	Horário de criação
updatedAt	timestamp	Horário da última atualização

sessions

Sessões de login ativas. Cada linha vincula um token de sessão a um usuário.

Coluna	Tipo	Observações
id	varchar	Chave primária (token de sessão)
userId	uuid	Chave estrangeira para users.id
expiresAt	timestamp	Horário de expiração
createdAt	timestamp	Horário de criação

teams

Grupos para organizar usuários. Administradores podem atribuir usuários a equipes.

Coluna	Tipo	Descrição
id	uuid	Chave primária
name	varchar (único, máx. 50 caracteres)	Nome da equipe
createdAt	timestamp	Horário de criação

api_keys

Chaves de API para acesso programático. A chave bruta é exibida uma única vez na criação; apenas o hash é armazenado.

Coluna	Tipo	Observações
id	uuid	Chave primária
userId	uuid	Chave estrangeira para users.id
keyHash	varchar	hash scrypt da chave
name	varchar	Rótulo fornecido pelo usuário
createdAt	timestamp	Horário de criação
lastUsedAt	timestamp	Atualizado a cada requisição autenticada

As chaves têm o prefixo si_ seguido de 96 caracteres hexadecimais (48 bytes aleatórios).

pipelines

Cadeias de ferramentas salvas que os usuários criam na interface.

Coluna	Tipo	Observações
id	uuid	Chave primária
name	varchar	Nome do pipeline
description	varchar	Descrição opcional
steps	jsonb	Array de objetos { toolId, settings }
createdAt	timestamp	Horário de criação

user_files

Biblioteca de arquivos persistente. Uma edição salva é inserida por padrão como uma linha raiz independente ("salvar como novo": version 1, parentId null, então o original permanece listado), ou como uma versão vinculada ao pai quando você sobrescreve o original (parentId definido, version incrementado, substituindo-o). A coluna toolChain registra as ferramentas aplicadas.

Coluna	Tipo	Descrição
id	uuid	Chave primária
userId	uuid	FK para users (CASCADE DELETE)
originalName	varchar	Nome do arquivo enviado original
storedName	varchar	Nome do arquivo em disco
mimeType	varchar	Tipo MIME
size	integer	Tamanho do arquivo em bytes
width	integer	Largura da imagem em px
height	integer	Altura da imagem em px
version	integer	Número da versão (1 = original)
parentId	uuid ou null	FK para user_files (versão pai)
toolChain	jsonb	IDs de ferramentas aplicados em ordem para produzir esta versão
createdAt	timestamp	Horário de criação

jobs

Rastreia jobs de processamento para relatório de progresso e limpeza.

Coluna	Tipo	Observações
id	uuid	Chave primária
type	varchar	Identificador da ferramenta ou do pipeline
status	varchar	queued, processing, completed ou failed
progress	real	Fração de 0.0 a 1.0
inputFiles	jsonb	Array de caminhos de arquivos de entrada
outputPath	varchar	Caminho para o arquivo de resultado
settings	jsonb	Configurações da ferramenta utilizadas
error	varchar	Mensagem de erro se falhou
createdAt	timestamp	Horário de criação
completedAt	timestamp	Horário de conclusão

settings

Armazenamento de chave-valor para configurações de todo o servidor que os administradores podem alterar pela interface.

Coluna	Tipo	Observações
key	varchar	Chave primária
value	varchar	Valor da configuração
updatedAt	timestamp	Horário da última atualização

roles

Papéis personalizados com permissões granulares.

Coluna	Tipo	Observações
id	uuid	Chave primária
name	varchar	Nome único do papel
description	varchar	Descrição opcional
permissions	jsonb	Array de strings de permissão
createdAt	timestamp	Horário de criação

audit_log

Registro de ações relevantes para segurança.

Coluna	Tipo	Observações
id	uuid	Chave primária
userId	uuid	FK para users
action	varchar	Tipo de ação
details	jsonb	Dados específicos da ação
createdAt	timestamp	Horário da ação

user_preferences

Estado da interface por usuário, indexado pelo nome da preferência. Guarda as ferramentas fixadas da página inicial, gravadas por meio de PUT /api/v1/preferences.

Coluna	Tipo	Observações
userId	text	FK para users, com exclusão em cascata. Chave primária junto com key
key	text	Nome da preferência. Chave primária junto com userId
value	jsonb	Conteúdo da preferência
updatedAt	timestamp	Última gravação

Migrações

O Drizzle cuida das migrações de esquema. Os arquivos de migração ficam em apps/api/drizzle/. Durante o desenvolvimento:

cd apps/api
npx drizzle-kit generate   # generate a migration from schema changes
npx drizzle-kit migrate    # apply pending migrations

Em produção, as migrações pendentes são aplicadas automaticamente na inicialização.

Backup e restauração

O banco de dados relacional reside no volume SnapOtter-pgdata do contêiner Postgres, não no volume /data do aplicativo.

Backup lógico com validação (recomendado)

# Dump into PostgreSQL's portable custom archive format
docker exec SnapOtter-postgres \
  pg_dump --format=custom --no-owner -U snapotter snapotter > snapotter.dump
test -s snapotter.dump
docker exec -i SnapOtter-postgres pg_restore --list < snapotter.dump >/dev/null

# Restore into a fresh/disposable target first and fail on the first SQL error
docker exec -i SnapOtter-postgres \
  pg_restore --exit-on-error --clean --if-exists --no-owner \
  -U snapotter -d snapotter < snapotter.dump

Este dump do banco de dados não contém objetos de biblioteca salvos em /data/files ou estado BullMQ durável no Redis. Faça backup e restaure-os com o procedimento coordenado em Segurança e Proteção.

Instantâneo de volume frio

# Stop every service first, then use your storage platform to snapshot the
# PostgreSQL, app-data, and Redis volumes as one crash-consistent set.
docker compose -f docker/docker-compose.yml stop

Não copie um diretório de dados PostgreSQL ativo com tar. Componha nomes de volume de prefixos por projeto, portanto resolva os IDs de volume montados de docker inspect ou de sua plataforma de armazenamento em vez de assumir o rótulo literal SnapOtter-pgdata.

Migrando da versão 1.x (SQLite)

Atualizar do SnapOtter 1.x tem seu próprio guia: veja Atualizando da 1.x para a 2.0. Em resumo, reutilize seu volume /data existente e a 2.0 detecta e importa automaticamente o /data/snapotter.db na primeira inicialização (ou defina SQLITE_MIGRATE_PATH para apontar para ele explicitamente). Faça backup de todo o volume /data primeiro, não apenas de snapotter.db: a 1.x usa o modo WAL do SQLite, então um contêiner parado frequentemente deixa a maior parte de seus dados em snapotter.db-wal ao lado de um snapotter.db quase vazio.