Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

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

オープン
#301 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 3 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
45/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
docker-compose, mysql, postgresql, python

調査の方向性

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時間
マージ済み PR(30日)
20

環境構築

  • Dockerfile または Docker Compose ファイルあり
  • プルリクエストのテンプレートなし
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

datajoint/datajoint-docs のほかの issue

datajoint/datajoint-docs の issue をすべて見る

似ている issue

Databases の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。