GPKGResultSet

Objective-C

@interface GPKGResultSet : NSObject <NSFastEnumeration>

Swift

class GPKGResultSet : NSObject, NSFastEnumeration

Result set from a database query

Show on GitHub

  • SQL statement

    Declaration

    Objective-C

    @property (nonatomic) sqlite3_stmt *statement;

    Swift

    var statement: OpaquePointer! { get set }
    Show on GitHub
  • sql

    SQL string statement

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *sql;

    Swift

    var sql: String! { get set }
    Show on GitHub

  • SQL arguments

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray *args;

    Swift

    var args: [Any]! { get set }
    Show on GitHub

  • Result count

    Declaration

    Objective-C

    @property (nonatomic) int count;

    Swift

    var count: Int32 { get set }
    Show on GitHub

  • SQL Connection

    Declaration

    Objective-C

    @property (nonatomic, strong) GPKGDbConnection *connection;

    Swift

    var connection: GPKGDbConnection! { get set }
    Show on GitHub

  • Column Names

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *columnNames;

    Swift

    var columnNames: [String]! { get set }
    Show on GitHub

  • Column name to index mapping

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSNumber *> *columnIndex;

    Swift

    var columnIndex: [String : NSNumber]! { get set }
    Show on GitHub

  • User columns

    Declaration

    Objective-C

    @property (nonatomic, strong) GPKGUserColumns *columns;

    Swift

    var columns: GPKGUserColumns! { get set }
    Show on GitHub

  • Initialize

    Declaration

    Objective-C

    - (instancetype)initWithStatement:(sqlite3_stmt *)statement
                           andSql:(NSString *)sql
                          andArgs:(NSArray *)args
                         andCount:(int)count
                    andConnection:(GPKGDbConnection *)connection;

    Swift

    init!(statement: OpaquePointer!, andSql sql: String!, andArgs args: [Any]!, andCount count: Int32, andConnection connection: GPKGDbConnection!)

    Parameters

    statement

    statement
    sql

    SQL statement
    args

    SQL arguments
    count

    result count
    connection

    db connection

    Return Value

    new result set

    Show on GitHub

  • Initialize reusing existing result set statement and connection

    Declaration

    Objective-C

    - (instancetype)initWithResultSet:(GPKGResultSet *)resultSet;

    Swift

    init!(resultSet: GPKGResultSet!)

    Parameters

    resultSet

    result set

    Return Value

    new result set

    Show on GitHub

  • Move to the next result if one exists

    Declaration

    Objective-C

    - (BOOL)moveToNext;

    Swift

    func moveToNext() -> Bool

    Return Value

    true if a result found, false if no more results

    Show on GitHub

  • Move to the first result

    Declaration

    Objective-C

    - (BOOL)moveToFirst;

    Swift

    func moveToFirst() -> Bool

    Return Value

    reset code

    Show on GitHub

  • Move result to index position

    Declaration

    Objective-C

    - (BOOL)moveToPosition:(int)position;

    Swift

    func move(toPosition position: Int32) -> Bool

    Parameters

    position

    index position

    Return Value

    true if result at position found

    Show on GitHub

  • Close the result set

    Declaration

    Objective-C

    - (void)close;

    Swift

    func close()
    Show on GitHub

  • Close the result set statement, but leave the connection open

    Declaration

    Objective-C

    - (void)closeStatement;

    Swift

    func closeStatement()
    Show on GitHub

  • Get the column count

    Declaration

    Objective-C

    - (int)columnCount;

    Swift

    func columnCount() -> Int32

    Return Value

    count

    Show on GitHub

  • Get the row value

    Declaration

    Objective-C

    - (GPKGRow *)row;

    Swift

    func row() -> GPKGRow!

    Return Value

    row value

    Show on GitHub

  • Get the row values

    Declaration

    Objective-C

    - (NSArray<NSObject *> *)rowValues;

    Swift

    func rowValues() -> [NSObject]!

    Return Value

    row value array

    Show on GitHub

  • Get a row and populate with values

    Declaration

    Objective-C

    - (void)rowPopulateValues:(NSMutableArray *)values;

    Swift

    func rowPopulateValues(_ values: NSMutableArray!)

    Parameters

    values

    values
    Show on GitHub

  • Get value with column index

    Declaration

    Objective-C

    - (NSObject *)valueWithIndex:(int)index;

    Swift

    func value(with index: Int32) -> NSObject!

    Parameters

    index

    column index

    Return Value

    value

    Show on GitHub

  • Get the value for the column name

    Declaration

    Objective-C

    - (NSObject *)valueWithColumnName:(NSString *)columnName;

    Swift

    func value(withColumnName columnName: String!) -> NSObject!

    Parameters

    columnName

    column name

    Return Value

    value

    Show on GitHub

  • Get column index for column name

    Declaration

    Objective-C

    - (int)columnIndexWithName:(NSString *)columnName;

    Swift

    func columnIndex(withName columnName: String!) -> Int32

    Parameters

    columnName

    column name

    Return Value

    index

    Show on GitHub

  • Get the column type of the column index

    Declaration

    Objective-C

    - (int)type:(int)columnIndex;

    Swift

    func type(_ columnIndex: Int32) -> Int32

    Parameters

    columnIndex

    index

    Return Value

    column type

    Show on GitHub

  • Get the string value at the column index

    Declaration

    Objective-C

    - (NSString *)stringWithIndex:(int)columnIndex;

    Swift

    func string(with columnIndex: Int32) -> String!

    Parameters

    columnIndex

    column index

    Return Value

    string value

    Show on GitHub

  • Get the int value at the column index

    Declaration

    Objective-C

    - (NSNumber *)intWithIndex:(int)columnIndex;

    Swift

    func int(with columnIndex: Int32) -> NSNumber!

    Parameters

    columnIndex

    column index

    Return Value

    int number

    Show on GitHub

  • Get the blob value at the column index

    Declaration

    Objective-C

    - (NSData *)blobWithIndex:(int)columnIndex;

    Swift

    func blob(with columnIndex: Int32) -> Data!

    Parameters

    columnIndex

    column index

    Return Value

    blob data

    Show on GitHub

  • Get the long value at the column index

    Declaration

    Objective-C

    - (NSNumber *)longWithIndex:(int)columnIndex;

    Swift

    func long(with columnIndex: Int32) -> NSNumber!

    Parameters

    columnIndex

    column index

    Return Value

    long number

    Show on GitHub

  • Get the double value at the column index

    Declaration

    Objective-C

    - (NSNumber *)doubleWithIndex:(int)columnIndex;

    Swift

    func double(with columnIndex: Int32) -> NSNumber!

    Parameters

    columnIndex

    column index

    Return Value

    double number

    Show on GitHub

  • Get the result count and close the result set

    Declaration

    Objective-C

    - (int)countAndClose;

    Swift

    func countAndClose() -> Int32

    Return Value

    result count

    Show on GitHub

  • Set the columns from the user table

    Declaration

    Objective-C

    - (void)setColumnsFromTable:(GPKGUserTable *)table;

    Swift

    func setColumnsFrom(_ table: GPKGUserTable!)

    Parameters

    table

    user table
    Show on GitHub
  • -id

    Get the id value

    Declaration

    Objective-C

    - (NSNumber *)id;

    Swift

    func id() -> NSNumber!

    Return Value

    id value

    Show on GitHub

  • Get the id value

    Declaration

    Objective-C

    - (int)idValue;

    Swift

    func idValue() -> Int32

    Return Value

    id value, or -1 if none

    Show on GitHub