Class DatabaseProviderMetadataExtensions

Extension methods for IDatabaseProviderMetadata.

Inheritance

object

Namespace: Umbraco.Cms.Infrastructure.Persistence

Assembly: Umbraco.Infrastructure.dll

Syntax

public static class DatabaseProviderMetadataExtensions

Methods

View Source

CanForceCreateDatabase(IEnumerable<IDatabaseProviderMetadata>, IUmbracoDatabaseFactory)

Determines whether a database can be created for the specified provider name.

Declaration

public static bool CanForceCreateDatabase(this IEnumerable<IDatabaseProviderMetadata> databaseProviderMetadata, IUmbracoDatabaseFactory umbracoDatabaseFactory)

Parameters

Type	Name	Description
IEnumerable<IDatabaseProviderMetadata>	databaseProviderMetadata	The database provider metadata.
IUmbracoDatabaseFactory	umbracoDatabaseFactory	The database factory.

Returns

Type	Description
bool	`true` if a database can be created for the specified database; otherwise, `false`.

View Source

GenerateConnectionString(IDatabaseProviderMetadata, string?, string?, string?, string?, bool?)

Generates the connection string.

Declaration

public static string? GenerateConnectionString(this IDatabaseProviderMetadata databaseProviderMetadata, string? databaseName = null, string? server = null, string? login = null, string? password = null, bool? integratedAuth = null)

Parameters

Type	Name	Description
IDatabaseProviderMetadata	databaseProviderMetadata	The database provider metadata.
string	databaseName	The name of the database, uses the default database name when `null`.
string	server	The server.
string	login	The login.
string	password	The password.
bool?	integratedAuth	Indicates whether integrated authentication should be used (when supported by the provider).

Returns

Type	Description
string	The generated connection string.

View Source

GetAvailable(IEnumerable<IDatabaseProviderMetadata>, bool)

Gets the available database provider metadata.

Declaration

public static IEnumerable<IDatabaseProviderMetadata> GetAvailable(this IEnumerable<IDatabaseProviderMetadata> databaseProviderMetadata, bool onlyQuickInstall = false)

Parameters

Type	Name	Description
IEnumerable<IDatabaseProviderMetadata>	databaseProviderMetadata	The database provider metadata.
bool	onlyQuickInstall	If set to `true` only returns providers that support quick install.

Returns

Type	Description
IEnumerable<IDatabaseProviderMetadata>	The available database provider metadata.