ArxRetrieveOptions

Definition

Namespace

ARX.SDK.Services

Package

ARX.SDK

public sealed class ArxRetrieveOptions

Properties

• ArxMatch Match { get; init; }

  How RetrieveAsync(entity, options) finds its record: Id by default, a declared key, or any columns. More than one matching row is ARX2003 (a Retrieve answers one record). Not used by RetrieveMultiple.

• ArxColumnSet? Columns { get; init; }

  The columns to read for RetrieveAsync(entity, options); null reads every column.

• bool LookupNames { get; init; }

  True (the default): a requested lookup column whose referenced table declares a display name reads back with Name filled, through one LEFT JOIN per lookup column. False skips the joins.

• int? CommandTimeout { get; init; }

  Seconds before the query is cancelled (ARX7003). Null keeps the driver's default (30 s in the PostgreSQL, SQL Server and MySQL drivers).

Usage

await service.RetrieveAsync(match, new ArxRetrieveOptions { Match = ArxMatch.Columns("last_name") });

Find a record by id, key or columns, scenario 4

Used in:

• Find a record by id, key or columnsRetrieve
• Retrieve without a catalogRetrieve
• Lookups and display namesRetrieveMultiple