MigsLab SDKARX.SDK documentation
Ctrl K

MySQL · Types · Queries

ArxLinkEntity

Definition

Namespace
ARX.SDK.Services
Package
ARX.SDK
C#
public class ArxLinkEntity

A join from a query's row source (or from another link) to another table: the column on each side, the join (JoinOperator), an alias, the columns it returns (read back as alias.column) and its own criteria.

Constructor

  • ArxLinkEntity()

    An empty link; set its tables, columns and join.

  • ArxLinkEntity(string linkToEntityName, string linkFromAttributeName, string linkToAttributeName, ArxJoinOperator joinOperator)

    A join to another table: JOIN linkTo ON linkTo.linkToAttribute = from.linkFromAttribute.

    Parameter Type Description
    linkToEntityNamestringThe table joined.
    linkFromAttributeNamestringThe column on the query's side (or the parent link's).
    linkToAttributeNamestringThe column on the joined table.
    joinOperatorArxJoinOperatorINNER, LEFT or RIGHT; DEFAULT joins as INNER.

Properties

  • string LinkFromAttributeName { get; set; }

    The column on the query's side (or the parent link's) that the join matches.

  • string? LinkFromEntityName { get; set; }

    The table on the query's side; informational, the join starts from the query or the parent link.

  • string LinkToEntityName { get; set; }

    The table joined.

  • string LinkToAttributeName { get; set; }

    The column on the joined table that the join matches.

  • ArxColumnSet ColumnSet { get; set; }

    The joined table's columns to read, returned as alias.column.

  • string? EntityAlias { get; set; }

    The join's alias: the prefix of its columns in the result, and the name conditions and orders use for it.

  • ArxFilterExpression LinkCriteria { get; set; }

    Conditions on the joined table, applied in the join itself (a LEFT join keeps rows with no match).

  • ArxJoinOperator JoinOperator { get; set; }

    INNER, LEFT or RIGHT; DEFAULT joins as INNER.

  • List<ArxLinkEntity> LinkEntities { get; set; }

    Further joins from this joined table.

Usage

C#

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

query.LinkEntities.Add(new ArxLinkEntity("order_line", "id", "product_id", ArxJoinOperator.Left) { EntityAlias = "l" });

Read other row sources: a view in a schema, a summary view, a table with no id, scenario 1

Used in: