Name of class created to hold the data returned by stored procedure select statement doesn't follow the proper naming convention

[boggye]

Bug description / exact reproduction steps

Hello,

I have a stored procedure using this naming convention: dbo.some_name_sp. This stored procedures returns a resultset, in other words it contains a select statement.

When EFCpt generates the class that maps to the structures of the resultset, it uses the name: some_name_spResult.cs which doesn't match the normal convention I use. The name should have been SomeNameSpResult.cs.

This is what I have in the json config file:

  "code-generation": {
    "enable-on-configuring": false,
    "type": "all",
    "use-database-names": false,
    "use-data-annotations": true,
    "use-nullable-reference-types": true,
    "use-inflector": true,
    "use-legacy-inflector": false,
    "use-many-to-many-entity": false,
    "use-t4": false,
    "remove-defaultsql-from-bool-properties": false,
    "soft-delete-obsolete-files": false,
    "discover-multiple-stored-procedure-resultsets-preview": true,
    "use-alternate-stored-procedure-resultset-discovery": true,
    "t4-template-path": null,
    "use-no-navigations-preview": false,
    "merge-dacpacs": false,
    "refresh-object-lists": false
  },

I am reporting this as an issue because the table & view names are generated properly from all the table & view names that use the snake_case convention. It is possible that I missed a setting. I apologize if that is the case.

Thank you

Your code

Stored procedure to test:

SET ANSI_NULLS ON;
GO

SET QUOTED_IDENTIFIER ON;
GO

CREATE OR ALTER PROCEDURE dbo.some_name_sp 
AS
BEGIN
select 1 as field_name
end
go

Stack traces

EF Core Power Tools version

for .Net 8

EF Core Power Tools CLI version

8.1.1094

Provider:

The one for Sql Server 2017

Target framework

.Net 8

IDE

N/A - I use the command line CLI

Additional features in use

• T4 templates
• SQL Server .dacpac
• Handlebars template

[ErikEJ]

@boggye Please share your full config, or at least the top of the stored-procedures section.

[boggye]

Hi,

Here it is. I just included some dummy names. The real config includes more tables, views and stored procedures.

Again, the naming convention in the database is snake_case.

{
  "$schema": "https://raw.githubusercontent.com/ErikEJ/EFCorePowerTools/master/samples/efcpt-config.schema.json",
  "tables": [
    {
      "name": "dbo.some_table1"
    },
    {
      "name": "dbo.some_table2"
    },
    ...
  ],
  "views": [
    {
      "name": "dbo.some_view1"
    },
    {
      "name": "dbo.some_view2"
    },
    ...
  ],
  "stored-procedures": [
    {
      "name": "dbo.some_stored_proc1_sp"
    },
    {
      "name": "dbo.some_stored_proc1_sp"
    },
    ...
  ],
  "functions": [

  ],
  "code-generation": {
    "enable-on-configuring": false,
    "type": "all",
    "use-database-names": false,
    "use-data-annotations": true,
    "use-nullable-reference-types": true,
    "use-inflector": true,
    "use-legacy-inflector": false,
    "use-many-to-many-entity": false,
    "use-t4": false,
    "remove-defaultsql-from-bool-properties": false,
    "soft-delete-obsolete-files": false,
    "discover-multiple-stored-procedure-resultsets-preview": true,
    "use-alternate-stored-procedure-resultset-discovery": true,
    "t4-template-path": null,
    "use-no-navigations-preview": false,
    "merge-dacpacs": false,
    "refresh-object-lists": false
  },
  "names": {
    "root-namespace": "Some.App.Data",
    "dbcontext-name": "AppDbContext",
    "dbcontext-namespace": "Db.App",
    "model-namespace":  "Db.App.Entities"
  },
  "file-layout": {
    "output-path": "Db\\App\\Entities",
    "output-dbcontext-path": "Db\\App",
    "split-dbcontext-preview": false,
    "use-schema-folders-preview": false,
    "use-schema-namespaces-preview": false
  },
  "type-mappings": {
    "use-DateOnly-TimeOnly": false,
    "use-HierarchyId": false,
    "use-spatial": false,
    "use-NodaTime": false
  },
  "replacements": {
    "preserve-casing-with-regex": false,
    "uncountable-words": [
      "Status",
      "Data"
    ]
  }
}

Thank you

[boggye]

I want to add that in the AppDbContextProcedures, the names of the methods use snake_case . The EFCpt generator does not use the PascalCase when it generates the C# methods that call the stored procedures. Until now, all the procedures we call didn't return any resultset (i.e. didn't include a select statement that returned data to the app) and I haven't been bothered by it. I thought whatever, it is not the end of the world if these methods have snake_case names, but in this case the class that maps to the structure of the select statement returned by the stored procedure also uses snake_case and it stands out because all the other entity classes use PascalCase .

[ErikEJ]

The default behaviour is PascalCase for sure, so please create a small runnable project that reproduces this and I will have a look.

[boggye]

Hi,

You need to run first the create_test_table.sql and test_sp.sql sql scripts in your test sql server database.

Command used to generate the entity:
efcpt "Server=SERVER;Database=DATABASE;Trusted_Connection=True;TrustServerCertificate=True" Microsoft.EntityFrameworkCore.SqlServer --input .\efcpt.json.

Replace SERVER and DATABASE with your sql server server name respectively the name of your test database where you compiled the sql scripts. You may also need to modify the connection string to include the user name and password. I used windows authentication and this way I did not have to specify the password.

I archived the C# console project.

TestEfcpt.zip

As you can see the problems are:

1. The name of the class that stores the result from test_sp is: test_spResult, and also the property name is: test_field
2. The name of the method that executes the store procedure is:

Task<List<test_spResult>?> test_spAsync(
      OutputParameter<int>? returnValue = null,
      CancellationToken? cancellationToken = default
    );

Also, you'll notice that the C# entity name that maps to the test_table is TestTable which is correct.

I hope this will help you review this issue.

Thank you

[ErikEJ]

Ah, you are looking for this:

"use-database-names-for-routines": false

"use-database-names-for-routines": {
          "type": "boolean",
          "title": "Use stored procedure, stored procedure result and function names from the database",
          "default": true
        },

[boggye]

Yes, thank you! Using that setting did the trick. 🙏

[ErikEJ]

@boggye Great!

If you like my free tools, I would be very grateful for a rating/review on Visual Studio Marketplace and/or a one-time or monthly sponsorship

[ErikEJ]

@boggye The setting is actually documented here: https://github.com/ErikEJ/EFCorePowerTools/wiki/Reverse-Engineering#sql-server-stored-procedures