Class MySqlDbContextOptionsExtensions

Namespace

Steeltoe.Connector.MySql.EFCore

Assembly

Steeltoe.Connector.EFCore.dll

public static class MySqlDbContextOptionsExtensions

Inheritance

object

MySqlDbContextOptionsExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

UseMySql(DbContextOptionsBuilder, IConfiguration, object)

Configure Entity Framework Core to use a MySQL database

public static DbContextOptionsBuilder UseMySql(this DbContextOptionsBuilder optionsBuilder, IConfiguration config, object mySqlOptionsAction = null)

Parameters

optionsBuilder DbContextOptionsBuilder

DbContextOptionsBuilder

config IConfiguration

Application configuration

mySqlOptionsAction object

An action for customizing the MySqlDbContextOptionsBuilder

Returns

DbContextOptionsBuilder

DbContextOptionsBuilder, configured to use MySQL

Remarks

When used with EF Core 5.0, this method may result in the use of ServerVersion.AutoDetect(), which opens an extra connection to the server.

Pass in a ServerVersion to avoid the extra DB Connection - see https://github.com/PomeloFoundation/Pomelo.EntityFrameworkCore.MySql/issues/1088#issuecomment-726091533

UseMySql(DbContextOptionsBuilder, IConfiguration, object, object)

Configure Entity Framework Core to use a MySQL database

public static DbContextOptionsBuilder UseMySql(this DbContextOptionsBuilder optionsBuilder, IConfiguration config, object serverVersion, object mySqlOptionsAction = null)

Parameters

optionsBuilder DbContextOptionsBuilder

DbContextOptionsBuilder

config IConfiguration

Application configuration

serverVersion object

The version of MySQL/MariaDB to connect to (introduced in EF Core 5.0)

mySqlOptionsAction object

An action for customizing the MySqlDbContextOptionsBuilder

Returns

DbContextOptionsBuilder

DbContextOptionsBuilder, configured to use MySQL

UseMySql(DbContextOptionsBuilder, IConfiguration, string, object)

Configure Entity Framework Core to use a MySQL database identified by a named service binding

public static DbContextOptionsBuilder UseMySql(this DbContextOptionsBuilder optionsBuilder, IConfiguration config, string serviceName, object mySqlOptionsAction = null)

Parameters

optionsBuilder DbContextOptionsBuilder

DbContextOptionsBuilder

config IConfiguration

Application configuration

serviceName string

The name of the service binding to use

mySqlOptionsAction object

An action for customizing the MySqlDbContextOptionsBuilder

Returns

DbContextOptionsBuilder

DbContextOptionsBuilder, configured to use MySQL

Remarks

When used with EF Core 5.0, this method may result in the use of ServerVersion.AutoDetect(), which opens an extra connection to the server.

Pass in a ServerVersion to avoid the extra DB Connection - see https://github.com/PomeloFoundation/Pomelo.EntityFrameworkCore.MySql/issues/1088#issuecomment-726091533

UseMySql(DbContextOptionsBuilder, IConfiguration, string, object, object)

Configure Entity Framework Core to use a MySQL database identified by a named service binding

public static DbContextOptionsBuilder UseMySql(this DbContextOptionsBuilder optionsBuilder, IConfiguration config, string serviceName, object serverVersion, object mySqlOptionsAction = null)

Parameters

optionsBuilder DbContextOptionsBuilder

DbContextOptionsBuilder

config IConfiguration

Application configuration

serviceName string

The name of the service binding to use

serverVersion object

The version of MySQL/MariaDB to connect to (introduced in EF Core 5.0)

mySqlOptionsAction object

An action for customizing the MySqlDbContextOptionsBuilder

Returns

DbContextOptionsBuilder

DbContextOptionsBuilder, configured to use MySQL

UseMySql<TContext>(DbContextOptionsBuilder<TContext>, IConfiguration, object, object)

Configure Entity Framework Core to use a MySQL database

public static DbContextOptionsBuilder<TContext> UseMySql<TContext>(this DbContextOptionsBuilder<TContext> optionsBuilder, IConfiguration config, object mySqlOptionsAction = null, object serverVersion = null) where TContext : DbContext

Parameters

optionsBuilder DbContextOptionsBuilder<TContext>

DbContextOptionsBuilder

config IConfiguration

Application configuration

mySqlOptionsAction object

An action for customizing the MySqlDbContextOptionsBuilder

serverVersion object

The version of MySQL/MariaDB to connect to (introduced in EF Core 5.0)

Returns

DbContextOptionsBuilder<TContext>

DbContextOptionsBuilder, configured to use MySQL

Type Parameters

TContext

Type of DbContext

UseMySql<TContext>(DbContextOptionsBuilder<TContext>, IConfiguration, string, object, object)

Configure Entity Framework Core to use a MySQL database identified by a named service binding

public static DbContextOptionsBuilder<TContext> UseMySql<TContext>(this DbContextOptionsBuilder<TContext> optionsBuilder, IConfiguration config, string serviceName, object mySqlOptionsAction = null, object serverVersion = null) where TContext : DbContext

Parameters

optionsBuilder DbContextOptionsBuilder<TContext>

DbContextOptionsBuilder

config IConfiguration

Application configuration

serviceName string

The name of the service binding to use

mySqlOptionsAction object

An action for customizing the MySqlDbContextOptionsBuilder

serverVersion object

The version of MySQL/MariaDB to connect to (introduced in EF Core 5.0)

Returns

DbContextOptionsBuilder<TContext>

DbContextOptionsBuilder, configured to use MySQL

Type Parameters

TContext

Type of DbContext