Skip to content

feat(mysqldump): warn when foreign keys are missing due to insufficient privileges #1047

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
Soner (shyim) merged 1 commit into from
May 21, 2026
+50 −5
Merged

feat(mysqldump): warn when foreign keys are missing due to insufficient privileges #1047

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
14 changes: 12 additions & 2 deletions internal/mysqldump/mysql_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,12 @@ func mockPrefetchSchemas(mock sqlmock.Sqlmock) {
"TABLE_NAME", "INDEX_NAME", "COLUMN_NAME", "NON_UNIQUE", "INDEX_TYPE", "SUB_PART", "COLLATION", "INDEX_COMMENT", "SEQ_IN_INDEX",
}))

mock.ExpectQuery("SELECT.*FROM INFORMATION_SCHEMA.KEY_COLUMN_USAGE.*").
mock.ExpectQuery("SELECT COUNT.*KEY_COLUMN_USAGE.*").
WillReturnRows(sqlmock.NewRows([]string{"c"}).AddRow(0))
mock.ExpectQuery("SELECT COUNT.*REFERENTIAL_CONSTRAINTS.*").
WillReturnRows(sqlmock.NewRows([]string{"c"}).AddRow(0))

mock.ExpectQuery("SELECT DISTINCT.*FROM INFORMATION_SCHEMA.KEY_COLUMN_USAGE.*").
WillReturnRows(sqlmock.NewRows([]string{
"TABLE_NAME", "CONSTRAINT_NAME", "COLUMN_NAME", "REFERENCED_TABLE_NAME",
"REFERENCED_COLUMN_NAME", "UPDATE_RULE", "DELETE_RULE", "ORDINAL_POSITION",
Expand Down Expand Up @@ -124,7 +129,12 @@ func TestMySQLDumpCreateTable(t *testing.T) {
AddRow("table", "PRIMARY", "id", 0, "BTREE", nil, "A", "", 1).
AddRow("table", "idx_name", "name", 1, "BTREE", nil, "A", "", 1))

mock.ExpectQuery("SELECT.*FROM INFORMATION_SCHEMA.KEY_COLUMN_USAGE.*").
mock.ExpectQuery("SELECT COUNT.*KEY_COLUMN_USAGE.*").
WillReturnRows(sqlmock.NewRows([]string{"c"}).AddRow(0))
mock.ExpectQuery("SELECT COUNT.*REFERENTIAL_CONSTRAINTS.*").
WillReturnRows(sqlmock.NewRows([]string{"c"}).AddRow(0))

mock.ExpectQuery("SELECT DISTINCT.*FROM INFORMATION_SCHEMA.KEY_COLUMN_USAGE.*").
WillReturnRows(sqlmock.NewRows([]string{
"TABLE_NAME", "CONSTRAINT_NAME", "COLUMN_NAME", "REFERENCED_TABLE_NAME",
"REFERENCED_COLUMN_NAME", "UPDATE_RULE", "DELETE_RULE", "ORDINAL_POSITION",
Expand Down
20 changes: 20 additions & 0 deletions internal/mysqldump/schema.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ import (
"regexp"
"strconv"
"strings"

"github.com/shopware/shopware-cli/logging"
)

type TableSchema struct {
Expand Down Expand Up @@ -711,6 +713,24 @@ func (d *Dumper) fetchAllIndexes(ctx context.Context) error {
}

func (d *Dumper) fetchAllForeignKeys(ctx context.Context) error {
var expectedFKs, fetchedFKs int
if err := d.db.QueryRowContext(ctx, `
SELECT COUNT(DISTINCT CONCAT(TABLE_NAME, '|', CONSTRAINT_NAME))
FROM INFORMATION_SCHEMA.KEY_COLUMN_USAGE
WHERE TABLE_SCHEMA = DATABASE() AND REFERENCED_TABLE_NAME IS NOT NULL`).Scan(&expectedFKs); err != nil {
return fmt.Errorf("count foreign keys in KEY_COLUMN_USAGE: %w", err)
}
if err := d.db.QueryRowContext(ctx, `
SELECT COUNT(*) FROM INFORMATION_SCHEMA.REFERENTIAL_CONSTRAINTS
WHERE CONSTRAINT_SCHEMA = DATABASE()`).Scan(&fetchedFKs); err != nil {
return fmt.Errorf("count foreign keys in REFERENTIAL_CONSTRAINTS: %w", err)
}
if expectedFKs > fetchedFKs {
logging.FromContext(ctx).Warnf(
"Found %d foreign key columns in KEY_COLUMN_USAGE but only %d rows in REFERENTIAL_CONSTRAINTS — %d foreign key constraint(s) will be missing from the dump. This usually means the connecting user lacks privileges on the referenced tables. Grant SELECT (or REFERENCES) on the parent tables and re-run.",
expectedFKs, fetchedFKs, expectedFKs-fetchedFKs)
}

query := `
SELECT DISTINCT
kcu.TABLE_NAME,
Expand Down
21 changes: 18 additions & 3 deletions internal/mysqldump/schema_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,7 +360,12 @@ func TestFetchTableSchema(t *testing.T) {
}).
AddRow("test_table", "PRIMARY", "id", 0, "BTREE", nil, "A", "", 1))

mock.ExpectQuery("SELECT.*FROM INFORMATION_SCHEMA.KEY_COLUMN_USAGE.*").
mock.ExpectQuery("SELECT COUNT.*KEY_COLUMN_USAGE.*").
WillReturnRows(sqlmock.NewRows([]string{"c"}).AddRow(0))
mock.ExpectQuery("SELECT COUNT.*REFERENTIAL_CONSTRAINTS.*").
WillReturnRows(sqlmock.NewRows([]string{"c"}).AddRow(0))

mock.ExpectQuery("SELECT DISTINCT.*FROM INFORMATION_SCHEMA.KEY_COLUMN_USAGE.*").
WillReturnRows(sqlmock.NewRows([]string{
"TABLE_NAME", "CONSTRAINT_NAME", "COLUMN_NAME", "REFERENCED_TABLE_NAME",
"REFERENCED_COLUMN_NAME", "UPDATE_RULE", "DELETE_RULE", "ORDINAL_POSITION",
Expand Down Expand Up @@ -413,7 +418,12 @@ func TestGetCreateTableStatement_Integration(t *testing.T) {
}).
AddRow("products", "PRIMARY", "id", 0, "BTREE", nil, "A", "", 1))

mock.ExpectQuery("SELECT.*FROM INFORMATION_SCHEMA.KEY_COLUMN_USAGE.*").
mock.ExpectQuery("SELECT COUNT.*KEY_COLUMN_USAGE.*").
WillReturnRows(sqlmock.NewRows([]string{"c"}).AddRow(0))
mock.ExpectQuery("SELECT COUNT.*REFERENTIAL_CONSTRAINTS.*").
WillReturnRows(sqlmock.NewRows([]string{"c"}).AddRow(0))

mock.ExpectQuery("SELECT DISTINCT.*FROM INFORMATION_SCHEMA.KEY_COLUMN_USAGE.*").
WillReturnRows(sqlmock.NewRows([]string{
"TABLE_NAME", "CONSTRAINT_NAME", "COLUMN_NAME", "REFERENCED_TABLE_NAME",
"REFERENCED_COLUMN_NAME", "UPDATE_RULE", "DELETE_RULE", "ORDINAL_POSITION",
Expand Down Expand Up @@ -560,7 +570,12 @@ func TestFetchAllForeignKeys_NumericName(t *testing.T) {
"product": {Name: "product"},
}

mock.ExpectQuery("SELECT.*FROM INFORMATION_SCHEMA.KEY_COLUMN_USAGE.*").
mock.ExpectQuery("SELECT COUNT.*KEY_COLUMN_USAGE.*").
WillReturnRows(sqlmock.NewRows([]string{"c"}).AddRow(1))
mock.ExpectQuery("SELECT COUNT.*REFERENTIAL_CONSTRAINTS.*").
WillReturnRows(sqlmock.NewRows([]string{"c"}).AddRow(1))

mock.ExpectQuery("SELECT DISTINCT.*FROM INFORMATION_SCHEMA.KEY_COLUMN_USAGE.*").
WillReturnRows(sqlmock.NewRows([]string{
"TABLE_NAME", "CONSTRAINT_NAME", "COLUMN_NAME", "REFERENCED_TABLE_NAME",
"REFERENCED_COLUMN_NAME", "UPDATE_RULE", "DELETE_RULE", "ORDINAL_POSITION",
Expand Down