Ionut/EFCore.AutomaticMigrationsv10.0.0

<!-- GETTING STARTED -->

About the package

Enable Automatic Migrations for Entity Framework Core for SQL Databases without manual migration files..

<!-- USAGE EXAMPLES -->

Usage

The package support following ways to apply/view-applied migrations:

Context methods

• Execute(TContext context);
• Execute(TContext context, TMigrationsOptions options);
• ExecuteAsync(TContext context, CancellationToken cancellationToken);
• ExecuteAsync(TContext context, TMigrationsOptions options, CancellationToken cancellationToken);

Extensions methods

• MigrateToLatestVersion<TContext, TMigrationsOptions>(this TContext context);
• MigrateToLatestVersion<TContext, TMigrationsOptions>(this TContext context, TMigrationsOptions options);
• MigrateToLatestVersionAsync<TContext, TMigrationsOptions>(this TContext context, CancellationToken cancellationToken);
• MigrateToLatestVersionAsync<TContext, TMigrationsOptions>(this TContext context, TMigrationsOptions options, CancellationToken cancellationToken);

DbMigrationsOptions object allows to configure migration options:

/// <summary> /// Configuration options for automatic Entity Framework Core migrations. /// </summary> /// <remarks> /// This class provides settings to control how automatic migrations are executed, /// including data loss protection, schema reset capabilities, and snapshot management. /// </remarks> public class DbMigrationsOptions { /// <summary> /// Gets or sets a value indicating whether automatic migrations that could result in data loss are allowed. /// </summary> /// <value> /// <see langword="true"/> if data loss is allowed during migrations; otherwise, <see langword="false"/>. /// Default is <see langword="false"/>. /// </value> /// <remarks> /// When set to <see langword="false"/>, migrations that could potentially cause data loss /// (such as dropping columns or tables) will throw an exception. /// </remarks> public bool AutomaticMigrationDataLossAllowed { get; set; } = false; /// <summary> /// Gets or sets a value indicating whether automatic migrations are enabled. /// </summary> /// <value> /// <see langword="true"/> if automatic migrations are enabled; otherwise, <see langword="false"/>. /// Default is <see langword="true"/>. /// </value> public bool AutomaticMigrationsEnabled { get; set; } = true; /// <summary> /// Gets or sets a value indicating whether to reset the database schema by dropping all tables and recreating them. /// </summary> /// <value> /// <see langword="true"/> to reset the database schema; otherwise, <see langword="false"/>. /// Default is <see langword="false"/>. /// </value> /// <remarks> /// <para> /// When set to <see langword="true"/>, all existing tables will be dropped and recreated based on the current model. /// This is useful during development, testing, or when working with transient data that can be safely discarded. /// </para> /// <para> /// <strong>Warning:</strong> This will result in complete data loss. Use with caution in production environments. /// </para> /// </remarks> public bool ResetDatabaseSchema { get; set; } = false; /// <summary> /// Gets or sets a dictionary of key-value pairs for updating the model snapshot. /// </summary> /// <value> /// A dictionary where keys are replaced with their corresponding values in the snapshot. /// Default is an empty dictionary. /// </value> /// <remarks> /// This property allows for dynamic modification of the generated model snapshot code /// by performing string replacements during the migration process. /// </remarks> public Dictionary<string, string> UpdateSnapshot { get; set; } = []; /// <summary> /// Gets or sets the database schema name for the migration history table. /// </summary> /// <value> /// The schema name for the migration table, or <see langword="null"/> to use the model's default schema. /// </value> /// <remarks> /// <para> /// If not specified, the migration history table will be created in the same schema as defined by the model. /// For SQL databases, this defaults to the "dbo" schema. /// </para> /// <para> /// This property is particularly useful in multi-tenant scenarios or when working with specific database schemas. /// </para> /// </remarks> public string Schema { get; set; } }