View Source

Class CustomConnectionStringDatabaseProviderMetadata

Provider metadata for custom connection string setup.

Inheritance
System.Object
Namespace: Umbraco.Cms.Infrastructure.Persistence
Assembly: Umbraco.Infrastructure.dll
Syntax
[DataContract]
public class CustomConnectionStringDatabaseProviderMetadata : IDatabaseProviderMetadata

Properties

View Source

DefaultDatabaseName

Gets the default database name for the provider.

Declaration
public string DefaultDatabaseName { get; }
Property Value
Type Description
System.String
View Source

DisplayName

Gets a friendly name to describe the provider.

Declaration
public string DisplayName { get; }
Property Value
Type Description
System.String
View Source

ForceCreateDatabase

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

Declaration
public bool ForceCreateDatabase { get; }
Property Value
Type Description
System.Boolean
View Source

Id

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

Declaration
public Guid Id { get; }
Property Value
Type Description
Guid
View Source

IsAvailable

Gets a value indicating whether should be available for selection.

Declaration
public bool IsAvailable { get; }
Property Value
Type Description
System.Boolean
View Source

ProviderName

Gets the database factory provider name.

Declaration
public string ProviderName { get; }
Property Value
Type Description
System.String
View Source

RequiresConnectionTest

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

Declaration
public bool RequiresConnectionTest { get; }
Property Value
Type Description
System.Boolean
View Source

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
System.Boolean
View Source

RequiresServer

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

Declaration
public bool RequiresServer { get; }
Property Value
Type Description
System.Boolean
View Source

ServerPlaceholder

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

Declaration
public string ServerPlaceholder { get; }
Property Value
Type Description
System.String
View Source

SortOrder

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

Declaration
public int SortOrder { get; }
Property Value
Type Description
System.Int32
View Source

SupportsIntegratedAuthentication

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

Declaration
public bool SupportsIntegratedAuthentication { get; }
Property Value
Type Description
System.Boolean
View Source

SupportsQuickInstall

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

Declaration
public bool SupportsQuickInstall { get; }
Property Value
Type Description
System.Boolean

Methods

View Source

GenerateConnectionString(DatabaseModel)

Creates a connection string for this provider.

Declaration
public string GenerateConnectionString(DatabaseModel databaseModel)
Parameters
Type Name Description
DatabaseModel databaseModel
Returns
Type Description
System.String