PostgreSQL · Delete

Nothing to delete is not an error

Deleting something that is already gone is a normal outcome, not an error (a retry, or two users at once). Two scenarios: one record (false), and a list (0).

Set up for this page

Besides the sample itself, it uses SampleContext.cs (the dbContext every sample is given); SampleOutput.cs (Step and Show, which print), in the files below.

Before scenario 1 the sample runs this, so the service and the rows the scenarios use are there:

Set up
var service = new ArxPgDbService(connectionString, ArxSchemaCatalog.Create()
    .Table("account", ArxIdColumn.Generated<long>("id"))
    .Build());

1 One record

Delete twice: the second call returns false, so a retry is safe.

Already in scope: service (ArxPgDbService)

C#
var account = new ArxEntity("account");
account["name"] = "Deleted twice";
account["account_number"] = "ACC-D301";
var id = await service.CreateAsync(account);

var first = await service.DeleteAsync("account", id);
var second = await service.DeleteAsync("account", id);

Console.WriteLine($"first {first}, then {second}");

Check it in the database

SQL

Run it in any SQL tool connected to the database, after the code has run.

SELECT count(*)
FROM account
WHERE account_number = 'ACC-D301';

Expect: 0.

2 A list

A list of ids none of which exists: 0. An empty list is 0 too, without touching the database.

Already in scope: service (ArxPgDbService)

C#
var none = await service.DeleteMultipleAsync("account", new List<long> { 999_999_994, 999_999_993 });
var empty = await service.DeleteMultipleAsync("account", new List<long>());

Console.WriteLine($"{none} deleted, empty list {empty}");

Check it in the database

SQL

Run it in any SQL tool connected to the database, after the code has run.

SELECT count(*)
FROM account
WHERE id IN (999999994, 999999993);

Expect: 0.

Run the complete sample

The code above comes from one program, built in a fresh project and run against the database. To run it yourself, here is every file and step.

The program, its files and how to run it

Run it locally

  1. .NET SDK: .NET SDK 10.0.100 or later 10.0.x (target net10.0).
  2. Create the project:
    Terminal
    dotnet new console -n ArxSample -f net10.0
    cd ArxSample
  3. Install the packages:
    Terminal
    dotnet add package ARX.SDK.PostgreSql --version 1.0.0-rc.1
  4. Database: a PostgreSQL 16 (tested with 16.15) database with the sample schema.
  5. Configuration: set ARX_SAMPLES_POSTGRESQL to its connection string. Nothing is hard-coded.
  6. Source code: replace Program.cs and add the 3 other files below, with the file names shown.
  7. Run it:
    Terminal
    dotnet run
  8. Expected output: below.

The files

Program.cs

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

using ArxSamples.PostgreSql;
using ArxSamples.PostgreSql.Operations.Delete.Basics;

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

await new Basic2_NothingToDelete().RunAsync(new SampleContext(connectionString));
Basic2_NothingToDelete.cs

The sample, as it is in the repository.

using ARX.SDK.PostgreSql.Services;
using ARX.SDK.Services;

using static ArxSamples.PostgreSql.SampleOutput;

namespace ArxSamples.PostgreSql.Operations.Delete.Basics;

/// <summary>
/// Deleting something that is already gone is a normal outcome, not an error (a retry, or two users at once). Two
/// scenarios: one record (false), and a list (0).
/// </summary>
public sealed class Basic2_NothingToDelete : ISample
{
    public string Name => "delete-basics-2-nothing-to-delete";

    public string Title => "Nothing to delete is not an error";

    public async Task RunAsync(SampleContext dbContext)
    {
        var service = new ArxPgDbService(dbContext.ConnectionString, ArxSchemaCatalog.Create()
            .Table("account", ArxIdColumn.Generated<long>("id"))
            .Build());

        await Scenario1_OneRecordAsync(service);

        await Scenario2_AListAsync(service);
    }

    /// <summary>1. Delete twice: the second call returns false, so a retry is safe.</summary>
    private static async Task Scenario1_OneRecordAsync(ArxPgDbService service)
    {
        Step("1. One record");

        var account = new ArxEntity("account");
        account["name"] = "Deleted twice";
        account["account_number"] = "ACC-D301";
        var id = await service.CreateAsync(account);

        var first = await service.DeleteAsync("account", id);
        var second = await service.DeleteAsync("account", id);

        Show($"first {first}, then {second}");

        /* ===========================================================
         * [DIRECT QUERY CHECK]
         * -----------------------------------------------------------
         * SELECT count(*)
         * FROM account
         * WHERE account_number = 'ACC-D301';
         * -- Expect: 0.
         * ===========================================================
         */
    }

    /// <summary>2. A list of ids none of which exists: 0. An empty list is 0 too, without touching the database.</summary>
    private static async Task Scenario2_AListAsync(ArxPgDbService service)
    {
        Step("2. A list");

        var none = await service.DeleteMultipleAsync("account", new List<long> { 999_999_994, 999_999_993 });
        var empty = await service.DeleteMultipleAsync("account", new List<long>());

        Show($"{none} deleted, empty list {empty}");

        /* ===========================================================
         * [DIRECT QUERY CHECK]
         * -----------------------------------------------------------
         * SELECT count(*)
         * FROM account
         * WHERE id IN (999999994, 999999993);
         * -- Expect: 0.
         * ===========================================================
         */
    }
}
SampleContext.cs

What every sample is given: the connection string (and the ISample interface the samples implement).

namespace ArxSamples.PostgreSql;

/// <summary>One documentation sample: a scenario a real application has, shown end to end.</summary>
public interface ISample
{
    /// <summary>The name to run it alone: <c>dotnet run -- &lt;name&gt;</c>.</summary>
    string Name { get; }

    /// <summary>One line on what it shows.</summary>
    string Title { get; }

    Task RunAsync(SampleContext dbContext);
}

/// <summary>
/// What a sample is given. Every sample gets the connection string; the application's service and catalog
/// (SampleContext.Application.cs) and the plain Npgsql read-back helper (SampleContext.Direct.cs) live in their own
/// files, so a sample needs only the files it uses.
/// </summary>
public sealed partial class SampleContext
{
    public SampleContext(string connectionString)
    {
        ConnectionString = connectionString;
    }

    public string ConnectionString { get; }
}
SampleOutput.cs

How the samples print: Step for each scenario, Show for what it did, ShowError for an error caught on purpose.

using ARX.SDK;

namespace ArxSamples.PostgreSql;

/// <summary>How the samples print: a numbered step for each scenario, then what it did.</summary>
public static class SampleOutput
{
    /// <summary>The start of a scenario: <c>Step("1. By the id Create returned")</c>.</summary>
    public static void Step(string text) => Console.WriteLine($"  > {text}");

    /// <summary>What the scenario did.</summary>
    public static void Show(string text) => Console.WriteLine($"      {text}");

    /// <summary>An ARX error the scenario caught on purpose.</summary>
    public static void ShowError(ArxException exception)
        => Console.WriteLine($"      caught {exception.GetType().Name}: {exception.Message}");
}

Expected output

What dotnet run printed when the sample was verified, on a freshly created sample schema. Ids differ when the tables already hold rows.

Output
  > 1. One record
      first True, then False
  > 2. A list
      0 deleted, empty list 0