├── .gitignore ├── Cargo.toml ├── LICENSE.spdx ├── LICENSE_APACHE-2.0 ├── LICENSE_MIT ├── README.md ├── banner.png ├── dist-js ├── index.d.ts ├── index.min.js ├── index.min.js.map ├── index.mjs └── index.mjs.map ├── guest-js └── index.ts ├── package.json ├── rollup.config.mjs ├── src ├── decode │ ├── mod.rs │ ├── mysql.rs │ ├── postgres.rs │ └── sqlite.rs ├── lib.rs └── plugin.rs └── tsconfig.json /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "tauri-plugin-sql" 3 | version = "0.0.0" 4 | description = "Interface with SQL databases." 5 | authors = { workspace = true } 6 | license = { workspace = true } 7 | edition = { workspace = true } 8 | #rust-version = { workspace = true } 9 | rust-version = "1.80" 10 | 11 | # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html 12 | 13 | [dependencies] 14 | serde = { workspace = true } 15 | serde_json = { workspace = true } 16 | tauri = { workspace = true } 17 | log = { workspace = true } 18 | thiserror = { workspace = true } 19 | futures-core = "0.3" 20 | sqlx = { version = "0.8", features = ["json", "time"] } 21 | time = "0.3" 22 | tokio = { version = "1", features = ["sync"] } 23 | 24 | [features] 25 | sqlite = ["sqlx/sqlite", "sqlx/runtime-tokio"] 26 | mysql = ["sqlx/mysql", "sqlx/runtime-tokio-rustls"] 27 | postgres = ["sqlx/postgres", "sqlx/runtime-tokio-rustls"] 28 | -------------------------------------------------------------------------------- /LICENSE.spdx: -------------------------------------------------------------------------------- 1 | SPDXVersion: SPDX-2.1 2 | DataLicense: CC0-1.0 3 | PackageName: tauri 4 | DataFormat: SPDXRef-1 5 | PackageSupplier: Organization: The Tauri Programme in the Commons Conservancy 6 | PackageHomePage: https://tauri.app 7 | PackageLicenseDeclared: Apache-2.0 8 | PackageLicenseDeclared: MIT 9 | PackageCopyrightText: 2019-2022, The Tauri Programme in the Commons Conservancy 10 | PackageSummary: Tauri is a rust project that enables developers to make secure 11 | and small desktop applications using a web frontend. 12 | 13 | PackageComment: The package includes the following libraries; see 14 | Relationship information. 15 | 16 | Created: 2019-05-20T09:00:00Z 17 | PackageDownloadLocation: git://github.com/tauri-apps/tauri 18 | PackageDownloadLocation: git+https://github.com/tauri-apps/tauri.git 19 | PackageDownloadLocation: git+ssh://github.com/tauri-apps/tauri.git 20 | Creator: Person: Daniel Thompson-Yvetot -------------------------------------------------------------------------------- /LICENSE_APACHE-2.0: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS -------------------------------------------------------------------------------- /LICENSE_MIT: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2017 - Present Tauri Apps Contributors 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![plugin-sql](https://github.com/tauri-apps/plugins-workspace/raw/v1/plugins/sql/banner.png) 2 | 3 | Interface with SQL databases through [sqlx](https://github.com/launchbadge/sqlx). It supports the `sqlite`, `mysql` and `postgres` drivers, enabled by a Cargo feature. 4 | 5 | ## Install 6 | 7 | _This plugin requires a Rust version of at least **1.80**_ 8 | 9 | There are three general methods of installation that we can recommend. 10 | 11 | 1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked) 12 | 2. Pull sources directly from Github using git tags / revision hashes (most secure) 13 | 3. Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use) 14 | 15 | Install the Core plugin by adding the following to your `Cargo.toml` file: 16 | 17 | `src-tauri/Cargo.toml` 18 | 19 | ```toml 20 | [dependencies.tauri-plugin-sql] 21 | git = "https://github.com/tauri-apps/plugins-workspace" 22 | branch = "v1" 23 | features = ["sqlite"] # or "postgres", or "mysql" 24 | ``` 25 | 26 | You can install the JavaScript Guest bindings using your preferred JavaScript package manager: 27 | 28 | > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. 29 | 30 | ```sh 31 | pnpm add https://github.com/tauri-apps/tauri-plugin-sql#v1 32 | # or 33 | npm add https://github.com/tauri-apps/tauri-plugin-sql#v1 34 | # or 35 | yarn add https://github.com/tauri-apps/tauri-plugin-sql#v1 36 | ``` 37 | 38 | ## Usage 39 | 40 | First you need to register the core plugin with Tauri: 41 | 42 | `src-tauri/src/main.rs` 43 | 44 | ```rust 45 | fn main() { 46 | tauri::Builder::default() 47 | .plugin(tauri_plugin_sql::Builder::default().build()) 48 | .run(tauri::generate_context!()) 49 | .expect("error while running tauri application"); 50 | } 51 | ``` 52 | 53 | Afterwards all the plugin's APIs are available through the JavaScript guest bindings: 54 | 55 | ```javascript 56 | import Database from "tauri-plugin-sql-api"; 57 | 58 | // sqlite. The path is relative to `tauri::api::path::BaseDirectory::App`. 59 | const db = await Database.load("sqlite:test.db"); 60 | // mysql 61 | const db = await Database.load("mysql://user:pass@host/database"); 62 | // postgres 63 | const db = await Database.load("postgres://postgres:password@localhost/test"); 64 | 65 | await db.execute("INSERT INTO ..."); 66 | ``` 67 | 68 | ## Syntax 69 | 70 | We use sqlx as our underlying library, adopting their query syntax: 71 | 72 | - sqlite and postgres use the "$#" syntax when substituting query data 73 | - mysql uses "?" when substituting query data 74 | 75 | ```javascript 76 | // INSERT and UPDATE examples for sqlite and postgres 77 | const result = await db.execute( 78 | "INSERT into todos (id, title, status) VALUES ($1, $2, $3)", 79 | [todos.id, todos.title, todos.status], 80 | ); 81 | 82 | const result = await db.execute( 83 | "UPDATE todos SET title = $1, completed = $2 WHERE id = $3", 84 | [todos.title, todos.status, todos.id], 85 | ); 86 | 87 | // INSERT and UPDATE examples for mysql 88 | const result = await db.execute( 89 | "INSERT into todos (id, title, status) VALUES (?, ?, ?)", 90 | [todos.id, todos.title, todos.status], 91 | ); 92 | 93 | const result = await db.execute( 94 | "UPDATE todos SET title = ?, completed = ? WHERE id = ?", 95 | [todos.title, todos.status, todos.id], 96 | ); 97 | ``` 98 | 99 | ## Migrations 100 | 101 | This plugin supports database migrations, allowing you to manage database schema evolution over time. 102 | 103 | ### Defining Migrations 104 | 105 | Migrations are defined in Rust using the `Migration` struct. Each migration should include a unique version number, a description, the SQL to be executed, and the type of migration (Up or Down). 106 | 107 | Example of a migration: 108 | 109 | ```rust 110 | use tauri_plugin_sql::{Migration, MigrationKind}; 111 | 112 | let migration = Migration { 113 | version: 1, 114 | description: "create_initial_tables", 115 | sql: "CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT);", 116 | kind: MigrationKind::Up, 117 | }; 118 | ``` 119 | 120 | ### Adding Migrations to the Plugin Builder 121 | 122 | Migrations are registered with the `Builder` struct provided by the plugin. Use the `add_migrations` method to add your migrations to the plugin for a specific database connection. 123 | 124 | Example of adding migrations: 125 | 126 | ```rust 127 | use tauri_plugin_sql::{Builder, Migration, MigrationKind}; 128 | 129 | fn main() { 130 | let migrations = vec![ 131 | // Define your migrations here 132 | Migration { 133 | version: 1, 134 | description: "create_initial_tables", 135 | sql: "CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT);", 136 | kind: MigrationKind::Up, 137 | } 138 | ]; 139 | 140 | tauri::Builder::default() 141 | .plugin( 142 | tauri_plugin_sql::Builder::default() 143 | .add_migrations("sqlite:mydatabase.db", migrations) 144 | .build(), 145 | ) 146 | ... 147 | } 148 | ``` 149 | 150 | ### Applying Migrations 151 | 152 | Migrations are applied automatically when the plugin is initialized. The plugin runs these migrations against the database specified by the connection string. Ensure that the migrations are defined in the correct order and are idempotent (safe to run multiple times). 153 | 154 | ### Migration Management 155 | 156 | - **Version Control**: Each migration must have a unique version number. This is crucial for ensuring the migrations are applied in the correct order. 157 | - **Idempotency**: Write migrations in a way that they can be safely re-run without causing errors or unintended consequences. 158 | - **Testing**: Thoroughly test migrations to ensure they work as expected and do not compromise the integrity of your database. 159 | 160 | ## Contributing 161 | 162 | PRs accepted. Please make sure to read the Contributing Guide before making a pull request. 163 | 164 | ## Partners 165 | 166 | 167 | 168 | 169 | 174 | 175 | 176 |
170 | 171 | CrabNebula 172 | 173 |
177 | 178 | For the complete list of sponsors please visit our [website](https://tauri.app#sponsors) and [Open Collective](https://opencollective.com/tauri). 179 | 180 | ## License 181 | 182 | Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy. 183 | 184 | MIT or MIT/Apache 2.0 where applicable. 185 | -------------------------------------------------------------------------------- /banner.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tauri-apps/tauri-plugin-sql/f766cdacba244a135b11c4c5d6b8d561618d0b58/banner.png -------------------------------------------------------------------------------- /dist-js/index.d.ts: -------------------------------------------------------------------------------- 1 | export interface QueryResult { 2 | /** The number of rows affected by the query. */ 3 | rowsAffected: number; 4 | /** 5 | * The last inserted `id`. 6 | * 7 | * This value is always `0` when using the Postgres driver. If the 8 | * last inserted id is required on Postgres, the `select` function 9 | * must be used, with a `RETURNING` clause 10 | * (`INSERT INTO todos (title) VALUES ($1) RETURNING id`). 11 | */ 12 | lastInsertId: number; 13 | } 14 | /** 15 | * **Database** 16 | * 17 | * The `Database` class serves as the primary interface for 18 | * communicating with the rust side of the sql plugin. 19 | */ 20 | export default class Database { 21 | path: string; 22 | constructor(path: string); 23 | /** 24 | * **load** 25 | * 26 | * A static initializer which connects to the underlying database and 27 | * returns a `Database` instance once a connection to the database is established. 28 | * 29 | * # Sqlite 30 | * 31 | * The path is relative to `tauri::api::path::BaseDirectory::App` and must start with `sqlite:`. 32 | * 33 | * @example 34 | * ```ts 35 | * const db = await Database.load("sqlite:test.db"); 36 | * ``` 37 | */ 38 | static load(path: string): Promise; 39 | /** 40 | * **get** 41 | * 42 | * A static initializer which synchronously returns an instance of 43 | * the Database class while deferring the actual database connection 44 | * until the first invocation or selection on the database. 45 | * 46 | * # Sqlite 47 | * 48 | * The path is relative to `tauri::api::path::BaseDirectory::App` and must start with `sqlite:`. 49 | * 50 | * @example 51 | * ```ts 52 | * const db = Database.get("sqlite:test.db"); 53 | * ``` 54 | */ 55 | static get(path: string): Database; 56 | /** 57 | * **execute** 58 | * 59 | * Passes a SQL expression to the database for execution. 60 | * 61 | * @example 62 | * ```ts 63 | * // for sqlite & postgres 64 | * // INSERT example 65 | * const result = await db.execute( 66 | * "INSERT into todos (id, title, status) VALUES ($1, $2, $3)", 67 | * [ todos.id, todos.title, todos.status ] 68 | * ); 69 | * // UPDATE example 70 | * const result = await db.execute( 71 | * "UPDATE todos SET title = $1, completed = $2 WHERE id = $3", 72 | * [ todos.title, todos.status, todos.id ] 73 | * ); 74 | * 75 | * // for mysql 76 | * // INSERT example 77 | * const result = await db.execute( 78 | * "INSERT into todos (id, title, status) VALUES (?, ?, ?)", 79 | * [ todos.id, todos.title, todos.status ] 80 | * ); 81 | * // UPDATE example 82 | * const result = await db.execute( 83 | * "UPDATE todos SET title = ?, completed = ? WHERE id = ?", 84 | * [ todos.title, todos.status, todos.id ] 85 | * ); 86 | * ``` 87 | */ 88 | execute(query: string, bindValues?: unknown[]): Promise; 89 | /** 90 | * **select** 91 | * 92 | * Passes in a SELECT query to the database for execution. 93 | * 94 | * @example 95 | * ```ts 96 | * // for sqlite & postgres 97 | * const result = await db.select( 98 | * "SELECT * from todos WHERE id = $1", id 99 | * ); 100 | * 101 | * // for mysql 102 | * const result = await db.select( 103 | * "SELECT * from todos WHERE id = ?", id 104 | * ); 105 | * ``` 106 | */ 107 | select(query: string, bindValues?: unknown[]): Promise; 108 | /** 109 | * **close** 110 | * 111 | * Closes the database connection pool. 112 | * 113 | * @example 114 | * ```ts 115 | * const success = await db.close() 116 | * ``` 117 | * @param db - Optionally state the name of a database if you are managing more than one. Otherwise, all database pools will be in scope. 118 | */ 119 | close(db?: string): Promise; 120 | } 121 | -------------------------------------------------------------------------------- /dist-js/index.min.js: -------------------------------------------------------------------------------- 1 | // Copyright 2019-2023 Tauri Programme within The Commons Conservancy 2 | // SPDX-License-Identifier: Apache-2.0 3 | // SPDX-License-Identifier: MIT 4 | /** @ignore */ 5 | function uid() { 6 | return window.crypto.getRandomValues(new Uint32Array(1))[0]; 7 | } 8 | /** 9 | * Transforms a callback function to a string identifier that can be passed to the backend. 10 | * The backend uses the identifier to `eval()` the callback. 11 | * 12 | * @return A unique identifier associated with the callback function. 13 | * 14 | * @since 1.0.0 15 | */ 16 | function transformCallback(callback, once = false) { 17 | const identifier = uid(); 18 | const prop = `_${identifier}`; 19 | Object.defineProperty(window, prop, { 20 | value: (result) => { 21 | if (once) { 22 | Reflect.deleteProperty(window, prop); 23 | } 24 | return callback === null || callback === void 0 ? void 0 : callback(result); 25 | }, 26 | writable: false, 27 | configurable: true 28 | }); 29 | return identifier; 30 | } 31 | /** 32 | * Sends a message to the backend. 33 | * @example 34 | * ```typescript 35 | * import { invoke } from '@tauri-apps/api/tauri'; 36 | * await invoke('login', { user: 'tauri', password: 'poiwe3h4r5ip3yrhtew9ty' }); 37 | * ``` 38 | * 39 | * @param cmd The command name. 40 | * @param args The optional arguments to pass to the command. 41 | * @return A promise resolving or rejecting to the backend response. 42 | * 43 | * @since 1.0.0 44 | */ 45 | async function invoke(cmd, args = {}) { 46 | return new Promise((resolve, reject) => { 47 | const callback = transformCallback((e) => { 48 | resolve(e); 49 | Reflect.deleteProperty(window, `_${error}`); 50 | }, true); 51 | const error = transformCallback((e) => { 52 | reject(e); 53 | Reflect.deleteProperty(window, `_${callback}`); 54 | }, true); 55 | window.__TAURI_IPC__({ 56 | cmd, 57 | callback, 58 | error, 59 | ...args 60 | }); 61 | }); 62 | } 63 | 64 | /** 65 | * **Database** 66 | * 67 | * The `Database` class serves as the primary interface for 68 | * communicating with the rust side of the sql plugin. 69 | */ 70 | class Database { 71 | constructor(path) { 72 | this.path = path; 73 | } 74 | /** 75 | * **load** 76 | * 77 | * A static initializer which connects to the underlying database and 78 | * returns a `Database` instance once a connection to the database is established. 79 | * 80 | * # Sqlite 81 | * 82 | * The path is relative to `tauri::api::path::BaseDirectory::App` and must start with `sqlite:`. 83 | * 84 | * @example 85 | * ```ts 86 | * const db = await Database.load("sqlite:test.db"); 87 | * ``` 88 | */ 89 | static async load(path) { 90 | const _path = await invoke("plugin:sql|load", { 91 | db: path, 92 | }); 93 | return new Database(_path); 94 | } 95 | /** 96 | * **get** 97 | * 98 | * A static initializer which synchronously returns an instance of 99 | * the Database class while deferring the actual database connection 100 | * until the first invocation or selection on the database. 101 | * 102 | * # Sqlite 103 | * 104 | * The path is relative to `tauri::api::path::BaseDirectory::App` and must start with `sqlite:`. 105 | * 106 | * @example 107 | * ```ts 108 | * const db = Database.get("sqlite:test.db"); 109 | * ``` 110 | */ 111 | static get(path) { 112 | return new Database(path); 113 | } 114 | /** 115 | * **execute** 116 | * 117 | * Passes a SQL expression to the database for execution. 118 | * 119 | * @example 120 | * ```ts 121 | * // for sqlite & postgres 122 | * // INSERT example 123 | * const result = await db.execute( 124 | * "INSERT into todos (id, title, status) VALUES ($1, $2, $3)", 125 | * [ todos.id, todos.title, todos.status ] 126 | * ); 127 | * // UPDATE example 128 | * const result = await db.execute( 129 | * "UPDATE todos SET title = $1, completed = $2 WHERE id = $3", 130 | * [ todos.title, todos.status, todos.id ] 131 | * ); 132 | * 133 | * // for mysql 134 | * // INSERT example 135 | * const result = await db.execute( 136 | * "INSERT into todos (id, title, status) VALUES (?, ?, ?)", 137 | * [ todos.id, todos.title, todos.status ] 138 | * ); 139 | * // UPDATE example 140 | * const result = await db.execute( 141 | * "UPDATE todos SET title = ?, completed = ? WHERE id = ?", 142 | * [ todos.title, todos.status, todos.id ] 143 | * ); 144 | * ``` 145 | */ 146 | async execute(query, bindValues) { 147 | const [rowsAffected, lastInsertId] = await invoke("plugin:sql|execute", { 148 | db: this.path, 149 | query, 150 | values: bindValues !== null && bindValues !== void 0 ? bindValues : [], 151 | }); 152 | return { 153 | lastInsertId, 154 | rowsAffected, 155 | }; 156 | } 157 | /** 158 | * **select** 159 | * 160 | * Passes in a SELECT query to the database for execution. 161 | * 162 | * @example 163 | * ```ts 164 | * // for sqlite & postgres 165 | * const result = await db.select( 166 | * "SELECT * from todos WHERE id = $1", id 167 | * ); 168 | * 169 | * // for mysql 170 | * const result = await db.select( 171 | * "SELECT * from todos WHERE id = ?", id 172 | * ); 173 | * ``` 174 | */ 175 | async select(query, bindValues) { 176 | const result = await invoke("plugin:sql|select", { 177 | db: this.path, 178 | query, 179 | values: bindValues !== null && bindValues !== void 0 ? bindValues : [], 180 | }); 181 | return result; 182 | } 183 | /** 184 | * **close** 185 | * 186 | * Closes the database connection pool. 187 | * 188 | * @example 189 | * ```ts 190 | * const success = await db.close() 191 | * ``` 192 | * @param db - Optionally state the name of a database if you are managing more than one. Otherwise, all database pools will be in scope. 193 | */ 194 | async close(db) { 195 | const success = await invoke("plugin:sql|close", { 196 | db, 197 | }); 198 | return success; 199 | } 200 | } 201 | 202 | export { Database as default }; 203 | //# sourceMappingURL=index.min.js.map 204 | -------------------------------------------------------------------------------- /dist-js/index.min.js.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.min.js","sources":["../../../node_modules/.pnpm/@tauri-apps+api@1.6.0/node_modules/@tauri-apps/api/tauri.js","../guest-js/index.ts"],"sourcesContent":["// Copyright 2019-2023 Tauri Programme within The Commons Conservancy\n// SPDX-License-Identifier: Apache-2.0\n// SPDX-License-Identifier: MIT\n/** @ignore */\nfunction uid() {\n return window.crypto.getRandomValues(new Uint32Array(1))[0];\n}\n/**\n * Transforms a callback function to a string identifier that can be passed to the backend.\n * The backend uses the identifier to `eval()` the callback.\n *\n * @return A unique identifier associated with the callback function.\n *\n * @since 1.0.0\n */\nfunction transformCallback(callback, once = false) {\n const identifier = uid();\n const prop = `_${identifier}`;\n Object.defineProperty(window, prop, {\n value: (result) => {\n if (once) {\n Reflect.deleteProperty(window, prop);\n }\n return callback === null || callback === void 0 ? void 0 : callback(result);\n },\n writable: false,\n configurable: true\n });\n return identifier;\n}\n/**\n * Sends a message to the backend.\n * @example\n * ```typescript\n * import { invoke } from '@tauri-apps/api/tauri';\n * await invoke('login', { user: 'tauri', password: 'poiwe3h4r5ip3yrhtew9ty' });\n * ```\n *\n * @param cmd The command name.\n * @param args The optional arguments to pass to the command.\n * @return A promise resolving or rejecting to the backend response.\n *\n * @since 1.0.0\n */\nasync function invoke(cmd, args = {}) {\n return new Promise((resolve, reject) => {\n const callback = transformCallback((e) => {\n resolve(e);\n Reflect.deleteProperty(window, `_${error}`);\n }, true);\n const error = transformCallback((e) => {\n reject(e);\n Reflect.deleteProperty(window, `_${callback}`);\n }, true);\n window.__TAURI_IPC__({\n cmd,\n callback,\n error,\n ...args\n });\n });\n}\n/**\n * Convert a device file path to an URL that can be loaded by the webview.\n * Note that `asset:` and `https://asset.localhost` must be added to [`tauri.security.csp`](https://tauri.app/v1/api/config/#securityconfig.csp) in `tauri.conf.json`.\n * Example CSP value: `\"csp\": \"default-src 'self'; img-src 'self' asset: https://asset.localhost\"` to use the asset protocol on image sources.\n *\n * Additionally, `asset` must be added to [`tauri.allowlist.protocol`](https://tauri.app/v1/api/config/#allowlistconfig.protocol)\n * in `tauri.conf.json` and its access scope must be defined on the `assetScope` array on the same `protocol` object.\n * For example:\n * ```json\n * {\n * \"tauri\": {\n * \"allowlist\": {\n * \"protocol\": {\n * \"asset\": true,\n * \"assetScope\": [\"$APPDATA/assets/*\"]\n * }\n * }\n * }\n * }\n * ```\n *\n * @param filePath The file path.\n * @param protocol The protocol to use. Defaults to `asset`. You only need to set this when using a custom protocol.\n * @example\n * ```typescript\n * import { appDataDir, join } from '@tauri-apps/api/path';\n * import { convertFileSrc } from '@tauri-apps/api/tauri';\n * const appDataDirPath = await appDataDir();\n * const filePath = await join(appDataDirPath, 'assets/video.mp4');\n * const assetUrl = convertFileSrc(filePath);\n *\n * const video = document.getElementById('my-video');\n * const source = document.createElement('source');\n * source.type = 'video/mp4';\n * source.src = assetUrl;\n * video.appendChild(source);\n * video.load();\n * ```\n *\n * @return the URL that can be used as source on the webview.\n *\n * @since 1.0.0\n */\nfunction convertFileSrc(filePath, protocol = 'asset') {\n return window.__TAURI__.convertFileSrc(filePath, protocol);\n}\n\nexport { convertFileSrc, invoke, transformCallback };\n",null],"names":[],"mappings":"AAAA;AACA;AACA;AACA;AACA,SAAS,GAAG,GAAG;AACf,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/D;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAAS,iBAAiB,CAAC,QAAQ,EAAE,IAAI,GAAG,KAAK,EAAE;AACnD,IAAI,MAAM,UAAU,GAAG,GAAG,EAAE;AAC5B,IAAI,MAAM,IAAI,GAAG,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;AACjC,IAAI,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE;AACxC,QAAQ,KAAK,EAAE,CAAC,MAAM,KAAK;AAC3B,YAAY,IAAI,IAAI,EAAE;AACtB,gBAAgB,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC;AACpD;AACA,YAAY,OAAO,QAAQ,KAAK,IAAI,IAAI,QAAQ,KAAK,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;AACvF,SAAS;AACT,QAAQ,QAAQ,EAAE,KAAK;AACvB,QAAQ,YAAY,EAAE;AACtB,KAAK,CAAC;AACN,IAAI,OAAO,UAAU;AACrB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,eAAe,MAAM,CAAC,GAAG,EAAE,IAAI,GAAG,EAAE,EAAE;AACtC,IAAI,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,KAAK;AAC5C,QAAQ,MAAM,QAAQ,GAAG,iBAAiB,CAAC,CAAC,CAAC,KAAK;AAClD,YAAY,OAAO,CAAC,CAAC,CAAC;AACtB,YAAY,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;AACvD,SAAS,EAAE,IAAI,CAAC;AAChB,QAAQ,MAAM,KAAK,GAAG,iBAAiB,CAAC,CAAC,CAAC,KAAK;AAC/C,YAAY,MAAM,CAAC,CAAC,CAAC;AACrB,YAAY,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;AAC1D,SAAS,EAAE,IAAI,CAAC;AAChB,QAAQ,MAAM,CAAC,aAAa,CAAC;AAC7B,YAAY,GAAG;AACf,YAAY,QAAQ;AACpB,YAAY,KAAK;AACjB,YAAY,GAAG;AACf,SAAS,CAAC;AACV,KAAK,CAAC;AACN;;AC7CA;;;;;AAKG;AACW,MAAO,QAAQ,CAAA;AAE3B,IAAA,WAAA,CAAY,IAAY,EAAA;AACtB,QAAA,IAAI,CAAC,IAAI,GAAG,IAAI;;AAGlB;;;;;;;;;;;;;;AAcG;AACH,IAAA,aAAa,IAAI,CAAC,IAAY,EAAA;AAC5B,QAAA,MAAM,KAAK,GAAG,MAAM,MAAM,CAAS,iBAAiB,EAAE;AACpD,YAAA,EAAE,EAAE,IAAI;AACT,SAAA,CAAC;AAEF,QAAA,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC;;AAG5B;;;;;;;;;;;;;;;AAeG;IACH,OAAO,GAAG,CAAC,IAAY,EAAA;AACrB,QAAA,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC;;AAG3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BG;AACH,IAAA,MAAM,OAAO,CAAC,KAAa,EAAE,UAAsB,EAAA;QACjD,MAAM,CAAC,YAAY,EAAE,YAAY,CAAC,GAAG,MAAM,MAAM,CAC/C,oBAAoB,EACpB;YACE,EAAE,EAAE,IAAI,CAAC,IAAI;YACb,KAAK;AACL,YAAA,MAAM,EAAE,UAAU,KAAA,IAAA,IAAV,UAAU,KAAV,MAAA,GAAA,UAAU,GAAI,EAAE;AACzB,SAAA,CACF;QACD,OAAO;YACL,YAAY;YACZ,YAAY;SACb;;AAEH;;;;;;;;;;;;;;;;;AAiBG;AACH,IAAA,MAAM,MAAM,CAAI,KAAa,EAAE,UAAsB,EAAA;AACnD,QAAA,MAAM,MAAM,GAAG,MAAM,MAAM,CAAI,mBAAmB,EAAE;YAClD,EAAE,EAAE,IAAI,CAAC,IAAI;YACb,KAAK;AACL,YAAA,MAAM,EAAE,UAAU,KAAA,IAAA,IAAV,UAAU,KAAV,MAAA,GAAA,UAAU,GAAI,EAAE;AACzB,SAAA,CAAC;AAEF,QAAA,OAAO,MAAM;;AAGf;;;;;;;;;;AAUG;IACH,MAAM,KAAK,CAAC,EAAW,EAAA;AACrB,QAAA,MAAM,OAAO,GAAG,MAAM,MAAM,CAAU,kBAAkB,EAAE;YACxD,EAAE;AACH,SAAA,CAAC;AACF,QAAA,OAAO,OAAO;;AAEjB;;;;","x_google_ignoreList":[0]} -------------------------------------------------------------------------------- /dist-js/index.mjs: -------------------------------------------------------------------------------- 1 | import { invoke } from '@tauri-apps/api/tauri'; 2 | 3 | /** 4 | * **Database** 5 | * 6 | * The `Database` class serves as the primary interface for 7 | * communicating with the rust side of the sql plugin. 8 | */ 9 | class Database { 10 | constructor(path) { 11 | this.path = path; 12 | } 13 | /** 14 | * **load** 15 | * 16 | * A static initializer which connects to the underlying database and 17 | * returns a `Database` instance once a connection to the database is established. 18 | * 19 | * # Sqlite 20 | * 21 | * The path is relative to `tauri::api::path::BaseDirectory::App` and must start with `sqlite:`. 22 | * 23 | * @example 24 | * ```ts 25 | * const db = await Database.load("sqlite:test.db"); 26 | * ``` 27 | */ 28 | static async load(path) { 29 | const _path = await invoke("plugin:sql|load", { 30 | db: path, 31 | }); 32 | return new Database(_path); 33 | } 34 | /** 35 | * **get** 36 | * 37 | * A static initializer which synchronously returns an instance of 38 | * the Database class while deferring the actual database connection 39 | * until the first invocation or selection on the database. 40 | * 41 | * # Sqlite 42 | * 43 | * The path is relative to `tauri::api::path::BaseDirectory::App` and must start with `sqlite:`. 44 | * 45 | * @example 46 | * ```ts 47 | * const db = Database.get("sqlite:test.db"); 48 | * ``` 49 | */ 50 | static get(path) { 51 | return new Database(path); 52 | } 53 | /** 54 | * **execute** 55 | * 56 | * Passes a SQL expression to the database for execution. 57 | * 58 | * @example 59 | * ```ts 60 | * // for sqlite & postgres 61 | * // INSERT example 62 | * const result = await db.execute( 63 | * "INSERT into todos (id, title, status) VALUES ($1, $2, $3)", 64 | * [ todos.id, todos.title, todos.status ] 65 | * ); 66 | * // UPDATE example 67 | * const result = await db.execute( 68 | * "UPDATE todos SET title = $1, completed = $2 WHERE id = $3", 69 | * [ todos.title, todos.status, todos.id ] 70 | * ); 71 | * 72 | * // for mysql 73 | * // INSERT example 74 | * const result = await db.execute( 75 | * "INSERT into todos (id, title, status) VALUES (?, ?, ?)", 76 | * [ todos.id, todos.title, todos.status ] 77 | * ); 78 | * // UPDATE example 79 | * const result = await db.execute( 80 | * "UPDATE todos SET title = ?, completed = ? WHERE id = ?", 81 | * [ todos.title, todos.status, todos.id ] 82 | * ); 83 | * ``` 84 | */ 85 | async execute(query, bindValues) { 86 | const [rowsAffected, lastInsertId] = await invoke("plugin:sql|execute", { 87 | db: this.path, 88 | query, 89 | values: bindValues !== null && bindValues !== void 0 ? bindValues : [], 90 | }); 91 | return { 92 | lastInsertId, 93 | rowsAffected, 94 | }; 95 | } 96 | /** 97 | * **select** 98 | * 99 | * Passes in a SELECT query to the database for execution. 100 | * 101 | * @example 102 | * ```ts 103 | * // for sqlite & postgres 104 | * const result = await db.select( 105 | * "SELECT * from todos WHERE id = $1", id 106 | * ); 107 | * 108 | * // for mysql 109 | * const result = await db.select( 110 | * "SELECT * from todos WHERE id = ?", id 111 | * ); 112 | * ``` 113 | */ 114 | async select(query, bindValues) { 115 | const result = await invoke("plugin:sql|select", { 116 | db: this.path, 117 | query, 118 | values: bindValues !== null && bindValues !== void 0 ? bindValues : [], 119 | }); 120 | return result; 121 | } 122 | /** 123 | * **close** 124 | * 125 | * Closes the database connection pool. 126 | * 127 | * @example 128 | * ```ts 129 | * const success = await db.close() 130 | * ``` 131 | * @param db - Optionally state the name of a database if you are managing more than one. Otherwise, all database pools will be in scope. 132 | */ 133 | async close(db) { 134 | const success = await invoke("plugin:sql|close", { 135 | db, 136 | }); 137 | return success; 138 | } 139 | } 140 | 141 | export { Database as default }; 142 | //# sourceMappingURL=index.mjs.map 143 | -------------------------------------------------------------------------------- /dist-js/index.mjs.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"index.mjs","sources":["../guest-js/index.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAgBA;;;;;AAKG;AACW,MAAO,QAAQ,CAAA;AAE3B,IAAA,WAAA,CAAY,IAAY,EAAA;AACtB,QAAA,IAAI,CAAC,IAAI,GAAG,IAAI;;AAGlB;;;;;;;;;;;;;;AAcG;AACH,IAAA,aAAa,IAAI,CAAC,IAAY,EAAA;AAC5B,QAAA,MAAM,KAAK,GAAG,MAAM,MAAM,CAAS,iBAAiB,EAAE;AACpD,YAAA,EAAE,EAAE,IAAI;AACT,SAAA,CAAC;AAEF,QAAA,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC;;AAG5B;;;;;;;;;;;;;;;AAeG;IACH,OAAO,GAAG,CAAC,IAAY,EAAA;AACrB,QAAA,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC;;AAG3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BG;AACH,IAAA,MAAM,OAAO,CAAC,KAAa,EAAE,UAAsB,EAAA;QACjD,MAAM,CAAC,YAAY,EAAE,YAAY,CAAC,GAAG,MAAM,MAAM,CAC/C,oBAAoB,EACpB;YACE,EAAE,EAAE,IAAI,CAAC,IAAI;YACb,KAAK;AACL,YAAA,MAAM,EAAE,UAAU,KAAA,IAAA,IAAV,UAAU,KAAV,MAAA,GAAA,UAAU,GAAI,EAAE;AACzB,SAAA,CACF;QACD,OAAO;YACL,YAAY;YACZ,YAAY;SACb;;AAEH;;;;;;;;;;;;;;;;;AAiBG;AACH,IAAA,MAAM,MAAM,CAAI,KAAa,EAAE,UAAsB,EAAA;AACnD,QAAA,MAAM,MAAM,GAAG,MAAM,MAAM,CAAI,mBAAmB,EAAE;YAClD,EAAE,EAAE,IAAI,CAAC,IAAI;YACb,KAAK;AACL,YAAA,MAAM,EAAE,UAAU,KAAA,IAAA,IAAV,UAAU,KAAV,MAAA,GAAA,UAAU,GAAI,EAAE;AACzB,SAAA,CAAC;AAEF,QAAA,OAAO,MAAM;;AAGf;;;;;;;;;;AAUG;IACH,MAAM,KAAK,CAAC,EAAW,EAAA;AACrB,QAAA,MAAM,OAAO,GAAG,MAAM,MAAM,CAAU,kBAAkB,EAAE;YACxD,EAAE;AACH,SAAA,CAAC;AACF,QAAA,OAAO,OAAO;;AAEjB;;;;"} -------------------------------------------------------------------------------- /guest-js/index.ts: -------------------------------------------------------------------------------- 1 | import { invoke } from "@tauri-apps/api/tauri"; 2 | 3 | export interface QueryResult { 4 | /** The number of rows affected by the query. */ 5 | rowsAffected: number; 6 | /** 7 | * The last inserted `id`. 8 | * 9 | * This value is always `0` when using the Postgres driver. If the 10 | * last inserted id is required on Postgres, the `select` function 11 | * must be used, with a `RETURNING` clause 12 | * (`INSERT INTO todos (title) VALUES ($1) RETURNING id`). 13 | */ 14 | lastInsertId: number; 15 | } 16 | 17 | /** 18 | * **Database** 19 | * 20 | * The `Database` class serves as the primary interface for 21 | * communicating with the rust side of the sql plugin. 22 | */ 23 | export default class Database { 24 | path: string; 25 | constructor(path: string) { 26 | this.path = path; 27 | } 28 | 29 | /** 30 | * **load** 31 | * 32 | * A static initializer which connects to the underlying database and 33 | * returns a `Database` instance once a connection to the database is established. 34 | * 35 | * # Sqlite 36 | * 37 | * The path is relative to `tauri::api::path::BaseDirectory::App` and must start with `sqlite:`. 38 | * 39 | * @example 40 | * ```ts 41 | * const db = await Database.load("sqlite:test.db"); 42 | * ``` 43 | */ 44 | static async load(path: string): Promise { 45 | const _path = await invoke("plugin:sql|load", { 46 | db: path, 47 | }); 48 | 49 | return new Database(_path); 50 | } 51 | 52 | /** 53 | * **get** 54 | * 55 | * A static initializer which synchronously returns an instance of 56 | * the Database class while deferring the actual database connection 57 | * until the first invocation or selection on the database. 58 | * 59 | * # Sqlite 60 | * 61 | * The path is relative to `tauri::api::path::BaseDirectory::App` and must start with `sqlite:`. 62 | * 63 | * @example 64 | * ```ts 65 | * const db = Database.get("sqlite:test.db"); 66 | * ``` 67 | */ 68 | static get(path: string): Database { 69 | return new Database(path); 70 | } 71 | 72 | /** 73 | * **execute** 74 | * 75 | * Passes a SQL expression to the database for execution. 76 | * 77 | * @example 78 | * ```ts 79 | * // for sqlite & postgres 80 | * // INSERT example 81 | * const result = await db.execute( 82 | * "INSERT into todos (id, title, status) VALUES ($1, $2, $3)", 83 | * [ todos.id, todos.title, todos.status ] 84 | * ); 85 | * // UPDATE example 86 | * const result = await db.execute( 87 | * "UPDATE todos SET title = $1, completed = $2 WHERE id = $3", 88 | * [ todos.title, todos.status, todos.id ] 89 | * ); 90 | * 91 | * // for mysql 92 | * // INSERT example 93 | * const result = await db.execute( 94 | * "INSERT into todos (id, title, status) VALUES (?, ?, ?)", 95 | * [ todos.id, todos.title, todos.status ] 96 | * ); 97 | * // UPDATE example 98 | * const result = await db.execute( 99 | * "UPDATE todos SET title = ?, completed = ? WHERE id = ?", 100 | * [ todos.title, todos.status, todos.id ] 101 | * ); 102 | * ``` 103 | */ 104 | async execute(query: string, bindValues?: unknown[]): Promise { 105 | const [rowsAffected, lastInsertId] = await invoke<[number, number]>( 106 | "plugin:sql|execute", 107 | { 108 | db: this.path, 109 | query, 110 | values: bindValues ?? [], 111 | }, 112 | ); 113 | return { 114 | lastInsertId, 115 | rowsAffected, 116 | }; 117 | } 118 | /** 119 | * **select** 120 | * 121 | * Passes in a SELECT query to the database for execution. 122 | * 123 | * @example 124 | * ```ts 125 | * // for sqlite & postgres 126 | * const result = await db.select( 127 | * "SELECT * from todos WHERE id = $1", id 128 | * ); 129 | * 130 | * // for mysql 131 | * const result = await db.select( 132 | * "SELECT * from todos WHERE id = ?", id 133 | * ); 134 | * ``` 135 | */ 136 | async select(query: string, bindValues?: unknown[]): Promise { 137 | const result = await invoke("plugin:sql|select", { 138 | db: this.path, 139 | query, 140 | values: bindValues ?? [], 141 | }); 142 | 143 | return result; 144 | } 145 | 146 | /** 147 | * **close** 148 | * 149 | * Closes the database connection pool. 150 | * 151 | * @example 152 | * ```ts 153 | * const success = await db.close() 154 | * ``` 155 | * @param db - Optionally state the name of a database if you are managing more than one. Otherwise, all database pools will be in scope. 156 | */ 157 | async close(db?: string): Promise { 158 | const success = await invoke("plugin:sql|close", { 159 | db, 160 | }); 161 | return success; 162 | } 163 | } 164 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "tauri-plugin-sql-api", 3 | "version": "0.0.0", 4 | "description": "Interface with SQL databases", 5 | "license": "MIT or APACHE-2.0", 6 | "authors": [ 7 | "Tauri Programme within The Commons Conservancy" 8 | ], 9 | "type": "module", 10 | "browser": "dist-js/index.min.js", 11 | "module": "dist-js/index.mjs", 12 | "types": "dist-js/index.d.ts", 13 | "exports": { 14 | "import": "./dist-js/index.mjs", 15 | "types": "./dist-js/index.d.ts", 16 | "browser": "./dist-js/index.min.js" 17 | }, 18 | "scripts": { 19 | "build": "rollup -c" 20 | }, 21 | "files": [ 22 | "dist-js", 23 | "!dist-js/**/*.map", 24 | "README.md", 25 | "LICENSE" 26 | ], 27 | "devDependencies": { 28 | "tslib": "2.8.1" 29 | }, 30 | "dependencies": { 31 | "@tauri-apps/api": "1.6.0" 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /rollup.config.mjs: -------------------------------------------------------------------------------- 1 | import { readFileSync } from "fs"; 2 | 3 | import { createConfig } from "../../shared/rollup.config.mjs"; 4 | 5 | export default createConfig({ 6 | input: "guest-js/index.ts", 7 | pkg: JSON.parse( 8 | readFileSync(new URL("./package.json", import.meta.url), "utf8"), 9 | ), 10 | external: [/^@tauri-apps\/api/], 11 | }); 12 | -------------------------------------------------------------------------------- /src/decode/mod.rs: -------------------------------------------------------------------------------- 1 | #[cfg(feature = "mysql")] 2 | mod mysql; 3 | #[cfg(feature = "postgres")] 4 | mod postgres; 5 | #[cfg(feature = "sqlite")] 6 | mod sqlite; 7 | 8 | #[cfg(feature = "mysql")] 9 | pub(crate) use mysql::to_json; 10 | 11 | #[cfg(feature = "postgres")] 12 | pub(crate) use postgres::to_json; 13 | 14 | #[cfg(feature = "sqlite")] 15 | pub(crate) use sqlite::to_json; 16 | -------------------------------------------------------------------------------- /src/decode/mysql.rs: -------------------------------------------------------------------------------- 1 | use serde_json::Value as JsonValue; 2 | use sqlx::{mysql::MySqlValueRef, TypeInfo, Value, ValueRef}; 3 | use time::{Date, OffsetDateTime, PrimitiveDateTime, Time}; 4 | 5 | use crate::Error; 6 | 7 | pub(crate) fn to_json(v: MySqlValueRef) -> Result { 8 | if v.is_null() { 9 | return Ok(JsonValue::Null); 10 | } 11 | 12 | let res = match v.type_info().name() { 13 | "CHAR" | "VARCHAR" | "TINYTEXT" | "TEXT" | "MEDIUMTEXT" | "LONGTEXT" | "ENUM" => { 14 | if let Ok(v) = ValueRef::to_owned(&v).try_decode() { 15 | JsonValue::String(v) 16 | } else { 17 | JsonValue::Null 18 | } 19 | } 20 | "FLOAT" => { 21 | if let Ok(v) = ValueRef::to_owned(&v).try_decode::() { 22 | JsonValue::from(v) 23 | } else { 24 | JsonValue::Null 25 | } 26 | } 27 | "DOUBLE" => { 28 | if let Ok(v) = ValueRef::to_owned(&v).try_decode::() { 29 | JsonValue::from(v) 30 | } else { 31 | JsonValue::Null 32 | } 33 | } 34 | "TINYINT" | "SMALLINT" | "INT" | "MEDIUMINT" | "BIGINT" => { 35 | if let Ok(v) = ValueRef::to_owned(&v).try_decode::() { 36 | JsonValue::Number(v.into()) 37 | } else { 38 | JsonValue::Null 39 | } 40 | } 41 | "TINYINT UNSIGNED" | "SMALLINT UNSIGNED" | "INT UNSIGNED" | "MEDIUMINT UNSIGNED" 42 | | "BIGINT UNSIGNED" | "YEAR" => { 43 | if let Ok(v) = ValueRef::to_owned(&v).try_decode::() { 44 | JsonValue::Number(v.into()) 45 | } else { 46 | JsonValue::Null 47 | } 48 | } 49 | "BOOLEAN" => { 50 | if let Ok(v) = ValueRef::to_owned(&v).try_decode() { 51 | JsonValue::Bool(v) 52 | } else { 53 | JsonValue::Null 54 | } 55 | } 56 | "DATE" => { 57 | if let Ok(v) = ValueRef::to_owned(&v).try_decode::() { 58 | JsonValue::String(v.to_string()) 59 | } else { 60 | JsonValue::Null 61 | } 62 | } 63 | "TIME" => { 64 | if let Ok(v) = ValueRef::to_owned(&v).try_decode::