docs: ColumnOption::ForeignKey docs have wrong SQL syntax

Abierto Apto para principiantes
#1,761 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
72/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
rust
Área
documentation

Línea de trabajo

Abre la página enlazada de docs.rs y localiza la documentación de ColumnOption::ForeignKey en el código fuente del repositorio. Verifica la sintaxis de las restricciones de columna con los ejemplos del issue, luego corrige la descripción de la sintaxis y coloca el literal de sintaxis grande en su propio párrafo. La tarea estará terminada cuando la documentación generada describa una sintaxis de columna válida sin el prefijo FOREIGN KEY de la restricción de tabla.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Rust
Estrellas
3.5k
Forks
774
Merge medio
3 d 10 h
PR fusionados (30 d)
15

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de apache/datafusion-sqlparser-rs

Todos los issues de apache/datafusion-sqlparser-rs

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.