Document IPNetwork/cidr breaking change

npgsql · Oct 27, 2024 · 8cdfca8 · 8cdfca8
1 parent 586ea15
commit 8cdfca8
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/conceptual/EFCore.PG/release-notes/9.0.md b/conceptual/EFCore.PG/release-notes/9.0.md
@@ -85,6 +85,10 @@ If your application passes an NpgsqlDataSource to `UseNpgsql`, it also needs to
 
 See the [enum documentation](../mapping/enum.md) for more information.
 
+### PostgreSQL `cidr` is now mapped to .NET `IPNetwork` by default
+
+When scaffolding a table that contains a `cidr` column, a .NET [`IPNetwork`](https://learn.microsoft.com/dotnet/api/system.net.ipnetwork) will be scaffolded instead of the previous `NpgsqlCidr`.
+
 ## Contributors
 
 A big thank you to all the following people who contributed to the 9.0 release!

diff --git a/conceptual/Npgsql/types/basic.md b/conceptual/Npgsql/types/basic.md
@@ -37,7 +37,7 @@ date                        | DateTime                   | DateOnly (6.0+)
 time without time zone      | TimeSpan                   | TimeOnly (6.0+)
 time with time zone         | DateTimeOffset             |
 interval                    | TimeSpan<sup>3</sup>       | <xref:NpgsqlTypes.NpgsqlInterval>
-cidr                        | <xref:NpgsqlTypes.NpgsqlCidr><sup>4</sup> |
+cidr                        | <xref:NpgsqlTypes.NpgsqlCidr><sup>4</sup> | [`IPNetwork`](https://learn.microsoft.com/dotnet/api/system.net.ipnetwork)
 inet                        | IPAddress                  | <xref:NpgsqlTypes.NpgsqlInet>
 macaddr                     | PhysicalAddress            |
 tsquery                     | NpgsqlTsQuery              |
@@ -115,7 +115,7 @@ date                        | DateOnly (6.0+)                            | DateT
 time without time zone      | TimeOnly (6.0+)                            | TimeSpan                                | Time                  | Time
 time with time zone         |                                            | DateTimeOffset                          | TimeTz                |
 interval                    | TimeSpan                                   | <xref:NpgsqlTypes.NpgsqlInterval>       | Interval              |
-cidr                        |                                            | ValueTuple\<IPAddress, int\>, IPAddress | Cidr                  |
+cidr                        | <xref:NpgsqlTypes.NpgsqlCidr>, [`IPNetwork`](https://learn.microsoft.com/dotnet/api/system.net.ipnetwork) | ValueTuple\<IPAddress, int\>, IPAddress | Cidr                  |
 inet                        | IPAddress                                  | ValueTuple\<IPAddress, int\>            | Inet                  |
 macaddr                     | PhysicalAddress                            |                                         | MacAddr               |
 tsquery                     | NpgsqlTsQuery                              |                                         | TsQuery               |