1
0
mirror of https://github.com/sqlite/sqlite.git synced 2025-07-29 08:01:23 +03:00

JS API doc updates.

FossilOrigin-Name: 4f80fd3b8d4c85894664093d8310d6f5299faac4eb879edc608b3ffcd8558e9a
This commit is contained in:
stephan
2022-12-09 02:23:15 +00:00
parent 735dd03377
commit 75f54dba50
3 changed files with 21 additions and 20 deletions

View File

@ -10,9 +10,9 @@
*/ */
/** /**
This file installs sqlite3.VfsHelper, and object which exists to This file installs sqlite3.vfs, and object which exists to assist
assist in the creation of JavaScript implementations of sqlite3_vfs, in the creation of JavaScript implementations of sqlite3_vfs, along
along with its virtual table counterpart, sqlite3.VtabHelper. with its virtual table counterpart, sqlite3.vtab.
*/ */
'use strict'; 'use strict';
self.sqlite3ApiBootstrap.initializers.push(function(sqlite3){ self.sqlite3ApiBootstrap.initializers.push(function(sqlite3){
@ -468,7 +468,7 @@ self.sqlite3ApiBootstrap.initializers.push(function(sqlite3){
let rc = ... let rc = ...
return rc; return rc;
}catch(e){ }catch(e){
return sqlite3.VtabHelper.exceptionToRc(e, sqlite3.capi.SQLITE_XYZ); return sqlite3.vtab.exceptionToRc(e, sqlite3.capi.SQLITE_XYZ);
// where SQLITE_XYZ is some call-appropriate result code. // where SQLITE_XYZ is some call-appropriate result code.
} }
``` ```
@ -492,7 +492,7 @@ self.sqlite3ApiBootstrap.initializers.push(function(sqlite3){
let rc = ... let rc = ...
return rc; return rc;
}catch(e){ }catch(e){
return sqlite3.VtabHelper.xError( return sqlite3.vtab.xError(
'xColumn', e, sqlite3.capi.SQLITE_XYZ); 'xColumn', e, sqlite3.capi.SQLITE_XYZ);
// where SQLITE_XYZ is some call-appropriate result code. // where SQLITE_XYZ is some call-appropriate result code.
} }
@ -540,18 +540,19 @@ self.sqlite3ApiBootstrap.initializers.push(function(sqlite3){
*/ */
/** /**
A helper for sqlite3_vtab::xRowid() implementations. It must be A helper for sqlite3_vtab::xRowid() and xUpdate()
passed that function's 2nd argument (an output pointer to an implementations. It must be passed the final argument to one of
int64 row ID) and the value to store at the output pointer's those methods (an output pointer to an int64 row ID) and the
address. Returns the same as wasm.setMemValue() and will throw value to store at the output pointer's address. Returns the same
if the 1st or 2nd arguments are invalid for that function. as wasm.setMemValue() and will throw if the 1st or 2nd arguments
are invalid for that function.
Example xRowid impl: Example xRowid impl:
``` ```
const xRowid = (pCursor, ppRowid64)=>{ const xRowid = (pCursor, ppRowid64)=>{
const c = VtabHelper.xCursor(pCursor); const c = vtab.xCursor(pCursor);
VtabHelper.xRowid(ppRowid64, c.myRowId); vtab.xRowid(ppRowid64, c.myRowId);
return 0; return 0;
}; };
``` ```
@ -591,7 +592,7 @@ self.sqlite3ApiBootstrap.initializers.push(function(sqlite3){
If `catchExceptions` is false, it is up to the client to ensure If `catchExceptions` is false, it is up to the client to ensure
that no exceptions escape the methods, as doing so would move that no exceptions escape the methods, as doing so would move
them through the C API, leading to undefined them through the C API, leading to undefined
behavior. (VtabHelper.xError() is intended to assist in reporting behavior. (vtab.xError() is intended to assist in reporting
such exceptions.) such exceptions.)
Certain methods may refer to the same implementation. To simplify Certain methods may refer to the same implementation. To simplify

View File

@ -1,5 +1,5 @@
C Expose\ssqlite3_table_column_metadata()\sto\swasm. C JS\sAPI\sdoc\supdates.
D 2022-12-09T02:12:43.224 D 2022-12-09T02:23:15.484
F .fossil-settings/empty-dirs dbb81e8fc0401ac46a1491ab34a7f2c7c0452f2f06b54ebb845d024ca8283ef1 F .fossil-settings/empty-dirs dbb81e8fc0401ac46a1491ab34a7f2c7c0452f2f06b54ebb845d024ca8283ef1
F .fossil-settings/ignore-glob 35175cdfcf539b2318cb04a9901442804be81cd677d8b889fcc9149c21f239ea F .fossil-settings/ignore-glob 35175cdfcf539b2318cb04a9901442804be81cd677d8b889fcc9149c21f239ea
F LICENSE.md df5091916dbb40e6e9686186587125e1b2ff51f022cc334e886c19a0e9982724 F LICENSE.md df5091916dbb40e6e9686186587125e1b2ff51f022cc334e886c19a0e9982724
@ -509,7 +509,7 @@ F ext/wasm/api/sqlite3-api-prologue.js c0411213b696301ba19ee11cf8fea7876c883e739
F ext/wasm/api/sqlite3-api-worker1.js e94ba98e44afccfa482874cd9acb325883ade50ed1f9f9526beb9de1711f182f F ext/wasm/api/sqlite3-api-worker1.js e94ba98e44afccfa482874cd9acb325883ade50ed1f9f9526beb9de1711f182f
F ext/wasm/api/sqlite3-license-version-header.js a661182fc93fc2cf212dfd0b987f8e138a3ac98f850b1112e29b5fbdaecc87c3 F ext/wasm/api/sqlite3-license-version-header.js a661182fc93fc2cf212dfd0b987f8e138a3ac98f850b1112e29b5fbdaecc87c3
F ext/wasm/api/sqlite3-opfs-async-proxy.js 7795b84b66a7a8dedc791340709b310bb497c3c72a80bef364fa2a58e2ddae3f F ext/wasm/api/sqlite3-opfs-async-proxy.js 7795b84b66a7a8dedc791340709b310bb497c3c72a80bef364fa2a58e2ddae3f
F ext/wasm/api/sqlite3-v-helper.js edcf2dd0caab42aeac41e41e3e97a36d1ada4eb2fdd02cda4488c5b9f9144e0b F ext/wasm/api/sqlite3-v-helper.js 181117ad4c604500599dc07f07314a75f111dd06aab756e77ac8db64dff59d1d
F ext/wasm/api/sqlite3-vfs-opfs.c-pp.js 78133d710bee4c48a1a30262b44a284bc017a3751caa7967bdc030f5d0178daa F ext/wasm/api/sqlite3-vfs-opfs.c-pp.js 78133d710bee4c48a1a30262b44a284bc017a3751caa7967bdc030f5d0178daa
F ext/wasm/api/sqlite3-wasi.h 25356084cfe0d40458a902afb465df8c21fc4152c1d0a59b563a3fba59a068f9 F ext/wasm/api/sqlite3-wasi.h 25356084cfe0d40458a902afb465df8c21fc4152c1d0a59b563a3fba59a068f9
F ext/wasm/api/sqlite3-wasm.c 5d61665dec993e401535730ba536e207e780ed12d7455b6f0a5be48ab5654924 F ext/wasm/api/sqlite3-wasm.c 5d61665dec993e401535730ba536e207e780ed12d7455b6f0a5be48ab5654924
@ -2067,8 +2067,8 @@ F vsixtest/vsixtest.tcl 6a9a6ab600c25a91a7acc6293828957a386a8a93
F vsixtest/vsixtest.vcxproj.data 2ed517e100c66dc455b492e1a33350c1b20fbcdc F vsixtest/vsixtest.vcxproj.data 2ed517e100c66dc455b492e1a33350c1b20fbcdc
F vsixtest/vsixtest.vcxproj.filters 37e51ffedcdb064aad6ff33b6148725226cd608e F vsixtest/vsixtest.vcxproj.filters 37e51ffedcdb064aad6ff33b6148725226cd608e
F vsixtest/vsixtest_TemporaryKey.pfx e5b1b036facdb453873e7084e1cae9102ccc67a0 F vsixtest/vsixtest_TemporaryKey.pfx e5b1b036facdb453873e7084e1cae9102ccc67a0
P d5753668915c1db204fa80153614653243081ffaddea22f26ad59bb1836948b9 P c31eb509e5cb1025de058132ee9a45d70c84ee47a6abe18811a65ce339f062a0
R 739ea8b3ac4045dd84659edd33542511 R be70f20baf9f8b1aac1710d7d4bd92be
U stephan U stephan
Z 266a78087ef6b67b6598f56aee51656a Z e13c75cc4f01c10c6d98532e21e633db
# Remove this line to create a well-formed Fossil manifest. # Remove this line to create a well-formed Fossil manifest.

View File

@ -1 +1 @@
c31eb509e5cb1025de058132ee9a45d70c84ee47a6abe18811a65ce339f062a0 4f80fd3b8d4c85894664093d8310d6f5299faac4eb879edc608b3ffcd8558e9a