dev: EF example

KirillKurdyukov · KirillKurdyukov · commit 57dcc6260cd0 · 2025-03-24T11:23:53.000+03:00
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -166,7 +166,11 @@ jobs:
         run: |
           cd ./examples/src/DapperExample
           dotnet run
-      - name: YDB Topic example
+      - name: Run YDB Topic example
         run: |
           cd ./examples/src/Topic
           dotnet run
+      - name: Run EF example
+        run: |
+          cd ./examples/src/EF
+          dotnet run
diff --git a/examples/src/EF/EF.csproj b/examples/src/EF/EF.csproj
@@ -0,0 +1,15 @@
+﻿<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <OutputType>Exe</OutputType>
+        <TargetFramework>net8.0</TargetFramework>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+        <RootNamespace>EfCore</RootNamespace>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <ProjectReference Include="..\..\..\src\EfCore.Ydb\src\EfCore.Ydb.csproj"/>
+    </ItemGroup>
+    
+</Project>
diff --git a/examples/src/EF/Program.cs b/examples/src/EF/Program.cs
@@ -0,0 +1,51 @@
+﻿using Microsoft.EntityFrameworkCore;
+using EfCore.Ydb.Extensions;
+
+await using var db = new BloggingContext();
+
+await db.Database.EnsureCreatedAsync();
+
+Console.WriteLine("Inserting a new blog");
+db.Add(new Blog { Url = "http://blogs.msdn.com/adonet" });
+await db.SaveChangesAsync();
+
+Console.WriteLine("Querying for a blog");
+var blog = await db.Blogs
+    .OrderBy(b => b.BlogId)
+    .FirstAsync();
+
+Console.WriteLine("Updating the blog and adding a post");
+blog.Url = "https://devblogs.microsoft.com/dotnet";
+blog.Posts.Add(new Post { Title = "Hello World", Content = "I wrote an app using EF Core!" });
+await db.SaveChangesAsync();
+
+Console.WriteLine("Delete the blog");
+db.Remove(blog);
+await db.SaveChangesAsync();
+
+internal class BloggingContext : DbContext
+{
+    public DbSet<Blog> Blogs { get; set; }
+    public DbSet<Post> Posts { get; set; }
+
+    protected override void OnConfiguring(DbContextOptionsBuilder options)
+        => options.UseYdb("Host=localhost;Port=2136;Database=/local");
+}
+
+internal class Blog
+{
+    public int BlogId { get; set; }
+    public string Url { get; set; }
+
+    public List<Post> Posts { get; } = new();
+}
+
+internal class Post
+{
+    public int PostId { get; set; }
+    public string Title { get; set; }
+    public string Content { get; set; }
+
+    public int BlogId { get; set; }
+    public Blog Blog { get; set; }
+}
diff --git a/examples/src/YdbExamples.sln b/examples/src/YdbExamples.sln
@@ -17,6 +17,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "YC", "YC\YC.csproj", "{753E
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Topic", "Topic\Topic.csproj", "{0FB9A1C2-4B0C-4AE4-9FA2-E0ED37802A6E}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "EF", "EF\EF.csproj", "{0CE9DF93-1411-4E73-BA88-A66018FAB948}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -51,6 +53,10 @@ Global
 		{0FB9A1C2-4B0C-4AE4-9FA2-E0ED37802A6E}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{0FB9A1C2-4B0C-4AE4-9FA2-E0ED37802A6E}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{0FB9A1C2-4B0C-4AE4-9FA2-E0ED37802A6E}.Release|Any CPU.Build.0 = Release|Any CPU
+		{0CE9DF93-1411-4E73-BA88-A66018FAB948}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{0CE9DF93-1411-4E73-BA88-A66018FAB948}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{0CE9DF93-1411-4E73-BA88-A66018FAB948}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{0CE9DF93-1411-4E73-BA88-A66018FAB948}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
diff --git a/src/EfCore.Ydb/src/Extensions/YdbContextOptionsBuilderExtensions.cs b/src/EfCore.Ydb/src/Extensions/YdbContextOptionsBuilderExtensions.cs
@@ -9,7 +9,7 @@ namespace EfCore.Ydb.Extensions;
 
 public static class YdbContextOptionsBuilderExtensions
 {
-    public static DbContextOptionsBuilder UseEfYdb(
+    public static DbContextOptionsBuilder UseYdb(
         this DbContextOptionsBuilder optionsBuilder,
         string? connectionString,
         Action<YdbDbContextOptionsBuilder>? efYdbOptionsAction = null
@@ -24,7 +24,7 @@ public static DbContextOptionsBuilder UseEfYdb(
         return optionsBuilder;
     }
 
-    public static DbContextOptionsBuilder UseEfYdb(
+    public static DbContextOptionsBuilder UseYdb(
         this DbContextOptionsBuilder optionsBuilder,
         DbConnection connection,
         Action<YdbDbContextOptionsBuilder>? efYdbOptionsAction = null
diff --git a/src/EfCore.Ydb/src/Infrastructure/EntityFrameworkYdbServicesBuilder.cs b/src/EfCore.Ydb/src/Infrastructure/EntityFrameworkYdbServicesBuilder.cs
@@ -20,8 +20,6 @@ private static readonly IDictionary<Type, ServiceCharacteristics> YdbServices
     protected override ServiceCharacteristics GetServiceCharacteristics(Type serviceType)
     {
         var contains = YdbServices.TryGetValue(serviceType, out var characteristics);
-        return contains
-            ? characteristics
-            : base.GetServiceCharacteristics(serviceType);
+        return contains ? characteristics : base.GetServiceCharacteristics(serviceType);
     }
 }
diff --git a/src/EfCore.Ydb/src/Infrastructure/Internal/YdbModelValidator.cs b/src/EfCore.Ydb/src/Infrastructure/Internal/YdbModelValidator.cs
@@ -2,7 +2,6 @@
 
 namespace EfCore.Ydb.Infrastructure.Internal;
 
-// TODO: Not required for mvp
 public class YdbModelValidator(
     ModelValidatorDependencies dependencies,
     RelationalModelValidatorDependencies relationalDependencies
diff --git a/src/EfCore.Ydb/src/Infrastructure/Internal/YdbOptionsExtension.cs b/src/EfCore.Ydb/src/Infrastructure/Internal/YdbOptionsExtension.cs
@@ -13,7 +13,7 @@ public YdbOptionsExtension()
     {
     }
 
-    protected YdbOptionsExtension(YdbOptionsExtension copyFrom) : base(copyFrom)
+    private YdbOptionsExtension(YdbOptionsExtension copyFrom) : base(copyFrom)
     {
     }
 
diff --git a/src/EfCore.Ydb/src/Query/Internal/YdbQueryTranslationPostprocessorFactory.cs b/src/EfCore.Ydb/src/Query/Internal/YdbQueryTranslationPostprocessorFactory.cs
@@ -2,12 +2,12 @@
 
 namespace EfCore.Ydb.Query.Internal;
 
-public class YdbQueryTranslationPostprocessorFactory(
+public sealed class YdbQueryTranslationPostprocessorFactory(
     QueryTranslationPostprocessorDependencies dependencies,
     RelationalQueryTranslationPostprocessorDependencies relationalDependencies
 ) : IQueryTranslationPostprocessorFactory
 {
-    public virtual QueryTranslationPostprocessor Create(QueryCompilationContext queryCompilationContext)
+    public QueryTranslationPostprocessor Create(QueryCompilationContext queryCompilationContext)
         => new YdbQueryTranslationPostprocessor(
             dependencies,
             relationalDependencies,
diff --git a/src/EfCore.Ydb/src/Storage/Internal/YdbRelationalConnection.cs b/src/EfCore.Ydb/src/Storage/Internal/YdbRelationalConnection.cs
@@ -14,7 +14,7 @@ public class YdbRelationalConnection(RelationalConnectionDependencies dependenci
     public IYdbRelationalConnection Clone()
     {
         var connectionStringBuilder = new YdbConnectionStringBuilder(GetValidatedConnectionString());
-        var options = new DbContextOptionsBuilder().UseEfYdb(connectionStringBuilder.ToString()).Options;
+        var options = new DbContextOptionsBuilder().UseYdb(connectionStringBuilder.ToString()).Options;
         return new YdbRelationalConnection(Dependencies with { ContextOptions = options });
     }
 }
diff --git a/src/EfCore.Ydb/src/Storage/Internal/YdbTypeMappingSource.cs b/src/EfCore.Ydb/src/Storage/Internal/YdbTypeMappingSource.cs
@@ -10,10 +10,10 @@
 
 namespace EfCore.Ydb.Storage.Internal;
 
-public class YdbTypeMappingSource : RelationalTypeMappingSource
+public sealed class YdbTypeMappingSource : RelationalTypeMappingSource
 {
-    protected virtual ConcurrentDictionary<string, RelationalTypeMapping[]> StoreTypeMapping { get; }
-    protected virtual ConcurrentDictionary<Type, RelationalTypeMapping> ClrTypeMapping { get; }
+    private ConcurrentDictionary<string, RelationalTypeMapping[]> StoreTypeMapping { get; }
+    private ConcurrentDictionary<Type, RelationalTypeMapping> ClrTypeMapping { get; }
 
     #region Mappings
 
@@ -118,7 +118,7 @@ RelationalTypeMappingSourceDependencies relationalDependencies
         => FindBaseMapping(mappingInfo)
            ?? base.FindMapping(mappingInfo);
 
-    protected virtual RelationalTypeMapping? FindBaseMapping(in RelationalTypeMappingInfo mappingInfo)
+    private RelationalTypeMapping? FindBaseMapping(in RelationalTypeMappingInfo mappingInfo)
     {
         var clrType = mappingInfo.ClrType;
         var storeTypeName = mappingInfo.StoreTypeName;
diff --git a/src/EfCore.Ydb/test/EfCore.Ydb.FunctionalTests/TestUtilities/YdbTestStore.cs b/src/EfCore.Ydb/test/EfCore.Ydb.FunctionalTests/TestUtilities/YdbTestStore.cs
@@ -23,8 +23,8 @@ public static YdbTestStore GetOrCreate(
     ) => new(name: name, scriptPath: scriptPath);
 
     public override DbContextOptionsBuilder AddProviderOptions(DbContextOptionsBuilder builder) => UseConnectionString
-        ? builder.UseEfYdb(Connection.ConnectionString)
-        : builder.UseEfYdb(Connection);
+        ? builder.UseYdb(Connection.ConnectionString)
+        : builder.UseYdb(Connection);
 
     protected override async Task InitializeAsync(
         Func<DbContext> createContext,

Original file line number	Diff line number	Diff line change
`@@ -20,8 +20,6 @@ private static readonly IDictionary<Type, ServiceCharacteristics> YdbServices`
`20`	`20`	`protected override ServiceCharacteristics GetServiceCharacteristics(Type serviceType)`
`21`	`21`	`{`
`22`	`22`	`var contains = YdbServices.TryGetValue(serviceType, out var characteristics);`
`23`		`- return contains`
`24`		`- ? characteristics`
`25`		`- : base.GetServiceCharacteristics(serviceType);`
	`23`	`+ return contains ? characteristics : base.GetServiceCharacteristics(serviceType);`
`26`	`24`	`}`
`27`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ public YdbOptionsExtension()`
`13`	`13`	`{`
`14`	`14`	`}`
`15`	`15`
`16`		`- protected YdbOptionsExtension(YdbOptionsExtension copyFrom) : base(copyFrom)`
	`16`	`+ private YdbOptionsExtension(YdbOptionsExtension copyFrom) : base(copyFrom)`
`17`	`17`	`{`
`18`	`18`	`}`
`19`	`19`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ public class YdbRelationalConnection(RelationalConnectionDependencies dependenci`
`14`	`14`	`public IYdbRelationalConnection Clone()`
`15`	`15`	`{`
`16`	`16`	`var connectionStringBuilder = new YdbConnectionStringBuilder(GetValidatedConnectionString());`
`17`		`- var options = new DbContextOptionsBuilder().UseEfYdb(connectionStringBuilder.ToString()).Options;`
	`17`	`+ var options = new DbContextOptionsBuilder().UseYdb(connectionStringBuilder.ToString()).Options;`
`18`	`18`	`return new YdbRelationalConnection(Dependencies with { ContextOptions = options });`
`19`	`19`	`}`
`20`	`20`	`}`