Index Structure Reference


                    
                    
                    init(_:unique:on:columns:)

Initialize an instance of Index.

Swift

public init(_ name: String, unique: Bool = false, on table: Table, columns: [IndexColumn])

`name`	The name of the index.
`unique`	An indication whether the index has to be unique.
`columns`	An array of columns of the index.


                    
                    
                    init(_:unique:on:columns:)

Initialize an instance of Index.

Swift

public init(_ name: String, unique: Bool = false, on table: Table, columns: IndexColumn...)

`name`	The name of the index.
`unique`	An indication whether the index has to be unique.
`columns`	A list of columns of the index.


                    
                    
                    create(connection:onCompletion:)

Create the index in the database.

Swift

public func create(connection: Connection, onCompletion: @escaping ((QueryResult) -> ()))

`connection`	The connection to the database.
`onCompletion`	The function to be called when the execution of the query has completed.


                    
                    
                    drop(connection:onCompletion:)

Drop the index from the database.

Swift

public func drop(connection: Connection, onCompletion: @escaping ((QueryResult) -> ()))

`connection`	The connection to the database.
`onCompletion`	The function to be called when the execution of the query has completed.


                    
                    
                    description(connection:)

Return a String representation of the index create statement.

Throws

QueryError.syntaxError if statement build fails.

Swift

public func description(connection: Connection) throws -> String

A String representation of the index create statement.