Interface IIndexHintRenderer

Namespace

NextORM.Core

Assembly

nextorm.core.dll

A dialect's renderer for table index hints (MySQL/MariaDB USE|FORCE|IGNORE INDEX, SQLite INDEXED BY/NOT INDEXED, SQL Server WITH (INDEX(...))). The object's presence is the capability: a dialect that returns null rejects a command that carries an index hint.

public interface IIndexHintRenderer

Extension Methods

EntityBuilderExtensions.AsEntityBuilder<T>(object?)

Properties

MergesWithTableHints

True when the hint is rendered as another entry of the table-hint WITH (...) list (SQL Server) rather than as a standalone clause after the table name.

bool MergesWithTableHints { get; }

Property Value

bool

Methods

RenderIndexHint(IReadOnlyList<string>, IndexHintKind, KeywordCase)

Renders the index hint for indexes and kind. When MergesWithTableHints is true the returned fragment is the bare table-hint token (the caller wraps it in WITH (...)); otherwise it is the standalone clause including its leading separator. Returns null when the kind cannot be expressed (for example FORCE on SQL Server).

string? RenderIndexHint(IReadOnlyList<string> indexes, IndexHintKind kind, KeywordCase keywordCase = KeywordCase.Lower)

Parameters

indexes IReadOnlyList<string>

kind IndexHintKind

keywordCase KeywordCase

Returns

string