Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Prefix guidance contradicts itself; update for database.name as the schema namespace

Aperta
  • Qualcosa non va?
#301 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 3 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
45/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
docker-compose, mysql, postgresql, python
Ambito
databases, documentation

Direzione di ricerca

Start with how-to/deploy-production.md (§Use Database Prefixes, plus the environment, Compose and checklist examples) and reference/configuration.md (lines 25, 28, 269), then how-to/configure-database.md §Database Name. Confirm the library behaviour in datajoint-python#1582 before writing, since the MySQL schema-prefix wording depends on it. Done when DJ_DATABASE_PREFIX is gone from the examples, both backends are described for database.name, and the version admonitions are updated.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation

Library proposal: datajoint/datajoint-python#1582 (database.name namespaces schema names on MySQL as it does on PostgreSQL).

What the docs say now
  • how-to/deploy-production.md §Use Database Prefixes:
    • It teaches database.database_prefix / DJ_DATABASE_PREFIX with manual concatenation (dj.Schema(prefix + 'subject')).
    • It does so under a banner saying the setting is deprecated and "will be removed in 2.3", with replacement advice that covers only PostgreSQL.
    • The same page uses DJ_DATABASE_PREFIX in its environment, Docker Compose and checklist examples (lines ~203, 221, 288, 311–312, 336); one of these is a validation function that requires database_prefix in production.
  • how-to/configure-database.md: it says database.name is "PostgreSQL only" and that setting it on MySQL emits a warning (line 72, §Database Name).
  • reference/configuration.md: it says database.name is for PostgreSQL connections and database_prefix is "deprecated — use database.name instead" (lines 25, 28, 269), without saying what that means on MySQL.

A MySQL user who reads all three ends up with no supported way to separate projects.

Changes, once the library change is released
  • configure-database.md:
    • Describe database.name as the namespace on both backends: the database on PostgreSQL, a schema-name prefix (name_) on MySQL.
    • Add a short example with two projects on one server, and update the settings table.
  • deploy-production.md: rewrite §Use Database Prefixes as "Separate projects on a shared server".
    • Set DJ_DATABASE_NAME per project; pipelines write plain schema names.
    • Grant by pattern on MySQL (lab\_project\_%) and by database on PostgreSQL.
    • Show the migration from hand-made prefixes.
    • Replace DJ_DATABASE_PREFIX in the environment, Compose and checklist examples.
  • reference/configuration.md: new descriptions for both settings and a version note on database.name.
  • Version admonitions: "Changed in 2.x" on database.name; on database_prefix, drop "removed in 2.3".
Lingua principale
Jupyter Notebook
Stelle
7
Fork
12
Merge medio
2g 19h
PR unite (30g)
20

Preparare l'ambiente

  • Include un Dockerfile o un file Docker Compose
  • Nessun modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di datajoint/datajoint-docs

Tutte le issue di datajoint/datajoint-docs

Issue simili

Altre issue su Databases

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.