Skip to content

MySQL: Support index_name in FK constraints #1871

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 6, 2025
Merged

MySQL: Support index_name in FK constraints #1871

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion src/ast/ddl.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1019,6 +1019,9 @@ pub enum TableConstraint {
/// }`).
ForeignKey {
name: Option<Ident>,
/// MySQL-specific field
/// <https://dev.mysql.com/doc/refman/8.4/en/create-table-foreign-keys.html>
index_name: Option<Ident>,
columns: Vec<Ident>,
foreign_table: ObjectName,
referred_columns: Vec<Ident>,
Expand Down Expand Up @@ -1129,6 +1132,7 @@ impl fmt::Display for TableConstraint {
}
TableConstraint::ForeignKey {
name,
index_name,
columns,
foreign_table,
referred_columns,
Expand All @@ -1138,8 +1142,9 @@ impl fmt::Display for TableConstraint {
} => {
write!(
f,
"{}FOREIGN KEY ({}) REFERENCES {}",
"{}FOREIGN KEY{} ({}) REFERENCES {}",
display_constraint_name(name),
display_option_spaced(index_name),
display_comma_separated(columns),
foreign_table,
)?;
Expand Down
2 changes: 2 additions & 0 deletions src/ast/spans.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -670,6 +670,7 @@ impl Spanned for TableConstraint {
TableConstraint::ForeignKey {
name,
columns,
index_name,
foreign_table,
referred_columns,
on_delete,
Expand All @@ -678,6 +679,7 @@ impl Spanned for TableConstraint {
} => union_spans(
name.iter()
.map(|i| i.span)
.chain(index_name.iter().map(|i| i.span))
.chain(columns.iter().map(|i| i.span))
.chain(core::iter::once(foreign_table.span()))
.chain(referred_columns.iter().map(|i| i.span))
Expand Down
14 changes: 8 additions & 6 deletions src/parser/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8061,7 +8061,7 @@ impl<'a> Parser<'a> {
let nulls_distinct = self.parse_optional_nulls_distinct()?;

// optional index name
let index_name = self.parse_optional_indent()?;
let index_name = self.parse_optional_ident()?;
let index_type = self.parse_optional_using_then_index_type()?;

let columns = self.parse_parenthesized_column_list(Mandatory, false)?;
Expand All @@ -8083,7 +8083,7 @@ impl<'a> Parser<'a> {
self.expect_keyword_is(Keyword::KEY)?;

// optional index name
let index_name = self.parse_optional_indent()?;
let index_name = self.parse_optional_ident()?;
let index_type = self.parse_optional_using_then_index_type()?;

let columns = self.parse_parenthesized_column_list(Mandatory, false)?;
Expand All @@ -8100,6 +8100,7 @@ impl<'a> Parser<'a> {
}
Token::Word(w) if w.keyword == Keyword::FOREIGN => {
self.expect_keyword_is(Keyword::KEY)?;
let index_name = self.parse_optional_ident()?;
let columns = self.parse_parenthesized_column_list(Mandatory, false)?;
self.expect_keyword_is(Keyword::REFERENCES)?;
let foreign_table = self.parse_object_name(false)?;
Expand All @@ -8122,6 +8123,7 @@ impl<'a> Parser<'a> {

Ok(Some(TableConstraint::ForeignKey {
name,
index_name,
columns,
foreign_table,
referred_columns,
Expand All @@ -8145,7 +8147,7 @@ impl<'a> Parser<'a> {

let name = match self.peek_token().token {
Token::Word(word) if word.keyword == Keyword::USING => None,
_ => self.parse_optional_indent()?,
_ => self.parse_optional_ident()?,
};

let index_type = self.parse_optional_using_then_index_type()?;
Expand Down Expand Up @@ -8176,7 +8178,7 @@ impl<'a> Parser<'a> {

let index_type_display = self.parse_index_type_display();

let opt_index_name = self.parse_optional_indent()?;
let opt_index_name = self.parse_optional_ident()?;

let columns = self.parse_parenthesized_column_list(Mandatory, false)?;

Expand Down Expand Up @@ -8286,7 +8288,7 @@ impl<'a> Parser<'a> {

/// Parse `[ident]`, mostly `ident` is name, like:
/// `window_name`, `index_name`, ...
pub fn parse_optional_indent(&mut self) -> Result<Option<Ident>, ParserError> {
pub fn parse_optional_ident(&mut self) -> Result<Option<Ident>, ParserError> {
self.maybe_parse(|parser| parser.parse_identifier())
}

Expand Down Expand Up @@ -15689,7 +15691,7 @@ impl<'a> Parser<'a> {
pub fn parse_window_spec(&mut self) -> Result<WindowSpec, ParserError> {
let window_name = match self.peek_token().token {
Token::Word(word) if word.keyword == Keyword::NoKeyword => {
self.parse_optional_indent()?
self.parse_optional_ident()?
}
_ => None,
};
Expand Down
8 changes: 8 additions & 0 deletions tests/sqlparser_common.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3791,6 +3791,7 @@ fn parse_create_table() {
vec![
TableConstraint::ForeignKey {
name: Some("fkey".into()),
index_name: None,
columns: vec!["lat".into()],
foreign_table: ObjectName::from(vec!["othertable3".into()]),
referred_columns: vec!["lat".into()],
Expand All @@ -3800,6 +3801,7 @@ fn parse_create_table() {
},
TableConstraint::ForeignKey {
name: Some("fkey2".into()),
index_name: None,
columns: vec!["lat".into()],
foreign_table: ObjectName::from(vec!["othertable4".into()]),
referred_columns: vec!["lat".into()],
Expand All @@ -3809,6 +3811,7 @@ fn parse_create_table() {
},
TableConstraint::ForeignKey {
name: None,
index_name: None,
columns: vec!["lat".into()],
foreign_table: ObjectName::from(vec!["othertable4".into()]),
referred_columns: vec!["lat".into()],
Expand All @@ -3818,6 +3821,7 @@ fn parse_create_table() {
},
TableConstraint::ForeignKey {
name: None,
index_name: None,
columns: vec!["lng".into()],
foreign_table: ObjectName::from(vec!["othertable4".into()]),
referred_columns: vec!["longitude".into()],
Expand Down Expand Up @@ -3914,6 +3918,7 @@ fn parse_create_table_with_constraint_characteristics() {
vec![
TableConstraint::ForeignKey {
name: Some("fkey".into()),
index_name: None,
columns: vec!["lat".into()],
foreign_table: ObjectName::from(vec!["othertable3".into()]),
referred_columns: vec!["lat".into()],
Expand All @@ -3927,6 +3932,7 @@ fn parse_create_table_with_constraint_characteristics() {
},
TableConstraint::ForeignKey {
name: Some("fkey2".into()),
index_name: None,
columns: vec!["lat".into()],
foreign_table: ObjectName::from(vec!["othertable4".into()]),
referred_columns: vec!["lat".into()],
Expand All @@ -3940,6 +3946,7 @@ fn parse_create_table_with_constraint_characteristics() {
},
TableConstraint::ForeignKey {
name: None,
index_name: None,
columns: vec!["lat".into()],
foreign_table: ObjectName::from(vec!["othertable4".into()]),
referred_columns: vec!["lat".into()],
Expand All @@ -3953,6 +3960,7 @@ fn parse_create_table_with_constraint_characteristics() {
},
TableConstraint::ForeignKey {
name: None,
index_name: None,
columns: vec!["lng".into()],
foreign_table: ObjectName::from(vec!["othertable4".into()]),
referred_columns: vec!["longitude".into()],
Expand Down
7 changes: 7 additions & 0 deletions tests/sqlparser_mysql.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3988,6 +3988,13 @@ fn parse_straight_join() {
.verified_stmt("SELECT a.*, b.* FROM table_a STRAIGHT_JOIN table_b AS b ON a.b_id = b.id");
}

#[test]
fn mysql_foreign_key_with_index_name() {
mysql().verified_stmt(
"CREATE TABLE orders (customer_id INT, INDEX idx_customer (customer_id), CONSTRAINT fk_customer FOREIGN KEY idx_customer (customer_id) REFERENCES customers(id))",
);
}

#[test]
fn parse_drop_index() {
let sql = "DROP INDEX idx_name ON table_name";
Expand Down