@capgo/capacitor-fast-sql
Fast SQL Plugin for high-performance SQLite database access.
Overview
Section titled “Overview”Fast SQL Plugin for high-performance SQLite database access.
Core Capabilities
Section titled “Core Capabilities”connect- Initialize the database connection and start the HTTP server.disconnect- Close database connection and stop the HTTP server.getServerInfo- Get the HTTP server port and token for direct communication.execute- Execute a SQL query via Capacitor bridge (for simple queries). For better performance with large datasets, use the HTTP protocol directly via SQLConnection class.
Public API
Section titled “Public API”| Method | Description |
|---|---|
connect | Initialize the database connection and start the HTTP server. |
disconnect | Close database connection and stop the HTTP server. |
getServerInfo | Get the HTTP server port and token for direct communication. |
execute | Execute a SQL query via Capacitor bridge (for simple queries). For better performance with large datasets, use the HTTP protocol directly via SQLConnection class. |
beginTransaction | Begin a database transaction. |
commitTransaction | Commit the current transaction. |
rollbackTransaction | Rollback the current transaction. |
getPluginVersion | Get the native Capacitor plugin version. |
configureWeb | Configure web-specific options for the sql.js WASM module. |
Source Of Truth
Section titled “Source Of Truth”This reference is synced from src/definitions.ts in capacitor-fast-sql.