ArxDeleteOptions

Definition

Namespace

ARX.SDK.Services

Package

ARX.SDK

public sealed class ArxDeleteOptions

Properties

• ArxMatch Match { get; init; }

  How the rows are found; Id by default.

• bool RequireSingleRow { get; init; }

  When true, every entity must delete exactly one row: none is ARX2002 RecordNotFound, more than one is ARX2003 MultipleRecordsMatched, and either way nothing is deleted. Off by default: a delete that finds nothing is a normal outcome, and a delete by custom columns may remove many rows.

Usage

int deleted = await service.DeleteAsync(byNumber, new ArxDeleteOptions { Match = ArxMatch.Key("account_number") });

Delete by key, by compound key, by columns, scenario 1

Used in:

• Delete by key, by compound key, by columnsDelete
• Delete without a catalogDelete
• Remove a contact by id or by emailDelete
• Undo an import of 5,000 contactsDelete
• A referenced record: ARX3002, then delete in orderDelete
• Catch an SQL injection attempt on deleteDelete
• Replace an order's lines: delete, create, update, all or nothingDelete
• Delete on a preloaded schema: keys only, StrictDelete
• Remove the contacts a user selectedDeleteMultiple