diff --git a/docs/assets/search.js b/docs/assets/search.js index b18024e..e3a446d 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA62bb2+cuBbGv4v7FnXjvyR5V/WqUqXVbnezt/tiFI0I4ySoDMwCM51u1O9+ZWCYc5hj4sB9mfY8fsC/x8aMzQuryu81u129sG9ZsWG34uom5lpErEi2lt2yuz9+zRr7sdzukiZ7yO1fP3aWRWxf5eyWNT92tv6FKnn/3GxzFrE0T+ra1uyWsZ/R4KHNqP2vn+6GRrOisdVjkg4tf/10N9kcvxJqaG97/JI0z7+5P15t8B0qBm1HbJdUtmjQ9YHrv1LXg+HxY17WIWZD4VyjP22yCfHp6+ba/F1lTdD9nArnGv1V7Ys0CfMCtXPt7n4UaYhVXzfX5lOW27vs36C7ArVz7X4t028hVn3dXJv/Fnmg0VA5ezw92/Tbn7a21cFuQm+PEi0h+LEsmqrMQyGey+ea/scestR+fE6qJG1sldVNltYh9j7h3Av5fWeLEN++bv795jZs6A+Vc60+pKmtg/pyqHyD1cWz7EtlneL3XZOVxYQtrgt/wu2LOi13duJRQLT8Dqimbm508Z5LeMyTp7fd2buTZJb5ZSd/+PLZ7//hy+fp9QeMx0NWbNZpmec2dbavt/ruUjF1U+5KJ6wD/ZaZrB/y8iH0zvraJXabcv+QTwxubDhUL7HMiibUrytdaGbUG+za4iWGxT6feBZhv752id0uqZKtbWy1Tst9eMdeyv4/F1FMruZ911C8vqx/7RIaewy++b52pl36nBRPdmJOHczOlXOtpt9XzkYBrytTNmW+34ZMp0PhIqPQKQ5XL7T80YQhw+XLTENH5Kh8mWnwhD6uX2YbNqmj4sWGQRP7qHyZaeD0hquXW74huafyZaaBsymuXmgJf6163bKrnmtZ2aSx68d9EbqQvFTMtN4kTRI8MaDimYb2aCd+Sxms+rKZJo9ZkeSTv6QMRqB0ptmTbdbJvinTcrvNQrrxQjDTOM8eDraqwxKDihcbrov99sFWb/I9a2bbh/XvqW6mTbmzxfogAozOlTOtdlX5VNm6Xj8nxSYP6k9CMtO8srUN6c5T3XybfR7o0xUuMgpdzeHqZZbBa5xx/TLbsDUOKl5sGLTGGZUvMw18gcXVyywDlxu4eq5l+T3Eqq2aaVF3z5vnssr+DZpjLgRzjf8JIddVzbVoksZubdGErElR8WxDuwuyastmmhySfB8yn5zqltiETpioeJlh4Msvrl5kGTxDj8oXmYbNz7B2qV3Q7IyrF1kGTpSoeJlh2FsZKp5r+FivK/uU1U3QnDkqf9X0PmJZsbFHdvvCTgvzWybey/c3LGKPmc037nAFO720l1s3cbH7/v++2rQpK1fRlfxyxaLVVSRv3streX8frU6K9j/af2jLOItWnCrjqEywaCWoMoHKJItWkiqTqEyxaKWoMoXKNItWmirTqMywaGWoMoPKYhatYqosRmXXLFpdU2XXqOyGRasbquwGd6/rbU5y4CMQLQkaBWbBXZ9zkgbHOLjrdk4C4ZgIdz3PSSYcQ+Gu8zmJhWMu3PU/J8lwjIY7BJyEwzEd7ihwkg/HgLgDwUlEHDMSDoQgGQnMSDgQgmQkRuOlHTD0iMGMhAMhSEYCMxIOhCAZCcxIOBCCZCQwI+FACJKRwIyEAyFIRgIzEg6EIBkJzEg4EIJkJDAj6UBIkpHEjKQDIUlGEjOSDoQkGcnRtNbOa/TEhhlJB0KSjCRmJB0ISTKSmJF0ICTJSGJG0oGQJCOJGUkHQpKMJGYkHQhJMpKYkXIgFMlIYUbKgVAkI4UZKQdCkYwUZqQcCEUyUqOnT/v4oZ8/mJFyIBTJSGFGyoFQJCOFGSkHQpGMFGakHAhFMlKYkXIgFMlIYUbagdAkI40ZaQdCk4w0ZqQdCE0y0piRdiA0yUhjRtqB0CQjPVoktKsEepmAGWkHQpOMNGakHQhNMtKYkXYgNMlIY0bagdAkI40ZGQfCkIwMZmQcCEMyMpiRcSAMychgRsaBMCQjgxm514WVIRkZzMg4EIZkZEZruXYxR6/mMCPjQBiSkcGMjANhSEYGMzIOhCEZGcwodiBiklGMGcUOREwyijGj2IGISUYxZhQ7EDHJKMaMYgciJhnFmFHsQMQko7hj1L6hHGzV2M3n7k1lteoPHr2wdf/yIobz3i9MCHb78vPn+WXF/eUaBoeDgFICpZxSwgNTQM+Bnk/pT2/zQKuAVk1p2/dyINRAqF8RulEBpAZIzZS0+w0TKGOgjKeUF8doQCPXoJHrsEa6d0/Qxg1o42aqje5d/6yUV2elvPIoh/MpQAcgSx/k/rgJUIFQSl8oT4dHgAwkUvoSiU6BAC1IlPQlCp/mAGKQKulLFT6VAcQgV9KXq9HhCqAG2ZK+bMFjEkAKEiV9icLHHYAYREn6ooTOLZy1CoRJecOEzh8AMUiU8iYKHiQAWpArNZ2r/scnoAXhUt5wjbf1gR4ETPkCBjfogRTES/ni1W24AxGIlfLF6rx5DoQgUcqXqP5M71nFQR64Lw/jjXNgCrKofFmEW+BACpyVz5nYxT63oEEetS+P/aY0UIEgal8Qt8dd0jxfzMNgGvYIh61pYAhk2qe73F4GDYAIa1+E+91ioALB1b7gnvZ+gQyEVvtCizZxgRZkV/uyO9qLBWoQYO0LMNxVBVIQQ+2LId4dBWIQRO0LItrmPGsNiKDxRRDtVwItCKLxBbHdgAQakCXjy9J4GxHIQZKML0ntviDQgBwZX47qf/KssckuQ8MFdI7wdU6nTIdPEcfzN2hjuold9ylCefqIA8xxIFjcF6yukcMjVgKhTwf2NkGngVFkfKOo26sEIjB8jG/4nL8KAZcJ4s998T90e5bADnSL8XXLAew+AikwNJOGl4suA4ab8Q23A9oOPItjEIfYl4fDeWcPKAHL2AfzALfogBaMutg36g5gsw1IwYiLfSPuALbNgBQMvNg38PD2FxCDAMa+AB6T/uspECWQQe7L4DF13+5V/bd73ceDoAk4anw9fbx8eQALU59o039YBszAfXLvfW7aL+7S8Rd3oBngzr32j1lu09N3g0AM4sF98WjF9WjNBoaRbxQdx90Lho9v9BzL9ks/cIUgStwXpWPVfoUMVmhggebT1O2ntyB3IHY+TTN8GQxmBTAp+HT74iJqYDrgvung+L376hk88cEDnxLdR2yX7WyeFZbdru5//vwfKkXaW3Q/AAA="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA62bW2/buBaF/4v6anRC8aIkb0UPChQYzHQmczoPRmAoMpMIlSWPJLvuBP3vB5Rva8ubCiOdx7R7cUn8FinKpF6iuvreRLfzl+hbXi6j2/jqJhE6nkVlurLRbXT3x695az9Wq3Xa5g+F/evH2kazaFMX0W3U/ljb5heu5P1zuyqiWZQVadPYJrqNop+zk4c2vfa/fro7NZqXra0f0+zU8tdPd4PNiatYndpb7b6k7fNv7o9XG3xHiqHtWbROa1u25Prg+q/U9clw97GomhCzU+FYoz9tugzxOdSNtfm7ztug+zkWjjX6q96UWRrmBbVj7e5+lFmI1aFurM2nvLB3+b9BdwW1Y+1+rbJvIVaHurE2/y2LQKNT5ejx9Gyzb3/axtZbuwy9PU40heDHqmzrqgiFeC4fa/ofu80z+/E5rdOstXXetHnWhNj7hGMv5Pe1LUN8D3Xj77ewYUP/VDnW6kOW2SaoL0+Vb7C6eJZ9qa1T/L5u86ocsKV14U+4Tdlk1doOPAqYlt+BaujmehfvuYTHIn162529O0pGmV928ocvn/3+H758Hl5/YDwe8nK5yKqisJmzfb3Vd5eKoZtyVzpgHeg3zWTxUFQPoXd2qJ1it6w2D8XA4KaGp+oplnnZhvrtSyeaGfUGu654imG5KQaeRdTvUDvFbp3W6cq2tl5k1Sa8Yy9l/5+LKAdX875rKF9f1r92Ca3dBd/8oXakXfaclk92YE49mZ0rx1oVNq0X7przcmgWPzv2BaONB1+UwO/196Qhm6rYrELm8VPhJKPQuZVWT7T80YZlhZZPMw2dCnrl00yDnyT9+mm2YU8TUjzZMOiJ0iufZho4r9Lq6ZZvSO6xfJpp4DROqyda4s9kr1vuq8da1jZt7eJxU4auYC8VI62XaZsGTwykeKSh3dmBH3FOVoeykSaPeZkWgz/hnIygdKTZk20X6aatsmq1ykO68UIw0rjIH7a2bsISQ4onGy7KzerB1m/yPWtG24f177FupE21tuViGwcYnStHWq3r6qm2TbN4TstlEdSfjGSkeW0bG9Kdx7rxNpsi0GdfOMkodDVHq6dZBq9x+vXTbMPWOKR4smHQGqdXPs008M2ZVk+zDFxu0OqxltX3EKuuaqRFs3/ePFd1/m/QHHMhGGv8Twi5fdVYizZt7cqWbcialBSPNrTrIKuubKTJNi02IfPJsW6KTeiESYqnGQa+/NLqSZbBM3SvfJJp2PyMtVPtgmZnWj3JMnCiJMXTDMPeykjxWMPHZlHbp7xpg+bMXvmrpvezKC+XdhfdvkTHhfltFL+X72+iWfSY22LpTnVEx5f2auUmruj+8H9fbdZWtavYl/xyFc3mVzN5816L+P5+Nj8quv/o/qErE9FsLrgyQcriaDaPubKYlMloNpdcmSRlKprNFVemSJmOZnPNlWlSZqLZ3HBlhpQl0WyecGUJKbuOZvNrruyalN1Es/kNV3ZDu9f1tmA5iB6IjgSPgrIQrs8FS0NQHMJ1u2CBCEpEuJ4XLBNBoQjX+YLFIigX4fpfsGQERSMcAsHCEZSOcBQEy0dQQMKBECwiQRnFDkTMMoopo9iBiFlGcW+8dAOGHzGUUexAxCyjmDKKHYiYZRRTRrEDEbOMYsoodiBillFMGcUORMwyiimj2IGIWUYxZRQ7EDHLKKaMpAMhWUaSMpIOhGQZScpIOhCSZSR701o3r/ETG2UkHQjJMpKUkXQgJMtIUkbSgZAsI0kZSQdCsowkZSQdCMkykpSRdCAky0hSRsqBUCwjRRkpB0KxjBRlpBwIxTJSlJFyIBTLSPWePt3jh3/+UEbKgVAsI0UZKQdCsYwUZaQcCMUyUpSRciAUy0hRRsqBUCwjRRlpB0KzjDRlpB0IzTLSlJF2IDTLSFNG2oHQLCNNGWkHQrOMdG+R0K0S+GUCZaQdCM0y0pSRdiA0y0hTRtqB0CwjTRlpB0KzjDRlZBwIwzIylJFxIAzLyFBGxoEwLCNDGRkHwrCMDGXkXhfmhmVkKCPjQBiWkemt5brFHL+ao4yMA2FYRoYyMg6EYRkZysg4EIZlZCijxIFIWEYJZZQ4EAnLKKGMEgciYRkllFHiQCQso4QyShyIhGWUUEaJA5GwjBLKKHEgEpZRsmfUvctsbd3a5ef9O818fjgb9RItDq858elI+ksUx9Hty8+f59ca95drGM4vgVKCUg4p8UwX6AXoxZD++N4PWgVaNaTt3uBBqEGoXxG68QNSA1IzJN3/2gnKBJTJkPLipA80cg2NXIc1sn9LhTZuoI2boTb2vwqclfLqrJRXHuXpCA3oALL0Qe4fhAE5pFP60nk41wIqSKb0JfN4SgVkECrpCxU5bgJayJX05YoeGwExJEv6kkWPf4AYwiV94eqd4gA1pEr6UoXnMUAKYZK+MNFzFWexgjwpb57wgARoIVPKmyly0AHEkCjlTRSeWAAt5EoN5+rwKxdoIVzKG67++QHQQ8CUL2B4EgCkEC/li9d+Zx9EECvli9V5lx6EkCjlS9Th1PJZJSBMwhem/g49mIJc+eS4136Wakii9iWR2S6HFiCP2pfHw+43qCCI2hfE1W6dts8X0zjM4h7haQ8cDCG92pfey31saAAirH0RPmxLgwqCq33BPW4ygwxCq32hJbvFoIXsal92e5u+oIYAa1+AcfsWpBBD7Ysh3YY9iw0E0fiCSPZTQQsRNL4Iko1R0EKcjC9P3U4naCBLxpel/n4lyCFJxpekbgMSNJAj48tR80+RtzZd52S4QMfGvo7dK7PTx5b9+RvaGG5ivf/Yojp+pgJzHMRS+GK5b2T7SJUg9OlgExU6DUaR8Y2i/aYoiOA6je86z9+9wGXCyBG+kbPdb46CHajMoOpioBsYb8Y33ra4X3nWJkA08SHdkn1HEAORxIdke95CBCWMtsQ32ra4FwhaGHWJb9RtYVcPpDDiEt+I28L+HEhh4CW+gUf32UAMAUx8Adylh+/DIEqgE15d5r5OrA9fJ+4/j4QmcNT4GO0uXx5gVesTLQ+fzoEZdJLwddJu2X1TmPW/KYRmwF147R/zwmbHLyNBDNESvmh14qa3ZoMR6BuAu373wtDzjbxd1X3LCFcIKRS+FO7q7jtrWNzB2s6nabqPiyF3EDufpj19+wwzCkwoPt2mvIgazCXCN5fsvu+/64blAqwWONH9LFrna1vkpY1u5/c/f/4Pnq/we1ZAAAA="; \ No newline at end of file diff --git a/docs/interfaces/SQLiteAPI.html b/docs/interfaces/SQLiteAPI.html index c22d557..5243897 100644 --- a/docs/interfaces/SQLiteAPI.html +++ b/docs/interfaces/SQLiteAPI.html @@ -10,7 +10,7 @@ 
// Import an ES6 module factory function from one of the
// package builds, either 'wa-sqlite.mjs' (synchronous) or
// 'wa-sqlite-async.mjs' (asynchronous). You should only
// use the asynchronous build if you plan to use an
// asynchronous VFS or module.
import SQLiteESMFactory from 'wa-sqlite/dist/wa-sqlite.mjs';

// Import the Javascript API wrappers.
import * as SQLite from 'wa-sqlite';

// Use an async function to simplify Promise handling.
(async function() {
  // Invoke the ES6 module factory to create the SQLite
  // Emscripten module. This will fetch and compile the
  // .wasm file.
  const module = await SQLiteESMFactory();

  // Use the module to build the API instance.
  const sqlite3 = SQLite.Factory(module);

  // Use the API to open and access a database.
  const db = await sqlite3.open_v2('myDB');
  ...
})();

See

https://sqlite.org/c3ref/funclist.html

-
interface SQLiteAPI {
    bind(stmt, i, value): number;
    bind_blob(stmt, i, value): number;
    bind_collection(stmt, bindings): number;
    bind_double(stmt, i, value): number;
    bind_int(stmt, i, value): number;
    bind_int64(stmt, i, value): number;
    bind_null(stmt, i): number;
    bind_parameter_count(stmt): number;
    bind_parameter_name(stmt, i): string;
    bind_text(stmt, i, value): number;
    changes(db): number;
    close(db): Promise<number>;
    column(stmt, i): SQLiteCompatibleType;
    column_blob(stmt, i): Uint8Array;
    column_bytes(stmt, i): number;
    column_count(stmt): number;
    column_double(stmt, i): number;
    column_int(stmt, i): number;
    column_int64(stmt, i): bigint;
    column_name(stmt, i): string;
    column_names(stmt): string[];
    column_text(stmt, i): string;
    column_type(stmt, i): number;
    create_function(db, zFunctionName, nArg, eTextRep, pApp, xFunc?, xStep?, xFinal?): number;
    data_count(stmt): number;
    exec(db, zSQL, callback?): Promise<number>;
    finalize(stmt): Promise<number>;
    get_autocommit(db): number;
    libversion(): string;
    libversion_number(): number;
    limit(db, id, newVal): number;
    open_v2(zFilename, iFlags?, zVfs?): Promise<number>;
    progress_handler(db, nProgressOps, handler, userData): any;
    reset(stmt): Promise<number>;
    result(context, value): void;
    result_blob(context, value): void;
    result_double(context, value): void;
    result_int(context, value): void;
    result_int64(context, value): void;
    result_null(context): void;
    result_text(context, value): void;
    row(stmt): SQLiteCompatibleType[];
    set_authorizer(db, authFunction, userData): number;
    sql(stmt): string;
    statements(db, sql, options?): AsyncIterable<number>;
    step(stmt): Promise<number>;
    value(pValue): SQLiteCompatibleType;
    value_blob(pValue): Uint8Array;
    value_bytes(pValue): number;
    value_double(pValue): number;
    value_int(pValue): number;
    value_int64(pValue): bigint;
    value_text(pValue): string;
    value_type(pValue): number;
    vfs_register(vfs, makeDefault?): number;
}

Methods

bind +
interface SQLiteAPI {
    bind(stmt, i, value): number;
    bind_blob(stmt, i, value): number;
    bind_collection(stmt, bindings): number;
    bind_double(stmt, i, value): number;
    bind_int(stmt, i, value): number;
    bind_int64(stmt, i, value): number;
    bind_null(stmt, i): number;
    bind_parameter_count(stmt): number;
    bind_parameter_name(stmt, i): string;
    bind_text(stmt, i, value): number;
    changes(db): number;
    clear_bindings(stmt): number;
    close(db): Promise<number>;
    column(stmt, i): SQLiteCompatibleType;
    column_blob(stmt, i): Uint8Array;
    column_bytes(stmt, i): number;
    column_count(stmt): number;
    column_double(stmt, i): number;
    column_int(stmt, i): number;
    column_int64(stmt, i): bigint;
    column_name(stmt, i): string;
    column_names(stmt): string[];
    column_text(stmt, i): string;
    column_type(stmt, i): number;
    create_function(db, zFunctionName, nArg, eTextRep, pApp, xFunc?, xStep?, xFinal?): number;
    data_count(stmt): number;
    exec(db, zSQL, callback?): Promise<number>;
    finalize(stmt): Promise<number>;
    get_autocommit(db): number;
    libversion(): string;
    libversion_number(): number;
    limit(db, id, newVal): number;
    open_v2(zFilename, iFlags?, zVfs?): Promise<number>;
    progress_handler(db, nProgressOps, handler, userData): any;
    reset(stmt): Promise<number>;
    result(context, value): void;
    result_blob(context, value): void;
    result_double(context, value): void;
    result_int(context, value): void;
    result_int64(context, value): void;
    result_null(context): void;
    result_text(context, value): void;
    row(stmt): SQLiteCompatibleType[];
    set_authorizer(db, authFunction, userData): number;
    sql(stmt): string;
    statements(db, sql, options?): AsyncIterable<number>;
    step(stmt): Promise<number>;
    value(pValue): SQLiteCompatibleType;
    value_blob(pValue): Uint8Array;
    value_bytes(pValue): number;
    value_double(pValue): number;
    value_int(pValue): number;
    value_int64(pValue): bigint;
    value_text(pValue): string;
    value_type(pValue): number;
    vfs_register(vfs, makeDefault?): number;
}

Methods

bind bind_blob bind_collection bind_double @@ -21,6 +21,7 @@ bind_parameter_name bind_text changes +clear_bindings close column column_blob @@ -136,6 +137,10 @@

Parameters

  • db: any

    database pointer

Returns number

number of rows modified

See

https://www.sqlite.org/c3ref/changes.html

+

clear_bindings

close

  • close(db): Promise<number>

  • Close database connection

    Parameters

    • db: any

      database pointer

    Returns Promise<number>

    SQLITE_OK (throws exception on error)

    @@ -366,4 +371,4 @@

Parameters

  • vfs: SQLiteVFS

    VFS object

  • Optional makeDefault: boolean

Returns number

SQLITE_OK (throws exception on error)

See

https://www.sqlite.org/c3ref/vfs_find.html

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/src/sqlite-api.js b/src/sqlite-api.js index 37cf8d0..2d29f90 100644 --- a/src/sqlite-api.js +++ b/src/sqlite-api.js @@ -236,6 +236,16 @@ export function Factory(Module) { }; })(); + sqlite3.clear_bindings = (function() { + const fname = 'sqlite3_clear_bindings'; + const f = Module.cwrap(fname, ...decl('n:n')); + return function(stmt) { + verifyStatement(stmt); + const result = f(stmt); + return check(fname, result, mapStmtToDB.get(stmt)); + }; + })(); + sqlite3.close = (function() { const fname = 'sqlite3_close'; const f = Module.cwrap(fname, ...decl('n:n'), { async }); diff --git a/src/types/index.d.ts b/src/types/index.d.ts index e39b92f..31a5985 100644 --- a/src/types/index.d.ts +++ b/src/types/index.d.ts @@ -330,6 +330,14 @@ declare interface SQLiteAPI { */ changes(db): number; + /** + * Reset all bindings on a prepared statement. + * @see https://www.sqlite.org/c3ref/clear_bindings.html + * @param stmt prepared statement pointer + * @returns `SQLITE_OK` (throws exception on error) + */ + clear_bindings(stmt: number): number; + /** * Close database connection * @see https://www.sqlite.org/c3ref/close.html diff --git a/test/api_statements.js b/test/api_statements.js index 9a3d568..d3f76d9 100644 --- a/test/api_statements.js +++ b/test/api_statements.js @@ -366,6 +366,41 @@ export function api_statements(context) { rc = await sqlite3.finalize(stmt); expect(rc).toEqual(SQLite.SQLITE_OK); }); + + it('should clear bindings', async function() { + let rc; + + const sql = 'SELECT ?'; + for await (const stmt of i(sqlite3.statements(db, sql))) { + { + rc = await sqlite3.bind_int(stmt, 1, 42); + expect(rc).toEqual(SQLite.SQLITE_OK); + + rc = await sqlite3.reset(stmt); + expect(rc).toEqual(SQLite.SQLITE_OK); + + rc = await sqlite3.step(stmt); + expect(rc).toEqual(SQLite.SQLITE_ROW); + + const value = await sqlite3.column(stmt, 0); + expect(value).toEqual(42); + } + + { + rc = await sqlite3.clear_bindings(stmt); + expect(rc).toEqual(SQLite.SQLITE_OK); + + rc = await sqlite3.reset(stmt); + expect(rc).toEqual(SQLite.SQLITE_OK); + + rc = await sqlite3.step(stmt); + expect(rc).toEqual(SQLite.SQLITE_ROW); + + const value = await sqlite3.column(stmt, 0); + expect(value).not.toEqual(42); + } + } + }); }); }