View Source

Class CustomConnectionStringDatabaseProviderMetadata

Provider metadata for custom connection string setup.

Inheritance

object

Namespace: Umbraco.Cms.Infrastructure.Persistence

Assembly: Umbraco.Infrastructure.dll

Syntax

[DataContract]
public class CustomConnectionStringDatabaseProviderMetadata : IDatabaseProviderMetadata

Constructors

CustomConnectionStringDatabaseProviderMetadata()

Declaration

public CustomConnectionStringDatabaseProviderMetadata()

Properties

DefaultDatabaseName

Gets the default database name for the provider.

Declaration

public string DefaultDatabaseName { get; }

Property Value

Type	Description
string

DisplayName

Gets a friendly name to describe the provider.

Declaration

public string DisplayName { get; }

Property Value

Type	Description
string

ForceCreateDatabase

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

Declaration

public bool ForceCreateDatabase { get; }

Property Value

Type	Description
bool

Id

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

Declaration

public Guid Id { get; }

Property Value

Type	Description
Guid

IsAvailable

Gets a value indicating whether should be available for selection.

Declaration

public bool IsAvailable { get; }

Property Value

Type	Description
bool

ProviderName

Gets the database factory provider name.

Declaration

public string? ProviderName { get; }

Property Value

Type	Description
string

RequiresConnectionTest

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

Declaration

public 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

public bool RequiresCredentials { get; }

Property Value

Type	Description
bool

RequiresServer

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

Declaration

public bool RequiresServer { get; }

Property Value

Type	Description
bool

ServerPlaceholder

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

Declaration

public string? ServerPlaceholder { get; }

Property Value

Type	Description
string

SortOrder

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

Declaration

public int SortOrder { get; }

Property Value

Type	Description
int

SupportsIntegratedAuthentication

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

Declaration

public bool SupportsIntegratedAuthentication { get; }

Property Value

Type	Description
bool

SupportsQuickInstall

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

Declaration

public 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

public bool SupportsTrustServerCertificate { get; }

Property Value

Type	Description
bool

Methods

GenerateConnectionString(DatabaseModel)

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

Declaration

public 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.