MigsLab SDKARX.SDK documentation
Ctrl K

SQL Server · Types · The schema catalog

ArxKey

Definition

Namespace
ARX.SDK.Services
Package
ARX.SDK
C#
public sealed class ArxKey : IEquatable<ArxKey>

A business key of a table: one or more columns whose values identify a record, such as account_number, or region and sku together. Optional: a table whose rows may repeat declares none. Create doesn't use keys (the database's unique constraints enforce them); Update and Delete can find rows by them.

Constructor

  • ArxKey(params string[] columns)

    A key of one column, or of several for a compound key.

    Parameter Type Description
    columnsparams string[]The key's columns: one, or several that identify a row together.

Properties

  • IReadOnlyList<string> Columns { get; }

    The key's columns, as declared.

  • bool IsCompound { get; }

    True when the key has more than one column.

Methods

  • bool Equals(ArxKey? other)

    Equal when both keys have the same columns, in any order, ignoring case.

    Parameter Type Description
    otherArxKey?The key to compare with.

Usage

C#

A line from a verified sample; the full, runnable code is on its page.

price.Keys = new[] { new ArxKey("region", "sku") };

Where to declare: on the entity, or a schema for one call, never both, scenario 1

Used in: