VirtualTableCursor

public protocol VirtualTableCursor

A cursor for an SQLite virtual table

  • Returns the value of column index in the row at which the cursor is pointing

    Note

    Column indexes are 0-based

    Throws

    SQLiteError if an error occurs

    Declaration

    Swift

    func column(_ index: Int32) throws -> DatabaseValue

    Parameters

    index

    The desired column

    Return Value

    The value of column index in the current row

  • Advances the cursor to the next row of output

    Throws

    SQLiteError if an error occurs

    Declaration

    Swift

    func next() throws

  • Returns the rowid for the current row

    Throws

    SQLiteError if an error occurs

    Declaration

    Swift

    func rowid() throws -> Int64

    Return Value

    The rowid of the current row

  • Applies a filter to the virtual table

    Throws

    SQLiteError if an error occurs

    Declaration

    Swift

    func filter(_ arguments: [DatabaseValue], indexNumber: Int32, indexName: String?) throws

    Parameters

    arguments

    Arguments applicable to the query plan made in VirtualTableModule.bestIndex()
    indexNumber

    The index number returned by VirtualTableModule.bestIndex()
    indexName

    The index name returned by VirtualTableModule.bestIndex()
  • eof

    true if the cursor has been moved off the last row of output

    Declaration

    Swift

    var eof: Bool { get }