apache / apache/datafusion-sqlparser-rs

docs: ColumnOption::ForeignKey docs have wrong SQL syntax

Đang mở Phù hợp với người mới
#1,761 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
Rust
Star
3.5k
Fork
772
Merge trung bình
4 ngày 9 giờ
Pull request đã merge (30 ngày)
17

Mô tả

https://docs.rs/sqlparser/0.55.0/sqlparser/ast/enum.ColumnOption.html#variant.ForeignKey

says

> A referential integrity constraint (`[FOREIGN KEY REFERENCES () { [ON DELETE ] [ON UPDATE ] | [ON UPDATE ] [ON DELETE ] } []`).

I believe the `FOREIGN KEY (name) REFERENCES` syntax is only for table constraints. That's why it has to say which source columns it talks about!

I believe the syntax for column constraints is just `col_name REFERENCES othertable (othercolumn)`.

As far as I can tell, the sqlparser-rs is already correct. For example, this won't parse:

```sql
-- wrong
CREATE TABLE myschema.mytable (
mycolumn BIGINT NOT NULL,
PRIMARY KEY(mycolumn),
bar BIGINT FOREIGN KEY REFERENCES foo (bar));
```

This does:

```sql
-- good
CREATE TABLE myschema.mytable (
mycolumn BIGINT NOT NULL,
PRIMARY KEY(mycolumn),
bar BIGINT REFERENCES foo (bar));
```

While we're at it, that big syntax literal should live in its own paragraph.

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Hướng nghiên cứu

Mở trang docs.rs được liên kết và tìm tài liệu về ColumnOption::ForeignKey trong mã nguồn của repository. Đối chiếu cú pháp ràng buộc cột với các ví dụ trong issue, sau đó sửa phần mô tả cú pháp và đặt literal cú pháp lớn vào một đoạn riêng. Hoàn tất khi tài liệu được tạo mô tả cú pháp cột hợp lệ mà không có tiền tố FOREIGN KEY của ràng buộc bảng.

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

Đánh giá

Công nghệ
rust
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Đặc tả rõ ràng
Mức phù hợp với người mới
72/100

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.