Audit.NET.PostgreSql 25.0.5

dotnet add package Audit.NET.PostgreSql --version 25.0.5
NuGet\Install-Package Audit.NET.PostgreSql -Version 25.0.5
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Audit.NET.PostgreSql" Version="25.0.5" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Audit.NET.PostgreSql --version 25.0.5
#r "nuget: Audit.NET.PostgreSql, 25.0.5"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Audit.NET.PostgreSql as a Cake Addin
#addin nuget:?package=Audit.NET.PostgreSql&version=25.0.5

// Install Audit.NET.PostgreSql as a Cake Tool
#tool nuget:?package=Audit.NET.PostgreSql&version=25.0.5

Audit.NET.PostgreSql

PostgreSQL Server provider for Audit.NET library (An extensible framework to audit executing operations in .NET).

Store the audit events in a PostgreSQL Table, in JSON format.

Install

NuGet Package To install the package run the following command on the Package Manager Console:

PM> Install-Package Audit.NET.PostgreSql

NuGet Status NuGet Count

Usage

Please see the Audit.NET Readme

Configuration

Set the static Audit.Core.Configuration.DataProvider property to set the PostgreSQL data provider, or call the UsePostgreSql method on the fluent configuration. This should be done before any AuditScope creation, i.e. during application startup.

For example:

Audit.Core.Configuration.DataProvider = new PostgreSqlDataProvider()
{
    ConnectionString = "Server=127.0.0.1;Port=5432;User Id=admin;Password=admin;Database=postgres;",
    TableName = "event",
    IdColumnName = "id",
    DataColumnName = "data",
    DataType = "JSONB",
    LastUpdatedDateColumnName = "updated_date",
    CustomColumns = new List<CustomColumn>()
    {
        new CustomColumn("event_type", ev => ev.EventType),
        new CustomColumn("user", ev => ev.Environment.UserName),
    }
};

Or by using the fluent configuration API:

Audit.Core.Configuration.Setup()
    .UsePostgreSql(config => config
        .ConnectionString("Server=127.0.0.1;Port=5432;User Id=admin;Password=admin;Database=postgres;")
        .TableName("event")
        .IdColumnName("id")
        .DataColumn("data", DataType.JSONB)
        .LastUpdatedColumnName("updated_date")
        .CustomColumn("event_type", ev => ev.EventType)
        .CustomColumn("user", ev => ev.Environment.UserName));

Provider Options

Mandatory:

  • ConnectionString: The PostgreSQL Server connection string.
  • TableName: The events table name.
  • DataColumnName: The column name of the event table where the JSON will be stored.
  • IdColumnName: The column name of the event identifier (the primary key).

Optional:

  • Schema: The PostgreSQL schema to use.
  • DataType: The type of the data column that stores the events. Can be JSON, JSONP or STRING. (Default is JSON).
  • LastUpdatedDateColumnName: The datetime column name to update when replacing events.
  • CustomColumn: Additional columns to store information from the audit event. (optional)

Table constraints

  • The table must exists.
  • The table must have a single ID column (Unique or Primary key).
  • The type of the ID column must be convertible to STRING.

For example:

CREATE TABLE public.event
(
    id bigserial NOT NULL,
    inserted_date timestamp without time zone NOT NULL DEFAULT now(),
    updated_date timestamp without time zone NOT NULL DEFAULT now(),
    data jsonb NOT NULL,
    event_type varchar(50),
    user varchar(50) NULL,
    CONSTRAINT event_pkey PRIMARY KEY (id)
)
WITH (
    OIDS = FALSE
)
TABLESPACE pg_default;

Query events

This provider implements GetEvent and GetEventAsync methods to obtain an audit event by id:

var event = dataProvider.GetEvent(1000);

The Postgre SQL data provider also includes basic support for querying the events collection.

Use the EnumerateEvents() method on PostgreSqlDataProvider class to run SQL-like queries against the audit events. The EnumerateEvents() method accepts any valid Postgre WHERE clause as a parameter.

For example:

IEnumerable<AuditEvent> events = postgreDataProvider.EnumerateEvents(
       "data #> '{Environment,UserName}' = '\"John\"'");

Will return the events whose property Environment.UserName is equal to 'John'.

This post contains information about the query syntax supported by JSONP data type. And here is the PostgreSQL documentation about JSON operators.

For complex querying capabilities, you should use the npgsql driver or the Npgsql EntityFramework provider directly.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (4)

Showing the top 4 NuGet packages that depend on Audit.NET.PostgreSql:

Package Downloads
Reo.Core.AutoHistory

Package Description

edyo_infrastructure

Package Description

Dalmarkit.AspNetCore

Dalmarkit is an opinionated .NET utility library that simplifies the building of AWS Cognito secured JSON REST APIs with audit trails using ASP.NET Core and Entity Framework Core with PostgreSQL.

Reo.Core.AutoHistory.31

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
25.0.5 310 6/18/2024
25.0.4 43,200 3/24/2024
25.0.3 1,098 3/13/2024
25.0.2 201 3/12/2024
25.0.1 10,502 2/28/2024
25.0.0 53,662 2/16/2024
24.0.1 702 2/12/2024
24.0.0 96 2/12/2024
23.0.0 57,387 12/14/2023
22.1.0 2,739 12/9/2023
22.0.2 4,128 12/1/2023
22.0.1 17,987 11/16/2023
22.0.0 373 11/14/2023
21.1.0 29,533 10/9/2023
21.0.4 13,276 9/15/2023
21.0.3 34,482 7/9/2023
21.0.2 173 7/6/2023
21.0.1 22,767 5/27/2023
21.0.0 64,763 4/15/2023
20.2.4 35,959 3/27/2023
20.2.3 125,242 3/17/2023
20.2.2 6,798 3/14/2023
20.2.1 309 3/11/2023
20.2.0 666 3/7/2023
20.1.6 54,120 2/23/2023
20.1.5 2,282 2/9/2023
20.1.4 42,140 1/28/2023
20.1.3 59,737 12/21/2022
20.1.2 3,509 12/14/2022
20.1.1 3,603 12/12/2022
20.1.0 1,876 12/4/2022
20.0.4 2,202 11/30/2022
20.0.3 5,122 10/28/2022
20.0.2 607 10/26/2022
20.0.1 2,744 10/21/2022
20.0.0 3,798 10/1/2022
19.4.1 6,303 9/10/2022
19.4.0 1,480 9/2/2022
19.3.0 2,823 8/23/2022
19.2.2 3,362 8/11/2022
19.2.1 587 8/6/2022
19.2.0 1,881 7/24/2022
19.1.4 11,860 5/23/2022
19.1.3 503 5/22/2022
19.1.2 1,437 5/18/2022
19.1.1 38,324 4/28/2022
19.1.0 53,169 4/10/2022
19.0.7 25,105 3/13/2022
19.0.6 1,196 3/7/2022
19.0.5 18,957 1/28/2022
19.0.4 1,044 1/23/2022
19.0.3 20,796 12/14/2021
19.0.2 1,644 12/11/2021
19.0.1 2,019 11/20/2021
19.0.0 2,389 11/11/2021
19.0.0-rc.net60.2 1,082 9/26/2021
19.0.0-rc.net60.1 219 9/16/2021
18.1.6 758,025 9/26/2021
18.1.5 41,756 9/7/2021
18.1.4 32,568 9/6/2021
18.1.3 5,165 8/19/2021
18.1.2 1,218 8/8/2021
18.1.1 452 8/5/2021
18.1.0 903 8/1/2021
18.0.1 478 7/30/2021
18.0.0 496 7/26/2021
17.0.8 14,882 7/7/2021
17.0.7 711 6/16/2021
17.0.6 588 6/5/2021
17.0.5 700 5/28/2021
17.0.4 3,106 5/4/2021
17.0.3 496 5/1/2021
17.0.2 8,197 4/22/2021
17.0.1 477 4/18/2021
17.0.0 949 3/26/2021
16.5.6 509 3/25/2021
16.5.5 6,486 3/23/2021
16.5.4 706 3/9/2021
16.5.3 490 2/26/2021
16.5.2 480 2/23/2021
16.5.1 3,420 2/21/2021
16.5.0 7,307 2/17/2021
16.4.5 480 2/15/2021
16.4.4 905 2/5/2021
16.4.3 479 1/27/2021
16.4.2 4,070 1/22/2021
16.4.1 532 1/21/2021
16.4.0 1,183 1/11/2021
16.3.3 541 1/8/2021
16.3.2 551 1/3/2021
16.3.1 556 12/31/2020
16.3.0 515 12/30/2020
16.2.1 4,354 12/27/2020
16.2.0 17,943 10/13/2020
16.1.5 657 10/4/2020
16.1.4 2,992 9/17/2020
16.1.3 1,681 9/13/2020
16.1.2 562 9/9/2020
16.1.1 1,121 9/3/2020
16.1.0 645 8/19/2020
16.0.3 682 8/15/2020
16.0.2 13,295 8/9/2020
16.0.1 605 8/8/2020
16.0.0 1,750 8/7/2020
15.3.0 288,802 7/23/2020
15.2.3 2,789 7/14/2020
15.2.2 50,551 5/19/2020
15.2.1 3,694 5/12/2020
15.2.0 622 5/9/2020
15.1.1 614 5/4/2020
15.1.0 1,868 4/13/2020
15.0.5 744 3/18/2020
15.0.4 662 2/28/2020
15.0.3 571 2/26/2020
15.0.2 4,731 1/20/2020
15.0.1 696 1/10/2020
15.0.0 694 12/17/2019
14.9.1 697 11/30/2019
14.9.0 640 11/29/2019
14.8.1 629 11/26/2019
14.8.0 834 11/20/2019
14.7.0 939 10/9/2019
14.6.6 655 10/8/2019
14.6.5 36,696 9/27/2019
14.6.4 610 9/21/2019
14.6.3 5,356 8/12/2019
14.6.2 763 8/3/2019
14.6.1 681 8/3/2019
14.6.0 695 7/26/2019
14.5.7 696 7/18/2019
14.5.6 1,029 7/10/2019
14.5.5 672 7/1/2019
14.5.4 673 6/17/2019
14.5.3 734 6/5/2019
14.5.2 713 5/30/2019
14.5.1 7,435 5/28/2019
14.5.0 2,465 5/24/2019
14.4.0 747 5/22/2019
14.3.4 2,184 5/14/2019
14.3.3 695 5/9/2019
14.3.2 852 4/30/2019
14.3.1 719 4/27/2019
14.3.0 5,310 4/24/2019
14.2.3 842 4/17/2019
14.2.2 713 4/10/2019
14.2.1 15,953 4/5/2019
14.2.0 739 3/16/2019
14.1.1 728 3/8/2019
14.1.0 2,051 2/11/2019
14.0.4 2,739 1/31/2019
14.0.3 5,852 1/22/2019
14.0.2 1,387 12/15/2018
14.0.1 876 11/29/2018
14.0.0 885 11/19/2018
13.3.0 924 11/16/2018
13.2.2 881 11/15/2018
13.2.1 2,844 11/13/2018
13.2.0 979 10/31/2018
13.1.5 896 10/31/2018
13.1.4 931 10/25/2018
13.1.3 918 10/18/2018
13.1.2 1,072 9/12/2018
13.1.1 956 9/11/2018
13.1.0 948 9/11/2018
13.0.0 1,009 8/29/2018
12.3.6 993 8/29/2018
12.3.5 1,011 8/22/2018
12.3.4 1,404 8/21/2018
12.3.3 25,761 8/21/2018
12.3.2 1,005 8/20/2018
12.3.1 1,019 8/20/2018
12.3.0 1,011 8/20/2018
12.2.2 1,053 8/15/2018
12.2.1 1,039 8/9/2018
12.2.0 972 8/8/2018
12.1.11 982 7/30/2018
12.1.10 1,067 7/20/2018
12.1.9 1,110 7/10/2018
12.1.8 1,001 7/2/2018
12.1.7 1,158 6/7/2018
12.1.6 1,131 6/4/2018
12.1.5 1,110 6/2/2018
12.1.4 1,179 5/25/2018
12.1.3 1,220 5/16/2018
12.1.2 1,058 5/15/2018
12.1.1 1,196 5/14/2018
12.1.0 1,311 5/9/2018
12.0.7 1,231 5/5/2018
12.0.6 1,231 5/4/2018
12.0.5 1,172 5/3/2018
12.0.4 1,166 4/30/2018
12.0.3 1,208 4/30/2018
12.0.2 1,108 4/27/2018
12.0.1 1,193 4/25/2018
12.0.0 1,114 4/22/2018
11.2.0 1,085 4/11/2018
11.1.0 1,168 4/8/2018
11.0.8 1,153 3/26/2018
11.0.7 1,141 3/20/2018
11.0.6 1,130 3/7/2018
11.0.5 1,082 2/22/2018
11.0.4 1,192 2/14/2018
11.0.3 1,119 2/12/2018
11.0.2 1,120 2/9/2018
11.0.1 1,076 1/29/2018
11.0.0 1,121 1/15/2018
10.0.3 1,072 12/29/2017
10.0.2 1,104 12/26/2017
10.0.1 1,129 12/18/2017
10.0.0 1,036 12/18/2017
9.3.0 1,152 12/17/2017
9.2.0 1,111 12/17/2017
9.1.3 1,138 12/5/2017
9.1.2 1,092 11/27/2017
9.1.1 1,110 11/21/2017
9.1.0 1,059 11/21/2017
9.0.1 1,068 11/11/2017
9.0.0 1,115 11/10/2017
8.7.0 1,123 11/9/2017
8.6.0 1,114 11/9/2017
8.5.0 1,131 10/3/2017
8.4.0 1,198 10/3/2017