Audit.NET.PostgreSql
27.3.2
dotnet add package Audit.NET.PostgreSql --version 27.3.2
NuGet\Install-Package Audit.NET.PostgreSql -Version 27.3.2
<PackageReference Include="Audit.NET.PostgreSql" Version="27.3.2" />
paket add Audit.NET.PostgreSql --version 27.3.2
#r "nuget: Audit.NET.PostgreSql, 27.3.2"
// Install Audit.NET.PostgreSql as a Cake Addin #addin nuget:?package=Audit.NET.PostgreSql&version=27.3.2 // Install Audit.NET.PostgreSql as a Cake Tool #tool nuget:?package=Audit.NET.PostgreSql&version=27.3.2
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
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 | Versions 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. |
NuGet packages (7)
Showing the top 5 NuGet packages that depend on Audit.NET.PostgreSql:
Package | Downloads |
---|---|
Reo.Core.AutoHistory
Package Description |
|
Reo.Core.Database
Package Description |
|
Reo.Core.Testing
Package Description |
|
Reo.Core.IntegrationTesting
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. |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
27.3.2 | 732 | 12/11/2024 |
27.3.1 | 164 | 12/10/2024 |
27.3.0 | 261 | 12/8/2024 |
27.2.0 | 6,334 | 11/23/2024 |
27.1.1 | 10,832 | 10/28/2024 |
27.1.0 | 921 | 10/24/2024 |
27.0.3 | 11,220 | 9/25/2024 |
27.0.2 | 4,730 | 9/19/2024 |
27.0.1 | 1,709 | 9/4/2024 |
27.0.0 | 558 | 9/3/2024 |
26.0.1 | 8,346 | 8/22/2024 |
26.0.0 | 18,805 | 7/19/2024 |
25.0.7 | 27,069 | 7/4/2024 |
25.0.6 | 2,412 | 6/24/2024 |
25.0.5 | 464 | 6/18/2024 |
25.0.4 | 110,839 | 3/24/2024 |
25.0.3 | 1,206 | 3/13/2024 |
25.0.2 | 272 | 3/12/2024 |
25.0.1 | 11,789 | 2/28/2024 |
25.0.0 | 94,878 | 2/16/2024 |
24.0.1 | 1,262 | 2/12/2024 |
24.0.0 | 134 | 2/12/2024 |
23.0.0 | 100,622 | 12/14/2023 |
22.1.0 | 7,977 | 12/9/2023 |
22.0.2 | 4,172 | 12/1/2023 |
22.0.1 | 30,543 | 11/16/2023 |
22.0.0 | 439 | 11/14/2023 |
21.1.0 | 36,645 | 10/9/2023 |
21.0.4 | 16,027 | 9/15/2023 |
21.0.3 | 37,514 | 7/9/2023 |
21.0.2 | 213 | 7/6/2023 |
21.0.1 | 29,253 | 5/27/2023 |
21.0.0 | 67,523 | 4/15/2023 |
20.2.4 | 37,810 | 3/27/2023 |
20.2.3 | 125,270 | 3/17/2023 |
20.2.2 | 7,141 | 3/14/2023 |
20.2.1 | 342 | 3/11/2023 |
20.2.0 | 698 | 3/7/2023 |
20.1.6 | 59,779 | 2/23/2023 |
20.1.5 | 2,349 | 2/9/2023 |
20.1.4 | 43,338 | 1/28/2023 |
20.1.3 | 61,205 | 12/21/2022 |
20.1.2 | 3,870 | 12/14/2022 |
20.1.1 | 5,583 | 12/12/2022 |
20.1.0 | 1,921 | 12/4/2022 |
20.0.4 | 2,304 | 11/30/2022 |
20.0.3 | 5,248 | 10/28/2022 |
20.0.2 | 642 | 10/26/2022 |
20.0.1 | 3,010 | 10/21/2022 |
20.0.0 | 4,259 | 10/1/2022 |
19.4.1 | 7,796 | 9/10/2022 |
19.4.0 | 1,525 | 9/2/2022 |
19.3.0 | 2,930 | 8/23/2022 |
19.2.2 | 4,070 | 8/11/2022 |
19.2.1 | 623 | 8/6/2022 |
19.2.0 | 1,922 | 7/24/2022 |
19.1.4 | 12,345 | 5/23/2022 |
19.1.3 | 534 | 5/22/2022 |
19.1.2 | 1,468 | 5/18/2022 |
19.1.1 | 38,385 | 4/28/2022 |
19.1.0 | 54,640 | 4/10/2022 |
19.0.7 | 26,172 | 3/13/2022 |
19.0.6 | 1,276 | 3/7/2022 |
19.0.5 | 22,388 | 1/28/2022 |
19.0.4 | 1,080 | 1/23/2022 |
19.0.3 | 21,094 | 12/14/2021 |
19.0.2 | 1,675 | 12/11/2021 |
19.0.1 | 2,067 | 11/20/2021 |
19.0.0 | 2,425 | 11/11/2021 |
19.0.0-rc.net60.2 | 1,103 | 9/26/2021 |
19.0.0-rc.net60.1 | 240 | 9/16/2021 |
18.1.6 | 777,662 | 9/26/2021 |
18.1.5 | 42,044 | 9/7/2021 |
18.1.4 | 32,835 | 9/6/2021 |
18.1.3 | 5,262 | 8/19/2021 |
18.1.2 | 1,250 | 8/8/2021 |
18.1.1 | 491 | 8/5/2021 |
18.1.0 | 935 | 8/1/2021 |
18.0.1 | 522 | 7/30/2021 |
18.0.0 | 537 | 7/26/2021 |
17.0.8 | 15,963 | 7/7/2021 |
17.0.7 | 749 | 6/16/2021 |
17.0.6 | 629 | 6/5/2021 |
17.0.5 | 751 | 5/28/2021 |
17.0.4 | 3,146 | 5/4/2021 |
17.0.3 | 534 | 5/1/2021 |
17.0.2 | 8,828 | 4/22/2021 |
17.0.1 | 509 | 4/18/2021 |
17.0.0 | 993 | 3/26/2021 |
16.5.6 | 542 | 3/25/2021 |
16.5.5 | 6,520 | 3/23/2021 |
16.5.4 | 743 | 3/9/2021 |
16.5.3 | 531 | 2/26/2021 |
16.5.2 | 512 | 2/23/2021 |
16.5.1 | 3,456 | 2/21/2021 |
16.5.0 | 7,352 | 2/17/2021 |
16.4.5 | 519 | 2/15/2021 |
16.4.4 | 938 | 2/5/2021 |
16.4.3 | 523 | 1/27/2021 |
16.4.2 | 4,307 | 1/22/2021 |
16.4.1 | 569 | 1/21/2021 |
16.4.0 | 1,224 | 1/11/2021 |
16.3.3 | 578 | 1/8/2021 |
16.3.2 | 581 | 1/3/2021 |
16.3.1 | 592 | 12/31/2020 |
16.3.0 | 550 | 12/30/2020 |
16.2.1 | 4,679 | 12/27/2020 |
16.2.0 | 18,140 | 10/13/2020 |
16.1.5 | 694 | 10/4/2020 |
16.1.4 | 4,612 | 9/17/2020 |
16.1.3 | 1,725 | 9/13/2020 |
16.1.2 | 602 | 9/9/2020 |
16.1.1 | 1,172 | 9/3/2020 |
16.1.0 | 685 | 8/19/2020 |
16.0.3 | 722 | 8/15/2020 |
16.0.2 | 13,372 | 8/9/2020 |
16.0.1 | 639 | 8/8/2020 |
16.0.0 | 1,791 | 8/7/2020 |
15.3.0 | 291,377 | 7/23/2020 |
15.2.3 | 2,834 | 7/14/2020 |
15.2.2 | 51,070 | 5/19/2020 |
15.2.1 | 3,726 | 5/12/2020 |
15.2.0 | 668 | 5/9/2020 |
15.1.1 | 653 | 5/4/2020 |
15.1.0 | 2,760 | 4/13/2020 |
15.0.5 | 783 | 3/18/2020 |
15.0.4 | 701 | 2/28/2020 |
15.0.3 | 609 | 2/26/2020 |
15.0.2 | 4,870 | 1/20/2020 |
15.0.1 | 739 | 1/10/2020 |
15.0.0 | 731 | 12/17/2019 |
14.9.1 | 731 | 11/30/2019 |
14.9.0 | 682 | 11/29/2019 |
14.8.1 | 672 | 11/26/2019 |
14.8.0 | 865 | 11/20/2019 |
14.7.0 | 976 | 10/9/2019 |
14.6.6 | 689 | 10/8/2019 |
14.6.5 | 38,982 | 9/27/2019 |
14.6.4 | 641 | 9/21/2019 |
14.6.3 | 5,412 | 8/12/2019 |
14.6.2 | 796 | 8/3/2019 |
14.6.1 | 714 | 8/3/2019 |
14.6.0 | 735 | 7/26/2019 |
14.5.7 | 746 | 7/18/2019 |
14.5.6 | 1,072 | 7/10/2019 |
14.5.5 | 711 | 7/1/2019 |
14.5.4 | 708 | 6/17/2019 |
14.5.3 | 769 | 6/5/2019 |
14.5.2 | 745 | 5/30/2019 |
14.5.1 | 7,476 | 5/28/2019 |
14.5.0 | 3,023 | 5/24/2019 |
14.4.0 | 780 | 5/22/2019 |
14.3.4 | 2,221 | 5/14/2019 |
14.3.3 | 730 | 5/9/2019 |
14.3.2 | 892 | 4/30/2019 |
14.3.1 | 762 | 4/27/2019 |
14.3.0 | 5,605 | 4/24/2019 |
14.2.3 | 877 | 4/17/2019 |
14.2.2 | 748 | 4/10/2019 |
14.2.1 | 16,005 | 4/5/2019 |
14.2.0 | 777 | 3/16/2019 |
14.1.1 | 762 | 3/8/2019 |
14.1.0 | 2,091 | 2/11/2019 |
14.0.4 | 2,782 | 1/31/2019 |
14.0.3 | 5,888 | 1/22/2019 |
14.0.2 | 1,424 | 12/15/2018 |
14.0.1 | 917 | 11/29/2018 |
14.0.0 | 932 | 11/19/2018 |
13.3.0 | 966 | 11/16/2018 |
13.2.2 | 929 | 11/15/2018 |
13.2.1 | 2,885 | 11/13/2018 |
13.2.0 | 1,019 | 10/31/2018 |
13.1.5 | 942 | 10/31/2018 |
13.1.4 | 973 | 10/25/2018 |
13.1.3 | 962 | 10/18/2018 |
13.1.2 | 1,121 | 9/12/2018 |
13.1.1 | 1,009 | 9/11/2018 |
13.1.0 | 1,000 | 9/11/2018 |
13.0.0 | 1,067 | 8/29/2018 |
12.3.6 | 1,040 | 8/29/2018 |
12.3.5 | 1,058 | 8/22/2018 |
12.3.4 | 1,447 | 8/21/2018 |
12.3.3 | 25,811 | 8/21/2018 |
12.3.2 | 1,056 | 8/20/2018 |
12.3.1 | 1,067 | 8/20/2018 |
12.3.0 | 1,061 | 8/20/2018 |
12.2.2 | 1,099 | 8/15/2018 |
12.2.1 | 1,081 | 8/9/2018 |
12.2.0 | 1,014 | 8/8/2018 |
12.1.11 | 1,031 | 7/30/2018 |
12.1.10 | 1,112 | 7/20/2018 |
12.1.9 | 1,151 | 7/10/2018 |
12.1.8 | 1,050 | 7/2/2018 |
12.1.7 | 1,213 | 6/7/2018 |
12.1.6 | 1,178 | 6/4/2018 |
12.1.5 | 1,155 | 6/2/2018 |
12.1.4 | 1,224 | 5/25/2018 |
12.1.3 | 1,263 | 5/16/2018 |
12.1.2 | 1,106 | 5/15/2018 |
12.1.1 | 1,238 | 5/14/2018 |
12.1.0 | 1,360 | 5/9/2018 |
12.0.7 | 1,277 | 5/5/2018 |
12.0.6 | 1,274 | 5/4/2018 |
12.0.5 | 1,223 | 5/3/2018 |
12.0.4 | 1,209 | 4/30/2018 |
12.0.3 | 1,258 | 4/30/2018 |
12.0.2 | 1,162 | 4/27/2018 |
12.0.1 | 1,240 | 4/25/2018 |
12.0.0 | 1,155 | 4/22/2018 |
11.2.0 | 1,137 | 4/11/2018 |
11.1.0 | 1,222 | 4/8/2018 |
11.0.8 | 1,198 | 3/26/2018 |
11.0.7 | 1,192 | 3/20/2018 |
11.0.6 | 1,188 | 3/7/2018 |
11.0.5 | 1,131 | 2/22/2018 |
11.0.4 | 1,242 | 2/14/2018 |
11.0.3 | 1,169 | 2/12/2018 |
11.0.2 | 1,163 | 2/9/2018 |
11.0.1 | 1,122 | 1/29/2018 |
11.0.0 | 1,164 | 1/15/2018 |
10.0.3 | 1,114 | 12/29/2017 |
10.0.2 | 1,162 | 12/26/2017 |
10.0.1 | 1,178 | 12/18/2017 |
10.0.0 | 1,082 | 12/18/2017 |
9.3.0 | 1,196 | 12/17/2017 |
9.2.0 | 1,153 | 12/17/2017 |
9.1.3 | 1,178 | 12/5/2017 |
9.1.2 | 1,139 | 11/27/2017 |
9.1.1 | 1,150 | 11/21/2017 |
9.1.0 | 1,109 | 11/21/2017 |
9.0.1 | 1,108 | 11/11/2017 |
9.0.0 | 1,154 | 11/10/2017 |
8.7.0 | 1,168 | 11/9/2017 |
8.6.0 | 1,162 | 11/9/2017 |
8.5.0 | 1,177 | 10/3/2017 |
8.4.0 | 1,271 | 10/3/2017 |