Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở
  • Có gì không ổn?
#301 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 3 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
docker-compose, mysql, postgresql, python
Lĩnh vực
databases, documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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".
Ngôn ngữ chính
Jupyter Notebook
Star
7
Fork
12
Merge trung bình
2 ngày 19 giờ
Pull request đã merge (30 ngày)
20

Chuẩn bị môi trường

  • Có Dockerfile hoặc tệp Docker Compose
  • Không có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của datajoint/datajoint-docs

Tất cả issue của datajoint/datajoint-docs

Issue tương tự

Thêm issue về Databases

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.