DbContextOptionsBuilder Kelas
Definisi
Penting
Beberapa informasi terkait produk prarilis yang dapat diubah secara signifikan sebelum dirilis. Microsoft tidak memberikan jaminan, tersirat maupun tersurat, sehubungan dengan informasi yang diberikan di sini.
Menyediakan permukaan API sederhana untuk mengonfigurasi DbContextOptions. Database (dan ekstensi lainnya) biasanya menentukan metode ekstensi pada objek ini yang memungkinkan Anda mengonfigurasi koneksi database (dan opsi lainnya) untuk digunakan untuk konteks.
public class DbContextOptionsBuilder : Microsoft.EntityFrameworkCore.Infrastructure.IDbContextOptionsBuilderInfrastructure
[System.Runtime.CompilerServices.Nullable(0)]
public class DbContextOptionsBuilder : Microsoft.EntityFrameworkCore.Infrastructure.IDbContextOptionsBuilderInfrastructure
type DbContextOptionsBuilder = class
interface IDbContextOptionsBuilderInfrastructure
[<System.Runtime.CompilerServices.Nullable(0)>]
type DbContextOptionsBuilder = class
interface IDbContextOptionsBuilderInfrastructure
Public Class DbContextOptionsBuilder
Implements IDbContextOptionsBuilderInfrastructure
- Warisan
-
DbContextOptionsBuilder
- Turunan
- Atribut
- Penerapan
Keterangan
Anda dapat menggunakan DbContextOptionsBuilder untuk mengonfigurasi konteks dengan menimpa OnConfiguring(DbContextOptionsBuilder) atau membuat DbContextOptions secara eksternal dan meneruskannya ke konstruktor konteks.
Lihat Menggunakan DbContextOptions untuk informasi dan contoh selengkapnya.
Konstruktor
| Nama | Deskripsi |
|---|---|
| DbContextOptionsBuilder() |
Menginisialisasi instans DbContextOptionsBuilder baru kelas tanpa set opsi. |
| DbContextOptionsBuilder(DbContextOptions) |
Menginisialisasi instans DbContextOptionsBuilder baru kelas untuk mengonfigurasi DbContextOptionslebih lanjut . |
Properti
| Nama | Deskripsi |
|---|---|
| IsConfigured |
Mendapatkan nilai yang menunjukkan apakah ada opsi yang telah dikonfigurasi. |
| Options |
Mendapatkan opsi yang sedang dikonfigurasi. |
Metode
| Nama | Deskripsi |
|---|---|
| AddInterceptors(IEnumerable<IInterceptor>) |
Menambahkan instans IInterceptor ke instans yang terdaftar pada konteks. |
| AddInterceptors(IInterceptor[]) |
Menambahkan instans IInterceptor ke instans yang terdaftar pada konteks. |
| ConfigureLoggingCacheTime(TimeSpan) |
Mengonfigurasi berapa lama EF Core akan menyimpan konfigurasi pengelogan di jalur performa tinggi tertentu. Ini membuat EF Core melewati pemeriksaan pengelogan yang berpotensi mahal, tetapi berarti bahwa perubahan pengelogan runtime (misalnya mendaftarkan yang baru DiagnosticListener mungkin tidak segera diperhitungkan). |
| ConfigureWarnings(Action<WarningsConfigurationBuilder>) |
Mengonfigurasi perilaku runtime peringatan yang dihasilkan oleh Kerangka Kerja Entitas. Anda dapat mengatur perilaku dan perilaku default untuk setiap jenis peringatan. |
| ConfigureWarnings(Action<WarningsConfigurationBuilder>) |
Mengonfigurasi perilaku runtime peringatan yang dihasilkan oleh Kerangka Kerja Entitas. Anda dapat mengatur perilaku dan perilaku default untuk setiap jenis peringatan. |
| EnableDetailedErrors(Boolean) |
Mengaktifkan kesalahan terperinci saat menangani pengecualian nilai data yang terjadi selama pemrosesan hasil kueri penyimpanan. Kesalahan tersebut paling sering terjadi karena kesalahan konfigurasi properti entitas. Misalnya, jika properti dikonfigurasi menjadi jenis 'int', tetapi data yang mendasari di penyimpanan sebenarnya berjenis 'string', maka pengecualian akan dihasilkan pada runtime selama pemrosesan nilai data. Ketika opsi ini diaktifkan dan terjadi kesalahan data, pengecualian yang dihasilkan akan menyertakan detail properti entitas tertentu yang menghasilkan kesalahan. |
| EnableSensitiveDataLogging() |
Memungkinkan data aplikasi disertakan dalam pesan pengecualian, pengelogan, dll. Ini dapat mencakup nilai yang ditetapkan ke properti instans entitas Anda, nilai parameter untuk perintah yang dikirim ke database, dan data lainnya. Anda hanya boleh mengaktifkan bendera ini jika Anda memiliki langkah-langkah keamanan yang sesuai berdasarkan sensitivitas data ini. |
| EnableSensitiveDataLogging(Boolean) |
Memungkinkan data aplikasi disertakan dalam pesan pengecualian, pengelogan, dll. Ini dapat mencakup nilai yang ditetapkan ke properti instans entitas Anda, nilai parameter untuk perintah yang dikirim ke database, dan data lainnya. Anda hanya boleh mengaktifkan bendera ini jika Anda memiliki langkah-langkah keamanan yang sesuai berdasarkan sensitivitas data ini. |
| EnableServiceProviderCaching(Boolean) |
Mengaktifkan atau menonaktifkan penembolokan penyedia layanan internal. Menonaktifkan penembolokan dapat berdampak besar pada performa dan hanya boleh digunakan dalam skenario pengujian yang membangun banyak penyedia layanan untuk isolasi pengujian. |
| EnableThreadSafetyChecks(Boolean) |
Menonaktifkan deteksi konkurensi, yang mendeteksi banyak kasus penggunaan instans bersamaan DbContext yang salah dan menyebabkan pengecualian informatif dilemparkan. Ini memberikan peningkatan performa kecil, tetapi jika instans digunakan secara bersamaan, perilaku tidak akan terdefinisi dan program mungkin gagal dengan cara yang DbContext tidak dapat diprediksi. |
| LogTo(Action<String>, Func<EventId,LogLevel,Boolean>, Nullable<DbContextLoggerOptions>) |
Mencatat peristiwa yang difilter oleh delegasi filter kustom yang disediakan. Filter harus mengembalikan true untuk mencatat pesan, atau false untuk memfilternya keluar dari log. |
| LogTo(Action<String>, IEnumerable<EventId>, LogLevel, Nullable<DbContextLoggerOptions>) |
Mencatat peristiwa yang ditentukan menggunakan tindakan yang disediakan. Misalnya, gunakan |
| LogTo(Action<String>, IEnumerable<String>, LogLevel, Nullable<DbContextLoggerOptions>) |
Mencatat semua peristiwa dalam kategori yang ditentukan menggunakan tindakan yang disediakan. Misalnya, gunakan |
| LogTo(Action<String>, LogLevel, Nullable<DbContextLoggerOptions>) |
Log menggunakan tindakan yang disediakan. Misalnya, gunakan |
| LogTo(Func<EventId,LogLevel,Boolean>, Action<EventData>) |
Mencatat peristiwa ke delegasi pencatat kustom yang difilter oleh delegasi filter kustom. Filter harus mengembalikan true untuk mencatat pesan, atau false untuk memfilternya keluar dari log. |
| ReplaceService<TService,TCurrentImplementation,TNewImplementation>() |
Mengganti implementasi Kerangka Kerja Entitas internal dari implementasi tertentu dari kontrak layanan dengan implementasi yang berbeda. |
| ReplaceService<TService,TImplementation>() |
Mengganti semua implementasi Kerangka Kerja Entitas internal dari kontrak layanan dengan implementasi yang berbeda. |
| UseApplicationServiceProvider(IServiceProvider) |
IServiceProvider Mengatur dari mana layanan aplikasi akan diperoleh. Ini dilakukan secara otomatis saat menggunakan 'AddDbContext' atau 'AddDbContextPool', sehingga jarang metode ini perlu dipanggil. |
| UseAsyncSeeding(Func<DbContext,Boolean,CancellationToken,Task>) |
Mengonfigurasi metode seed yang akan dijalankan setelah EnsureCreatedAsync(CancellationToken) dipanggil atau setelah migrasi diterapkan secara asinkron. Ini akan dipanggil bahkan jika tidak ada perubahan pada penyimpanan yang dilakukan. |
| UseInternalServiceProvider(IServiceProvider) |
IServiceProvider Mengatur asal konteks untuk menyelesaikan semua layanannya. EF akan membuat dan mengelola penyedia layanan jika tidak ada yang ditentukan. |
| UseLoggerFactory(ILoggerFactory) |
ILoggerFactory Mengatur yang akan digunakan untuk membuat ILogger instans untuk pengelogan yang dilakukan oleh konteks ini. |
| UseMemoryCache(IMemoryCache) |
Mengatur yang IMemoryCache akan digunakan untuk penembolokan kueri menurut konteks ini. |
| UseModel(IModel) |
Mengatur model yang akan digunakan untuk konteks. Jika model diatur, maka OnModelCreating(ModelBuilder) tidak akan dijalankan. |
| UseQueryTrackingBehavior(QueryTrackingBehavior) |
Mengatur perilaku pelacakan untuk kueri LINQ yang dijalankan terhadap konteks. Menonaktifkan pelacakan perubahan berguna untuk skenario baca-saja karena menghindari overhead pengaturan pelacakan perubahan untuk setiap instans entitas. Anda tidak boleh menonaktifkan pelacakan perubahan jika Anda ingin memanipulasi instans entitas dan mempertahankan perubahan tersebut ke database menggunakan SaveChanges(). |
| UseRootApplicationServiceProvider() |
Menyelesaikan akar IServiceProvider dari penyedia layanan aplikasi yang terlingkup. Penyedia akar dapat digunakan untuk mendapatkan layanan aplikasi singleton dari layanan internal singleton. |
| UseRootApplicationServiceProvider(IServiceProvider) |
Mengatur akar IServiceProvider tempat layanan aplikasi singleton dapat diperoleh dari layanan internal singleton. |
| UseSeeding(Action<DbContext,Boolean>) |
Mengonfigurasi metode seed untuk dijalankan setelah EnsureCreated() dipanggil atau setelah migrasi diterapkan. Ini akan dipanggil bahkan jika tidak ada perubahan pada penyimpanan yang dilakukan. |
Implementasi Antarmuka Eksplisit
| Nama | Deskripsi |
|---|---|
| IDbContextOptionsBuilderInfrastructure.AddOrUpdateExtension<TExtension>(TExtension) |
Menambahkan ekstensi yang diberikan ke opsi. Jika ekstensi yang ada dengan jenis yang sama sudah ada, ekstensi tersebut akan diganti. |
| IDbContextOptionsBuilderInfrastructure.RemoveExtension<TExtension>() |
Menghapus ekstensi jenis yang diberikan dari opsi. Jika tidak ada ekstensi dari jenis yang diberikan, ini adalah no-op. |
Metode Ekstensi
| Nama | Deskripsi |
|---|---|
| ConfigureSqlEngine(DbContextOptionsBuilder, Action<SqlEngineDbContextOptionsBuilder>) |
Mengonfigurasi konteks untuk menyambungkan ke salah satu database SQL Server, Azure SQL, Azure Synapse, tetapi tanpa awalnya mengatur salah satu DbConnection atau string koneksi. |
| UseAzureSql(DbContextOptionsBuilder, Action<AzureSqlDbContextOptionsBuilder>) |
Mengonfigurasi konteks untuk menyambungkan ke database Azure SQL, tetapi tanpa awalnya mengatur salah satu DbConnection atau string koneksi. |
| UseAzureSql(DbContextOptionsBuilder, DbConnection, Action<AzureSqlDbContextOptionsBuilder>) |
Mengonfigurasi konteks untuk menyambungkan ke database Azure SQL. |
| UseAzureSql(DbContextOptionsBuilder, DbConnection, Boolean, Action<AzureSqlDbContextOptionsBuilder>) |
Mengonfigurasi konteks untuk menyambungkan ke database Azure SQL. |
| UseAzureSql(DbContextOptionsBuilder, String, Action<AzureSqlDbContextOptionsBuilder>) |
Mengonfigurasi konteks untuk menyambungkan ke database Azure SQL. |
| UseAzureSynapse(DbContextOptionsBuilder, Action<AzureSynapseDbContextOptionsBuilder>) |
Mengonfigurasi konteks untuk menyambungkan ke database Azure Synapse, tetapi tanpa awalnya mengatur salah satu DbConnection atau string koneksi. |
| UseAzureSynapse(DbContextOptionsBuilder, DbConnection, Action<AzureSynapseDbContextOptionsBuilder>) |
Mengonfigurasi konteks untuk menyambungkan ke database Azure Synapse. |
| UseAzureSynapse(DbContextOptionsBuilder, DbConnection, Boolean, Action<AzureSynapseDbContextOptionsBuilder>) |
Mengonfigurasi konteks untuk menyambungkan ke database Azure Synapse. |
| UseAzureSynapse(DbContextOptionsBuilder, String, Action<AzureSynapseDbContextOptionsBuilder>) |
Mengonfigurasi konteks untuk menyambungkan ke database Azure Synapse. |
| UseChangeTrackingProxies(DbContextOptionsBuilder, Boolean, Boolean) |
Mengaktifkan pembuatan proksi pelacakan perubahan. |
| UseCosmos(DbContextOptionsBuilder, Action<CosmosDbContextOptionsBuilder>) |
Mengonfigurasi konteks untuk menyambungkan ke database Cosmos Azure. Detail koneksi perlu ditentukan dalam panggilan terpisah. |
| UseCosmos(DbContextOptionsBuilder, String, String, Action<CosmosDbContextOptionsBuilder>) |
Mengonfigurasi konteks untuk menyambungkan ke database Cosmos Azure. |
| UseCosmos(DbContextOptionsBuilder, String, String, String, Action<CosmosDbContextOptionsBuilder>) |
Mengonfigurasi konteks untuk menyambungkan ke database Cosmos Azure. |
| UseCosmos(DbContextOptionsBuilder, String, TokenCredential, String, Action<CosmosDbContextOptionsBuilder>) |
Mengonfigurasi konteks untuk menyambungkan ke database Cosmos Azure. |
| UseInMemoryDatabase(DbContextOptionsBuilder, Action<InMemoryDbContextOptionsBuilder>) |
Kedaluwarsa.
Kedaluwarsa.
Mengonfigurasi konteks untuk menyambungkan ke database dalam memori bersama warisan. Metode ini usang. Gunakan UseInMemoryDatabase(DbContextOptionsBuilder, String, Action<InMemoryDbContextOptionsBuilder>) sebagai gantinya. |
| UseInMemoryDatabase(DbContextOptionsBuilder, String, Action<InMemoryDbContextOptionsBuilder>) |
Mengonfigurasi konteks untuk menyambungkan ke database dalam memori bernama. Database dalam memori dibagikan di mana saja nama yang sama digunakan, tetapi hanya untuk penyedia layanan tertentu. Untuk menggunakan database dalam memori yang sama di seluruh penyedia layanan, panggil UseInMemoryDatabase(DbContextOptionsBuilder, String, InMemoryDatabaseRoot, Action<InMemoryDbContextOptionsBuilder>) meneruskan berbagi InMemoryDatabaseRoot untuk melakukan root database. |
| UseInMemoryDatabase(DbContextOptionsBuilder, String, InMemoryDatabaseRoot, Action<InMemoryDbContextOptionsBuilder>) |
Mengonfigurasi konteks untuk menyambungkan ke database dalam memori bernama. Database dalam memori dibagikan di mana saja nama yang sama digunakan, tetapi hanya untuk penyedia layanan tertentu. |
| UseLazyLoadingProxies(DbContextOptionsBuilder, Action<LazyLoadingProxiesOptionsBuilder>) |
Mengaktifkan pembuatan proksi pemuatan malas. |
| UseLazyLoadingProxies(DbContextOptionsBuilder, Boolean) |
Mengaktifkan pembuatan proksi pemuatan malas. |
| UseSqlite(DbContextOptionsBuilder, Action<SqliteDbContextOptionsBuilder>) |
Mengonfigurasi konteks untuk menyambungkan ke database SQLite, tetapi tanpa awalnya mengatur salah satu DbConnection atau string koneksi. |
| UseSqlite(DbContextOptionsBuilder, DbConnection, Action<SqliteDbContextOptionsBuilder>) |
Mengonfigurasi konteks untuk menyambungkan ke database SQLite. |
| UseSqlite(DbContextOptionsBuilder, DbConnection, Boolean, Action<SqliteDbContextOptionsBuilder>) |
Mengonfigurasi konteks untuk menyambungkan ke database SQLite. |
| UseSqlite(DbContextOptionsBuilder, String, Action<SqliteDbContextOptionsBuilder>) |
Mengonfigurasi konteks untuk menyambungkan ke database SQLite. |
| UseSqlServer(DbContextOptionsBuilder, Action<SqlServerDbContextOptionsBuilder>) |
Mengonfigurasi konteks untuk menyambungkan ke database SQL Server, tetapi tanpa awalnya mengatur salah satu DbConnection atau string koneksi. |
| UseSqlServer(DbContextOptionsBuilder, DbConnection, Action<SqlServerDbContextOptionsBuilder>) |
Mengonfigurasi konteks untuk menyambungkan ke database SQL Server. |
| UseSqlServer(DbContextOptionsBuilder, DbConnection, Boolean, Action<SqlServerDbContextOptionsBuilder>) |
Mengonfigurasi konteks untuk menyambungkan ke database SQL Server. |
| UseSqlServer(DbContextOptionsBuilder, String, Action<SqlServerDbContextOptionsBuilder>) |
Mengonfigurasi konteks untuk menyambungkan ke database SQL Server. |