PgCustomScanAttribute

Namespace: Ankus

Assembly: Ankus.Runtime.dll

Declares a custom scan provider from a class implementing IPgCustomScan<TState>.

[AttributeUsage(AttributeTargets.Class, Inherited = false)]
public sealed class PgCustomScanAttribute : Attribute

Ankus registers the provider when PostgreSQL loads the extension library and offers it every plain table the planner scans in that backend. EXPLAIN shows the chosen scan as Custom Scan (name).

Inheritance: object, Attribute

Constructors

PgCustomScanAttribute()

public PgCustomScanAttribute()

Properties

Name

Gets or sets the name PostgreSQL registers and EXPLAIN shows, defaulting to the class name in snake_case.

public string? Name { get; set; }

Value: string

The name is case-sensitive, must be unique in the backend and must fit 63 UTF-8 bytes.