IRelationalCommandDiagnosticsLogger CommandReaderExecuting adds logCommandText parameter

[rwoodslap]

Type of issue

Missing information

Description

In breaking changes for Entity Framework .NET 10, someone forgot that there is a new required parameter for "logCommandText" in the interface named IRelationalCommandDiagnosticsLogger when calling a number of methods, one of which is CommandReaderExecuting.

I need to know what that parameter is for since it is not nullable and I am already passing in the command as a parameter.

Page URL

https://learn.microsoft.com/en-us/ef/core/what-is-new/ef-core-10.0/breaking-changes

Content source URL

https://github.com/dotnet/EntityFramework.Docs/blob/main/entity-framework/core/what-is-new/ef-core-10.0/breaking-changes.md

Document Version Independent Id

bbde202d-67a5-fa94-03cd-8a526a1f2a56

Platform Id

9992e66c-a232-bf52-db0b-d236573bddb5

Article author

@roji

[roji]

Can you provide a bit of context on why this is breaking for you, i.e. how you're using the IRelationalCommandDiagnosticsLogger interface?

[rwoodslap]

I use the library "EntityFrameworkExtras", but for one application I needed to have logging working as it does in the native SQL library, so I added code to retrieve the correct IRelationalCommandDiagnosticsLogger and write logs to it.

For example:

// Read in the information from the connection
IRelationalConnection connection = database.GetService<IRelationalConnection>();
DbContext context = connection.Context;
IRelationalCommandDiagnosticsLogger logger = database.GetService<IRelationalCommandDiagnosticsLogger>();

.... Checks if the logger is valid and logging is on

var interceptionResult = logger.CommandReaderExecuting(
connection,
command,
???????????????????????,
context,
commandId.Value,
connection.ConnectionId,
startTime,
commandSource);

In .NET 9, there was no parameter for logCommandText. I'm not sure what that parameter does, so I'm not sure what to use for that parameter here. Is that what actually gets logged to logger? Why is the DbCommand still needed then? Can I get guidance on why the new parameter was added to the call for CommandReaderExecuting, CommandCanceled and CommandError?

The other methods I use (CommandCreated and CommandInitialized) did not change.

[roji]

Yes, logCommandText is what gets logged, as opposed to what gets executed; this supports the new "redact inlined constants' feature introduced in EF 10 (release notes).

[rwoodslap]

That's excellent, but the change to the IRelationalCommandDiagnosticsLogger should be listed as a breaking change (since my code from .NET 9 no longer compiles) and a description written to support what you sent me in this thread I would think.

Thank you for looking into this issue for me.

[roji]

Sure, I agree this is a low-impact breaking change that should be documented.