Adding support for table and column renaming using Regex

[evandromendonca]

Hello, first I'd like to thank you for this tool, it has been very useful and I am more than happy to contribute.

I had the need to remove some prefixes from my tables. I found out this thread but didn't want to map my entire database.

So I took inspiration from there and included 4 new properties in the Schema object. These will receive the pattern to be matched and a string to replace tables and columns names.

TableRegexPattern: pattern to be matched by table names
TablePatternReplaceWith: string that will replace the occurrences of the pattern in tables names
ColumnRegexPattern: pattern to be matched by column names
ColumnPatternReplaceWith: string that will replace the occurrences of the pattern in columns names

The regex renaming also have lower priority over the current renaming method, and therefore, if a table is renamed using "NewName", the NewName method will prevail over the regex

Example of use:

efpt.renaming.json

[
  {
    "UseSchemaName": false,
    "SchemaName": "dbo",
    "TableRegexPattern": "^Old",
    "TablePatternReplaceWith": "New",
    "ColumnRegexPattern": "^Old",
    "ColumnPatternReplaceWith": "New",
    "Tables": [
      {
        "Name": "course_sched",
        "NewName":  "CourseOffering",
        "Columns": [
          {
            "Name": "subj_area_cd",
            "NewName": "SubjectArea"
          }
        ]
      }
    ]
  }
]

[ErikEJ]

You must rebase on latest master

[ErikEJ]

Would it be possible to design for expetions from the general rules for individual tables and/or columns?

[evandromendonca]

Would it be possible to design for expetions from the general rules for individual tables and/or columns?

Sorry, I didn't understand what you meant there.

[ErikEJ]

I just didn't read this properly:

The regex renaming also have lower priority over the current renaming method, and therefore, if a table is renamed using "NewName", the NewName method will prevail over the regex.

[ErikEJ]

Please address review comments

[ErikEJ]

Great, thanks a lot for the contribution

[jamshally]

This is a great feature. Thanks!

[ErikEJ]

You are welcome, agree that it rounds out the renaming feature nicely.

[e-ngin]

I'm sorry but I don't understand how to use this feature.

i add

"TableRegexPattern": "^.+",
"TablePatternReplaceWith": "$0Entity"

to the efpt.config.json file but it gets overwritten when i rerun the reverse engineer.

[ErikEJ]

@engineruguz No worries - You got the file name wrong - see https://github.com/ErikEJ/EFCorePowerTools/wiki/Reverse-Engineering#custom-renaming-with-efptrenamingjson

[e-ngin]

oooh! i see. feel dumb lol

[e-ngin]

hi! sorry. i still can't find out why it's not working? i created efpt.renaming.json file at project root like below.

{
  "UseSchemaName": false,
  "SchemaName": "dbo",
  "TableRegexPattern": "^.+$",
  "TablePatternReplaceWith": "$0Entity"
}

i'm trying to add Entity at the end of every table. not sure about $0 is the correct syntax though but not getting anything different.

[ErikEJ]

Wrong file format...

[e-ngin]

uh ofc! sorry. thanks

[marcziss]

Either I'm doing something very dumb or there's an issue with ColumnPatternReplaceWith

{
"ColumnPatternReplaceWith": "TEST_COLUMN_",
"ColumnRegexPattern": "^",
"SchemaName": "PDM",
"TablePatternReplaceWith": "TEST_TABLE_",
"TableRegexPattern": "^",
"UseSchemaName": false
}

In this example using .net 5 (and latest version of vsix installed today) Every table is renamed properly with the TEST_TABLE_ prefix, however no column is renamed at all. Is there something I'm missing?

[ErikEJ]

@marcziss if you have an issue, please create one with detailed repro steps.

[HansB159]

@marcziss I struggled with the same problem. Solution: add "Table: []". That magically worked for me.