Создание документации

This commit is contained in:
2025-06-01 19:57:59 +04:00
parent 8ff9f6bbc6
commit c9c92a2b54
1222 changed files with 21314 additions and 74 deletions
+62
View File
@@ -0,0 +1,62 @@
#### [Pf2eModel](index.md 'index')
### [Pf2eModel](Pf2eModel.md 'Pf2eModel')
## Pf2eDbContext Class
A DbContext instance represents a session with the database and can be used to query and save
instances of your entities\. DbContext is a combination of the Unit Of Work and Repository patterns\.
```csharp
public class Pf2eDbContext : Microsoft.EntityFrameworkCore.DbContext
```
Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [Microsoft\.EntityFrameworkCore\.DbContext](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbContext 'Microsoft\.EntityFrameworkCore\.DbContext') 🡒 Pf2eDbContext
### Remarks
Entity Framework Core does not support multiple parallel operations being run on the same DbContext instance. This
includes both parallel execution of async queries and any explicit concurrent use from multiple threads.
Therefore, always await async calls immediately, or use separate DbContext instances for operations that execute
in parallel. See [Avoiding DbContext threading issues](https://aka.ms/efcore-docs-threading 'https://aka\.ms/efcore\-docs\-threading') for more information
and examples.
Typically you create a class that derives from DbContext and contains [Microsoft\.EntityFrameworkCore\.DbSet<>](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbSet-1 'Microsoft\.EntityFrameworkCore\.DbSet\`1')
properties for each entity in the model. If the [Microsoft\.EntityFrameworkCore\.DbSet<>](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbSet-1 'Microsoft\.EntityFrameworkCore\.DbSet\`1') properties have a public setter,
they are automatically initialized when the instance of the derived context is created.
Override the [Microsoft\.EntityFrameworkCore\.DbContext\.OnConfiguring\(Microsoft\.EntityFrameworkCore\.DbContextOptionsBuilder\)](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbContext.OnConfiguring#Microsoft_EntityFrameworkCore_DbContext_OnConfiguring_Microsoft_EntityFrameworkCore_DbContextOptionsBuilder_ 'Microsoft\.EntityFrameworkCore\.DbContext\.OnConfiguring\(Microsoft\.EntityFrameworkCore\.DbContextOptionsBuilder\)') method to configure the database (and
other options) to be used for the context. Alternatively, if you would rather perform configuration externally
instead of inline in your context, you can use [Microsoft\.EntityFrameworkCore\.DbContextOptionsBuilder<>](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbContextOptionsBuilder-1 'Microsoft\.EntityFrameworkCore\.DbContextOptionsBuilder\`1')
(or [Microsoft\.EntityFrameworkCore\.DbContextOptionsBuilder](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbContextOptionsBuilder 'Microsoft\.EntityFrameworkCore\.DbContextOptionsBuilder')) to externally create an instance of [Microsoft\.EntityFrameworkCore\.DbContextOptions<>](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbContextOptions-1 'Microsoft\.EntityFrameworkCore\.DbContextOptions\`1')
(or [Microsoft\.EntityFrameworkCore\.DbContextOptions](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbContextOptions 'Microsoft\.EntityFrameworkCore\.DbContextOptions')) and pass it to a base constructor of [Microsoft\.EntityFrameworkCore\.DbContext](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbContext 'Microsoft\.EntityFrameworkCore\.DbContext').
The model is discovered by running a set of conventions over the entity classes found in the
[Microsoft\.EntityFrameworkCore\.DbSet<>](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbSet-1 'Microsoft\.EntityFrameworkCore\.DbSet\`1') properties on the derived context. To further configure the model that
is discovered by convention, you can override the [Microsoft\.EntityFrameworkCore\.DbContext\.OnModelCreating\(Microsoft\.EntityFrameworkCore\.ModelBuilder\)](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbContext.OnModelCreating#Microsoft_EntityFrameworkCore_DbContext_OnModelCreating_Microsoft_EntityFrameworkCore_ModelBuilder_ 'Microsoft\.EntityFrameworkCore\.DbContext\.OnModelCreating\(Microsoft\.EntityFrameworkCore\.ModelBuilder\)') method.
See [DbContext lifetime, configuration, and initialization](https://aka.ms/efcore-docs-dbcontext 'https://aka\.ms/efcore\-docs\-dbcontext'),
[Querying data with EF Core](https://aka.ms/efcore-docs-query 'https://aka\.ms/efcore\-docs\-query'),
[Changing tracking](https://aka.ms/efcore-docs-change-tracking 'https://aka\.ms/efcore\-docs\-change\-tracking'), and
[Saving data with EF Core](https://aka.ms/efcore-docs-saving-data 'https://aka\.ms/efcore\-docs\-saving\-data') for more information and examples.
| Constructors | |
| :--- | :--- |
| [Pf2eDbContext\(\)](Pf2eDbContext.Pf2eDbContext.md#Pf2eModel.Pf2eDbContext.Pf2eDbContext() 'Pf2eModel\.Pf2eDbContext\.Pf2eDbContext\(\)') | Инициализирует новый экземпляр класса [Pf2eDbContext](Pf2eDbContext.md 'Pf2eModel\.Pf2eDbContext') без параметров\. |
| [Pf2eDbContext\(DbContextOptions&lt;Pf2eDbContext&gt;\)](Pf2eDbContext.Pf2eDbContext.md#Pf2eModel.Pf2eDbContext.Pf2eDbContext(Microsoft.EntityFrameworkCore.DbContextOptions_Pf2eModel.Pf2eDbContext_) 'Pf2eModel\.Pf2eDbContext\.Pf2eDbContext\(Microsoft\.EntityFrameworkCore\.DbContextOptions\<Pf2eModel\.Pf2eDbContext\>\)') | Инициализирует новый экземпляр класса [Pf2eDbContext](Pf2eDbContext.md 'Pf2eModel\.Pf2eDbContext') с указанными параметрами конфигурации базы данных\. |
| Fields | |
| :--- | :--- |
| [NameLength](Pf2eDbContext.NameLength.md 'Pf2eModel\.Pf2eDbContext\.NameLength') | Длина названия сущности\. |
| Methods | |
| :--- | :--- |
| [BindEntity&lt;T&gt;\(EntityTypeBuilder&lt;T&gt;\)](Pf2eDbContext.BindEntity_T_(EntityTypeBuilder_T_).md 'Pf2eModel\.Pf2eDbContext\.BindEntity\<T\>\(Microsoft\.EntityFrameworkCore\.Metadata\.Builders\.EntityTypeBuilder\<T\>\)') | Устанавливает связь между сущностью и её корневой сущностью\. |
| [BindLocaleString&lt;T&gt;\(EntityTypeBuilder&lt;T&gt;, Expression&lt;Func&lt;T,LocaleString&gt;&gt;, bool\)](Pf2eDbContext.BindLocaleString_T_(EntityTypeBuilder_T_,Expression_Func_T,LocaleString__,bool).md 'Pf2eModel\.Pf2eDbContext\.BindLocaleString\<T\>\(Microsoft\.EntityFrameworkCore\.Metadata\.Builders\.EntityTypeBuilder\<T\>, System\.Linq\.Expressions\.Expression\<System\.Func\<T,Pf2eModel\.Model\.Common\.I18n\.LocaleString\>\>, bool\)') | Устанавливает связь между сущностью и локализованной строкой\. |
| [DefineBase\(ModelBuilder\)](Pf2eDbContext.DefineBase(ModelBuilder).md 'Pf2eModel\.Pf2eDbContext\.DefineBase\(Microsoft\.EntityFrameworkCore\.ModelBuilder\)') | Определяет базовые сущности и их связи\. |
| [DefineCommon\(ModelBuilder\)](Pf2eDbContext.DefineCommon(ModelBuilder).md 'Pf2eModel\.Pf2eDbContext\.DefineCommon\(Microsoft\.EntityFrameworkCore\.ModelBuilder\)') | Определяет общие сущности и их связи\. |
| [DefineMethods\(ModelBuilder\)](Pf2eDbContext.DefineMethods(ModelBuilder).md 'Pf2eModel\.Pf2eDbContext\.DefineMethods\(Microsoft\.EntityFrameworkCore\.ModelBuilder\)') | Определяет методы, которые будут использоваться в запросах LINQ\. |
| [DefineStructure\(ModelBuilder\)](Pf2eDbContext.DefineStructure(ModelBuilder).md 'Pf2eModel\.Pf2eDbContext\.DefineStructure\(Microsoft\.EntityFrameworkCore\.ModelBuilder\)') | Определяет структуру сущностей и их связи\. |
| [LocaleSearch\(LocaleString, string\)](Pf2eDbContext.LocaleSearch(LocaleString,string).md 'Pf2eModel\.Pf2eDbContext\.LocaleSearch\(Pf2eModel\.Model\.Common\.I18n\.LocaleString, string\)') | CLR\-представление функции поиска в локализованной строке\. |
| [LocaleSearchArray\(LocaleString, IEnumerable&lt;string&gt;\)](Pf2eDbContext.LocaleSearchArray(LocaleString,IEnumerable_string_).md 'Pf2eModel\.Pf2eDbContext\.LocaleSearchArray\(Pf2eModel\.Model\.Common\.I18n\.LocaleString, System\.Collections\.Generic\.IEnumerable\<string\>\)') | CLR\-представление функции поиска в локализованной строке с массивом значений для поиска\. |
| [OnConfiguring\(DbContextOptionsBuilder\)](Pf2eDbContext.OnConfiguring(DbContextOptionsBuilder).md 'Pf2eModel\.Pf2eDbContext\.OnConfiguring\(Microsoft\.EntityFrameworkCore\.DbContextOptionsBuilder\)') | Override this method to configure the database \(and other options\) to be used for this context\. This method is called for each instance of the context that is created\. The base implementation does nothing\. |
| [OnModelCreating\(ModelBuilder\)](Pf2eDbContext.OnModelCreating(ModelBuilder).md 'Pf2eModel\.Pf2eDbContext\.OnModelCreating\(Microsoft\.EntityFrameworkCore\.ModelBuilder\)') | Override this method to further configure the model that was discovered by convention from the entity types exposed in [Microsoft\.EntityFrameworkCore\.DbSet&lt;&gt;](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbSet-1 'Microsoft\.EntityFrameworkCore\.DbSet\`1') properties on your derived context\. The resulting model may be cached and re\-used for subsequent instances of your derived context\. |