Skip to main content

create-index-name

Why?#

When creating an index, it's possible to omit a specific constraintName for the index. This is hazardous, because the database vendor will automatically name it for you in an unpredictable way, which makes things difficult later if you want to reference or remove it.

Also, you might already have a broad standard for object names - and be enforcing it with the object-name rule - but you might also want a more specific rule concerning how indexes are named.

This rule will fail if there is no constraintName given when creating an index, or when configured with a pattern, will fail if the given name does not match the pattern.

Options#

  • pattern - (regex, as string) optional regular expression that the name of any created index must adhere to
  • dynamicValue - (string) Spring EL expression, with the CreateIndexChange instance as its expression scope, that should resolve to a string, and can then be interpolated in the pattern with {{value}}

Example Usage#

To simply ensure that a name is always given:

{
"rules": {
"create-index-name": true
}
}

To ensure that a pattern is matched, including the table name:

{
"rules": {
"create-index-name": {
"pattern": "^{{value}}_I\\d$",
"dynamicValue": "tableName",
"errorMessage": "Index names must be the table name, suffixed with 'I' and a number, e.g. FOO_I2"
}
}
}