A single setting to disable all schema changes (DDL) at run time, Lookup contents included

Aberta
#1,649 3 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 6 dias

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
15/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
mysql, postgresql, python
Domínio
backend, databases

Direção de pesquisa

Start with schemas.py around lines 329-340 (Lookup contents insertion) and Schema.call / _decorate_table, then autopopulate.py lines 186-187 and jobs.py lines 383-384, where jobs tables are declared. The open design question is where a single allow_ddl check should sit, and whether it must cover alter() and drop(). Done means that with the setting false, each of these paths raises a clear error naming the setting, and an explicit declare_all() path exists for deployments.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

What the library does today

Schema changes happen implicitly whenever a process activates a schema with a privileged login:

  • Activating a schema declares every table that doesn't exist yet (Schema.__call__ → _decorate_table, when create_tables is true, the default).
  • Declaring a Lookup table inserts any contents rows that are missing (schemas.py:329–340).
  • populate() and jobs.refresh() declare a table's ~~jobs table on first use (autopopulate.py:186–187, jobs.py:383–384), even when create_tables is false.
  • alter() and drop() run whenever they're called.

So setting create_tables=False, as the production guide advises, still leaves schema changes at run time, through the jobs tables and Lookup contents. Nothing turns them all off at once.

Proposal

A single setting, for example database.allow_ddl (env DJ_ALLOW_DDL), default true. With it set to false, nothing changes the schema:

  • no table, part or jobs-table declaration;
  • no Lookup contents inserted, updated or deleted;
  • no alter(), drop() or schema creation.

An attempt raises a clear error naming the setting, rather than silently doing nothing. A missing table is reported as missing, not declared, and populate() and refresh() fail clearly if a jobs table doesn't exist.

Why

In a controlled deployment, schema changes are a deployment step: planned, reviewed and applied together, before the new code runs. Run-time processes (workers, notebooks, dashboards) then read and write rows but never change the schema. This setting lets an operator enforce that in the library, not only through database privileges.

Also needed

An explicit way for the deployment step to apply schema changes (declare missing tables, their jobs tables and Lookup contents) with the setting on, e.g. a schema.declare_all(), or the setting being overridable for one call.

Expected behavior

With allow_ddl=false, a pipeline whose tables all exist runs as before; one with a missing table, a missing jobs table or changed Lookup contents fails at activation or populate, with a message that says what's missing.

Related

#1552 proposes declaring draft tables on the server beside the pipeline's tables. With schema changes treated as a deployment step, should drafting stay entirely in memory instead?

Linguagem predominante
Python
Estrelas
198
Forks
103
Merge médio
6d 1h
PRs com merge (30d)
10

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de datajoint/datajoint-python

Todas as issues de datajoint/datajoint-python

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.