Skip to content

bindings-macro: add custom index name to prevent index name collisions #4725

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

Open
rudcode wants to merge 1 commit into
base: master
Choose a base branch
from
+35 −41
Open

bindings-macro: add custom index name to prevent index name collisions #4725

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
76 changes: 35 additions & 41 deletions crates/bindings-macro/src/table.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,58 +245,44 @@ impl IndexArg {
}
sym::name => {
check_duplicate(&canonical_name, &meta)?;
canonical_name = Some(meta.value()?.parse()?);
}

sym::btree => {
check_duplicate_msg(&algo, &meta, "index algorithm specified twice")?;
algo = Some(Self::parse_btree(meta)?);
}
sym::hash => {
check_duplicate_msg(&algo, &meta, "index algorithm specified twice")?;
algo = Some(Self::parse_hash(meta)?);
}
sym::direct => {
check_duplicate_msg(&algo, &meta, "index algorithm specified twice")?;
algo = Some(Self::parse_direct(meta)?);
}
sym::name => {
// If the user is trying to specify a `name`, do a bit of guessing at what their goal is.
// This is going to be best-effort, and we're not going to try to do lookahead or anything.

return Err(if accessor.is_some() {
// If the user's already specified an `accessor`,
// then probably they're trying to specify the canonical name,
// like you can for tables.
// Print an error that says this is unsupported.
meta.error(
"Unexpected argument `name` in index definition.

Overwriting the `name` of an index is currently unsupported.",
)
} else if let Ok(sym) = meta.value().and_then(|val| val.parse::<Ident>()) {
if let Ok(ident) = meta.value().and_then(|val| val.parse::<Ident>()) {
// If we haven't seen an `accessor` yet, and the value is an ident,
// then probably this is 1.* syntax that needs a migration.
// Note that, if the user specifies `name = {ident}` followed by `accessor = {ident}`,
// we'll hit this branch, even though the diagnostic doesn't apply and we'd prefer not to.
// I (pgoldman 2026-02-18) don't see a good way to distinguish this case
// without making our parsing dramatically more complicated,
// and it seems unlikely to occur.
meta.error(format_args!(
return Err(meta.error(format_args!(
"Expected an `accessor` in index definition, but got a `name` instead.

If you're migrating from SpacetimeDB 1.*, replace `name = {sym}` with `accessor = {sym}`."
))
If you're migrating from SpacetimeDB 1.*, replace `name = {ident}` with `accessor = {ident}`."
)));
} else if let Ok(lit_str) = meta.value()?.parse::<LitStr>() {
// User provided a string literal - use it as custom index name
canonical_name = Some(lit_str);
} else {
// If we haven't seen an `accessor` yet, but the value is not an ident,
// then we're not really sure what's going wrong, so print a more generic error message.
meta.error(format_args!(
"Unexpected argument `name` in index definition.

Overwriting the `name` of an index is currently unsupported.
Did you mean to specify an `accessor` instead? Do so with `accessor = my_index`, where `my_index` is an unquoted identifier."
))
});
return Err(meta.error(
"Unexpected argument `name` in index definition.\n\n\
Use a string literal for a custom index name: `name = \"my_index_name\"`.",
));
}
}

sym::btree => {
check_duplicate_msg(&algo, &meta, "index algorithm specified twice")?;
algo = Some(Self::parse_btree(meta)?);
}
sym::hash => {
check_duplicate_msg(&algo, &meta, "index algorithm specified twice")?;
algo = Some(Self::parse_hash(meta)?);
}
sym::direct => {
check_duplicate_msg(&algo, &meta, "index algorithm specified twice")?;
algo = Some(Self::parse_direct(meta)?);
}
});
Ok(())
Expand Down Expand Up @@ -369,6 +355,7 @@ Did you mean to specify an `accessor` instead? Do so with `accessor = my_index`,
/// Parses an inline `#[index(btree)]`, `#[index(hash)]`, or `#[index(direct)]` attribute on a field.
fn parse_index_attr(field: &Ident, attr: &syn::Attribute) -> syn::Result<Self> {
let mut kind = None;
let mut name = None;
attr.parse_nested_meta(|meta| {
match_meta!(match meta {
sym::btree => {
Expand All @@ -387,6 +374,10 @@ Did you mean to specify an `accessor` instead? Do so with `accessor = my_index`,
check_duplicate_msg(&kind, &meta, "index type specified twice")?;
kind = Some(IndexType::Direct { column: field.clone() })
}
sym::name => {
check_duplicate(&name, &meta)?;
name = Some(meta.value()?.parse()?);
}
});
Ok(())
})?;
Expand All @@ -395,7 +386,7 @@ Did you mean to specify an `accessor` instead? Do so with `accessor = my_index`,

// Default accessor = field name if not provided
let accessor = field.clone();
Ok(IndexArg::new(accessor, kind, None))
Ok(IndexArg::new(accessor, kind, name))
}

fn validate<'a>(&'a self, table_name: &str, cols: &'a [Column<'a>]) -> syn::Result<ValidatedIndex<'a>> {
Expand Down Expand Up @@ -436,7 +427,10 @@ Did you mean to specify an `accessor` instead? Do so with `accessor = my_index`,
is_unique: self.is_unique,
// This must be the canonical name (name used internally in database),
// as it is used in `index_id_from_name` abi.
index_name: gen_index_name(),
index_name: match self.canonical_name.as_ref() {
Some(s) => s.value(),
None => gen_index_name(),
},
accessor_name: &self.accessor,
kind,
canonical_name: self.canonical_name.as_ref().map(|s| s.value()),
Expand Down