docs: ColumnOption::ForeignKey docs have wrong SQL syntax

Aperta Adatta ai principianti
#1,761 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
72/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
rust
Ambito
documentation

Direzione di ricerca

Apri la pagina docs.rs collegata e individua la documentazione di ColumnOption::ForeignKey nel codice sorgente del repository. Verifica la sintassi dei vincoli di colonna rispetto agli esempi nell’issue, quindi correggi la descrizione della sintassi e inserisci il grande letterale di sintassi in un paragrafo separato. Il lavoro è completo quando la documentazione generata descrive una sintassi di colonna valida senza il prefisso FOREIGN KEY del vincolo di tabella.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

says

A referential integrity constraint ([FOREIGN KEY REFERENCES <foreign_table> (<referred_columns>) { [ON DELETE <referential_action>] [ON UPDATE <referential_action>] | [ON UPDATE <referential_action>] [ON DELETE <referential_action>] } [<constraint_characteristics>]).

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:

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

This does:

-- 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.

Lingua principale
Rust
Stelle
3.5k
Fork
774
Merge medio
3g 10h
PR unite (30g)
15

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di apache/datafusion-sqlparser-rs

Tutte le issue di apache/datafusion-sqlparser-rs

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.