Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

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

未关闭
  • 哪里不对？
#301 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 3 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
45/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
活跃
技术栈
docker-compose, mysql, postgresql, python
领域
databases, documentation

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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".
主要语言
Jupyter Notebook
星标
7
派生
12
平均合并
2 天 19 小时
30 天内合并 PR
20

环境准备

  • 提供 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 没有贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

datajoint/datajoint-docs 的其他 Issue

查看 datajoint/datajoint-docs 的全部 Issue

相似的 Issue

更多 Databases Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。