Skip to content

armgit / dbx

Public Imported from GitHub
0

25 MB lightweight cross-platform database client for 100+ databases, including MySQL, PostgreSQL, SQLite, Redis, MongoDB, DuckDB, SQL Server, and Dameng. Built-in AI, MCP Server, CLI, desktop and Docker. | 轻量级跨平台数据库管理工具,支持 MySQL、PostgreSQL、SQLite、Redis、MongoDB、达梦等 100+ 数据库,提供桌面端、Docker、CLI、内置 AI 助手和 MCP。

feat(structure): allow naming a newly created primary key

弈秋ed3ed28d2bdd
diff --git a/apps/desktop/src/components/structure/TableStructureEditor.primaryKey.spec.ts b/apps/desktop/src/components/structure/TableStructureEditor.primaryKey.spec.ts
index 2160de68ad..8da3d10e90 100644
--- a/apps/desktop/src/components/structure/TableStructureEditor.primaryKey.spec.ts
+++ b/apps/desktop/src/components/structure/TableStructureEditor.primaryKey.spec.ts
@@ -520,6 +520,46 @@ describe("TableStructureEditor primary key editing", () => {
);
});
+ it("offers a primary key name input when adding a new key and sends it in the options", async () => {
+ const root = await mountEditor("postgres");
+
+ expect(root.querySelector<HTMLInputElement>("[data-primary-key-name-input]")).toBeNull();
+
+ const primaryKey = columnCheckbox(root, "structureEditor.primaryKey");
+ primaryKey.checked = true;
+ primaryKey.dispatchEvent(new Event("change", { bubbles: true }));
+ await nextTick();
+
+ const nameInput = root.querySelector<HTMLInputElement>("[data-primary-key-name-input]");
+ expect(nameInput).not.toBeNull();
+
+ nameInput!.value = "users_pkey";
+ nameInput!.dispatchEvent(new Event("input", { bubbles: true }));
+ await nextTick();
+
+ await vi.waitFor(() => expect(mocks.buildTableStructureChangeSql).toHaveBeenCalled());
+ expect(mocks.buildTableStructureChangeSql).toHaveBeenLastCalledWith(expect.objectContaining({ primaryKeyName: "users_pkey" }));
+ });
+
+ it("keeps the primary key anonymous when the name is left blank", async () => {
+ const root = await mountEditor("postgres");
+ const primaryKey = columnCheckbox(root, "structureEditor.primaryKey");
+ primaryKey.checked = true;
+ primaryKey.dispatchEvent(new Event("change", { bubbles: true }));
+ await nextTick();
+
+ expect(root.querySelector<HTMLInputElement>("[data-primary-key-name-input]")).not.toBeNull();
+
+ await vi.waitFor(() => expect(mocks.buildTableStructureChangeSql).toHaveBeenCalled());
+ expect(mocks.buildTableStructureChangeSql).toHaveBeenLastCalledWith(expect.objectContaining({ primaryKeyName: undefined }));
+ });
+
+ it("hides the primary key name input when the table already has a primary key", async () => {
+ const root = await mountEditor("postgres", true);
+
+ expect(root.querySelector<HTMLInputElement>("[data-primary-key-name-input]")).toBeNull();
+ });
+
it.each(["oracle", "oceanbase-oracle"] as const)("enables a primary key on an existing keyless %s column and makes it not null", async (databaseType) => {
const root = await mountEditor(databaseType);
const primaryKey = columnCheckbox(root, "structureEditor.primaryKey");
diff --git a/apps/desktop/src/components/structure/TableStructureEditor.vue b/apps/desktop/src/components/structure/TableStructureEditor.vue
index c6b068d3b1..682ec1c703 100644
--- a/apps/desktop/src/components/structure/TableStructureEditor.vue
+++ b/apps/desktop/src/components/structure/TableStructureEditor.vue
@@ -1943,6 +1943,21 @@ const tableOwnerRoles = ref<string[]>([]);
const tableOwnerRolesLoading = ref(false);
const tableOwnerRolesLoadError = ref("");
const supportsTableOwner = computed(() => !isCreateMode.value && databaseType.value === "postgres");
+const primaryKeyName = ref("");
+// Mirrors Rust `supports_named_primary_key`: engines that persist a user-supplied
+// PK constraint name. Other dialects ignore the symbol, so the field is hidden.
+const canNamePrimaryKey = computed(() => {
+ if (connection.value?.driver_profile?.toLowerCase() === "gaussdb-m") return true;
+ const dialect = structureCapabilities.value.dialect;
+ return dialect === "mysql" || dialect === "postgres" || dialect === "sqlserver" || dialect === "oracle";
+});
+/** Whether the draft will create a primary key that did not exist before
+ * (matching the Rust builder's pure-add path; replacements never rename). */
+const willCreateNewPrimaryKey = computed(() => {
+ const active = columns.value.filter((column) => !column.markedForDrop);
+ return active.some((column) => column.isPrimaryKey) && !active.some((column) => column.original?.is_primary_key);
+});
+const canEditPrimaryKeyName = computed(() => canNamePrimaryKey.value && willCreateNewPrimaryKey.value && (isCreateMode.value || structureCapabilities.value.addPrimaryKey));
const canEditMysqlAutoIncrement = computed(() => canEditMysqlAutoIncrementCounter(connection.value, isCreateMode.value, columns.value));
const canBuildMysqlAutoIncrement = computed(() => !isCreateMode.value && canEditMysqlAutoIncrement.value && !mysqlAutoIncrementLoading.value && !mysqlAutoIncrementLoadError.value && originalMysqlAutoIncrementValue.value !== undefined);
const supportsMysqlEngine = computed(() => supportsMysqlTableEngine(connection.value));
@@ -2686,6 +2701,7 @@ function structureChangeOptions(): BuildTableStructureChangeSqlOptions {
partitioned: isPartitionedParent.value,
foreignTable: isForeignTable.value,
isGaussdbMMode: connection.value?.driver_profile?.toLowerCase() === "gaussdb-m",
+ primaryKeyName: willCreateNewPrimaryKey.value ? primaryKeyName.value.trim() || undefined : undefined,
};
}
@@ -5633,6 +5649,11 @@ watch(
</Tooltip>
</div>
+ <div v-if="canEditPrimaryKeyName" class="flex shrink-0 items-center gap-2">
+ <label class="shrink-0 font-medium text-muted-foreground">{{ t("structureEditor.primaryKeyName") }}</label>
+ <Input v-model="primaryKeyName" :placeholder="t('structureEditor.primaryKeyNamePlaceholder')" :class="[structureControlClass, 'max-w-[320px]']" :disabled="saving || loading" data-primary-key-name-input />
+ </div>
+
<div v-if="supportsMysqlEngine" class="flex shrink-0 items-center gap-2">
<label class="shrink-0 font-medium text-muted-foreground">{{ t("structureEditor.mysqlTableEngine") }}</label>
<SearchableSelect
diff --git a/apps/desktop/src/i18n/locales/az.ts b/apps/desktop/src/i18n/locales/az.ts
index 45ab2c5c3d..c8b5023eef 100644
--- a/apps/desktop/src/i18n/locales/az.ts
+++ b/apps/desktop/src/i18n/locales/az.ts
@@ -4749,6 +4749,8 @@ export default withEnglishFallback({
triggerName: "Tətikləyici",
triggerStatement: "Tətikləyici əmri",
primary: "Əsas",
+ primaryKeyName: "Əsas açar adı",
+ primaryKeyNamePlaceholder: "Avtomatik yaratmaq üçün boş buraxın",
drop: "Sil",
restore: "Bərpa et",
remove: "Çıxar",
diff --git a/apps/desktop/src/i18n/locales/en.ts b/apps/desktop/src/i18n/locales/en.ts
index f89900a18e..caf3f50de6 100644
--- a/apps/desktop/src/i18n/locales/en.ts
+++ b/apps/desktop/src/i18n/locales/en.ts
@@ -5621,6 +5621,8 @@ export default {
triggerName: "Trigger",
triggerStatement: "Trigger statement",
primary: "Primary",
+ primaryKeyName: "Primary key name",
+ primaryKeyNamePlaceholder: "Leave blank to auto-generate",
drop: "Drop",
restore: "Restore",
remove: "Remove",
diff --git a/apps/desktop/src/i18n/locales/es.ts b/apps/desktop/src/i18n/locales/es.ts
index 64162a1676..63858caafa 100644
--- a/apps/desktop/src/i18n/locales/es.ts
+++ b/apps/desktop/src/i18n/locales/es.ts
@@ -5024,6 +5024,8 @@ export default withEnglishFallback({
triggerName: "Disparador",
triggerStatement: "Sentencia del disparador",
primary: "Primaria",
+ primaryKeyName: "Nombre de clave primaria",
+ primaryKeyNamePlaceholder: "Dejar en blanco para autogenerar",
drop: "Eliminar",
restore: "Restaurar",
remove: "Quitar",
diff --git a/apps/desktop/src/i18n/locales/id.ts b/apps/desktop/src/i18n/locales/id.ts
index 3eba935310..7a4a7498ba 100644
--- a/apps/desktop/src/i18n/locales/id.ts
+++ b/apps/desktop/src/i18n/locales/id.ts
@@ -5389,6 +5389,8 @@ export default withEnglishFallback({
triggerName: "Trigger",
triggerStatement: "Statement trigger",
primary: "Primary",
+ primaryKeyName: "Nama kunci utama",
+ primaryKeyNamePlaceholder: "Biarkan kosong untuk dibuat otomatis",
drop: "Hapus",
restore: "Pulihkan",
remove: "Hapus",
diff --git a/apps/desktop/src/i18n/locales/it.ts b/apps/desktop/src/i18n/locales/it.ts
index 4ed8999792..1b959eaab0 100644
--- a/apps/desktop/src/i18n/locales/it.ts
+++ b/apps/desktop/src/i18n/locales/it.ts
@@ -4839,6 +4839,8 @@ export default withEnglishFallback({
triggerName: "Trigger",
triggerStatement: "Istruzione trigger",
primary: "Primario",
+ primaryKeyName: "Nome chiave primaria",
+ primaryKeyNamePlaceholder: "Lascia vuoto per generarlo automaticamente",
drop: "Elimina",
restore: "Ripristina",
remove: "Rimuovi",
diff --git a/apps/desktop/src/i18n/locales/ja.ts b/apps/desktop/src/i18n/locales/ja.ts
index 9f295e646e..cd89cebea4 100644
--- a/apps/desktop/src/i18n/locales/ja.ts
+++ b/apps/desktop/src/i18n/locales/ja.ts
@@ -4901,6 +4901,8 @@ export default withEnglishFallback({
triggerName: "トリガー",
triggerStatement: "トリガー文",
primary: "主キー",
+ primaryKeyName: "主キー名",
+ primaryKeyNamePlaceholder: "空欄の場合は自動生成",
drop: "削除",
restore: "復元",
remove: "削除",
diff --git a/apps/desktop/src/i18n/locales/ko.ts b/apps/desktop/src/i18n/locales/ko.ts
index 05988229f5..1846d2f748 100644
--- a/apps/desktop/src/i18n/locales/ko.ts
+++ b/apps/desktop/src/i18n/locales/ko.ts
@@ -4883,6 +4883,8 @@ export default withEnglishFallback({
triggerName: "트리거",
triggerStatement: "트리거 구문",
primary: "기본",
+ primaryKeyName: "기본 키 이름",
+ primaryKeyNamePlaceholder: "비워 두면 자동 생성",
drop: "삭제",
restore: "복원",
remove: "제거",
diff --git a/apps/desktop/src/i18n/locales/pt-BR.ts b/apps/desktop/src/i18n/locales/pt-BR.ts
index 7371bba10f..bd916e8338 100644
--- a/apps/desktop/src/i18n/locales/pt-BR.ts
+++ b/apps/desktop/src/i18n/locales/pt-BR.ts
@@ -4839,6 +4839,8 @@ export default withEnglishFallback({
triggerName: "Trigger",
triggerStatement: "Comando do trigger",
primary: "Primária",
+ primaryKeyName: "Nome da chave primária",
+ primaryKeyNamePlaceholder: "Deixe em branco para gerar automaticamente",
drop: "Remover",
restore: "Restaurar",
remove: "Remover",
diff --git a/apps/desktop/src/i18n/locales/ru.ts b/apps/desktop/src/i18n/locales/ru.ts
index f927cfb68e..37ede472ee 100644
--- a/apps/desktop/src/i18n/locales/ru.ts
+++ b/apps/desktop/src/i18n/locales/ru.ts
@@ -5416,6 +5416,8 @@ export default withEnglishFallback({
triggerName: "Триггер",
triggerStatement: "Оператор триггера",
primary: "Первичный",
+ primaryKeyName: "Имя первичного ключа",
+ primaryKeyNamePlaceholder: "Оставьте пустым для автогенерации",
drop: "Удалить",
restore: "Восстановить",
remove: "Убрать",
diff --git a/apps/desktop/src/i18n/locales/tr.ts b/apps/desktop/src/i18n/locales/tr.ts
index eb3db23ec4..2cb6857ecc 100644
--- a/apps/desktop/src/i18n/locales/tr.ts
+++ b/apps/desktop/src/i18n/locales/tr.ts
@@ -4651,6 +4651,8 @@ export default withEnglishFallback({
triggerName: "Tetikleyici",
triggerStatement: "Tetikleyici ifadesi",
primary: "Birincil",
+ primaryKeyName: "Birincil anahtar adı",
+ primaryKeyNamePlaceholder: "Otomatik oluşturmak için boş bırakın",
drop: "Sil",
restore: "Geri yükle",
remove: "Kaldır",
diff --git a/apps/desktop/src/i18n/locales/zh-CN.ts b/apps/desktop/src/i18n/locales/zh-CN.ts
index 4be27fa748..ceafbf4867 100644
--- a/apps/desktop/src/i18n/locales/zh-CN.ts
+++ b/apps/desktop/src/i18n/locales/zh-CN.ts
@@ -5612,6 +5612,8 @@ export default withEnglishFallback({
triggerName: "触发器名",
triggerStatement: "触发语句",
primary: "主键",
+ primaryKeyName: "主键名",
+ primaryKeyNamePlaceholder: "留空则自动生成",
drop: "删除",
restore: "恢复",
remove: "移除",
diff --git a/apps/desktop/src/i18n/locales/zh-TW.ts b/apps/desktop/src/i18n/locales/zh-TW.ts
index 716115615b..cbbe5a7664 100644
--- a/apps/desktop/src/i18n/locales/zh-TW.ts
+++ b/apps/desktop/src/i18n/locales/zh-TW.ts
@@ -4584,6 +4584,8 @@ export default withEnglishFallback({
triggerName: "觸發器名稱",
triggerStatement: "觸發語句",
primary: "主鍵",
+ primaryKeyName: "主鍵名",
+ primaryKeyNamePlaceholder: "留空則自動產生",
drop: "刪除",
restore: "復原",
remove: "移除",
diff --git a/apps/desktop/src/lib/table/tableStructureEditorSql.ts b/apps/desktop/src/lib/table/tableStructureEditorSql.ts
index dd11c02182..49b0e7de0f 100644
--- a/apps/desktop/src/lib/table/tableStructureEditorSql.ts
+++ b/apps/desktop/src/lib/table/tableStructureEditorSql.ts
@@ -116,6 +116,11 @@ export interface BuildTableStructureChangeSqlOptions {
/** When true, the connection is GaussDB M-mode which uses MySQL-compatible
* SQL dialect with backtick quoting. */
isGaussdbMMode?: boolean;
+ /** Optional constraint name for a newly created primary key. Empty or
+ * omitted keeps the anonymous `PRIMARY KEY (...)` form and lets the server
+ * auto-name the constraint. Ignored when the draft only replaces an
+ * existing primary key (renaming is out of scope). */
+ primaryKeyName?: string;
}
export interface TranswarpCreateTableOptions {
diff --git a/crates/dbx-core/src/schema/table_structure_sql/sqlite_rebuild.rs b/crates/dbx-core/src/schema/table_structure_sql/sqlite_rebuild.rs
index 3d7b82c456..aca683a212 100644
--- a/crates/dbx-core/src/schema/table_structure_sql/sqlite_rebuild.rs
+++ b/crates/dbx-core/src/schema/table_structure_sql/sqlite_rebuild.rs
@@ -1526,6 +1526,7 @@ mod tests {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
}
}
diff --git a/crates/dbx-core/tests/live_mysql_column_name_whitespace.rs b/crates/dbx-core/tests/live_mysql_column_name_whitespace.rs
index 72aac85f0e..f961506829 100644
--- a/crates/dbx-core/tests/live_mysql_column_name_whitespace.rs
+++ b/crates/dbx-core/tests/live_mysql_column_name_whitespace.rs
@@ -58,6 +58,7 @@ fn change_options(table_name: &str, columns: Vec<EditableStructureColumn>) -> Ta
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
}
}
diff --git a/crates/dbx-core/tests/live_mysql_generated_columns.rs b/crates/dbx-core/tests/live_mysql_generated_columns.rs
index 3761827ce7..4e0b2883ac 100644
--- a/crates/dbx-core/tests/live_mysql_generated_columns.rs
+++ b/crates/dbx-core/tests/live_mysql_generated_columns.rs
@@ -54,6 +54,7 @@ fn change_options(table_name: &str, columns: Vec<EditableStructureColumn>) -> Ta
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
}
}
diff --git a/crates/dbx-core/tests/live_postgres_concurrent_index.rs b/crates/dbx-core/tests/live_postgres_concurrent_index.rs
index 5d3a0bee8b..b2295b7157 100644
--- a/crates/dbx-core/tests/live_postgres_concurrent_index.rs
+++ b/crates/dbx-core/tests/live_postgres_concurrent_index.rs
@@ -68,6 +68,7 @@ async fn live_postgres_concurrent_index_builds_valid_index() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert!(result.warnings.is_empty(), "{:?}", result.warnings);
assert_eq!(
@@ -204,6 +205,7 @@ async fn live_postgres_partitioned_parent_concurrent_request_rejected() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(
result.warnings,
diff --git a/crates/dbx-core/tests/live_postgres_partitioning.rs b/crates/dbx-core/tests/live_postgres_partitioning.rs
index f0efc3e306..6b79ec201c 100644
--- a/crates/dbx-core/tests/live_postgres_partitioning.rs
+++ b/crates/dbx-core/tests/live_postgres_partitioning.rs
@@ -320,6 +320,7 @@ async fn live_postgres_create_partitioned_table_executes() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
};
let create = build_create_partitioned_table_sql(
options,
diff --git a/crates/dbx-core/tests/live_sqlserver_completion.rs b/crates/dbx-core/tests/live_sqlserver_completion.rs
index cb3148001c..904bd8b480 100644
--- a/crates/dbx-core/tests/live_sqlserver_completion.rs
+++ b/crates/dbx-core/tests/live_sqlserver_completion.rs
@@ -1029,6 +1029,7 @@ async fn live_sqlserver_table_structure_default_changes_drop_existing_constraint
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
assert_eq!(result.statements.len(), 4);
diff --git a/crates/dbx-sql-schema/src/db_admin_sql.rs b/crates/dbx-sql-schema/src/db_admin_sql.rs
index d853a9c172..544b19532f 100644
--- a/crates/dbx-sql-schema/src/db_admin_sql.rs
+++ b/crates/dbx-sql-schema/src/db_admin_sql.rs
@@ -3113,6 +3113,7 @@ mod tests {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(create.warnings, Vec::<String>::new());
assert_eq!(
diff --git a/crates/dbx-sql-schema/src/table_structure_sql/columns.rs b/crates/dbx-sql-schema/src/table_structure_sql/columns.rs
index 4729feefe8..62a0dba696 100644
--- a/crates/dbx-sql-schema/src/table_structure_sql/columns.rs
+++ b/crates/dbx-sql-schema/src/table_structure_sql/columns.rs
@@ -16,12 +16,12 @@ use super::column_format::{
original_mysql_generated_values,
};
use super::comments::build_sqlserver_column_comment_sql_for_profile;
-use super::dialect::{capabilities_for, database_label, is_oracle_like, StructureDialect};
+use super::dialect::{capabilities_for, database_label, is_oracle_like, supports_named_primary_key, StructureDialect};
use super::indexes::has_existing_index_change;
use super::types::{ColumnInfo, EditableStructureColumn, TableStructureSqlOptions};
use super::util::{
clean, is_protected_manticore_id_column, normalize_default, original_comment, original_default, qualified_table,
- quote_ident, quote_string,
+ quote_ident, quote_new_ident, quote_string,
};
use crate::models::connection::DatabaseType;
use std::collections::HashSet;
@@ -397,7 +397,16 @@ pub(super) fn build_column_sql(options: &TableStructureSqlOptions, warnings: &mu
.map(|name| quote_ident(StructureDialect::Mysql, name))
.collect::<Vec<_>>()
.join(", ");
- clauses.push(format!("ADD PRIMARY KEY ({pk_list})"));
+ // A pure add may carry a user-supplied constraint name (stored as the
+ // MySQL primary key index symbol). Replacing an existing key keeps the
+ // anonymous form: MySQL cannot DROP a PK by symbol, so a rename would
+ // silently diverge from the dropped constraint.
+ let constraint = if change.old_ids.is_empty() {
+ new_primary_key_constraint_clause(options, StructureDialect::Mysql)
+ } else {
+ String::new()
+ };
+ clauses.push(format!("ADD {constraint}PRIMARY KEY ({pk_list})"));
}
statements.push(format!("ALTER TABLE {table} {};", clauses.join(", ")));
} else {
@@ -593,15 +602,37 @@ pub(super) fn build_primary_key_sql(
if !change.new_names.is_empty() {
let pk_list = change.new_names.iter().map(|name| quote_ident(dialect, name)).collect::<Vec<_>>().join(", ");
// DM8: ADD [CONSTRAINT name] PRIMARY KEY; anonymous form matches Navicat/DBeaver/MySQL editors.
- let constraint = persisted_primary_key_name
- .map(|name| format!("CONSTRAINT {} ", quote_ident(dialect, name)))
- .unwrap_or_default();
+ // A pure add (no previous key to replace) may carry a user-supplied name; a replacement
+ // keeps the persisted name so Postgres/SqlServer DROP + ADD stays on the same constraint.
+ let constraint = if change.old_ids.is_empty() {
+ new_primary_key_constraint_clause(options, dialect)
+ } else {
+ persisted_primary_key_name
+ .map(|name| format!("CONSTRAINT {} ", quote_ident(dialect, name)))
+ .unwrap_or_default()
+ };
statements.push(format!("ALTER TABLE {table} ADD {constraint}PRIMARY KEY ({pk_list});"));
}
statements
}
+/// `"CONSTRAINT <name> "` for a user-supplied primary key name, or empty when
+/// the name is blank or the dialect does not persist PK constraint names.
+pub(super) fn new_primary_key_constraint_clause(
+ options: &TableStructureSqlOptions,
+ dialect: StructureDialect,
+) -> String {
+ options
+ .primary_key_name
+ .as_deref()
+ .map(clean)
+ .filter(|name| !name.is_empty())
+ .filter(|_| supports_named_primary_key(dialect))
+ .map(|name| format!("CONSTRAINT {} ", quote_new_ident(options.database_type, dialect, &name)))
+ .unwrap_or_default()
+}
+
/// Dialect-specific DROP for an existing primary key.
///
/// - MySQL: `DROP PRIMARY KEY`
diff --git a/crates/dbx-sql-schema/src/table_structure_sql/comments.rs b/crates/dbx-sql-schema/src/table_structure_sql/comments.rs
index 83d3e6c282..f8f1010b46 100644
--- a/crates/dbx-sql-schema/src/table_structure_sql/comments.rs
+++ b/crates/dbx-sql-schema/src/table_structure_sql/comments.rs
@@ -256,6 +256,7 @@ mod tests {
partitioned: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
foreign_table,
}
}
diff --git a/crates/dbx-sql-schema/src/table_structure_sql/create_table.rs b/crates/dbx-sql-schema/src/table_structure_sql/create_table.rs
index 6f3f53ee02..cfc551c7ee 100644
--- a/crates/dbx-sql-schema/src/table_structure_sql/create_table.rs
+++ b/crates/dbx-sql-schema/src/table_structure_sql/create_table.rs
@@ -275,7 +275,9 @@ pub(super) fn build_create_table_sql_with_partition_clause(
.map(|column| quote_new_ident(options.database_type, dialect, &column.name))
.collect::<Vec<_>>()
.join(", ");
- column_definitions.push(format!("PRIMARY KEY ({pk_list})"));
+ // Optional user-supplied constraint name; empty keeps the anonymous form.
+ let constraint = super::columns::new_primary_key_constraint_clause(&options, dialect);
+ column_definitions.push(format!("{constraint}PRIMARY KEY ({pk_list})"));
}
if let Some((_, definition)) = &inline_auto_index {
diff --git a/crates/dbx-sql-schema/src/table_structure_sql/dialect.rs b/crates/dbx-sql-schema/src/table_structure_sql/dialect.rs
index a7150a8a1b..d09ccabf1b 100644
--- a/crates/dbx-sql-schema/src/table_structure_sql/dialect.rs
+++ b/crates/dbx-sql-schema/src/table_structure_sql/dialect.rs
@@ -457,3 +457,24 @@ pub(super) fn database_type_for_dialect(dialect: StructureDialect) -> Option<Dat
StructureDialect::Unsupported => None,
}
}
+
+/// Whether the dialect persists a user-supplied primary key constraint name.
+///
+/// MySQL-family engines accept `CONSTRAINT name PRIMARY KEY` and store the
+/// symbol as the primary key index name; PostgreSQL, SQL Server, Oracle, Dameng
+/// and Oscar store real named constraints. Dialects outside this set either
+/// ignore the symbol (SQLite) or have no named PK constraint concept, so the
+/// builder keeps the anonymous form instead of emitting a no-op name.
+pub(super) fn supports_named_primary_key(dialect: StructureDialect) -> bool {
+ matches!(
+ dialect,
+ StructureDialect::Mysql
+ | StructureDialect::Doris
+ | StructureDialect::GaussdbM
+ | StructureDialect::Postgres
+ | StructureDialect::SqlServer
+ | StructureDialect::Oracle
+ | StructureDialect::Dameng
+ | StructureDialect::Oscar
+ )
+}
diff --git a/crates/dbx-sql-schema/src/table_structure_sql/tests.rs b/crates/dbx-sql-schema/src/table_structure_sql/tests.rs
index a6c27d061c..90937b5958 100644
--- a/crates/dbx-sql-schema/src/table_structure_sql/tests.rs
+++ b/crates/dbx-sql-schema/src/table_structure_sql/tests.rs
@@ -68,6 +68,7 @@ fn structure_change_options(
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
}
}
@@ -359,6 +360,7 @@ fn index_change_options(
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
}
}
@@ -444,6 +446,7 @@ fn builds_mysql_column_and_index_changes() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -809,6 +812,7 @@ fn builds_xugu_type_change_with_native_syntax() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -1078,6 +1082,7 @@ fn builds_mysql_unsigned_integer_column_with_length_before_attribute() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -1118,6 +1123,7 @@ fn doris_table_editor_renames_column_without_mysql_change_syntax() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -1183,6 +1189,7 @@ fn dameng_integer_column_omits_mysql_display_width() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -1230,6 +1237,7 @@ fn builds_highgo_foreign_key_changes_with_postgres_syntax() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -1308,6 +1316,7 @@ fn builds_informix_column_and_index_changes() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -1369,6 +1378,7 @@ fn oracle_does_not_generate_drop_sql_for_all_columns() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.statements, Vec::<String>::new());
@@ -1446,6 +1456,7 @@ fn oracle_create_table_places_default_before_not_null() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -1517,6 +1528,7 @@ fn oracle_create_table_preserves_character_length_units() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert!(result.statements[0].contains("BYTE_COL VARCHAR2(12 BYTE)"));
@@ -1557,6 +1569,7 @@ fn oracle_create_table_uses_unquoted_identifiers_for_new_objects() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -1598,6 +1611,7 @@ fn oracle_create_table_leaves_uppercase_regular_identifier_unquoted() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -1638,6 +1652,7 @@ fn oracle_create_table_quotes_special_and_reserved_identifiers() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -1681,6 +1696,7 @@ fn oracle_create_table_distinguishes_new_and_referenced_foreign_key_identifiers(
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -1725,6 +1741,7 @@ fn oracle_create_table_extracts_single_line_trigger_source_into_the_body() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -1761,6 +1778,7 @@ fn oracle_create_table_warns_instead_of_emitting_an_unparsed_trigger_declaration
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.statements, vec!["CREATE TABLE \"APP\".dbx_copy (\n \"id\" NUMBER\n);"]);
@@ -1801,6 +1819,7 @@ fn oracle_existing_quoted_identifiers_keep_exact_spelling() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -1838,6 +1857,7 @@ fn oracle_new_identifier_formatting_does_not_change_other_dialects() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new(), "{database_type:?}");
@@ -1937,6 +1957,7 @@ fn iris_drop_index_includes_table_name() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -1983,6 +2004,7 @@ fn iris_ignores_comment_changes_but_keeps_supported_column_alters() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(
@@ -2070,6 +2092,7 @@ fn oracle_compatible_databases_keep_comment_on_sql() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new(), "{database_type:?}");
@@ -2109,6 +2132,7 @@ fn mysql_create_index_with_comment() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -2147,6 +2171,7 @@ fn manticoresearch_builds_create_table_sql_only() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -2195,6 +2220,7 @@ fn manticoresearch_builds_add_and_drop_column_sql() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -2268,6 +2294,7 @@ fn gbase8a_uses_limited_mysql_ddl() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(
@@ -2343,6 +2370,7 @@ fn gbase8a_allows_mysql_style_column_reorder() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -2389,6 +2417,7 @@ fn gbase8s_uses_informix_ddl_not_mysql() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -2427,6 +2456,7 @@ fn gbase_without_driver_profile_still_uses_mysql_ddl() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -2467,6 +2497,7 @@ fn manticoresearch_does_not_drop_id_column() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.statements, Vec::<String>::new());
@@ -2540,6 +2571,7 @@ fn manticoresearch_warns_when_existing_column_properties_change() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.statements, Vec::<String>::new());
@@ -2580,6 +2612,7 @@ fn manticoresearch_ignores_mysql_column_options() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -2623,6 +2656,7 @@ fn manticoresearch_builds_text_column_properties() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -2658,6 +2692,7 @@ fn manticoresearch_builds_json_secondary_index_property() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -2689,6 +2724,7 @@ fn mysql_create_unique_index_with_comment_and_btree() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -2722,6 +2758,7 @@ fn mysql_create_functional_index_preserves_key_part_syntax() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -2755,6 +2792,7 @@ fn mysql_add_timestamp_column_drops_invalid_precision() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -2788,6 +2826,7 @@ fn mysql_add_timestamp_column_preserves_valid_precision() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -2828,6 +2867,7 @@ fn builds_postgres_create_table_with_comments_and_index() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -2865,6 +2905,7 @@ fn quotes_expression_like_new_index_columns_without_provenance() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -2942,6 +2983,7 @@ fn create_table_trims_table_name_whitespace_for_all_statements() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -2984,6 +3026,7 @@ fn warns_for_sqlite_unsafe_column_changes() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.statements, Vec::<String>::new());
@@ -3032,6 +3075,7 @@ fn qualifies_attached_sqlite_table_and_index_changes() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -3106,6 +3150,7 @@ fn builds_rqlite_changes_with_sqlite_dialect() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -3141,6 +3186,7 @@ fn builds_kingbase_add_column_without_column_keyword() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -3211,6 +3257,7 @@ fn builds_mysql_column_reorder_statements() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -3272,6 +3319,7 @@ fn mysql_add_column_before_existing_column_does_not_reorder_shifted_column() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -3340,6 +3388,7 @@ fn mysql_existing_column_reorder_does_not_reorder_columns_shifted_by_prior_move(
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -3420,6 +3469,7 @@ fn mysql_moving_first_column_to_end_uses_single_reorder_statement() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -3450,6 +3500,7 @@ fn builds_sql_server_quoted_column_and_index_statements() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -3486,6 +3537,7 @@ fn sqlserver_strips_mysql_display_width_from_fixed_integer_types() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -3516,6 +3568,7 @@ fn sqlserver_strips_scale_from_float() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -3546,6 +3599,7 @@ fn sqlserver_preserves_float_mantissa_bits() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -3601,6 +3655,7 @@ fn sqlserver_default_changes_drop_old_constraints_with_isolated_batches() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -3823,6 +3878,7 @@ fn sqlserver_unchanged_foreign_key_does_not_warn_when_saving_other_changes() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -3858,6 +3914,7 @@ fn sqlserver_add_column_with_identity() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -3894,6 +3951,7 @@ fn sqlserver_legacy_column_comment_change_uses_legacy_extended_properties() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -3933,6 +3991,7 @@ fn dameng_add_column_with_identity() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -3962,6 +4021,7 @@ fn dameng_uppercases_lowercase_column_type() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -3998,6 +4058,7 @@ fn dameng_rejects_identity_on_incompatible_type() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.statements, Vec::<String>::new());
@@ -4036,6 +4097,7 @@ fn sqlserver_rejects_identity_on_incompatible_type() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.statements, Vec::<String>::new());
@@ -4077,6 +4139,7 @@ fn sqlserver_changed_foreign_key_still_warns_as_unsupported() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.statements, Vec::<String>::new());
@@ -4123,6 +4186,7 @@ fn sqlserver_unchanged_identity_extra_does_not_mark_existing_column_changed() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -4169,6 +4233,7 @@ fn dameng_unchanged_identity_extra_does_not_mark_existing_column_changed() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -4428,6 +4493,7 @@ fn dameng_rejects_adding_second_identity_column() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.statements, Vec::<String>::new());
@@ -4486,6 +4552,7 @@ fn sqlserver_existing_column_identity_change_warns_without_unchanged_foreign_key
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.statements, Vec::<String>::new());
@@ -4523,6 +4590,7 @@ fn builds_duckdb_create_table_statements() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -4649,6 +4717,7 @@ fn builds_clickhouse_nullable_comment_and_reorder_statements() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -4701,6 +4770,7 @@ fn builds_h2_schema_qualified_existing_column_statements() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -4730,6 +4800,132 @@ fn builds_postgres_alter_table_add_primary_key() {
assert_eq!(result.statements, vec!["ALTER TABLE \"public\".\"users\" ADD PRIMARY KEY (\"id\");"]);
}
+#[test]
+fn postgres_adds_named_primary_key_when_requested() {
+ let mut options = structure_change_options(
+ DatabaseType::Postgres,
+ Some("public"),
+ "users",
+ vec![existing_pk_column("id", "integer", false, true)],
+ );
+ options.primary_key_name = Some("users_pkey".to_string());
+
+ let result = build_table_structure_change_sql(options);
+
+ assert_eq!(result.warnings, Vec::<String>::new());
+ assert_eq!(
+ result.statements,
+ vec!["ALTER TABLE \"public\".\"users\" ADD CONSTRAINT \"users_pkey\" PRIMARY KEY (\"id\");"]
+ );
+}
+
+#[test]
+fn mysql_adds_named_primary_key_when_requested() {
+ let mut options = structure_change_options(
+ DatabaseType::Mysql,
+ Some("dbx_test"),
+ "users",
+ vec![existing_pk_column("id", "int", false, true)],
+ );
+ options.primary_key_name = Some("users_pk".to_string());
+
+ let result = build_table_structure_change_sql(options);
+
+ assert_eq!(result.warnings, Vec::<String>::new());
+ assert_eq!(result.statements, vec!["ALTER TABLE `users` ADD CONSTRAINT `users_pk` PRIMARY KEY (`id`);"]);
+}
+
+#[test]
+fn mysql_primary_key_replacement_stays_anonymous_even_with_primary_key_name() {
+ let mut old_pk = existing_pk_column("old_id", "int", true, false);
+ old_pk.id = "old_id".to_string();
+ let mut new_pk = existing_pk_column("new_id", "int", false, true);
+ new_pk.id = "new_id".to_string();
+ let mut options = structure_change_options(DatabaseType::Mysql, Some("dbx_test"), "users", vec![old_pk, new_pk]);
+ options.primary_key_name = Some("users_pk".to_string());
+
+ let result = build_table_structure_change_sql(options);
+
+ assert_eq!(result.warnings, Vec::<String>::new());
+ assert_eq!(
+ result.statements,
+ vec!["ALTER TABLE `users` DROP PRIMARY KEY;", "ALTER TABLE `users` ADD PRIMARY KEY (`new_id`);",]
+ );
+}
+
+#[test]
+fn postgres_primary_key_replacement_keeps_persisted_name_despite_primary_key_name() {
+ let mut old_pk = existing_pk_column("id", "integer", true, false);
+ old_pk.id = "old_id".to_string();
+ let mut new_pk = existing_pk_column("asdas", "integer", false, true);
+ new_pk.id = "new_asdas".to_string();
+ let mut options = structure_change_options(DatabaseType::Postgres, Some("public"), "test", vec![old_pk, new_pk]);
+ options.indexes = vec![existing_primary_index("test_pk", &["id"])];
+ options.primary_key_name = Some("should_be_ignored".to_string());
+
+ let result = build_table_structure_change_sql(options);
+
+ assert_eq!(result.warnings, Vec::<String>::new());
+ assert_eq!(
+ result.statements,
+ vec![
+ "ALTER TABLE \"public\".\"test\" DROP CONSTRAINT \"test_pk\";",
+ "ALTER TABLE \"public\".\"test\" ADD CONSTRAINT \"test_pk\" PRIMARY KEY (\"asdas\");",
+ ]
+ );
+}
+
+#[test]
+fn blank_primary_key_name_keeps_anonymous_form() {
+ let mut options = structure_change_options(
+ DatabaseType::Postgres,
+ Some("public"),
+ "users",
+ vec![existing_pk_column("id", "integer", false, true)],
+ );
+ options.primary_key_name = Some(" ".to_string());
+
+ let result = build_table_structure_change_sql(options);
+
+ assert_eq!(result.statements, vec!["ALTER TABLE \"public\".\"users\" ADD PRIMARY KEY (\"id\");"]);
+}
+
+#[test]
+fn create_table_includes_named_primary_key() {
+ let mut options = structure_change_options(
+ DatabaseType::Postgres,
+ Some("public"),
+ "users",
+ vec![existing_pk_column("id", "integer", false, true)],
+ );
+ options.primary_key_name = Some("users_pkey".to_string());
+
+ let result = build_create_table_sql(options);
+
+ assert_eq!(result.warnings, Vec::<String>::new());
+ assert_eq!(
+ result.statements,
+ vec!["CREATE TABLE \"public\".\"users\" (\n \"id\" integer,\n CONSTRAINT \"users_pkey\" PRIMARY KEY (\"id\")\n);"]
+ );
+}
+
+#[test]
+fn create_table_ignores_primary_key_name_for_sqlite() {
+ let mut options = structure_change_options(
+ DatabaseType::Sqlite,
+ None,
+ "users",
+ vec![existing_pk_column("id", "integer", false, true)],
+ );
+ options.primary_key_name = Some("users_pkey".to_string());
+
+ let result = build_create_table_sql(options);
+
+ assert_eq!(result.warnings, Vec::<String>::new());
+ assert!(!result.statements[0].contains("CONSTRAINT"), "{}", result.statements[0]);
+ assert!(result.statements[0].contains("PRIMARY KEY"), "{}", result.statements[0]);
+}
+
#[test]
fn postgres_replaces_custom_named_primary_key_without_renaming_it() {
let mut old_pk = existing_pk_column("id", "integer", true, false);
@@ -5757,6 +5953,7 @@ fn mysql_create_table_with_auto_increment() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -5790,6 +5987,7 @@ fn mysql_create_table_keeps_column_charset_collation_and_comment() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -5827,6 +6025,7 @@ fn mysql_compatible_databases_do_not_emit_mysql_column_charset_clauses() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -5861,6 +6060,7 @@ fn mysql_create_table_with_on_update_current_timestamp() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -6027,6 +6227,7 @@ fn postgres_create_table_with_identity() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -6261,6 +6462,7 @@ fn dameng_create_table_with_identity() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -6293,6 +6495,7 @@ fn dameng_create_table_preserves_character_length_units() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -6333,6 +6536,7 @@ fn dameng_alter_column_preserves_character_length_unit() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -6374,6 +6578,7 @@ fn dameng_rejects_multiple_identity_columns() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert!(result.statements.is_empty());
@@ -6408,6 +6613,7 @@ fn dameng_rejects_zero_identity_increment() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert!(result.statements.is_empty());
@@ -6443,6 +6649,7 @@ fn sqlserver_create_table_with_identity() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -6473,6 +6680,7 @@ fn mysql_quotes_datetime_literal_default() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -6503,6 +6711,7 @@ fn mysql_does_not_quote_current_timestamp() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -6534,6 +6743,7 @@ fn mysql_does_not_quote_temporal_function_with_parens() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -6564,6 +6774,7 @@ fn mysql_date_literal_default_is_quoted() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -6594,6 +6805,7 @@ fn mysql_time_literal_default_is_quoted() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -6624,6 +6836,7 @@ fn non_temporal_types_are_not_quoted() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -6758,6 +6971,7 @@ fn builds_mysql_foreign_key_changes() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -6793,6 +7007,7 @@ fn builds_mysql_composite_foreign_key() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -6831,6 +7046,7 @@ fn builds_oracle_foreign_key_with_supported_actions() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -6873,6 +7089,7 @@ fn builds_oracle_foreign_key_replacement() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -6914,6 +7131,7 @@ fn builds_mysql_trigger_changes() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -6946,6 +7164,7 @@ fn builds_sqlserver_trigger_with_multiple_events() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -6994,6 +7213,7 @@ fn rebuilds_changed_sqlserver_trigger_from_complete_metadata_source() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -7036,6 +7256,7 @@ fn sqlserver_trigger_edit_restores_disabled_state() {
transwarp_create: None,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(
@@ -7084,6 +7305,7 @@ fn unchanged_postgres_trigger_does_not_block_column_rename() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -7119,6 +7341,7 @@ fn changed_postgres_trigger_remains_unsupported() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert!(result.statements.is_empty());
@@ -7159,6 +7382,7 @@ fn rejects_editing_existing_oracle_trigger_without_complete_source() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert!(result.statements.is_empty());
@@ -7188,6 +7412,7 @@ fn builds_oracle_statement_trigger_without_row_clause() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -7229,6 +7454,7 @@ fn drops_existing_oracle_trigger_without_reconstructing_it() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -7255,6 +7481,7 @@ fn rejects_unsupported_oracle_compound_trigger_shape() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert!(result.statements.is_empty());
@@ -7285,6 +7512,7 @@ fn mysql_varchar_default_is_quoted() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -7316,6 +7544,7 @@ fn mysql_char_default_is_quoted() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -7348,6 +7577,7 @@ fn mysql_text_default_is_quoted() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -7378,6 +7608,7 @@ fn mysql_enum_default_is_quoted() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -7408,6 +7639,7 @@ fn mysql_int_default_is_not_quoted() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -7548,6 +7780,7 @@ fn mysql_character_column_add_with_charset_collation() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -7668,6 +7901,7 @@ fn mysql_numeric_column_omits_charset_collation_in_column_definition() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -7716,6 +7950,7 @@ fn mysql_numeric_column_ignores_charset_collation_in_change_detection() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
// No ALTER should be emitted — charset/collation changes on
@@ -7759,6 +7994,7 @@ fn mysql_character_column_detects_charset_collation_change() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -7807,6 +8043,7 @@ fn mysql_character_column_preserves_charset_collation_on_other_change() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -7888,6 +8125,7 @@ fn mysql_inherited_column_charset_is_omitted_from_generated_ddl() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: Some("utf8mb4_0900_ai_ci".to_string()),
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -7937,6 +8175,7 @@ fn mysql_explicit_column_charset_survives_the_table_default_comparison() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: Some("utf8mb4_0900_ai_ci".to_string()),
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -7987,6 +8226,7 @@ fn mysql_inherited_column_charset_does_not_register_as_a_change() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: Some("utf8mb4_0900_ai_ci".to_string()),
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -8030,6 +8270,7 @@ fn mysql_collation_switched_away_from_the_table_default_is_emitted() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: Some("utf8mb4_0900_ai_ci".to_string()),
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -8078,6 +8319,7 @@ fn mysql_column_charset_switched_to_the_table_default_drops_the_clause() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: Some("utf8mb4_0900_ai_ci".to_string()),
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -8123,6 +8365,7 @@ fn mysql_column_charset_is_kept_when_the_table_default_is_unknown() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -8163,6 +8406,7 @@ fn mysql_create_table_omits_inherited_column_charset() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: Some("utf8mb4_0900_ai_ci".to_string()),
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -8872,6 +9116,7 @@ fn mysql_create_table_with_generated_column() {
partitioned: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
foreign_table: false,
});
@@ -8918,6 +9163,7 @@ fn oscar_create_table_with_primary_key_and_comments() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -9118,6 +9364,7 @@ fn oscar_drop_index_with_schema_qualifier() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -9144,6 +9391,7 @@ fn oscar_table_comment_uses_comment_on_table() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -9232,6 +9480,7 @@ fn postgres_partitioned_parent_concurrent_request_rejected() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
// Fail closed: PostgreSQL rejects CREATE INDEX CONCURRENTLY on a
@@ -9268,6 +9517,7 @@ fn postgres_partitioned_parent_plain_index_unchanged() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -9316,6 +9566,7 @@ fn postgres_create_table_partitioned_concurrent_request_rejected() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(
@@ -9448,6 +9699,7 @@ fn postgres_create_table_concurrent_index() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -9569,6 +9821,7 @@ fn gaussdb_m_options(columns: Vec<EditableStructureColumn>) -> TableStructureSql
foreign_table: false,
is_gaussdb_m_mode: true,
table_collation: None,
+ primary_key_name: None,
}
}
@@ -9808,6 +10061,7 @@ fn gaussdb_m_rebuild_index_unchanged_type_does_not_rebuild() {
foreign_table: false,
is_gaussdb_m_mode: true,
table_collation: None,
+ primary_key_name: None,
};
let result = build_table_structure_change_sql(options);
assert!(result.warnings.is_empty());
@@ -9860,6 +10114,7 @@ fn mysql_create_table_nullable_timestamp_without_default_gets_explicit_null() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -9894,6 +10149,7 @@ fn mysql_create_table_nullable_timestamp_with_default_still_gets_explicit_null()
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -9926,6 +10182,7 @@ fn mysql_create_table_nullable_datetime_does_not_gain_null_keyword() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
@@ -9958,6 +10215,7 @@ fn mysql_add_column_nullable_timestamp_without_default_gets_explicit_null() {
foreign_table: false,
is_gaussdb_m_mode: false,
table_collation: None,
+ primary_key_name: None,
});
assert_eq!(result.warnings, Vec::<String>::new());
diff --git a/crates/dbx-sql-schema/src/table_structure_sql/types.rs b/crates/dbx-sql-schema/src/table_structure_sql/types.rs
index 7e2925ef83..de2d012fac 100644
--- a/crates/dbx-sql-schema/src/table_structure_sql/types.rs
+++ b/crates/dbx-sql-schema/src/table_structure_sql/types.rs
@@ -286,6 +286,12 @@ pub struct TableStructureSqlOptions {
/// `StructureDialect::Mysql` so that DDL is generated with MySQL syntax.
#[serde(default)]
pub is_gaussdb_m_mode: bool,
+ /// Optional constraint name for a **newly created** primary key. Empty or
+ /// `None` keeps the anonymous `PRIMARY KEY (...)` form and lets the server
+ /// auto-name the constraint. Only applied when the draft adds a primary key
+ /// that did not exist before; replacing an existing key never renames it.
+ #[serde(default, skip_serializing_if = "Option::is_none")]
+ pub primary_key_name: Option<String>,
}
#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)]