PgTypeAttribute

Namespace: Ankus

Assembly: Ankus.Runtime.dll

Generates a PostgreSQL base type with CBOR, packed native storage, or an explicit storage codec.

[AttributeUsage(AttributeTargets.Class|AttributeTargets.Struct|AttributeTargets.Enum, Inherited = false)]
public sealed class PgTypeAttribute : Attribute

Generated CBOR contracts support inherited members and explicitly tagged class variants declared with JsonDerivedTypeAttribute and JsonPolymorphicAttribute. Abstract classes require generated storage with concrete variants; explicit storage codecs require a concrete managed type. Unknown runtime subtypes are rejected to preserve stored type identity.

Inheritance: object, Attribute

Constructors

PgTypeAttribute(Type?)

Generates a PostgreSQL base type with CBOR, packed native storage, or an explicit storage codec.

public PgTypeAttribute(Type? codec = null)

Parameters:

codec — Type

An explicit PgTypeCodec with an accessible parameterless constructor; omit to use generated storage and the selected text options.

Generated CBOR contracts support inherited members and explicitly tagged class variants declared with JsonDerivedTypeAttribute and JsonPolymorphicAttribute. Abstract classes require generated storage with concrete variants; explicit storage codecs require a concrete managed type. Unknown runtime subtypes are rejected to preserve stored type identity.

Properties

Alignment

Gets or sets the PostgreSQL datum alignment, defaulting to four bytes. Does not add payload padding or change the codec’s storage representation.

public PgTypeAlignment Alignment { get; set; }

Value: PgTypeAlignment

BinaryProtocol

Gets or sets whether binary send and receive functions expose the codec’s storage representation.

public bool BinaryProtocol { get; set; }

Value: bool

Codec

Gets the statically constructed codec type, or null for generated serialization.

public Type? Codec { get; }

Value: Type

GenerateSql

Gets or sets whether installation SQL is emitted for the type’s shell, I/O functions and completed base-type declaration. The default is true. False retains the generated codec, native I/O entry points, type mapping and dependency identifier. Cannot be false when Sql contains a replacement, including an empty string.

public bool GenerateSql { get; set; }

Value: bool

Id

Gets or sets the installation dependency identifier for the completed type.

public string? Id { get; set; }

Value: string

Name

Gets or sets the SQL type name; the default is the managed type name in snake_case.

public string? Name { get; set; }

Value: string

NativeLayout

Gets or sets whether storage uses the native representation of a sequential unmanaged struct, as pgrx’s pgvarlena_inoutfuncs stores a repr(C) struct. Requires TextCodec. Fields are aligned as C aligns them, limited by an optional StructLayout Pack, and every write sets the padding bytes to zero. Only fixed-width numeric fields, enums, nested sequential structs and fixed buffers of numeric fields are supported.

public bool NativeLayout { get; set; }

Value: bool

Native storage depends on field order, packing and host byte order. BinaryProtocol exposes this same representation. Changing the layout requires a data migration. Booleans, characters, pointers, platform-sized integers, explicit layouts, size overrides, empty structs and framework value types are rejected by the generator. Values of the declared struct use copied managed transport. PgVarlena wrappers provide checked native borrowing, copy-on-write mutation and explicit ownership for the same SQL type.

NullInputErrorMessage

Gets or sets the SQLSTATE 22004 message raised when the generated text input function receives SQL NULL. This includes untyped NULL literals coerced to this type, text array elements and text COPY fields. Null leaves the input function strict; already-typed SQL NULL values bypass the codec.

public string? NullInputErrorMessage { get; set; }

Value: string

Requires

Gets or sets installation entities that must precede the type declaration.

public string[] Requires { get; set; }

Value: string[]

Schema

Gets or sets a fixed schema; otherwise the enclosing PgSchema or extension installation schema applies.

public string? Schema { get; set; }

Value: string

Sql

Gets or sets literal installation SQL replacing this type’s complete shell, I/O functions and completed base-type declaration. Null preserves generated SQL; empty text emits no statements for this declaration.

public string? Sql { get; set; }

Value: string

Supports @INPUT_FUNCTION_NAME@ and @OUTPUT_FUNCTION_NAME@ for native exports, plus @RECEIVE_FUNCTION_NAME@ and @SEND_FUNCTION_NAME@ when BinaryProtocol is true. Binary tokens are rejected when those callbacks are disabled. @MODULE_PATHNAME@ becomes MODULE_PATHNAME. Add SQL quotes around native export tokens. Keep the declared type name, schema and variable-length storage representation compatible with the generated codec and managed consumers.

SqlRelocatable

Gets or sets whether the literal Sql replacement permits moving the extension to another schema. The default is false. This option applies only to non-null Sql; fixed schemas and other non-relocatable declarations can still prevent relocation.

public bool SqlRelocatable { get; set; }

Value: bool

TextCodec

Gets or sets a PgTypeTextCodec for custom SQL text with generated CBOR or packed native storage. Cannot be combined with an explicit storage codec.

public Type? TextCodec { get; set; }

Value: Type