Additional metadata specified in protocol

Removed ack for chunked responses
Removed sqlitemode connection arg
https://github.com/sqlitecloud/sdk/blob/master/PROTOCOL.md

Author: gionatamettifogo

README.md

@@ -1,4 +1,4 @@
-# sqlitecloud-js
+# @sqlitecloud/drivers
 
 [![npm package][npm-img]][npm-url]
 [![Build Status][build-img]][build-url]
@@ -9,13 +9,13 @@
 ## Install
 
 ```bash
-npm install sqlitecloud-js
+npm install @sqlitecloud/drivers
 ```
 
 ## Usage
 
 ```ts
-import { Database } from 'sqlitecloud-js'
+import { Database } from '@sqlitecloud/drivers'
 
 let database = new Database('sqlitecloud://user:password@xxx.sqlite.cloud:8860/chinook.db')
 

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "sqlitecloud-js",
-  "version": "0.0.33",
+  "name": "@sqlitecloud/drivers",
+  "version": "0.0.35",
   "description": "SQLiteCloud drivers for Typescript/Javascript in edge, web and node clients",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -10,7 +10,7 @@
   "scripts": {
     "test": "jest --coverage",
     "build": "rm -rf ./lib/ && tsc --project tsconfig.build.json && npx webpack",
-    "publish": "npm run build && npm publish",
+    "publish": "npm run build && npm publish --access public",
     "prettier": "prettier --write 'src/**/*'",
     "lint": "eslint ./src/ --fix && tsc --noEmit",
     "typedoc": "rm -rf ./docs/ && typedoc --out docs && typedoc --plugin typedoc-plugin-markdown --out docs/markdown",

src/connection.ts

@@ -113,7 +113,6 @@ export class SQLiteCloudConnection {
     config.compression = parseBoolean(config.compression)
     config.createDatabase = parseBoolean(config.createDatabase)
     config.nonlinearizable = parseBoolean(config.nonlinearizable)
-    config.sqliteMode = parseBoolean(config.sqliteMode)
 
     if (!config.username || !config.password || !config.host) {
       console.error('SQLiteCloudConnection.validateConfiguration - missing arguments', config)
@@ -251,9 +250,6 @@ export function getInitializationCommands(config: SQLiteCloudConfig): string {
     }
     commands += `USE DATABASE ${config.database}; `
   }
-  if (config.sqliteMode) {
-    commands += 'SET CLIENT KEY SQLITE TO 1; '
-  }
   if (config.compression) {
     commands += 'SET CLIENT KEY COMPRESSION TO 1; '
   }

src/transport-tls.ts

@@ -185,8 +185,10 @@ export class TlsSocketTransport implements ConnectionTransport {
                 // no ending string? ask server for another chunk
                 rowsetChunks.push(buffer)
                 buffer = Buffer.alloc(0)
-                const okCommand = formatCommand('OK')
-                this.socket?.write(okCommand)
+
+                // no longer need to ack the server
+                // const okCommand = formatCommand('OK')
+                // this.socket?.write(okCommand)
               }
             }
           }
@@ -374,6 +376,11 @@ function parseRowsetColumnsMetadata(buffer: Buffer, metadata: SQLCloudRowsetMeta
     for (let i = 0; i < metadata.numberOfColumns; i++) metadata.columns[i].database = popForward() as string
     for (let i = 0; i < metadata.numberOfColumns; i++) metadata.columns[i].table = popForward() as string
     for (let i = 0; i < metadata.numberOfColumns; i++) metadata.columns[i].column = popForward() as string // original column name
+
+    for (let i = 0; i < metadata.numberOfColumns; i++) metadata.columns[i].notNull = popForward() as boolean
+    for (let i = 0; i < metadata.numberOfColumns; i++) metadata.columns[i].primaryKey = popForward() as boolean
+    for (let i = 0; i < metadata.numberOfColumns; i++) metadata.columns[i].autoIncrement = popForward() as boolean
+    console.debug('metadata', metadata)
   }
 
   return buffer

src/types.ts

@@ -29,8 +29,6 @@ export interface SQLiteCloudConfig {
   createDatabase?: boolean
   /** Database will be created in memory */
   dbMemory?: boolean
-  /** Enable SQLite compatibility mode */
-  sqliteMode?: boolean
   /* Enable compression */
   compression?: boolean
   /** Request for immediate responses from the server node without waiting for linerizability guarantees */
@@ -79,6 +77,12 @@ export interface SQLCloudRowsetMetadata {
     table?: string
     /** Original name of the column */
     column?: string
+    /** Column is not nullable? */
+    notNull?: boolean
+    /** Column is primary key */
+    primaryKey?: boolean
+    /** Column has autoincrement flag */
+    autoIncrement?: boolean
   }[]
 }
 

test/connection-ws.test.ts

@@ -463,16 +463,4 @@ describe('connection-ws', () => {
       LONG_TIMEOUT
     )
   })
-
-  describe('anonimizeCommand', () => {
-    it('should mask username and password', () => {
-      const anonimized = anonimizeCommand('+62 AUTH USER admin PASSWORD notreallyapassword; USE DATABASE chinook.db; ')
-      expect(anonimized).toBe('+62 AUTH USER ****** PASSWORD ******; USE DATABASE chinook.db; ')
-    })
-
-    it('should leave other values untouched', () => {
-      const anonimized = anonimizeCommand('+62 AUTH USER admin SOMETHING notreallyapassword; USE DATABASE chinook.db; ')
-      expect(anonimized).toBe('+62 AUTH USER ****** SOMETHING notreallyapassword; USE DATABASE chinook.db; ')
-    })
-  })
 })