Explain schema changes as a deployment step, not a run-time operation

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

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

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
80/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với how-to/deploy-production.md và xem lại phần giải thích hiện có về create_tables=False. Thêm một trang hoặc mục giải thích các thay đổi lược đồ như một bước triển khai có kiểm soát, bao gồm nội dung Lookup, allow_ddl, các thông tin đăng nhập cơ sở dữ liệu riêng biệt và những gì không thay đổi đối với việc sử dụng tương tác. Công việc hoàn tất khi hướng dẫn bao quát các điểm được liệt kê và sẵn sàng phát hành cùng với thiết lập này.

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

Mô tả

The docs describe create_tables=False for production (how-to/deploy-production.md), but don't explain the principle behind it.

Proposal

Add an explanation page, or a section of the production guide, covering:

  • The principle. A schema change (declaring a table, altering or dropping it, changing a Lookup table's contents) is part of deploying new code. It is applied once, in a controlled step, before processes start running the new code.
  • Lookup contents count as schema. They change with the code, not at run time.
  • Why it matters. Run-time declaration is convenient for interactive work, but in a shared database it means whichever process imports new code first changes the schema, unreviewed. A table and the code that fills it should change together, at a known moment.
  • How to set it up. The allow_ddl setting (datajoint/datajoint-python#1649), separate database logins for deployment and for run time, and the deployment step that applies the changes.
  • What stays the same for interactive use. The defaults keep today's convenience.

This page should land in the same release as the setting.

Ngôn ngữ chính
Jupyter Notebook
Star
7
Fork
12
Merge trung bình
8 ngày 12 giờ
Pull request đã merge (30 ngày)
3

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ề Documentation

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.