RelationalSqlGenerationHelper Class

Definition

Namespace:

Microsoft.EntityFrameworkCore.Storage

Assembly:

Microsoft.EntityFrameworkCore.Relational.dll

Package:

Microsoft.EntityFrameworkCore.Relational v9.0.0

Source:

RelationalSqlGenerationHelper.cs

Provides services to help with generation of SQL commands.

This type is typically used by database providers (and other extensions). It is generally not used in application code.

public class RelationalSqlGenerationHelper : Microsoft.EntityFrameworkCore.Storage.ISqlGenerationHelper

type RelationalSqlGenerationHelper = class
    interface ISqlGenerationHelper

Public Class RelationalSqlGenerationHelper
Implements ISqlGenerationHelper

Inheritance

Object

RelationalSqlGenerationHelper

Implements

ISqlGenerationHelper

Remarks

The service lifetime is Singleton. This means a single instance is used by many DbContext instances. The implementation must be thread-safe. This service cannot depend on services registered as Scoped.

See Implementation of database providers and extensions for more information and examples.

Constructors

RelationalSqlGenerationHelper(RelationalSqlGenerationHelperDependencies)

Initializes a new instance of this class.

Properties

BatchTerminator	The terminator to be used for batches of SQL statements.
CommitTransactionStatement	Gets the SQL for a COMMIT statement.
Dependencies	Relational provider-specific dependencies for this service.
SingleLineCommentToken	The default single-line comment prefix.
StartTransactionStatement	Gets the SQL for a START TRANSACTION statement.
StatementTerminator	The terminator to be used for SQL statements.

Methods

DelimitIdentifier(String, String)	Generates the delimited SQL representation of an identifier (column name, table name, etc.).
DelimitIdentifier(String)	Generates the delimited SQL representation of an identifier (column name, table name, etc.).
DelimitIdentifier(StringBuilder, String, String)	Writes the delimited SQL representation of an identifier (column name, table name, etc.).
DelimitIdentifier(StringBuilder, String)	Writes the delimited SQL representation of an identifier (column name, table name, etc.).
DelimitJsonPathElement(String)	Writes the delimited SQL representation of an element in a JSON path.
EscapeIdentifier(String)	Generates the escaped SQL representation of an identifier (column name, table name, etc.).
EscapeIdentifier(StringBuilder, String)	Writes the escaped SQL representation of an identifier (column name, table name, etc.).
EscapeJsonPathElement(String)	Generates the escaped SQL representation of an identifier (column name, table name, etc.).
GenerateComment(String)	Generates a SQL comment.
GenerateCreateSavepointStatement(String)	Generates an SQL statement which creates a savepoint with the given name.
GenerateParameterName(String)	Generates a valid parameter name for the given candidate name.
GenerateParameterName(StringBuilder, String)	Writes a valid parameter name for the given candidate name.
GenerateParameterNamePlaceholder(String)	Generates a valid parameter placeholder name for the given candidate name.
GenerateParameterNamePlaceholder(StringBuilder, String)	Writes a valid parameter placeholder name for the given candidate name.
GenerateReleaseSavepointStatement(String)	Generates an SQL statement which releases a savepoint with the given name.
GenerateRollbackToSavepointStatement(String)	Generates an SQL statement which rolls back to a savepoint with the given name.