Configuration

open class Configuration

Database Configuration class.

Indicates the name and location of the database.

  • The name of the database

    Important

    Database names are restricted to using only the following characters: abcdefghijklmnopqrstuvwxyz0123456789_$()+-/

    Declaration

    Swift

    open private(set) lazy var name: String = self.defaultDatabaseName()

  • The local file location of database files

    Declaration

    Swift

    open private(set) lazy var fileLocation: URL = self.defaultLocation()

  • Initialize new Database Configuration with optional name and file location

    Important

    Database names are restricted to using only the following characters: abcdefghijklmnopqrstuvwxyz0123456789_$()+-/

    Declaration

    Swift

    public init(name: String? = nil, fileLocation: URL? = nil)

    Parameters

    name

    name of database. If nil, will default to result of defaultDatabaseName()
    fileLocation

    local file location URL of database. If nil, will default to result of defaultLocation()

  • The default database file location used when no location is provided to the initializer.

    By default this will be a subdirectory of the application support path, except on tvOS, where it will be a subdirectory of the cache path.

    Declaration

    Swift

    open func defaultLocation() -> URL

  • The default database name used when no name is provided to the initializer.

    The base class default database name is pm

    Declaration

    Swift

    open func defaultDatabaseName() -> String

  • Configurations with matching locations and names are considered equivalent.

    Declaration

    Swift

    public static func == (lhs: Database.Configuration, rhs: Database.Configuration) -> Bool

  • Declaration

    Swift

    public var hashValue: Int