DesignDocument

public struct DesignDocument: Document

This struct represents the agreed upon fields and structure of a design documents. The filters, lists, shows and updates fields objects are mapping of function name to string function source code. The views mapping is the same except that values are objects with map and reduce (optional) keys which also contains functions source code.

CouchDB reference: /db/_design/design-doc

Document fields

_id
The document ID.
Declaration
Swift

public let _id: String?
_rev
The document revision.
Declaration
Swift

public let _rev: String?

Configuration

language
The Query Server key to process design document functions. If this is nil, the language is assumed to be Javascript.
Declaration
Swift

public let language: String?
options
The View’s default options.
Declaration
Swift

public let options: [String: Bool]?

Functions

filters
Filter functions definition. http://docs.couchdb.org/en/2.2.0/ddocs/ddocs.html#filterfun
Declaration
Swift

public let filters: [String: String]?
lists
List functions definition. http://docs.couchdb.org/en/2.2.0/ddocs/ddocs.html#listfun
Declaration
Swift

public let lists: [String: String]?
rewrites
Rewrite rules definition.
Declaration
Swift

public let rewrites: [String]?
shows
Show functions definition. http://docs.couchdb.org/en/2.2.0/ddocs/ddocs.html#showfun
Declaration
Swift

public let shows: [String: String]?
updates
Update functions definition. http://docs.couchdb.org/en/2.2.0/ddocs/ddocs.html#updatefun
Declaration
Swift

public let updates: [String: String]?
validate_doc_update
Validate document update function source. http://docs.couchdb.org/en/2.2.0/ddocs/ddocs.html#vdufun
Declaration
Swift

public let validate_doc_update: String?
views
View functions definition. http://docs.couchdb.org/en/2.2.0/ddocs/ddocs.html#viewfun
Declaration
Swift

public let views: [String: [String: String]]?

Initializer


                    
                    
                    init(_id:_rev:language:options:filters:lists:rewrites:shows:updates:validate_doc_update:views:)

Initialize a DesignDocument instance.

Declaration

Swift

public init(_id: String? = nil,
        _rev: String? = nil,
        language: String? = nil,
        options: [String: Bool]? = nil,
        filters: [String: String]? = nil,
        lists: [String: String]? = nil,
        rewrites: [String]? = nil,
        shows: [String: String]? = nil,
        updates: [String: String]? = nil,
        validate_doc_update: String? = nil,
        views: [String: [String: String]]? = nil
)

Parameters

`language`	The coding language.
`options`	The View’s default options.
`filters`	Filter functions definition.
`lists`	Lists functions definition.
`rewrites`	Rewrite rules definition.
`shows`	Show functions definition.
`updates`	Update functions definition.
`views`	View functions definition.