update docs

pwelter34 · pwelter34 · commit 9bbe970fd319 · 2026-06-18T09:23:22.000-05:00
diff --git a/README.md b/README.md
@@ -128,6 +128,7 @@ Entity Framework Core Generator supports the following databases.
 - PostgreSQL
 - MySQL
 - Sqlite
+- Oracle
 
 The provider can be set via command line or via the [configuration file](https://efg.loresoft.com/configuration/).
 
@@ -147,14 +148,25 @@ database:
 
 ## Database Schema
 
-The database schema is loaded from the metadata model factory implementation of `IDatabaseModelFactory`.  Entity Framework Core Generator uses the implemented interface from each of the supported providers similar to how `ef dbcontext scaffold` works.
+The database schema is loaded from [SchemaSaurus](https://github.com/loresoft/SchemaSaurus) for each supported provider.
 
 ## View Models
 
 Entity Framework Core Generator supports generating [Read](https://efg.loresoft.com/md/read/), [Create](https://efg.loresoft.com/md/create/) and [Update](https://efg.loresoft.com/md/update/) view models from an entity.  Many projects rely on view models to shape data.  The model templates can be used to quickly get the basic view models created.  The model templates also support regeneration so any database change can easily be sync'd to the view models.  
 
 ## Change Log
 
+### Version 8.0
+
+- add support for .NET 10 while continuing to target .NET 8
+- update generated Entity Framework dependencies for Entity Framework Core 10
+- load database schema metadata from [SchemaSaurus](https://github.com/loresoft/SchemaSaurus) instead of Entity Framework Core Design
+- remove direct Entity Framework Core dependencies from the tool; Entity Framework Core packages are only needed by generated projects
+- add Oracle database provider support
+- add entity `typeMapping` configuration for mapping native database types to generated .NET types
+- update major package dependencies including AutoMapper 16, FluentValidation 12, Spectre.Console.Cli 0.55 and YamlDotNet 18
+- generated projects may need matching current Entity Framework Core and provider package versions
+
 ### Version 7.0
 
 - support for .net 9
@@ -181,7 +193,7 @@ database:
 
 - upgrade to .net 8
 - add option to turn off temporal table mapping
-- add rowversion options, ByteArray|Long|ULong 
+- add rowversion options, ByteArray|Long|ULong
 - add script template merge
 
 ### Version 5.0
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -28,7 +28,7 @@ database:
   # the connection string to the database
   connectionString: 'Data Source=(local);Initial Catalog=Tracker;Integrated Security=True'
   # the database provider name.  Default: SqlServer
-  provider: SqlServer|PostgreSQL|MySQL|Sqlite
+  provider: SqlServer|PostgreSQL|MySQL|Sqlite|Oracle
 
   # config name to read the connection string from the user secrets file
   connectionName: 'ConnectionStrings:Generator'
@@ -46,7 +46,7 @@ database:
   schemas:
     - dbo
   
-  # exclude tables or columns: Changed in v7.x
+  # exclude tables or columns
   exclude:
     # list of expressions for tables to exclude, source is Schema.TableName
     tables:
@@ -95,6 +95,14 @@ data:
     mappingAttributes: true
     # Generate class names with prefixed schema name eg. dbo.MyTable = DboMyTable
     prefixWithSchemaName: false
+
+    # Map native database type names to generated .NET system type names
+    typeMapping:
+      - nativeType: geometry
+        systemType: NetTopologySuite.Geometries.Geometry
+      - nativeType: dbo.StringList
+        systemType: List<string?>
+
     # file header
     header: // Entity header
 
diff --git a/docs/connectionString.md b/docs/connectionString.md
@@ -51,4 +51,4 @@ The `userSecretsId` can be shared with your .NET Core Project.
 
 Read more about user secrets in the ASP.NET Core documentation
 
-[Secret Manager](https://docs.microsoft.com/en-us/aspnet/core/security/app-secrets?tabs=windows&view=aspnetcore-2.1#secret-manager)
+[Secret Manager](https://learn.microsoft.com/aspnet/core/security/app-secrets#secret-manager)
diff --git a/docs/ef/dataContext.md b/docs/ef/dataContext.md
@@ -107,4 +107,4 @@ Property rename is supported.  The rename will be discovered during the parsing
 
 ### Generated Configuration
 
-The `Generated Configuration` region configures the entity type mapping.  
+The `Generated Configuration` region configures the entity type mapping.
diff --git a/docs/ef/extensions.md b/docs/ef/extensions.md
@@ -90,4 +90,4 @@ The query extension template has one region that is replaced on regeneration.
 
 ### Generated Configuration
 
-The `Generated Configure` region configures the entity type mapping.  
+The `Generated Configure` region configures the entity type mapping.
diff --git a/docs/ef/mapping.md b/docs/ef/mapping.md
@@ -136,11 +136,11 @@ Include XML documentation for the generated class.  Default: `false`
 
 ### temporal
 
-If temporal table mapping is enabled. Default true
+If temporal table mapping is enabled. Default `true`
 
 ### rowVersion
 
-How row versions should be mapped. Default ByteArray. ByteArray|Long|ULong
+How row versions should be mapped. Default ByteArray. `ByteArray|Long|ULong`
 
 ## Regeneration
 
diff --git a/docs/index.md b/docs/index.md
@@ -8,7 +8,9 @@ The Entity Framework Core Generator tool is available on nuget.org via package n
 
 To install EntityFrameworkCore.Generator, run the following command in the console
 
-    dotnet tool install --global EntityFrameworkCore.Generator
+```Shell
+dotnet tool install --global EntityFrameworkCore.Generator
+```
 
 More information about NuGet package available at
 <https://nuget.org/packages/EntityFrameworkCore.Generator>
@@ -25,4 +27,6 @@ More information about NuGet package available at
 
 To generate source code files from your database, use the generate command with your connection string.
 
-    efg generate -c <ConnectionString>
+```Shell
+efg generate -c <ConnectionString>
+```
diff --git a/docs/md/mapper.md b/docs/md/mapper.md
@@ -61,4 +61,4 @@ Include XML documentation for the generated mapper class.  Default: `false`
 
 ## Regeneration
 
-The mapper template does not support regeneration.  The mapper class will only be created if one doesn't exist for an entity.
+The mapper template does not support regeneration.  The mapper class will only be created if one doesn't exist for an entity.
diff --git a/docs/md/shared.md b/docs/md/shared.md
@@ -1,4 +1,4 @@
-# Shared Model Template 
+# Shared Model Template
 
 The [Read](read.md), [Create](create.md) and [Update](update.md) model templates share the following [configuration](../configuration.md).
 
@@ -39,4 +39,3 @@ Exclude all entities that match any of the listed regular expressions.
 #### properties
 
 Exclude all properties that match any of the listed regular expressions.  The value to match contains the parent entity the property belongs too, `Entity.Property`.
-
diff --git a/docs/md/validation.md b/docs/md/validation.md
@@ -67,4 +67,4 @@ The validation template has one region that is replaced on regeneration.
 
 ### Generated Constructor
 
-The `Generated Constructor` region initializes any model rules that can be derived from the database context.
+The `Generated Constructor` region initializes any model rules that can be derived from the database context.
diff --git a/docs/providers.md b/docs/providers.md
@@ -6,10 +6,11 @@ Entity Framework Core Generator (efg) supports the following databases.
 * PostgreSQL
 * MySQL
 * Sqlite
+* Oracle
 
 ## Database Schema
 
-The database schema is loaded from the Entity Framework Core database metadata model factory implementation of `IDatabaseModelFactory`.  Entity Framework Core Generator used the the implemented interface from each of the supported providers similar to how `ef dbcontext scaffold` works.
+The database schema is loaded from [SchemaSaurus](https://github.com/loresoft/SchemaSaurus) for each supported provider.
 
 ## Usage
 
@@ -27,4 +28,18 @@ Set in configuration file
 database:
   connectionString: 'Data Source=(local);Initial Catalog=Tracker;Integrated Security=True'
   provider: SqlServer
-```
+```
+
+Supported provider values are `SqlServer`, `PostgreSQL`, `MySQL`, `Sqlite` and `Oracle`.
+
+### Oracle
+
+Use `Oracle` as the provider value to generate from an Oracle database schema.
+
+```YAML
+database:
+  connectionString: 'User Id=<User>;Password=<Password>;Data Source=<Host>:<Port>/<ServiceName>'
+  provider: Oracle
+```
+
+Oracle provider support includes sequences and foreign keys. Schema filtering, identity columns, temporal tables and change tracking are not supported by the current Oracle provider defaults.
diff --git a/docs/quickStart.md b/docs/quickStart.md
@@ -110,6 +110,7 @@ Entity Framework Core Generator supports the following databases.
 - PostgreSQL
 - MySQL
 - Sqlite
+- Oracle
 
 The provider can be set via command line or via the [configuration file](configuration.md).
 
@@ -129,8 +130,8 @@ database:
 
 ## Database Schema
 
-The database schema is loaded from the metadata model factory implementation of `IDatabaseModelFactory`.  Entity Framework Core Generator uses the implemented interface from each of the supported providers similar to how `ef dbcontext scaffold` works.
+The database schema is loaded from [SchemaSaurus](https://github.com/loresoft/SchemaSaurus) for each supported provider.
 
 ## View Models
 
-Entity Framework Core Generator supports generating [Read](md/read.md), [Create](md/create.md) and [Update](md/update.md) view models from an entity.  Many projects rely on view models to shape data.  The model templates can be used to quickly get the basic view models created.  The model templates also support regeneration so any database change can easily be sync'd to the view models.  
+Entity Framework Core Generator supports generating [Read](md/read.md), [Create](md/create.md) and [Update](md/update.md) view models from an entity.  Many projects rely on view models to shape data.  The model templates can be used to quickly get the basic view models created.  The model templates also support regeneration so any database change can easily be sync'd to the view models.
diff --git a/docs/regeneration.md b/docs/regeneration.md
@@ -1,10 +1,10 @@
 # Regeneration
 
-Entity Framework Core Generator supports safe regeneration via region replacement and source code parsing.  A typical workflow for a project requires many database changes and updates.  Being able to regenerate the entities and associated files is a huge time saver. 
+Entity Framework Core Generator supports safe regeneration via region replacement and source code parsing.  A typical workflow for a project requires many database changes and updates.  Being able to regenerate the entities and associated files is a huge time saver.
 
 ## Region Replacement
 
-All the templates output a region on first generation.  On future regeneration, only the regions are replaced.  This keeps any other changes you've made the the source file.
+All the templates output a region on first generation.  On future regeneration, only the regions are replaced.  This keeps any other changes you've made to the source file.
 
 Example of a generated entity class
 
@@ -46,8 +46,10 @@ public partial class Status
 }
 ```
 
-When the `generate` command is re-run, the `Generated Constructor`, `Generated Properties` and `Generated Relationships` regions will be replace with the current output of the template.  Any other changes outside those regions will be safe.
+When the `generate` command is re-run, the `Generated Constructor`, `Generated Properties` and `Generated Relationships` regions will be replaced with the current output of the template.  Any other changes outside those regions will be safe.
 
 ## Source Parsing
 
-In order to capture and preserve Entity, Property and DbContext renames, the `generate` command parses any existing mapping and DbContext class to capture how things are named.  This allows you to use the full extend of Visual Studio's refactoring tools to rename things as you like.  Then, when regenerating, those changes won't be lost.
+In order to capture and preserve Entity, Property and DbContext renames, the `generate` command parses any existing mapping and DbContext class to capture how things are named.  This allows you to use the full extent of Visual Studio's refactoring tools to rename things as you like.  Then, when regenerating, those changes won't be lost.
+
+Generated model files are also parsed during regeneration.  Attributes added to existing model properties, including multi-line attributes, are preserved and written back to the matching generated model properties.

Original file line number	Diff line number	Diff line change
@@ -51,4 +51,4 @@ The `userSecretsId` can be shared with your .NET Core Project.
`51`	`51`
`52`	`52`	`Read more about user secrets in the ASP.NET Core documentation`
`53`	`53`
`54`		`-[Secret Manager](https://docs.microsoft.com/en-us/aspnet/core/security/app-secrets?tabs=windows&view=aspnetcore-2.1#secret-manager)`
	`54`	`+[Secret Manager](https://learn.microsoft.com/aspnet/core/security/app-secrets#secret-manager)`
Original file line number	Diff line number	Diff line change
`@@ -107,4 +107,4 @@ Property rename is supported. The rename will be discovered during the parsing`
`107`	`107`
`108`	`108`	`### Generated Configuration`
`109`	`109`
`110`		-The `Generated Configuration` region configures the entity type mapping.
	`110`	+The `Generated Configuration` region configures the entity type mapping.
Original file line number	Diff line number	Diff line change
`@@ -90,4 +90,4 @@ The query extension template has one region that is replaced on regeneration.`
`90`	`90`
`91`	`91`	`### Generated Configuration`
`92`	`92`
`93`		-The `Generated Configure` region configures the entity type mapping.
	`93`	+The `Generated Configure` region configures the entity type mapping.
Original file line number	Diff line number	Diff line change
@@ -61,4 +61,4 @@ Include XML documentation for the generated mapper class. Default: `false`
`61`	`61`
`62`	`62`	`## Regeneration`
`63`	`63`
`64`		`-The mapper template does not support regeneration. The mapper class will only be created if one doesn't exist for an entity.`
	`64`	`+The mapper template does not support regeneration. The mapper class will only be created if one doesn't exist for an entity.`
Original file line number	Diff line number	Diff line change
`@@ -67,4 +67,4 @@ The validation template has one region that is replaced on regeneration.`
`67`	`67`
`68`	`68`	`### Generated Constructor`
`69`	`69`
`70`		-The `Generated Constructor` region initializes any model rules that can be derived from the database context.
	`70`	+The `Generated Constructor` region initializes any model rules that can be derived from the database context.