@cap-js/sqlite 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change Log
+
+- All notable changes to this project are documented in this file.
+- The format is based on [Keep a Changelog](http://keepachangelog.com/).
+- This project adheres to [Semantic Versioning](http://semver.org/).
+
+## Version 0.1.0 - 2023-04-04
+
+- Initial release

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,189 @@
+# CDS database service for SQLite
+
+Welcome to the new SQLite database service for [SAP Cloud Application Programming Model](https://cap.cloud.sap) Node.js, based on new, streamlined database architecture and [*better-sqlite* driver](https://www.npmjs.com/package/better-sqlite3) .
+
+>  ⚠️  _**WARNING:** This package is in a beta state._  ⚠️
+>
+
+
+## Installing
+
+### Add `@cap-js/sqlite` as package dependency
+
+As SQLite is commonly used during development or tests only, add it as a dev dependency like so:
+
+```sh
+npm add @cap-js/sqlite -D 
+```
+
+>  **Note:** There's no need to add the [*better-sqlite*](https://www.npmjs.com/package/better-sqlite3) driver, and it's also not recommended anymore to do so, as that is done transiently. 
+
+
+### Remove `sqlite3` package dependency
+
+If migrating an existing project you may want to remove the old [*sqlite3* driver](https://www.npmjs.com/package/sqlite3) :
+
+```sh
+npm rm sqlite3
+```
+
+
+## Usage
+
+
+### Via `@cap-js/sqlite` in package dependencies
+
+Adding `@cap-js/sqlite` to your package dependencies as described above is all you need to do. We'll automatically use the new service if that dependency is there in 
+`dependencies` or in `devDependencies`. Your configuration can stay as is, e.g.:
+
+```jsonc
+{ ...,
+  "cds": {
+    "requires": { 
+      "db": "sql" 
+    }
+  }
+}
+```
+
+>  **Note:** This automatically also enables the new, lean draft implementation that's required for the new database services, i.e., `cds.fiori.lean_draft` will be automatically set to `true`.
+
+
+### Via `better-sqlite` config profile
+
+Alternatively, if you don't have `@cap-js/sqlite` in your package dependencies, but installed in an outer monorepo like in *[cap/samples](https://github.com/sap-samples/cloud-cap-samples)*, you can occasionally run or test your apps with the `better-sqlite` profile using one of these options to specify the profile:
+
+```sh
+cds watch bookshop --profile better-sqlite
+```
+```sh
+CDS_ENV=better-sqlite cds watch bookshop
+```
+```sh
+CDS_ENV=better-sqlite jest --silent
+```
+
+
+
+## New Features & Improvements
+
+### Full Support for Path Expressions
+
+The new SQLite service provides full support for all kinds of [path expressions](https://cap.cloud.sap/docs/cds/cql#path-expressions), including [infix filters](https://cap.cloud.sap/docs/cds/cql#with-infix-filters), and [exists predicates](https://cap.cloud.sap/docs/cds/cql#exists-predicate). For example, you can try this out with *[cap/samples](https://github.com/sap-samples/cloud-cap-samples)* as follows: 
+
+```sh
+cds repl --profile better-sqlite
+var { server } = await cds.test('bookshop')
+var { Books, Authors } = cds.entities
+await INSERT.into (Books) .entries ({ title: 'Unwritten Book' })
+await INSERT.into (Authors) .entries ({ name: 'Upcomming Author' })
+await SELECT `from ${Books} { title as book, author.name as author, genre.name as genre }`
+await SELECT `from ${Authors} { books.title as book, name as author, books.genre.name as genre }`
+await SELECT `from ${Books} { title as book, author[ID<170].name as author, genre.name as genre }`
+await SELECT `from ${Books} { title as book, author.name as author, genre.name as genre }` .where ({'author.name':{like:'Ed%'},or:{'author.ID':170}})
+await SELECT `from ${Books} { title as book, author.name as author, genre.name as genre } where author.name like 'Ed%' or author.ID=170`
+await SELECT `from ${Books}:author[name like 'Ed%' or ID=170] { books.title as book, name as author, books.genre.name as genre }`
+await SELECT `from ${Books}:author[150] { books.title as book, name as author, books.genre.name as genre }`
+await SELECT `from ${Authors} { ID, name, books { ID, title }}`
+await SELECT `from ${Authors} { ID, name, books { ID, title, genre { ID, name }}}`
+await SELECT `from ${Authors} { ID, name, books.genre { ID, name }}`
+await SELECT `from ${Authors} { ID, name, books as some_books { ID, title, genre.name as genre }}`
+await SELECT `from ${Authors} { ID, name, books[genre.ID=11] as dramatic_books { ID, title, genre.name as genre }}`
+await SELECT `from ${Authors} { ID, name, books.genre[name!='Drama'] as no_drama_books_count { count(*) as sum }}`
+await SELECT `from ${Authors} { books.genre.ID }`
+await SELECT `from ${Authors} { books.genre }`
+await SELECT `from ${Authors} { books.genre.name }`
+
+```
+
+
+
+### Specified Standard Functions
+
+A specified set of standard functions is now supported and translated to database-specific variants. These functions are by and large the same as specified in OData: 
+
+* `concat`, `indexof`, `length`
+* `contains`, `startswith`, `endswith`, `substring`, `matchesPattern`
+* `tolower`, `toupper`
+* `ceiling`
+* `year`, `month`, `day`, `hour`, `minute`, `second`
+
+The db service implementation translates these to the best-possible native SQL functions, thus enhancing the extend of **portable** queries. 
+
+> **Note** that usage is **case-sensitive**, which means you have to write these functions exactly as given above; all-uppercase usages are not supported. 
+
+### Support for Common HANA Functions
+
+In addition to the standard functions, which all new database services will support, the new SQLite service also supports these common HANA functions, to further increase the scope for portable testing:
+
+- `years_between`
+- `months_between`
+- `days_between`
+- `seconds_between`
+- `nano100_between`
+
+> Both usages are allowed here: all-lowercase as given above, as well as all-uppercase.
+
+### Support for Session Context Variables
+
+The new SQLite service can leverage  [*better-sqlite*](https://www.npmjs.com/package/better-sqlite3)'s user-defined functions to support *session context* variables. In particular, the pseudo variables `$user.id`, `$user.locale`,  `$valid.from`, and `$valid.to` are available in native SQL queries like so: 
+
+```sql
+SELECT session_context('$user.id')
+SELECT session_context('$user.locale')
+SELECT session_context('$valid.from')
+SELECT session_context('$valid.to')
+```
+
+Amongst other, this allows us to get rid of static helper views for localized data like `localized_de_sap_capire_Books`. 
+
+### Deep Reads via Single Queries
+
+The old database service implementation(s) translated deep reads, i.e., SELECTs with expands, into several database queries and collected the individual results into deep result structures. The new service uses `json_object` functions and alike to instead do that in one single query, with sub selects, which greatly improves performance. 
+
+### New `SELECT.localized` Queries
+
+With the old implementation when running queries like `SELECT.from(Books)` would always return localized data, without being able to easily read the non-localized data. The new service does only what you asked for, offering new `SELECT.localized` options:
+
+```js
+let books = await SELECT.from(Books)       //> non-localized data
+let lbooks = await SELECT.localized(Books) //> localized data
+```
+
+Usage variants include:  
+
+```js
+SELECT.localized(Books)
+SELECT.from.localized(Books)
+SELECT.one.localized(Books)
+```
+
+> **Note:** Queries executed through generic application service handlers continue to serve localized data as before. 
+
+### Using Lean Draft Implementation
+
+The old implementation was overly polluted with draft handling. But as draft is actually a Fiori UI concept, that should not be the case. Hence, we eliminated all draft handling from the new database service implementations, and implemented draft in a modular, non-intrusive way — called *'Lean Draft'*. The most important change is that we don't do expensive UNIONs anymore but work with single cheap selects. 
+
+When using the new SQLite service the new `cds.fiori.lean_draft` mode is automatically switched on. You may additionally switch on `cds.fiori_draft_compat` in case you run into problems. 
+
+More detailed documentation for that will follow soon. 
+
+### Performance Improvements
+
+The combination of the above-mentioned improvements commonly leads to significant performance improvements. For example displaying the list page of Travels in [cap/sflight](https://github.com/SAP-samples/cap-sflight) took **>250ms** in the past, and **~15ms** now.
+
+## Known Limitations & Changes
+
+- Node v14 is no longer supported → will be dropped anyways with upcomming cds7.
+- JOINs and UNIONs by CQN are no longer supported → use plain SQL instead.
+* CQNs with subqueries require table aliases to refer to elements of outer queries.
+* CQNs with an empty columns array now throws an error.
+* Search: only single values are allowed as search expression.
+* CSV input: column names like `author.ID` are disallowed → use  `author_ID` instead.
+* No `default` values are returned anymore for `virtual` elements.
+* `SELECT.from(...)` queries on database level don't return localized data anymore → use `SELECT.localized(...)`
+* Standard functions in CQN are case-sensitive → don't uppercase them.
+* For `@cds.on.insert/update`annotations only `$now` and `$user.id` are supported.
+* The `cds/db.stream()` methods are not implemented yet → will come soon.
+
+_The list of important changes is not final and will be constantly updated._

package/cds.js

@@ -0,0 +1,39 @@
+const cds = module.exports = require('@sap/cds/lib')
+const { extend, lazified } = cds
+
+extend(cds).with(lazified({
+  inferred: lazy => require('./lib/ql/cds.infer'),
+  cqn2sql: lazy => require('./lib/db/sql/cqn2sql'),
+  cqn4sql: lazy => require('./lib/db/sql/cqn4sql'),
+}))
+
+extend (cds.ql.Query) .with (class {
+  forSQL (db = cds.db || cds) { return this.flat(db.cqn4sql(this)) }
+  toSQL  (db = cds.db || cds) { return _2sql(db.cqn2sql(this)) }
+  toSql  (db = cds.db || cds) { return this.toSQL(db).sql }
+})
+
+// Monkey-patch req.event to be undefined for plain sql query strings -> remove when @sap/cds 6.6 is released
+const $super = Reflect.getOwnPropertyDescriptor(cds.Request.prototype,'event')
+Reflect.defineProperty (cds.Request.prototype,'event', {...$super, get(){
+  if (typeof this.query === 'string') return this._set ('event', undefined)
+  else return $super.get.call(this)
+}})
+
+// skip .cqn property when in repl
+const _2sql = cds.repl ? ({sql,values}) => ({sql,values}) : x => x
+
+cds.ApplicationService // FIXME: somehow we need to invoke the getter, must be removed in the future
+
+// cds.requires.kinds.postgres = {
+//   kind: 'postgres',
+//   dialect: 'plain',
+//   credentials: {
+//     "host": "localhost",
+//     "port": "5432",
+//     "database": "beershop", //> override per test
+//     "username": "postgres",
+//     "password": "postgres"
+//   },
+//   impl: __dirname + '/lib/db/pg'
+// }

package/index.js

@@ -0,0 +1 @@
+module.exports = require('./lib/db/sqlite/SQLiteService.js')

package/lib/db/DatabaseService.js

@@ -0,0 +1,101 @@
+const cds = require('../../cds')
+
+function Pool (factory, tenant) { return createPool (
+  { __proto__:factory, create: factory.create.bind(undefined,tenant) },
+  factory.options
+)}
+const { createPool } = require('@sap/cds-foss').pool
+
+class DatabaseService extends cds.Service {
+
+  /**
+   * Return a pool factory + options property as expected by
+   * https://github.com/coopernurse/node-pool#createpool.
+   */
+  get factory(){ throw '2b overriden in subclass' }
+  pools = { _factory: this.factory }
+
+  get isMultitenant() { return (
+    'multiTenant' in this.options ? this.options.multiTenant
+    : cds.env.requires.multitenancy
+  )}
+
+  /**
+   * Set one or more session context variables like so:
+   * ```js
+   * const tx = cds.db.tx()
+   * tx.set({
+   *   '$user.name': 'Alice',
+   *   '$user.role': 'admin'
+   * })
+   * ```
+   */
+  // eslint-disable-next-line no-unused-vars
+  set (variables) { throw '2b overridden by subclass' }
+
+  infer (q, m = this.model) {
+    return cds.inferred(q,m)
+  }
+
+  async begin() {
+    const ctx = this.context;  if (!ctx) return this.tx().begin()
+    const tenant =  this.isMultitenant && ctx.tenant
+    const pool = this.pools[tenant] ??= new Pool (this.pools._factory, tenant)
+    const dbc = this.dbc = await pool.acquire()
+    this._release = (dbc) => pool.release(dbc)
+    // Setting session context variables
+    await this.set({
+      get '$user.id'(){ return _set (this, '$user.id', ctx.user?.id || 'anonymous') },
+      get '$user.locale'(){ return _set (this, '$user.locale', ctx.locale || cds.env.i18n.default_language) },
+      get '$valid.from'(){ return _set (this, '$valid.from', ctx._?.['VALID-FROM'] || ctx._?.['VALID-AT'] || '1970-01-01T00:00:00Z') },
+      get '$valid.to'(){ return _set (this, '$valid.to', ctx._?.['VALID-TO'] || _validTo4(ctx._?.['VALID-AT']) || '9999-11-11T22:22:22Z') },
+    })
+    // Run BEGIN
+    try { await this.send('BEGIN') }
+    catch (e) { this._release(dbc); throw e }
+    return this
+  }
+
+  async commit() {
+    const dbc = this.dbc; if (!dbc) return
+    await this.send('COMMIT')
+    this._release(dbc) // only release on successful commit as otherwise released on rollback
+  }
+
+  async rollback() {
+    const dbc = this.dbc; if (!dbc) return
+    try { await this.send('ROLLBACK') }
+    finally { this._release(dbc) }
+  }
+
+  // REVISIT: should happen automatically after a configurable time
+  async disconnect (tenant) {
+    const pool = this.pools[tenant]
+    if (pool) delete this.pools[tenant]; else return
+    await pool.drain()
+    await pool.clear()
+  }
+
+  run (query, data, ...etc) {
+    // Allow db.run('...',1,2,3,4)
+    if (data !== undefined && typeof query === 'string' && typeof data !== 'object') data = [ data, ...etc ]
+    return super.run (query, data)
+  }
+
+  url4 (tenant) { // eslint-disable-line no-unused-vars
+    let { url } = this.options?.credentials || this.options || {}
+    return url
+  }
+  getDbUrl (tenant) { return this.url4 (tenant) } // REVISIT: Remove after cds v6.7
+}
+
+const _set = (context, variable, value) => {
+  Object.defineProperty (context, variable, { value, configurable:true })
+  return value
+}
+const _validTo4 = validAt => {
+  return validAt?.replace(/(\dZ?)$/,d=>parseInt(d[0])+1+d[1]||'')
+}
+
+DatabaseService.prototype.isDatabaseService = true
+module.exports = DatabaseService

package/lib/db/sql/InsertResults.js

@@ -0,0 +1,87 @@
+const iterator = Symbol.iterator
+
+// eslint-disable-next-line no-unused-vars
+const USAGE_SAMPLE = async ()=>{ // from https://pages.github.tools.sap/cap/docs/node.js/services?q=Emily#srvrun--query--results
+  const { Authors, Books } = {}
+  const [ Emily, Charlotte ] = await INSERT.into (Authors, [
+    { name: 'Emily Brontëe' },
+    { name: 'Charlotte Brontëe' },
+  ])
+  await INSERT.into (Books, [
+    { title: 'Wuthering Heights', author: Emily },
+    { title: 'Jane Eyre', author: Charlotte },
+  ])
+}
+
+
+module.exports = class InsertResult {
+
+  constructor (query, results) {
+    this.query = query
+    this.results = results
+  }
+
+  /*
+   * Lazy access to auto-generated keys.
+   */
+  get [iterator]() {
+
+    // For INSERT.as(SELECT.from(...)) return a dummy iterator with correct length
+    const { INSERT } = this.query
+    if (INSERT.as) {
+      return super[iterator] = function*(){
+        for (let i = 0; i < this.affectedRows; i++) yield {}
+      }
+    }
+
+    const { target } = this.query; if (!target?.keys) return (super[iterator] = this.results[iterator])
+    const keys = Object.keys(target.keys), [k1] = keys
+
+    // For INSERT.entries() with generated keys in there return these keys
+    const { entries } = INSERT; if (entries && k1 in entries[0]) {
+      return super[iterator] = function*(){
+        for (const each of entries)
+          yield keys.reduce ((p,k) => { p[k] = each[k]; return p },{})
+      }
+    }
+
+    // For INSERT.rows/values() with generated keys in there return these keys
+    const { columns } = INSERT; if (columns && columns.includes(k1)) {
+      return super[iterator] = function*(){
+        const indices = keys.reduce ((p,k) => {
+          let i = columns.indexOf(k); if (i >= 0) p[k] = i
+          return p
+        },{})
+        for (const each of INSERT.rows || [INSERT.values])
+          yield keys.reduce ((p,k) => { p[k] = each[indices[k]]; return p },{})
+      }
+    }
+
+    // If no generated keys in entries/rows/values we might have database-generated keys
+    const rows = this.results.slice(0, this.affectedRows) // only up to # of root entries
+    return super[iterator] = function*(){
+      for (const each of rows)
+        yield { [k1]: this.insertedRowId4(each) } // REVISIT: sqlite only returns a single lastID per row -> how is that with others?
+    }
+  }
+
+  /*
+   * the number of inserted (root) entries or the number of affectedRows in case of INSERT into SELECT
+   */
+  get affectedRows() {
+    const { INSERT:_ } = this.query
+    if (_.as) return super.affectedRows = this.affectedRows4(this.results[0]|| this.results)
+    else return super.affectedRows = _.entries?.length || _.rows?.length || this.results.length || 1
+  }
+
+  /*
+   * for checks such as res > 2
+   */
+  valueOf() {
+    return this.affectedRows
+  }
+
+  insertedRowId4 (result) { return result.lastID }
+  affectedRows4 (result) { return result.changes }
+
+}