Delete one record by id

Runs the sample. Generated for this page; it reads the connection string from the environment and first remakes the sample database from sample-schema.json.

using ArxSamples.MongoDb;
using ArxSamples.MongoDb.Operations.Delete.Basics;

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

var dbContext = new SampleContext(connectionString);

// Every run starts from the sample data: this deletes and makes again what sample-schema.json lists
// (save the file in the project folder, see Get started).
await dbContext.Direct.ResetAsync();

await new Basic1_DeleteOneRecord().RunAsync(dbContext);

The sample, as it is in the repository.

using ARX.SDK.MongoDb.Services;
using ARX.SDK.Services;

using static ArxSamples.MongoDb.SampleOutput;

namespace ArxSamples.MongoDb.Operations.Delete.Basics;

/// <summary>
/// Delete by id, in two scenarios: one document, and one that is already gone (not an error).
/// </summary>
/// <remarks>
/// <c>DeleteAsync(collection, id)</c> returns whether a document went. Many ids in one call are DeleteMultiple's.
/// </remarks>
public sealed class Basic1_DeleteOneRecord : ISample
{
    public string Name => "delete-basics-1-delete-one-record";

    public string Title => "Delete one record by id";

    public async Task RunAsync(SampleContext dbContext)
    {
        var account = new ArxEntity("account");
        account["name"] = "To delete ACC-M901";
        account["account_number"] = "ACC-M901";
        var id = await dbContext.Service.CreateAsync(account);

        await Scenario1_OneDocumentAsync(dbContext.Service, id);

        await Scenario2_AlreadyGoneAsync(dbContext.Service, id);
    }

    /// <summary>1. Delete the account by the id Create returned.</summary>
    private static async Task Scenario1_OneDocumentAsync(ArxMongoDbService service, ArxRecordId id)
    {
        Step("1. One document");

        bool deleted = await service.DeleteAsync("account", id);

        Show($"deleted: {deleted}");

        /* ===========================================================
         * [DIRECT QUERY CHECK]
         * -----------------------------------------------------------
         * db.account.countDocuments({ account_number: "ACC-M901" })
         * -- Expect: 0.
         * ===========================================================
         */
    }

    /// <summary>2. The same id again: nothing to delete, false, no error.</summary>
    private static async Task Scenario2_AlreadyGoneAsync(ArxMongoDbService service, ArxRecordId id)
    {
        Step("2. Already gone");

        bool deleted = await service.DeleteAsync("account", id);

        Show($"deleted: {deleted}");

        /* ===========================================================
         * [DIRECT QUERY CHECK]
         * -----------------------------------------------------------
         * db.account.countDocuments({ account_number: "ACC-M901" })
         * -- Expect: 0.
         * ===========================================================
         */
    }
}

  > 1. One document
      deleted: True
  > 2. Already gone
      deleted: False