expo-sqlite/src/NativeStatement.ts

Provides access to a database using SQLite (https://www.sqlite.org/). The database is persisted across restarts of your app.

/**
 * A result returned by [`SQLiteDatabase.runAsync`](#runasyncsource-params) or [`SQLiteDatabase.runSync`](#runsyncsource-params).
 */
export interface SQLiteRunResult {
  /**
   * The last inserted row ID. Returned from the [`sqlite3_last_insert_rowid()`](https://www.sqlite.org/c3ref/last_insert_rowid.html) function.
   */
  lastInsertRowId: number;

  /**
   * The number of rows affected. Returned from the [`sqlite3_changes()`](https://www.sqlite.org/c3ref/changes.html) function.
   */
  changes: number;
}

/**
 * Bind parameters to the prepared statement.
 * You can either pass the parameters in the following forms:
 *
 * @example
 * A single array for unnamed parameters.
 * ```ts
 * const statement = await db.prepareAsync('SELECT * FROM test WHERE value = ? AND intValue = ?');
 * const result = await statement.executeAsync(['test1', 789]);
 * const firstRow = await result.getFirstAsync();
 * ```
 *
 * @example
 * Variadic arguments for unnamed parameters.
 * ```ts
 * const statement = await db.prepareAsync('SELECT * FROM test WHERE value = ? AND intValue = ?');
 * const result = await statement.executeAsync('test1', 789);
 * const firstRow = await result.getFirstAsync();
 * ```
 *
 * @example
 * A single object for [named parameters](https://www.sqlite.org/lang_expr.html)
 *
 * We support multiple named parameter forms such as `:VVV`, `@VVV`, and `$VVV`. We recommend using `$VVV` because JavaScript allows using `$` in identifiers without escaping.
 * ```ts
 * const statement = await db.prepareAsync('SELECT * FROM test WHERE value = $value AND intValue = $intValue');
 * const result = await statement.executeAsync({ $value: 'test1', $intValue: 789 });
 * const firstRow = await result.getFirstAsync();
 * ```
 */
export type SQLiteBindValue = string | number | null | boolean | Uint8Array;
export type SQLiteBindParams = Record<string, SQLiteBindValue> | SQLiteBindValue[];
export type SQLiteVariadicBindParams = SQLiteBindValue[];

export type SQLiteBindPrimitiveParams = Record<string, Exclude<SQLiteBindValue, Uint8Array>>;
export type SQLiteBindBlobParams = Record<string, Uint8Array>;
export type SQLiteColumnNames = string[];
export type SQLiteColumnValues = any[];
export type SQLiteAnyDatabase = any;

/**
 * A class that represents an instance of the SQLite statement.
 */
export declare class NativeStatement {
  //#region Asynchronous API

  public runAsync(
    database: SQLiteAnyDatabase,
    bindParams: SQLiteBindPrimitiveParams,
    bindBlobParams: SQLiteBindBlobParams,
    shouldPassAsArray: boolean
  ): Promise<SQLiteRunResult & { firstRowValues: SQLiteColumnValues }>;
  public stepAsync(database: SQLiteAnyDatabase): Promise<SQLiteColumnValues | null | undefined>;
  public getAllAsync(database: SQLiteAnyDatabase): Promise<SQLiteColumnValues[]>;
  public resetAsync(database: SQLiteAnyDatabase): Promise<void>;
  public getColumnNamesAsync(): Promise<SQLiteColumnNames>;
  public finalizeAsync(database: SQLiteAnyDatabase): Promise<void>;

  //#endregion

  //#region Synchronous API

  public runSync(
    database: SQLiteAnyDatabase,
    bindParams: SQLiteBindPrimitiveParams,
    bindBlobParams: SQLiteBindBlobParams,
    shouldPassAsArray: boolean
  ): SQLiteRunResult & { firstRowValues: SQLiteColumnValues };
  public stepSync(database: SQLiteAnyDatabase): SQLiteColumnValues | null | undefined;
  public getAllSync(database: SQLiteAnyDatabase): SQLiteColumnValues[];
  public resetSync(database: SQLiteAnyDatabase): void;
  public getColumnNamesSync(): string[];
  public finalizeSync(database: SQLiteAnyDatabase): void;

  //#endregion
}