ArxRowSource

Definition

Namespace

ARX.SDK.Query

Package

ARX.SDK

public sealed class ArxRowSource

Constructor

No public constructor: create one with:

• ArxRowSource.Table(string name)

  A table or view (on PostgreSQL also a materialized view or foreign table).

  Parameter	Type	Description
  name	string	The table or view (on PostgreSQL also a materialized view or foreign table), or schema.name.

• ArxRowSource.Function(string name)

  A function with no arguments.

  Parameter	Type	Description
  name	string	The function, or schema.function.

• ArxRowSource.Function(string name, params (string Name, object? Value)[] arguments)

  A function with named arguments: Function("fn", ("p_region", "NL"), ("p_active", true)).

  Parameter	Type	Description
  name	string	The function, or schema.function.
  arguments	params (string Name, object? Value)[]	Each argument by its parameter's name, with its value.

• ArxRowSource.Function(string name, params object?[] arguments)

  A function with positional arguments: Function("fn", "NL", true).

  Parameter	Type	Description
  name	string	The function, or schema.function.
  arguments	params object?[]	The arguments, in the function's parameter order.

Properties

• ArxRowSourceKind Kind { get; }

  A table (anything read by name) or a function called with arguments.

• string Name { get; }

  The table, view or function name, optionally schema-qualified (reporting.v_sales). Validated by the provider.

• IReadOnlyList<ArxFunctionArgument> Arguments { get; }

  The function's arguments, in order. Empty for a table.

• IReadOnlyList<ArxResultColumn> ResultColumns { get; }

  The declared result columns of a function returning untyped rows; empty otherwise.

• bool AllowsWrites { get; }

  False (the default): a function is read in a read-only transaction when ARX owns the connection, so a function that writes is refused. Inside an ArxTransaction, a batch scope or a connection the caller passes in, the read runs in that transaction as it is: a function that writes does write there, since ARX can't make the caller's transaction read-only. True after AllowWrites.

• bool IsFunction { get; }

  True for a function row source.

Methods

• ArxRowSource Returns(params (string Name, Type Type)[] columns)

  Declares the result columns of a function that returns untyped rows (RETURNS SETOF record).

  Parameter	Type	Description
  columns	params (string Name, Type Type)[]	The function's result columns and their .NET types, in order.

• ArxRowSource AllowWrites()

  Lets a function read change data: no read-only transaction around it. Use only for functions you trust.

Usage

var query = new ArxQueryExpression(ArxRowSource.Function("fn_contacts_of_account", ("p_account_id", accountId.AsInt64())));

Read a function that returns a table, scenario 1

Used in:

• Read a function that returns a tableRetrieveMultiple
• Read functions in depth: table rows, OUT values, one value, records, writes, proceduresRetrieveMultiple
• Execute on a preloaded, Strict schema: routines aren't covered, tables areExecute