Search Results for

    Show / Hide Table of Contents
    View Source

    Interface IDatabaseProviderMetadata

    Namespace: Umbraco.Cms.Infrastructure.Persistence
    Assembly: Umbraco.Infrastructure.dll
    Syntax
    public interface IDatabaseProviderMetadata

    Properties

    View Source

    DefaultDatabaseName

    Gets the default database name for the provider.

    Declaration
    [DataMember(Name = "defaultDatabaseName")]
    string DefaultDatabaseName { get; }
    Property Value
    Type Description
    System.String
    View Source

    DisplayName

    Gets a friendly name to describe the provider.

    Declaration
    [DataMember(Name = "displayName")]
    string DisplayName { get; }
    Property Value
    Type Description
    System.String
    View Source

    ForceCreateDatabase

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

    Declaration
    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
    [DataMember(Name = "id")]
    Guid Id { get; }
    Property Value
    Type Description
    Guid
    View Source

    IsAvailable

    Gets a value indicating whether should be available for selection.

    Declaration
    [DataMember(Name = "isAvailable")]
    bool IsAvailable { get; }
    Property Value
    Type Description
    System.Boolean
    View Source

    ProviderName

    Gets the database factory provider name.

    Declaration
    [DataMember(Name = "providerName")]
    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
    [DataMember(Name = "requiresConnectionTest")]
    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
    [DataMember(Name = "requiresCredentials")]
    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
    [DataMember(Name = "requiresServer")]
    bool RequiresServer { get; }
    Property Value
    Type Description
    System.Boolean
    View Source

    ServerPlaceholder

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

    Declaration
    [DataMember(Name = "serverPlaceholder")]
    string ServerPlaceholder { get; }
    Property Value
    Type Description
    System.String
    View Source

    SortOrder

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

    Declaration
    [DataMember(Name = "sortOrder")]
    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
    [DataMember(Name = "supportsIntegratedAuthentication")]
    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
    [DataMember(Name = "supportsQuickInstall")]
    bool SupportsQuickInstall { get; }
    Property Value
    Type Description
    System.Boolean

    Methods

    View Source

    CanRecognizeConnectionString(String)

    Gets a value indicating whether this connections could have been build using GenerateConnectionString(DatabaseModel).

    Declaration
    virtual bool CanRecognizeConnectionString(string connectionString)
    Parameters
    Type Name Description
    System.String connectionString
    Returns
    Type Description
    System.Boolean
    View Source

    GenerateConnectionString(DatabaseModel)

    Creates a connection string for this provider.

    Declaration
    string GenerateConnectionString(DatabaseModel databaseModel)
    Parameters
    Type Name Description
    DatabaseModel databaseModel
    Returns
    Type Description
    System.String
    • Improve this Doc
    • View Source
    In This Article
    • Properties
      • DefaultDatabaseName
      • DisplayName
      • ForceCreateDatabase
      • Id
      • IsAvailable
      • ProviderName
      • RequiresConnectionTest
      • RequiresCredentials
      • RequiresServer
      • ServerPlaceholder
      • SortOrder
      • SupportsIntegratedAuthentication
      • SupportsQuickInstall
    • Methods
      • CanRecognizeConnectionString(String)
      • GenerateConnectionString(DatabaseModel)
    Back to top Copyright © 2016-present Umbraco
    Generated by DocFX