mirror of
https://github.com/aljazceru/turso.git
synced 2025-12-17 08:34:19 +01:00
974feac27b
- now, most of the work is happening on the main thread - for database in browser, we still have dedicated WebWorker - but it is used only for OPFS access and only for that - for syn in browser we still offload sync operations to the WebWorker
132 lines
3.4 KiB
TypeScript
132 lines
3.4 KiB
TypeScript
/* auto-generated by NAPI-RS */
|
|
/* eslint-disable */
|
|
/** A database connection. */
|
|
export declare class Database {
|
|
/**
|
|
* Creates a new database instance.
|
|
*
|
|
* # Arguments
|
|
* * `path` - The path to the database file.
|
|
*/
|
|
constructor(path: string, opts?: DatabaseOpts | undefined | null)
|
|
/** Returns whether the database is in memory-only mode. */
|
|
get memory(): boolean
|
|
/** Returns whether the database is in memory-only mode. */
|
|
get path(): string
|
|
/** Returns whether the database connection is open. */
|
|
get open(): boolean
|
|
/**
|
|
* Prepares a statement for execution.
|
|
*
|
|
* # Arguments
|
|
*
|
|
* * `sql` - The SQL statement to prepare.
|
|
*
|
|
* # Returns
|
|
*
|
|
* A `Statement` instance.
|
|
*/
|
|
prepare(sql: string): Statement
|
|
/**
|
|
* Returns the rowid of the last row inserted.
|
|
*
|
|
* # Returns
|
|
*
|
|
* The rowid of the last row inserted.
|
|
*/
|
|
lastInsertRowid(): number
|
|
/**
|
|
* Returns the number of changes made by the last statement.
|
|
*
|
|
* # Returns
|
|
*
|
|
* The number of changes made by the last statement.
|
|
*/
|
|
changes(): number
|
|
/**
|
|
* Returns the total number of changes made by all statements.
|
|
*
|
|
* # Returns
|
|
*
|
|
* The total number of changes made by all statements.
|
|
*/
|
|
totalChanges(): number
|
|
/**
|
|
* Closes the database connection.
|
|
*
|
|
* # Returns
|
|
*
|
|
* `Ok(())` if the database is closed successfully.
|
|
*/
|
|
close(): void
|
|
/**
|
|
* Sets the default safe integers mode for all statements from this database.
|
|
*
|
|
* # Arguments
|
|
*
|
|
* * `toggle` - Whether to use safe integers by default.
|
|
*/
|
|
defaultSafeIntegers(toggle?: boolean | undefined | null): void
|
|
/** Runs the I/O loop synchronously. */
|
|
ioLoopSync(): void
|
|
/** Runs the I/O loop asynchronously, returning a Promise. */
|
|
ioLoopAsync(): Promise<void>
|
|
}
|
|
|
|
/** A prepared statement. */
|
|
export declare class Statement {
|
|
reset(): void
|
|
/** Returns the number of parameters in the statement. */
|
|
parameterCount(): number
|
|
/**
|
|
* Returns the name of a parameter at a specific 1-based index.
|
|
*
|
|
* # Arguments
|
|
*
|
|
* * `index` - The 1-based parameter index.
|
|
*/
|
|
parameterName(index: number): string | null
|
|
/**
|
|
* Binds a parameter at a specific 1-based index with explicit type.
|
|
*
|
|
* # Arguments
|
|
*
|
|
* * `index` - The 1-based parameter index.
|
|
* * `value_type` - The type constant (0=null, 1=int, 2=float, 3=text, 4=blob).
|
|
* * `value` - The value to bind.
|
|
*/
|
|
bindAt(index: number, value: unknown): void
|
|
/**
|
|
* Step the statement and return result code (executed on the main thread):
|
|
* 1 = Row available, 2 = Done, 3 = I/O needed
|
|
*/
|
|
stepSync(): number
|
|
/**
|
|
* Step the statement and return result code (executed on the background thread):
|
|
* 1 = Row available, 2 = Done, 3 = I/O needed
|
|
*/
|
|
stepAsync(): Promise<number>
|
|
/** Get the current row data according to the presentation mode */
|
|
row(): unknown
|
|
/** Sets the presentation mode to raw. */
|
|
raw(raw?: boolean | undefined | null): void
|
|
/** Sets the presentation mode to pluck. */
|
|
pluck(pluck?: boolean | undefined | null): void
|
|
/**
|
|
* Sets safe integers mode for this statement.
|
|
*
|
|
* # Arguments
|
|
*
|
|
* * `toggle` - Whether to use safe integers.
|
|
*/
|
|
safeIntegers(toggle?: boolean | undefined | null): void
|
|
/** Get column information for the statement */
|
|
columns(): Promise<any>
|
|
/** Finalizes the statement. */
|
|
finalize(): void
|
|
}
|
|
|
|
export interface DatabaseOpts {
|
|
tracing?: string
|
|
}
|