An edit form changes some account details

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

using ArxSamples.MySQL;
using ArxSamples.MySQL.Operations.Update.RealCases;

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

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

The sample, as it is in the repository.

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

namespace ArxSamples.MySQL.Operations.Update.RealCases;

/// <summary>
/// An "edit account" form, in three scenarios: the fields the user changed are written and the rest kept; a field the
/// user emptied is cleared; the form sends the id it was opened with.
/// </summary>
public sealed class RealCase1_ChangeAccountDetails : ISample
{
    public string Name => "update-real-1-change-account-details";

    public string Title => "An edit form changes some account details";

    public async Task RunAsync(SampleContext dbContext)
    {
        // One account per scenario, so each scenario's check holds after the whole sample has run.
        await Scenario1_OnlyTheChangedFieldsAsync(dbContext, await CreateAccountAsync(dbContext, "ACC-U601"));

        await Scenario2_AnEmptiedFieldIsClearedAsync(dbContext, await CreateAccountAsync(dbContext, "ACC-U602"));

        await Scenario3_TheFormSendsTheIdAsync(dbContext, await CreateAccountAsync(dbContext, "ACC-U603"));
    }

    private static async Task<ArxRecordId> CreateAccountAsync(SampleContext dbContext, string number)
    {
        var account = new ArxEntity("account");
        account["name"] = "Alpine Ski House";
        account["account_number"] = number;
        account["website"] = "https://alpineskihouse.example";
        account["employee_count"] = 60;
        account["annual_revenue"] = 4_200_000.00m;
        return await dbContext.Service.CreateAsync(account);
    }

    /// <summary>1. The form posts only what the user changed. Each posted field becomes an attribute; nothing else is touched.</summary>
    private static async Task Scenario1_OnlyTheChangedFieldsAsync(SampleContext dbContext, ArxRecordId id)
    {
        Step("1. Write only the fields the user changed");

        var posted = new Dictionary<string, object> 
        { 
            ["employee_count"] = 75, 
            ["annual_revenue"] = 4_800_000.00m 
        };

        var change = new ArxEntity("account");
        change.RecordId = id;

        foreach (var (field, value) in posted)
        {
            change[field] = value;
        }

        var changed = await dbContext.Service.UpdateAsync(change);
        Show($"{changed} row changed: {string.Join(", ", posted.Keys)}");

        /* ===========================================================
         * [DIRECT QUERY CHECK]
         * -----------------------------------------------------------
         * SELECT name, website, employee_count, annual_revenue
         * FROM account
         * WHERE account_number = 'ACC-U601';
         * -- Expect: 1 row, Alpine Ski House, https://alpineskihouse.example, employee_count 75, annual_revenue 4800000.00.
         * ===========================================================
         */
    }

    /// <summary>2. The user emptied the website box: the form sends null, and the column is cleared.</summary>
    private static async Task Scenario2_AnEmptiedFieldIsClearedAsync(SampleContext dbContext, ArxRecordId id)
    {
        Step("2. An emptied field is cleared");

        var change = new ArxEntity("account");
        change.RecordId = id;
        change["website"] = null;
        await dbContext.Service.UpdateAsync(change);

        Show("website cleared");

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

    /// <summary>3. The form was opened with the account's id in a hidden field: it comes back as the id attribute.</summary>
    private static async Task Scenario3_TheFormSendsTheIdAsync(SampleContext dbContext, ArxRecordId id)
    {
        Step("3. The id comes back with the form");

        var hiddenField = id.AsInt64().ToString();

        var change = new ArxEntity("account");
        change["id"] = long.Parse(hiddenField);
        change["name"] = "Alpine Ski House Ltd.";
        await dbContext.Service.UpdateAsync(change);

        Show($"account {hiddenField} renamed");

        /* ===========================================================
         * [DIRECT QUERY CHECK]
         * -----------------------------------------------------------
         * SELECT name
         * FROM account
         * WHERE account_number = 'ACC-U603';
         * -- Expect: 1 row, Alpine Ski House Ltd.
         * ===========================================================
         */
    }
}

  > 1. Write only the fields the user changed
      1 row changed: employee_count, annual_revenue
  > 2. An emptied field is cleared
      website cleared
  > 3. The id comes back with the form
      account 3 renamed