https://github.com/borisdj/efcore.fluentapitoannotation
Console application for conversion FluentApi configuration to Annotations(Attributes extended with EfCore.Shaman library)
https://github.com/borisdj/efcore.fluentapitoannotation
Last synced: about 2 months ago
JSON representation
Console application for conversion FluentApi configuration to Annotations(Attributes extended with EfCore.Shaman library)
- Host: GitHub
- URL: https://github.com/borisdj/efcore.fluentapitoannotation
- Owner: borisdj
- License: mit
- Created: 2017-05-24T14:05:41.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T10:33:16.000Z (11 months ago)
- Last Synced: 2025-04-04T18:03:35.578Z (6 months ago)
- Language: C#
- Homepage:
- Size: 83 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EFCore.FluentApiToAnnotation
Console app in NetCore for converting FluentApi configuration to Annotations (Attributes extended with [EfCore.Shaman](https://github.com/isukces/EfCore.Shaman) lib)
Latest version 1.0.3
When using EntityFrameworkCore Code First approach specific config can be defined with [FluentApi](https://msdn.microsoft.com/en-us/library/jj591620(v=vs.113).aspx) or with [Annotations](https://msdn.microsoft.com/en-us/library/jj591583(v=vs.113).aspx).
I prefere Annotations because it requires less code, it's all in one place and configs are directly on Property they refer, similar like in database itself. Also nice thing here is that there is a lot of convention so we often get desired model without having to configure everything explicitly, like when PK is named *Id* or *TableId* we don't need `[Key]` attribute.
Only problem with Annotations was that EFCore does not have Attributes for everything, but with the help of EfCore.Shaman library that problem is solved.
This works well when creating new App, but sometimes we are migrating existing App to new Framework.
In that situation EFCore have built-in reverse engineering functionality:
`Scaffold-DbContext "Server=localhost;Database=DbName;Trusted_Connection=True;" Microsoft.EntityFrameworkCore.SqlServer -OutputDir Entities`
Now this creates pure POCO classes and Context file that has all configuration in FluentApi.
If we still want to have it in Annotations we would need to retype it and add appropriate Attributes to Entity classes.
Since database could be pretty large regarding number of tables this would be a of lot boring work.
So this application actuality automates that conversion.
It reads all files of Entity classes creating its models, parses FluentApi configs from Context, than adds apropriate Attributes to model, and writes again new files. Class models and writing them is implemented with [CsCodeGenerator](https://github.com/borisdj/CsCodeGenerator) library.
Additionally ICollections are omitted and DbSets changed to plural: `DbSet Company` -> `DbSet Companies`.
Here in repository there is exe.zip file which contains built app and 2 folders: `EntitiesInput` where we should put input files and the app will generate new files in `EntitiesOutput` folder.
REMARK:
Currently there is no Attribute for custom [*DeleteBehaviour(Rule)*](https://github.com/isukces/EfCore.Shaman/issues/7) options.
When having FK with DeleteBehaviour that is not default, it has to be configured in FluentApi explicitly. This will be updated when that feature gets implemented.
[](https://github.com/borisdj/EFCore.FluentApiToAnnotation/blob/master/LICENSE)
Also take a look into others packages:
-Open source (MIT or cFOSS) authored [.Net libraries](https://infopedia.io/dot-net-libraries/) (@**Infopedia.io** personal blog post)
| № | .Net library | Description |
| - | ------------------------ | -------------------------------------------------------- |
| 1 | [EFCore.BulkExtensions](https://github.com/borisdj/EFCore.BulkExtensions) | EF Core Bulk CRUD Ops (**Flagship** Lib) |
| 2 | [EFCore.UtilExtensions](https://github.com/borisdj/EFCore.UtilExtensions) | EF Core Custom Annotations and AuditInfo |
| 3* | [EFCore.FluentApiToAnnotation](https://github.com/borisdj/EFCore.FluentApiToAnnotation) | Converting FluentApi configuration to Annotations |
| 4 | [FixedWidthParserWriter](https://github.com/borisdj/FixedWidthParserWriter) | Reading & Writing fixed-width/flat data files |
| 5 | [CsCodeGenerator](https://github.com/borisdj/CsCodeGenerator) | C# code generation based on Classes and elements |
| 6 | [CsCodeExample](https://github.com/borisdj/CsCodeExample) | Examples of C# code in form of a simple tutorial |
## Support
If you find this project useful you can mark it by leaving a Github **Star** :star:
And even with community license, if you want help development, you can make a DONATION:
[
](https://www.buymeacoffee.com/boris.dj) _ or _
[:zap:](https://borisdj.net/donation/donate-btc.html)
## Contributing
Please read [CONTRIBUTING](CONTRIBUTING.md) for details on code of conduct, and the process for submitting pull requests.
When opening issues do write detailed explanation of the problem or feature with reproducible example.
Want to **Contact** for Development & Consulting: [www.codis.tech](http://www.codis.tech) (*Quality Delivery*)
## Usage
EXAMPLE
DB tables: **dbo.Company**, **dbo.Group**, **fin.Item**
| Column Name | Data Type | AllowNulls | Configuration |
| ------------ | ------------------ | ---------- | ------------------------ |
| CompanyId | int | False | PK (Identity: False) |
| Name | nvarchar(MAX) | False | |
|--------------|--------------------|------------| ------------------------ |
| GroupId | uniqueidentifier | False | PK (Identity: False) |
| Name | nvarchar(MAX) | False | |
|--------------|--------------------|------------| ------------------------ |
| ItemId | uniqueidentifier | False | PK (Identity: False) |
| CompanyId | uniqueidentifier | False | FKTable: Company(Cascade)|
| Description | nvarchar(255) | False | UniqueIndex |
| GroupId | int | False | FKTable: Group(Restrict) |
| Price | decimal(18, 2) | False | |
| PriceExtended| decimal(20, 4) | True | |
| TimeCreated | datetime2(7) | False | |
| TimeExpire | datetime | True | |
Scaffolded:
```csharp
public partial class AppContext : DbContext
{
public virtual DbSet Company { get; set; }
public virtual DbSet Group { get; set; }
public virtual DbSet Item { get; set; }
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
modelBuilder.Entity(entity =>
{
entity.Property(e => e.CompanyId).ValueGeneratedNever();
entity.Property(e => e.Name).IsRequired();
});
modelBuilder.Entity(entity =>
{
entity.Property(e => e.GroupId).ValueGeneratedNever();
entity.Property(e => e.Name).IsRequired();
});
modelBuilder.Entity(entity =>
{
entity.ToTable("Item", "fin");
entity.HasIndex(e => e.CompanyId).HasName("IX_Item_CompanyId");
entity.HasIndex(e => e.Description).HasName("IX_Item_Description").IsUnique();
entity.HasIndex(e => e.GroupId).HasName("IX_Item_GroupId");
entity.Property(e => e.ItemId).ValueGeneratedNever();
entity.Property(e => e.Description).IsRequired().HasMaxLength(255);
entity.Property(e => e.Price).HasColumnType("decimal");
entity.Property(e => e.PriceExtended).HasColumnType("decimal(20,4)");
entity.Property(e => e.TimeExpire).HasColumnType("datetime");
entity.HasOne(d => d.Company).WithMany(p => p.Item).HasForeignKey(d => d.CompanyId);
entity.HasOne(d => d.Group).WithMany(p => p.Item).HasForeignKey(d => d.GroupId)
.OnDelete(DeleteBehavior.Restrict);
});
}
...
}
public partial class Company
{
public Company()
{
Item = new HashSet();
}
public Guid CompanyId { get; set; }
public string Name { get; set; }
public virtual ICollection Item { get; set; }
}
public partial class Group
{
public Group()
{
Item = new HashSet();
}
public int GroupId { get; set; }
public string Name { get; set; }
public virtual ICollection Item { get; set; }
}
public partial class Item
{
public Guid ItemId { get; set; }
public Guid CompanyId { get; set; }
public string Description { get; set; }
public int GroupId { get; set; }
public decimal Price { get; set; }
public decimal? PriceExtended { get; set; }
public DateTime TimeCreated { get; set; }
public DateTime? TimeExpire { get; set; }
public virtual Company Company { get; set; }
public virtual Group Group { get; set; }
}
```
Converted:
```csharp
public partial class AppContext : DbContext
{
public DbSet Companies { get; set; }
public DbSet Groups { get; set; }
public DbSet Items { get; set; }
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
base.OnModelCreating(modelBuilder);
this.FixOnModelCreating(modelBuilder);
modelBuilder.Entity().HasOne(p => p.Group).WithMany().OnDelete(DeleteBehavior.Restrict);
}
}
public class Company
{
public Guid CompanyId { get; set; }
[Required]
public string Name { get; set; }
}
public class Group
{
[DatabaseGenerated(DatabaseGeneratedOption.None)]
public int GroupId { get; set; }
[Required]
public string Name { get; set; }
}
[Table(nameof(Item), Schema = "fin")]
public class Item
{
public Guid ItemId { get; set; }
public Guid CompanyId { get; set; }
[UniqueIndex]
[Required]
[MaxLength(255)]
public string Description { get; set; }
[ForeignKey("Group"/*, DeleteBehavior.Restrict*/)]
public int GroupId { get; set; }
public decimal Price { get; set; }
[DecimalType(20,4)]
public decimal? PriceExtended { get; set; }
public DateTime TimeCreated { get; set; }
[Column(TypeName = "datetime")]
public DateTime? TimeExpire { get; set; }
public virtual Company Company { get; set; }
public virtual Group Group { get; set; }
}
```