View Source

Interface IDatabaseProviderMetadata

Defines metadata details for a specific database provider implementation.

Namespace: Umbraco.Cms.Infrastructure.Persistence

Assembly: Umbraco.Infrastructure.dll

Syntax

public interface IDatabaseProviderMetadata

Properties

DefaultDatabaseName

Gets the default database name for the provider.

Declaration

[DataMember(Name = "defaultDatabaseName")]
string DefaultDatabaseName { get; }

Property Value

Type	Description
string

DisplayName

Gets a friendly name to describe the provider.

Declaration

[DataMember(Name = "displayName")]
string DisplayName { get; }

Property Value

Type	Description
string

ForceCreateDatabase

Gets a value indicating to ignore the value of GlobalSettings.InstallMissingDatabase

Declaration

bool ForceCreateDatabase { get; }

Property Value

Type	Description
bool

Id

Gets a unique identifier for this set of metadata used for filtering.

Declaration

[DataMember(Name = "id")]
Guid Id { get; }

Property Value

Type	Description
Guid

IsAvailable

Gets a value indicating whether should be available for selection.

Declaration

[DataMember(Name = "isAvailable")]
bool IsAvailable { get; }

Property Value

Type	Description
bool

ProviderName

Gets the database factory provider name.

Declaration

[DataMember(Name = "providerName")]
string? ProviderName { get; }

Property Value

Type	Description
string

RequiresConnectionTest

Gets a value indicating whether the connection should be tested before continuing install process.

Declaration

[DataMember(Name = "requiresConnectionTest")]
bool RequiresConnectionTest { get; }

Property Value

Type	Description
bool

RequiresCredentials

Gets a value indicating whether a username and password are required (in general) to connect to the database

Declaration

[DataMember(Name = "requiresCredentials")]
bool RequiresCredentials { get; }

Property Value

Type	Description
bool

RequiresServer

Gets a value indicating whether the server/hostname field must be populated.

Declaration

[DataMember(Name = "requiresServer")]
bool RequiresServer { get; }

Property Value

Type	Description
bool

ServerPlaceholder

Gets a value used as input placeholder for server/hostnmae field.

Declaration

[DataMember(Name = "serverPlaceholder")]
string? ServerPlaceholder { get; }

Property Value

Type	Description
string

SortOrder

Gets a value to determine display order and quick install priority.

Declaration

[DataMember(Name = "sortOrder")]
int SortOrder { get; }

Property Value

Type	Description
int

SupportsIntegratedAuthentication

Gets a value indicating whether integrated authentication is supported (e.g. SQL Server & Oracle).

Declaration

[DataMember(Name = "supportsIntegratedAuthentication")]
bool SupportsIntegratedAuthentication { get; }

Property Value

Type	Description
bool

SupportsQuickInstall

Gets a value indicating whether can be used for one click install.

Declaration

[DataMember(Name = "supportsQuickInstall")]
bool SupportsQuickInstall { get; }

Property Value

Type	Description
bool

SupportsTrustServerCertificate

Gets a value indicating whether "Trust the database certificate" is supported (e.g. SQL Server & Oracle).

Declaration

[DataMember(Name = "supportsTrustServerCertificate")]
bool SupportsTrustServerCertificate { get; }

Property Value

Type	Description
bool

Methods

CanRecognizeConnectionString(string?)

Determines whether the specified connection string could have been built using GenerateConnectionString(DatabaseModel).

Declaration

bool CanRecognizeConnectionString(string? connectionString)

Parameters

Type	Name	Description
string	connectionString	The connection string to evaluate.

Returns

Type	Description
bool	true if the connection string could have been built using GenerateConnectionString(DatabaseModel); otherwise, false.

GenerateConnectionString(DatabaseModel)

Generates a connection string for the specified database model using this provider's format.

Declaration

string? GenerateConnectionString(DatabaseModel databaseModel)

Parameters

Type	Name	Description
DatabaseModel	databaseModel	The database model for which to generate the connection string.

Returns

Type	Description
string	The generated connection string, or null if it cannot be generated.