Client-Breaking API Changes

As of sqlite3 release 3.40, the JavaScript/WASM APIs are considered beta. Though the WASM-exported C APIs have the same strong stability guarantees as the C API they mirror, the JavaScript APIs are brand new and subject to some period of "settling" before they, too, take on backward compatibility guarantees (tentatively planned for 3.41). Even then, new APIs will continue to be added as needed, and may undergo brief periods where user feedback or practical experience may lead to changes being made to them.

This page briefly covers any API changes which have the potential to break client-side code, newest first.

2022-12-25

• The signature of JS functions passed to sqlite3_exec() was simplified to remove the arguments which are extraneous for JS. The "full" form can be used from JS by manually installing a callback and passing its pointer, instead of the function object, to sqlite3_exec().

2022-12-14

• oo1.DB.exec()'s rowMode option previously accepted a column name reference in the forms "$X", "@X", or ":X". The latter two have been removed because they are superfluous and having unnecessary variety seems likely to cause confusion.

2012-12-09

• Renamed several oft-used methods of the sqlite3.wasm namespace, but retained the older names as aliases:

  • setMemValue() → poke()
  • setPtrValue() → pokePtr()
  • getMemValue() → peek()
  • getPtrValue() → peekPtr()
    The names peek and poke are explained in detail on Wikipedia. peekPtr() and pokePtr() are simply convenience forms with one fewer argument.

• The return semantics of wasm.poke() and wasm.pokePtr() have changed. They now return this instead of returning the function itself. They also now accept an array of addresses, but that is not a potentially breaking change.

2022-12-06

• sqlite3.wasm.cstringToJs() was renamed to cstrToJs() for consistency.

2022-11-30

• sqlite3.wasm.alloc() now proxies sqlite3_malloc() (formerly malloc()) and sqlite3.wasm.dealloc() now proxies sqlite3_free() (formerly free()). It is not expected that any clients are affected by this unless, perhaps, they link sqlite3.wasm into a larger application. This change eliminates some client-side inconsistencies in how JS-side WASM memory has to be managed, most notably via sqlite3_deserialize() and parts of the virtual table interface.

2022-11-29

• sqlite3.opfs.OpfsDb renamed to sqlite3.oo1.OpfsDb, for consistency with other oo1.DB subclasses. The older name will be usable for a brief period but will be removed by the 3.41 release. (Update: removed 2022-12-06.)