Soft delete: close and restore an account

Runs the sample. Generated for this page; it reads the connection string from the environment.

using ArxSamples.MSSQL;
using ArxSamples.MSSQL.Operations.Delete.RealCases;

// The connection string comes from the environment, never from the code (see "Configure the connection").
var connectionString = Environment.GetEnvironmentVariable("ARX_SAMPLES_SQLSERVER")
    ?? throw new InvalidOperationException("Set the ARX_SAMPLES_SQLSERVER environment variable to your SQL Server connection string.");

await new RealCase4_SoftDelete().RunAsync(new SampleContext(connectionString));

The sample, as it is in the repository.

using ARX.SDK.Services;
using static ArxSamples.MSSQL.SampleOutput;

namespace ArxSamples.MSSQL.Operations.Delete.RealCases;

/// <summary>
/// A soft delete keeps the row and marks it closed: it's an update of a status column, not a delete. Two
/// scenarios: close an account; restore it.
/// </summary>
public sealed class RealCase4_SoftDelete : ISample
{
    public string Name => "delete-real-4-soft-delete";

    public string Title => "Soft delete: close and restore an account";

    public async Task RunAsync(SampleContext dbContext)
    {
        // ACC-D601 is closed and stays closed; ACC-D602 is closed, then restored.
        foreach (var number in new[] { "ACC-D601", "ACC-D602" })
        {
            var account = new ArxEntity("account");
            account["name"] = "Soft deleted customer " + number;
            account["account_number"] = number;
            await dbContext.Service.CreateAsync(account);
        }

        await Scenario1_CloseTheAccountAsync(dbContext);

        await Scenario2_RestoreItAsync(dbContext);
    }

    private static ArxEntity Status(string number, string status)
    {
        var change = new ArxEntity("account");
        change["account_number"] = number;
        change["status"] = new ArxSelectionSetValue("AccountStatus", status);
        return change;
    }

    /// <summary>1. "Delete" in the app closes the account: an update of its status, by the account number.</summary>
    private static async Task Scenario1_CloseTheAccountAsync(SampleContext dbContext)
    {
        Step("1. Close the account instead of deleting it");

        await dbContext.Service.UpdateAsync(Status("ACC-D601", "CLOSED"), new ArxUpdateOptions { Match = ArxMatch.Key("account_number") });
        Show("ACC-D601 closed; its history stays");

        /* ===========================================================
         * [DIRECT QUERY CHECK]
         * -----------------------------------------------------------
         * SELECT account_number, status
         * FROM account
         * WHERE account_number = 'ACC-D601';
         * -- Expect: 1 row, CLOSED.
         * ===========================================================
         */
    }

    /// <summary>2. Undo is another update.</summary>
    private static async Task Scenario2_RestoreItAsync(SampleContext dbContext)
    {
        Step("2. Restore it");

        var byNumber = new ArxUpdateOptions { Match = ArxMatch.Key("account_number") };
        await dbContext.Service.UpdateAsync(Status("ACC-D602", "CLOSED"), byNumber);
        await dbContext.Service.UpdateAsync(Status("ACC-D602", "ACTIVE"), byNumber);
        Show("ACC-D602 closed, then active again");

        /* ===========================================================
         * [DIRECT QUERY CHECK]
         * -----------------------------------------------------------
         * SELECT account_number, status
         * FROM account
         * WHERE account_number = 'ACC-D602';
         * -- Expect: 1 row, ACTIVE.
         * ===========================================================
         */
    }
}

  > 1. Close the account instead of deleting it
      ACC-D601 closed; its history stays
  > 2. Restore it
      ACC-D602 closed, then active again