@graffy/clickhouse 0.17.9-alpha.1 → 0.18.1-alpha.1

package/Readme.md

@@ -1,22 +1,36 @@
 # ClickHouse Provider
 
-Read-only Graffy provider for ClickHouse.
+Graffy provider for ClickHouse.
 
-Current scope is intentionally minimal and focused on read patterns used by
-tracker-like workloads:
+Current scope is intentionally minimal and focused on tracker-like workloads:
 
 - ID reads and `$key` reads
 - Range args: `$all`, `$first`, `$last`, `$order`, `$after`, `$before`
 - Filter operators: `$eq`, `$not`, `$lt`, `$lte`, `$gt`, `$gte`, `$re`, `$ire`,
   `$cts`, plus list shorthand (`prop: [a, b]`)
-- Dot-path filters on JSON-encoded string columns (for example
-  `sources.messageId`)
+- Dot-path filters on JSON-encoded string columns and native `Map(...)`
+  columns (for example `sources.messageId` or `recordIds.gmailMessageId`)
 - Nested projection from JSON-encoded string columns
 - Join filters via subqueries (for example `$key: { syncJob: { ... } }`)
 - Aggregates: `$count`, `$sum`, `$avg`, `$max`, `$min`, `$card` with
   `$group: true` and `$group: [..]`
+- Writes: single-row id writes with `$put`
 
-Writes are out of scope.
+The default table model is append-only `MergeTree`. Reads do not add `FINAL`
+unless you explicitly opt into `final: true` for a legacy
+`ReplacingMergeTree` table.
+
+Write support is append-only. `$put` is mandatory, writes must target a scalar
+id path, and the adapter always does a blind insert. Filter writes, patch-style
+updates, and deletes are not supported.
+
+The default `idCol` is `id`, and the default `verCol` is `time`.
+
+`idCol` and `verCol` must be Graffy-compatible: when loaded through the
+ClickHouse client they should be strings or numbers. `verCol` should also be
+backed by a table `DEFAULT` expression. If a write provides a value for
+`verCol`, it is inserted as-is. If not, the column is omitted from the insert
+and ClickHouse supplies the default value.
 
 ## E2E tests
 

package/index.cjs

@@ -6,6 +6,21 @@ function quoteIdent(name) {
   const ident = String(name).replace(/`/g, "``");
   return `\`${ident}\``;
 }
+function unwrapType(type) {
+  let current = type;
+  while (typeof current === "string") {
+    if (current.startsWith("Nullable(") && current.endsWith(")")) {
+      current = current.slice("Nullable(".length, -1);
+      continue;
+    }
+    if (current.startsWith("LowCardinality(") && current.endsWith(")")) {
+      current = current.slice("LowCardinality(".length, -1);
+      continue;
+    }
+    break;
+  }
+  return current;
+}
 function literal(value) {
   if (value === null || value === void 0) return "NULL";
   if (typeof value === "boolean") return value ? "1" : "0";
@@ -26,8 +41,35 @@ function literal(value) {
 function isPlainObject(value) {
   return !!value && typeof value === "object" && !Array.isArray(value) && value.constructor === Object;
 }
+function isUInt8Type(type) {
+  return unwrapType(type) === "UInt8";
+}
 function isStringishType(type) {
-  return type === "String" || type === "Nullable(String)";
+  const unwrapped = unwrapType(type);
+  return unwrapped === "String" || /^FixedString\(\d+\)$/.test(unwrapped || "") || /^Enum(?:8|16)\(/.test(unwrapped || "");
+}
+function splitTopLevelArgs(value) {
+  const parts = [];
+  let depth = 0;
+  let start = 0;
+  for (let i = 0; i < value.length; i += 1) {
+    const ch2 = value[i];
+    if (ch2 === "(") depth += 1;
+    else if (ch2 === ")") depth -= 1;
+    else if (ch2 === "," && depth === 0) {
+      parts.push(value.slice(start, i).trim());
+      start = i + 1;
+    }
+  }
+  parts.push(value.slice(start).trim());
+  return parts;
+}
+function getMapTypes(type) {
+  const unwrapped = unwrapType(type);
+  if (!unwrapped?.startsWith("Map(") || !unwrapped.endsWith(")")) return null;
+  const inner = unwrapped.slice("Map(".length, -1);
+  const [keyType, valueType] = splitTopLevelArgs(inner);
+  return keyType && valueType ? { keyType, valueType } : null;
 }
 function getLookup(prop, options) {
   const [root, ...suffix] = prop.split(".");
@@ -37,6 +79,7 @@ function getLookup(prop, options) {
     throw Error(`clickhouse.no_column ${root}`);
   }
   const rootExpr = quoteIdent(root);
+  const mapTypes = getMapTypes(type);
   if (!suffix.length) {
     return {
       root,
@@ -50,6 +93,25 @@ function getLookup(prop, options) {
       numericExpr: `toFloat64OrZero(${rootExpr})`
     };
   }
+  if (mapTypes) {
+    if (suffix.length !== 1) {
+      throw Error(`clickhouse.map_deep_lookup_unsupported ${prop}`);
+    }
+    const keyExpr = literal(suffix[0]);
+    const rawExpr = `if(mapContains(${rootExpr}, ${keyExpr}), ${rootExpr}[${keyExpr}], NULL)`;
+    return {
+      root,
+      suffix,
+      type: mapTypes.valueType,
+      isJsonPath: false,
+      isMapPath: true,
+      rootExpr,
+      orderExpr: rawExpr,
+      textExpr: isStringishType(mapTypes.valueType) ? `ifNull(${rawExpr}, '')` : `toString(${rawExpr})`,
+      rawExpr,
+      numericExpr: `toFloat64OrZero(${rawExpr})`
+    };
+  }
   const pathArgs = suffix.map((seg) => literal(seg)).join(", ");
   const jsonExpr = `ifNull(${rootExpr}, '{}')`;
   const textExpr = `JSONExtractString(${jsonExpr}, ${pathArgs})`;
@@ -195,7 +257,7 @@ function simplify(node) {
   }
   return node;
 }
-function getTableSql$1({ database = "default", table, final = true }) {
+function getTableSql$1({ database = "default", table, final = false }) {
   const tableSql = `${quoteIdent(database)}.${quoteIdent(table)}`;
   return final ? `${tableSql} FINAL` : tableSql;
 }
@@ -293,11 +355,7 @@ function getNodeSql(ast, options) {
     const joinName = ast[1];
     const joinOptions = options.joins?.[joinName];
     if (!joinOptions) throw Error(`clickhouse.no_join ${joinName}`);
-    const where = [];
-    if (joinOptions.final !== false && joinOptions.schema?.types?._sign) {
-      where.push("`_sign` = 1");
-    }
-    where.push(getNodeSql(ast[2], joinOptions));
+    const where = [getNodeSql(ast[2], joinOptions)];
     const rootIdCol = quoteIdent(options.idCol);
     const joinRefCol = quoteIdent(joinOptions.refCol);
     return `${rootIdCol} IN (SELECT ${joinRefCol} FROM ${getTableSql$1(joinOptions)} WHERE ${where.join(" AND ")})`;
@@ -339,9 +397,6 @@ function getArgSql({ $first, $last, $after, $before, $since, $until, $all, $curs
     throw Error("clickhouse_arg.range_arg_expected");
   }
   const where = [];
-  if (options.final !== false && options.schema?.types?._sign) {
-    where.push("`_sign` = 1");
-  }
   if (!common.isEmpty(filter)) where.push(getFilterSql(filter, options));
   if (!hasRangeArg) {
     return {
@@ -408,7 +463,7 @@ const aggOps = {
   $card: (lookup) => `uniqExact(${lookup.rawExpr})`
 };
 const aggOpOrder = ["$sum", "$avg", "$max", "$min", "$card"];
-function getTableSql({ database = "default", table, final = true }) {
+function getTableSql({ database = "default", table, final = false }) {
   const tableSql = `${quoteIdent(database)}.${quoteIdent(table)}`;
   return final ? `${tableSql} FINAL` : tableSql;
 }
@@ -483,13 +538,9 @@ function selectByArgs(args, projection, options) {
   };
 }
 function selectByIds(ids, options) {
-  const where = [];
-  if (options.final !== false && options.schema?.types?._sign) {
-    where.push("`_sign` = 1");
-  }
-  where.push(
+  const where = [
     `${quoteIdent(options.idCol)} IN (${ids.map((id) => literal(id)).join(", ")})`
-  );
+  ];
   return {
     sql: `SELECT * FROM ${getTableSql(options)} WHERE ${where.join(" AND ")}`
   };
@@ -511,6 +562,20 @@ function maybeParseJson(value) {
 function deepCloneJson(value) {
   return JSON.parse(JSON.stringify(value));
 }
+function stripJsonValue(value) {
+  if (value === void 0 || value === null) return value ?? null;
+  if (Array.isArray(value)) return value.map((item) => stripJsonValue(item));
+  if (!common.isPlainObject(value)) return value;
+  if ("$val" in value) return stripJsonValue(value.$val);
+  const out = {};
+  for (const [key, item] of Object.entries(value)) {
+    if (key[0] === "$") continue;
+    const next = stripJsonValue(item);
+    if (next === void 0 || next === null) continue;
+    out[key] = next;
+  }
+  return common.isEmpty(out) ? null : out;
+}
 function applyAggregateAliases(object, aggregateAliases) {
   Object.entries(aggregateAliases).forEach(([alias, { op, prop }]) => {
     if (!(alias in object)) return;
@@ -546,6 +611,19 @@ class Db {
       throw Error(`clickhouse.sql_error ${message}`);
     }
   }
+  async insert(tableOptions, rows) {
+    if (!rows.length) return;
+    try {
+      await this.client.insert({
+        table: `${tableOptions.database || "default"}.${tableOptions.table}`,
+        values: rows,
+        format: "JSONEachRow"
+      });
+    } catch (e) {
+      const message = [e?.message, JSON.stringify(rows)].filter(Boolean).join("; ");
+      throw Error(`clickhouse.sql_error ${message}`);
+    }
+  }
   async ensureSchema(tableOptions) {
     if (!tableOptions.schema?.types) {
       const rows = await this.query(`
@@ -574,9 +652,9 @@ class Db {
       const type = schema?.types?.[key];
       if (value === null || value === void 0) {
         out[key] = null;
-      } else if (type === "UInt8" || type === "Nullable(UInt8)") {
+      } else if (isUInt8Type(type)) {
         out[key] = Boolean(value);
-      } else if (type === "String" || type === "Nullable(String)") {
+      } else if (isStringishType(type)) {
         out[key] = maybeParseJson(value);
       } else {
         out[key] = value;
@@ -600,6 +678,42 @@ class Db {
     }
     return -numeric;
   }
+  applyRowChange(row, change, tableOptions) {
+    for (const [col, value] of Object.entries(change)) {
+      if (col[0] === "$") continue;
+      const type = tableOptions.schema?.types?.[col];
+      if (isStringishType(type) && (value === null || Array.isArray(value) || common.isPlainObject(value))) {
+        row[col] = stripJsonValue(value);
+      } else {
+        row[col] = value;
+      }
+    }
+  }
+  getWriteRow(change, tableOptions) {
+    const row = {};
+    this.applyRowChange(row, change, tableOptions);
+    return row;
+  }
+  getInsertRow(row, tableOptions) {
+    const out = {};
+    for (const [col, type] of Object.entries(
+      tableOptions.schema?.types || {}
+    )) {
+      if (!(col in row)) continue;
+      const value = row[col];
+      if (value === void 0) continue;
+      if (value === null) {
+        out[col] = null;
+      } else if (isUInt8Type(type)) {
+        out[col] = value ? 1 : 0;
+      } else if (isStringishType(type) && typeof value === "object") {
+        out[col] = JSON.stringify(value);
+      } else {
+        out[col] = value;
+      }
+    }
+    return out;
+  }
   async read(rootQuery, tableOptions) {
     const idQueries = {};
     const promises = [];
@@ -630,7 +744,7 @@ class Db {
           delete object[alias];
         });
         object.$key = key;
-        object.$ver = object[tableOptions.verCol] ?? object._version ?? null;
+        object.$ver = object[tableOptions.verCol];
         if (!selection.isAggregate) {
           object.$ref = [...rawPrefix, object[tableOptions.idCol]];
         }
@@ -644,7 +758,7 @@ class Db {
       for (const row of rows) {
         const object = this.normalizeRow(row, tableOptions.schema);
         object.$key = object[tableOptions.idCol];
-        object.$ver = object[tableOptions.verCol] ?? object._version ?? null;
+        object.$ver = object[tableOptions.verCol];
         common.merge(results, common.encodeGraph(common.wrapObject(object, rawPrefix)));
       }
     };
@@ -670,12 +784,51 @@ class Db {
     await Promise.all(promises);
     return common.finalize(results, common.wrap(query, prefix));
   }
+  async write(rootChange, tableOptions) {
+    const { prefix: rawPrefix } = tableOptions;
+    const prefix = common.encodePath(rawPrefix);
+    await this.ensureSchema(tableOptions);
+    const change = common.unwrap(rootChange, prefix);
+    const result = [];
+    for (const node of change) {
+      if (common.isRange(node)) {
+        throw Error("clickhouse_write.delete_unsupported");
+      }
+      const arg = common.decodeArgs(node);
+      const object = common.decodeGraph(node.children) || {};
+      if (common.isPlainObject(arg)) {
+        throw Error("clickhouse_write.object_arg_unsupported");
+      }
+      if (!object.$put || object.$put !== true) {
+        throw Error("clickhouse_write.put_required");
+      }
+      object[tableOptions.idCol] = arg;
+      const writtenRow = this.getWriteRow(object, tableOptions);
+      await this.insert(tableOptions, [
+        this.getInsertRow(writtenRow, tableOptions)
+      ]);
+      common.merge(
+        result,
+        common.encodeGraph(
+          common.wrapObject(
+            {
+              ...writtenRow,
+              $key: writtenRow[tableOptions.idCol],
+              $ver: writtenRow[tableOptions.verCol]
+            },
+            rawPrefix
+          )
+        )
+      );
+    }
+    return result;
+  }
 }
 function getTableOpts(name, options = {}, parentName = null, parentDefaults = {}) {
   const { table, idCol, verCol, schema, database, final } = options;
   const tableName = table || name;
   const tableDatabase = database || parentDefaults.database || "default";
-  const tableFinal = final ?? parentDefaults.final ?? true;
+  const tableFinal = final ?? parentDefaults.final ?? false;
   const joins = Object.fromEntries(
     Object.entries(options.joins || {}).map(([joinName, joinRaw = {}]) => {
       const { refCol = parentName, ...joinOptions } = joinRaw;
@@ -694,7 +847,7 @@ function getTableOpts(name, options = {}, parentName = null, parentDefaults = {}
   return {
     table: tableName,
     idCol: idCol || "id",
-    verCol: verCol || "updatedAt",
+    verCol: verCol || "time",
     database: tableDatabase,
     final: tableFinal,
     schema,
@@ -704,6 +857,7 @@ function getTableOpts(name, options = {}, parentName = null, parentDefaults = {}
 const clickhouse = (options = {}) => (store) => {
   const { connection, ...rawOptions } = options;
   store.on("read", read);
+  store.on("write", write);
   const prefix = store.path;
   const tableOpts = getTableOpts(prefix[prefix.length - 1], rawOptions);
   tableOpts.prefix = prefix;
@@ -718,6 +872,18 @@ const clickhouse = (options = {}) => (store) => {
       }
     );
   }
+  function write(change, writeOptions, next) {
+    const { chClient, clickhouseClient } = writeOptions || {};
+    const db = chClient || clickhouseClient ? new Db(chClient || clickhouseClient) : defaultDb;
+    const writePromise = db.write(change, tableOpts);
+    const remainingChange = common.remove(change, common.encodePath(prefix));
+    const nextPromise = next(remainingChange);
+    return Promise.all([writePromise, nextPromise]).then(
+      ([writeRes, nextRes]) => {
+        return common.merge(writeRes, nextRes);
+      }
+    );
+  }
 };
 const ch = clickhouse;
 exports.ch = ch;

package/index.mjs

@@ -1,9 +1,24 @@
-import { isEmpty, encodePath, unwrap, decodeArgs, isPlainObject as isPlainObject$1, decodeQuery, finalize, wrap, merge, encodeGraph, wrapObject, remove } from "@graffy/common";
+import { isEmpty, isPlainObject as isPlainObject$1, encodePath, unwrap, decodeArgs, decodeQuery, finalize, wrap, isRange, decodeGraph, merge, encodeGraph, wrapObject, remove } from "@graffy/common";
 import { createClient } from "@clickhouse/client";
 function quoteIdent(name) {
   const ident = String(name).replace(/`/g, "``");
   return `\`${ident}\``;
 }
+function unwrapType(type) {
+  let current = type;
+  while (typeof current === "string") {
+    if (current.startsWith("Nullable(") && current.endsWith(")")) {
+      current = current.slice("Nullable(".length, -1);
+      continue;
+    }
+    if (current.startsWith("LowCardinality(") && current.endsWith(")")) {
+      current = current.slice("LowCardinality(".length, -1);
+      continue;
+    }
+    break;
+  }
+  return current;
+}
 function literal(value) {
   if (value === null || value === void 0) return "NULL";
   if (typeof value === "boolean") return value ? "1" : "0";
@@ -24,8 +39,35 @@ function literal(value) {
 function isPlainObject(value) {
   return !!value && typeof value === "object" && !Array.isArray(value) && value.constructor === Object;
 }
+function isUInt8Type(type) {
+  return unwrapType(type) === "UInt8";
+}
 function isStringishType(type) {
-  return type === "String" || type === "Nullable(String)";
+  const unwrapped = unwrapType(type);
+  return unwrapped === "String" || /^FixedString\(\d+\)$/.test(unwrapped || "") || /^Enum(?:8|16)\(/.test(unwrapped || "");
+}
+function splitTopLevelArgs(value) {
+  const parts = [];
+  let depth = 0;
+  let start = 0;
+  for (let i = 0; i < value.length; i += 1) {
+    const ch2 = value[i];
+    if (ch2 === "(") depth += 1;
+    else if (ch2 === ")") depth -= 1;
+    else if (ch2 === "," && depth === 0) {
+      parts.push(value.slice(start, i).trim());
+      start = i + 1;
+    }
+  }
+  parts.push(value.slice(start).trim());
+  return parts;
+}
+function getMapTypes(type) {
+  const unwrapped = unwrapType(type);
+  if (!unwrapped?.startsWith("Map(") || !unwrapped.endsWith(")")) return null;
+  const inner = unwrapped.slice("Map(".length, -1);
+  const [keyType, valueType] = splitTopLevelArgs(inner);
+  return keyType && valueType ? { keyType, valueType } : null;
 }
 function getLookup(prop, options) {
   const [root, ...suffix] = prop.split(".");
@@ -35,6 +77,7 @@ function getLookup(prop, options) {
     throw Error(`clickhouse.no_column ${root}`);
   }
   const rootExpr = quoteIdent(root);
+  const mapTypes = getMapTypes(type);
   if (!suffix.length) {
     return {
       root,
@@ -48,6 +91,25 @@ function getLookup(prop, options) {
       numericExpr: `toFloat64OrZero(${rootExpr})`
     };
   }
+  if (mapTypes) {
+    if (suffix.length !== 1) {
+      throw Error(`clickhouse.map_deep_lookup_unsupported ${prop}`);
+    }
+    const keyExpr = literal(suffix[0]);
+    const rawExpr = `if(mapContains(${rootExpr}, ${keyExpr}), ${rootExpr}[${keyExpr}], NULL)`;
+    return {
+      root,
+      suffix,
+      type: mapTypes.valueType,
+      isJsonPath: false,
+      isMapPath: true,
+      rootExpr,
+      orderExpr: rawExpr,
+      textExpr: isStringishType(mapTypes.valueType) ? `ifNull(${rawExpr}, '')` : `toString(${rawExpr})`,
+      rawExpr,
+      numericExpr: `toFloat64OrZero(${rawExpr})`
+    };
+  }
   const pathArgs = suffix.map((seg) => literal(seg)).join(", ");
   const jsonExpr = `ifNull(${rootExpr}, '{}')`;
   const textExpr = `JSONExtractString(${jsonExpr}, ${pathArgs})`;
@@ -193,7 +255,7 @@ function simplify(node) {
   }
   return node;
 }
-function getTableSql$1({ database = "default", table, final = true }) {
+function getTableSql$1({ database = "default", table, final = false }) {
   const tableSql = `${quoteIdent(database)}.${quoteIdent(table)}`;
   return final ? `${tableSql} FINAL` : tableSql;
 }
@@ -291,11 +353,7 @@ function getNodeSql(ast, options) {
     const joinName = ast[1];
     const joinOptions = options.joins?.[joinName];
     if (!joinOptions) throw Error(`clickhouse.no_join ${joinName}`);
-    const where = [];
-    if (joinOptions.final !== false && joinOptions.schema?.types?._sign) {
-      where.push("`_sign` = 1");
-    }
-    where.push(getNodeSql(ast[2], joinOptions));
+    const where = [getNodeSql(ast[2], joinOptions)];
     const rootIdCol = quoteIdent(options.idCol);
     const joinRefCol = quoteIdent(joinOptions.refCol);
     return `${rootIdCol} IN (SELECT ${joinRefCol} FROM ${getTableSql$1(joinOptions)} WHERE ${where.join(" AND ")})`;
@@ -337,9 +395,6 @@ function getArgSql({ $first, $last, $after, $before, $since, $until, $all, $curs
     throw Error("clickhouse_arg.range_arg_expected");
   }
   const where = [];
-  if (options.final !== false && options.schema?.types?._sign) {
-    where.push("`_sign` = 1");
-  }
   if (!isEmpty(filter)) where.push(getFilterSql(filter, options));
   if (!hasRangeArg) {
     return {
@@ -406,7 +461,7 @@ const aggOps = {
   $card: (lookup) => `uniqExact(${lookup.rawExpr})`
 };
 const aggOpOrder = ["$sum", "$avg", "$max", "$min", "$card"];
-function getTableSql({ database = "default", table, final = true }) {
+function getTableSql({ database = "default", table, final = false }) {
   const tableSql = `${quoteIdent(database)}.${quoteIdent(table)}`;
   return final ? `${tableSql} FINAL` : tableSql;
 }
@@ -481,13 +536,9 @@ function selectByArgs(args, projection, options) {
   };
 }
 function selectByIds(ids, options) {
-  const where = [];
-  if (options.final !== false && options.schema?.types?._sign) {
-    where.push("`_sign` = 1");
-  }
-  where.push(
+  const where = [
     `${quoteIdent(options.idCol)} IN (${ids.map((id) => literal(id)).join(", ")})`
-  );
+  ];
   return {
     sql: `SELECT * FROM ${getTableSql(options)} WHERE ${where.join(" AND ")}`
   };
@@ -509,6 +560,20 @@ function maybeParseJson(value) {
 function deepCloneJson(value) {
   return JSON.parse(JSON.stringify(value));
 }
+function stripJsonValue(value) {
+  if (value === void 0 || value === null) return value ?? null;
+  if (Array.isArray(value)) return value.map((item) => stripJsonValue(item));
+  if (!isPlainObject$1(value)) return value;
+  if ("$val" in value) return stripJsonValue(value.$val);
+  const out = {};
+  for (const [key, item] of Object.entries(value)) {
+    if (key[0] === "$") continue;
+    const next = stripJsonValue(item);
+    if (next === void 0 || next === null) continue;
+    out[key] = next;
+  }
+  return isEmpty(out) ? null : out;
+}
 function applyAggregateAliases(object, aggregateAliases) {
   Object.entries(aggregateAliases).forEach(([alias, { op, prop }]) => {
     if (!(alias in object)) return;
@@ -544,6 +609,19 @@ class Db {
       throw Error(`clickhouse.sql_error ${message}`);
     }
   }
+  async insert(tableOptions, rows) {
+    if (!rows.length) return;
+    try {
+      await this.client.insert({
+        table: `${tableOptions.database || "default"}.${tableOptions.table}`,
+        values: rows,
+        format: "JSONEachRow"
+      });
+    } catch (e) {
+      const message = [e?.message, JSON.stringify(rows)].filter(Boolean).join("; ");
+      throw Error(`clickhouse.sql_error ${message}`);
+    }
+  }
   async ensureSchema(tableOptions) {
     if (!tableOptions.schema?.types) {
       const rows = await this.query(`
@@ -572,9 +650,9 @@ class Db {
       const type = schema?.types?.[key];
       if (value === null || value === void 0) {
         out[key] = null;
-      } else if (type === "UInt8" || type === "Nullable(UInt8)") {
+      } else if (isUInt8Type(type)) {
         out[key] = Boolean(value);
-      } else if (type === "String" || type === "Nullable(String)") {
+      } else if (isStringishType(type)) {
         out[key] = maybeParseJson(value);
       } else {
         out[key] = value;
@@ -598,6 +676,42 @@ class Db {
     }
     return -numeric;
   }
+  applyRowChange(row, change, tableOptions) {
+    for (const [col, value] of Object.entries(change)) {
+      if (col[0] === "$") continue;
+      const type = tableOptions.schema?.types?.[col];
+      if (isStringishType(type) && (value === null || Array.isArray(value) || isPlainObject$1(value))) {
+        row[col] = stripJsonValue(value);
+      } else {
+        row[col] = value;
+      }
+    }
+  }
+  getWriteRow(change, tableOptions) {
+    const row = {};
+    this.applyRowChange(row, change, tableOptions);
+    return row;
+  }
+  getInsertRow(row, tableOptions) {
+    const out = {};
+    for (const [col, type] of Object.entries(
+      tableOptions.schema?.types || {}
+    )) {
+      if (!(col in row)) continue;
+      const value = row[col];
+      if (value === void 0) continue;
+      if (value === null) {
+        out[col] = null;
+      } else if (isUInt8Type(type)) {
+        out[col] = value ? 1 : 0;
+      } else if (isStringishType(type) && typeof value === "object") {
+        out[col] = JSON.stringify(value);
+      } else {
+        out[col] = value;
+      }
+    }
+    return out;
+  }
   async read(rootQuery, tableOptions) {
     const idQueries = {};
     const promises = [];
@@ -628,7 +742,7 @@ class Db {
           delete object[alias];
         });
         object.$key = key;
-        object.$ver = object[tableOptions.verCol] ?? object._version ?? null;
+        object.$ver = object[tableOptions.verCol];
         if (!selection.isAggregate) {
           object.$ref = [...rawPrefix, object[tableOptions.idCol]];
         }
@@ -642,7 +756,7 @@ class Db {
       for (const row of rows) {
         const object = this.normalizeRow(row, tableOptions.schema);
         object.$key = object[tableOptions.idCol];
-        object.$ver = object[tableOptions.verCol] ?? object._version ?? null;
+        object.$ver = object[tableOptions.verCol];
         merge(results, encodeGraph(wrapObject(object, rawPrefix)));
       }
     };
@@ -668,12 +782,51 @@ class Db {
     await Promise.all(promises);
     return finalize(results, wrap(query, prefix));
   }
+  async write(rootChange, tableOptions) {
+    const { prefix: rawPrefix } = tableOptions;
+    const prefix = encodePath(rawPrefix);
+    await this.ensureSchema(tableOptions);
+    const change = unwrap(rootChange, prefix);
+    const result = [];
+    for (const node of change) {
+      if (isRange(node)) {
+        throw Error("clickhouse_write.delete_unsupported");
+      }
+      const arg = decodeArgs(node);
+      const object = decodeGraph(node.children) || {};
+      if (isPlainObject$1(arg)) {
+        throw Error("clickhouse_write.object_arg_unsupported");
+      }
+      if (!object.$put || object.$put !== true) {
+        throw Error("clickhouse_write.put_required");
+      }
+      object[tableOptions.idCol] = arg;
+      const writtenRow = this.getWriteRow(object, tableOptions);
+      await this.insert(tableOptions, [
+        this.getInsertRow(writtenRow, tableOptions)
+      ]);
+      merge(
+        result,
+        encodeGraph(
+          wrapObject(
+            {
+              ...writtenRow,
+              $key: writtenRow[tableOptions.idCol],
+              $ver: writtenRow[tableOptions.verCol]
+            },
+            rawPrefix
+          )
+        )
+      );
+    }
+    return result;
+  }
 }
 function getTableOpts(name, options = {}, parentName = null, parentDefaults = {}) {
   const { table, idCol, verCol, schema, database, final } = options;
   const tableName = table || name;
   const tableDatabase = database || parentDefaults.database || "default";
-  const tableFinal = final ?? parentDefaults.final ?? true;
+  const tableFinal = final ?? parentDefaults.final ?? false;
   const joins = Object.fromEntries(
     Object.entries(options.joins || {}).map(([joinName, joinRaw = {}]) => {
       const { refCol = parentName, ...joinOptions } = joinRaw;
@@ -692,7 +845,7 @@ function getTableOpts(name, options = {}, parentName = null, parentDefaults = {}
   return {
     table: tableName,
     idCol: idCol || "id",
-    verCol: verCol || "updatedAt",
+    verCol: verCol || "time",
     database: tableDatabase,
     final: tableFinal,
     schema,
@@ -702,6 +855,7 @@ function getTableOpts(name, options = {}, parentName = null, parentDefaults = {}
 const clickhouse = (options = {}) => (store) => {
   const { connection, ...rawOptions } = options;
   store.on("read", read);
+  store.on("write", write);
   const prefix = store.path;
   const tableOpts = getTableOpts(prefix[prefix.length - 1], rawOptions);
   tableOpts.prefix = prefix;
@@ -716,6 +870,18 @@ const clickhouse = (options = {}) => (store) => {
       }
     );
   }
+  function write(change, writeOptions, next) {
+    const { chClient, clickhouseClient } = writeOptions || {};
+    const db = chClient || clickhouseClient ? new Db(chClient || clickhouseClient) : defaultDb;
+    const writePromise = db.write(change, tableOpts);
+    const remainingChange = remove(change, encodePath(prefix));
+    const nextPromise = next(remainingChange);
+    return Promise.all([writePromise, nextPromise]).then(
+      ([writeRes, nextRes]) => {
+        return merge(writeRes, nextRes);
+      }
+    );
+  }
 };
 const ch = clickhouse;
 export {

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@graffy/clickhouse",
-  "description": "Read-only Graffy provider for ClickHouse.",
+  "description": "Graffy provider for ClickHouse.",
   "author": "aravind (https://github.com/aravindet)",
-  "version": "0.17.9-alpha.1",
+  "version": "0.18.1-alpha.1",
   "main": "./index.cjs",
   "exports": {
     "import": "./index.mjs",
@@ -16,7 +16,7 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@graffy/common": "0.17.9-alpha.1"
+    "@graffy/common": "0.18.1-alpha.1"
   },
   "peerDependencies": {
     "@clickhouse/client": "^1.17.0"

package/types/Db.d.ts

@@ -2,12 +2,17 @@ export default class Db {
     constructor(connection: any);
     client: any;
     query(sql: any): Promise<any>;
+    insert(tableOptions: any, rows: any): Promise<void>;
     ensureSchema(tableOptions: any): Promise<void>;
     normalizeRow(row: any, schema: any): {};
     getCursorValue(row: any, orderItem: any): any;
+    applyRowChange(row: any, change: any, tableOptions: any): void;
+    getWriteRow(change: any, tableOptions: any): {};
+    getInsertRow(row: any, tableOptions: any): {};
     read(rootQuery: any, tableOptions: any): Promise<{
         key: Uint8Array<ArrayBuffer>;
         end: Uint8Array<ArrayBuffer>;
         version: number;
     }[]>;
+    write(rootChange: any, tableOptions: any): Promise<any[]>;
 }

package/types/sql/escape.d.ts

@@ -1,4 +1,5 @@
 export function quoteIdent(name: any): string;
+export function unwrapType(type: any): any;
 export function literal(value: any): any;
 export function isPlainObject(value: any): boolean;
 export function isUInt8Type(type: any): boolean;

package/types/sql/lookup.d.ts

@@ -8,4 +8,16 @@ export function getLookup(prop: any, options: any): {
     textExpr: string;
     rawExpr: string;
     numericExpr: string;
+    isMapPath?: undefined;
+} | {
+    root: any;
+    suffix: any;
+    type: any;
+    isJsonPath: boolean;
+    isMapPath: boolean;
+    rootExpr: string;
+    orderExpr: string;
+    textExpr: string;
+    rawExpr: string;
+    numericExpr: string;
 };