PgCompositeTypeAttribute

Namespace: Ankus

Assembly: Ankus.Runtime.dll

Binds a PgHeapTuple value or array to an existing PostgreSQL composite type. Without this attribute, the SQL type is record or record[].

[AttributeUsage(AttributeTargets.Parameter|AttributeTargets.ReturnValue, AllowMultiple = true)]
public sealed class PgCompositeTypeAttribute : Attribute

Inheritance: object, Attribute

Constructors

PgCompositeTypeAttribute(string)

Binds a PgHeapTuple value or array to an existing PostgreSQL composite type. Without this attribute, the SQL type is record or record[].

public PgCompositeTypeAttribute(string name)

Parameters:

name — string

The exact composite type identifier, without SQL quoting.

Properties

Column

Gets or sets the exact SQL TABLE column name to bind when a result contains multiple composite columns. A single composite output is selected automatically when this value is omitted.

public string? Column { get; set; }

Value: string

Element

Gets or sets the exact C# tuple element to bind within a typed aggregate argument group. Omit for a scalar parameter or return value.

public string? Element { get; set; }

Value: string

Name

Gets the exact PostgreSQL composite type identifier.

public string Name { get; }

Value: string

Schema

Gets or sets the schema identifier. An omitted schema leaves the SQL type name unqualified.

public string? Schema { get; set; }

Value: string