SQL notebooks with Markdown cells and saved results

Đang mở
  • Có gì không ổn?
#3,618 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 1 ngày

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

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
macos, markdown, sql, swift
Lĩnh vực
databases, desktop

Hướng nghiên cứu

Read features/query-results.mdx, features/sql-files.mdx, and features/query-parameters.mdx to understand the existing query, file, and parameter behavior. The issue defines the target as a Markdown notebook with three SQL cells, two Markdown cells, saved results, and ordered execution that stops at the first error. No implementation files or tests are named, so the first step is locating the notebook and query execution entry points.

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

Mô tả

enhancement platform-macos
Problem

A query tab holds SQL text and a set of results. Each statement can run on its own from the gutter (#2278), every run gets its own result, and pinning keeps one while you try another (features/query-results.mdx:8-40). Two things are missing:

  • Results are not kept. Saving a tab writes its SQL to the .sql file and nothing else (features/sql-files.mdx:18-26), so reopening an investigation means running every query again.
  • Notes live in SQL comments. Nothing renders Markdown between queries.

An incident write-up, a runbook or a weekly report that mixes queries, explanations and results gets rebuilt by hand each time, or pasted cell by cell into another document with Copy as Markdown (features/data-grid.mdx:166). #2278 set real notebook cells aside as a separate document model and product decision; this issue is that decision.

Proposed solution
  • A notebook is a Markdown file. Each fenced sql block is a SQL cell and the text between blocks is a Markdown cell, so a notebook diffs cleanly in Git and reads on GitHub.
  • Each SQL cell shows its result grid, or its chart, beneath it, using the existing grid and row cap. Cmd+Enter runs the cell; Run All and Run From Here run in order and stop at the first error.
  • A notebook runs on one connection, database and schema, shown in its header. :name query parameters set once at the top apply to every cell (features/query-parameters.mdx).
  • Save Results writes each cell's result below it as a Markdown table, capped at 100 rows, so a shared notebook shows what it showed. Clear Results removes them before a commit.
  • Export to HTML and PDF.
  • Notebooks open from Finder and Cmd+O, and linked SQL folders list them beside .sql files.
  • Safe Mode and the connection's policies apply to every cell as they do to a query tab.

Done when: a notebook with three SQL cells and two Markdown cells saves, reopens with its results, renders on GitHub, and Run All stops at a failing second cell without running the third.

Alternatives considered

Keep the queries in a .sql file and the notes and pasted results in a separate document.

Platform

macOS

Related database type

N/A / General

Ngôn ngữ chính
Swift
Star
6.2k
Fork
412
Merge trung bình
3 giờ 56 phút
Pull request đã merge (30 ngày)
669

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

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 TableProApp/TablePro

Tất cả issue của TableProApp/TablePro

Issue tương tự

Thêm issue về Swift

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.