Insert Formats · Clickhouse Js Node Coding · ClickHouse/agent-skills · Skills Docs

Insert Formats · Clickhouse Js Node Coding · ClickHouse/agent-skills · Skills Docs

import { createClient } from "@clickhouse/client";

const client = createClient();

await client.insert({
  table: "events",
  format: "JSONEachRow",
  values: [
    { id: 42, name: "foo" },
    { id: 43, name: "bar" },
  ],
});

await client.close();

Format	`values` shape
`JSONEachRow`	`Array<{ col: value, ... }>`
`JSONStringsEachRow`	`Array<{ col: stringifiedValue, ... }>`
`JSONCompactEachRow`	`Array<[v1, v2, ...]>`
`JSONCompactStringsEachRow`	`Array<[stringV1, stringV2, ...]>`
`JSONCompactEachRowWithNames`	First row = column names, then data rows
`JSONCompactEachRowWithNamesAndTypes`	Row 1 = names, row 2 = types, then data
`JSONCompactStringsEachRowWithNames`	First row = names, then stringified data rows
`JSONCompactStringsEachRowWithNamesAndTypes`	Row 1 = names, row 2 = types, then stringified data

await client.insert({
  table: "events",
  format: "JSONCompactEachRowWithNamesAndTypes",
  values: [
    ["id", "name", "sku"],
    ["UInt32", "String", "Array(UInt32)"],
    [11, "foo", [1, 2, 3]],
    [12, "bar", [4, 5, 6]],
  ],
});

Format	`values` shape (typed via `InputJSON<T>` / `InputJSONObjectEachRow<T>`)
`JSON`	`{ meta: [], data: Array<{ col: value, ... }> }` — for TypeScript/client usage, pass `meta: []` if metadata is not needed
`JSONCompact`	`{ meta: [{ name, type }, ...], data: Array<[v1, v2, ...]> }`
`JSONColumnsWithMetadata`	`{ meta: [...], data: { col1: [v, ...], col2: [v, ...] } }`
`JSONObjectEachRow`	`Record<string, { col: value, ... }>` (the record key labels each row but is not stored)

import type { InputJSON, InputJSONObjectEachRow } from "@clickhouse/client";

const meta: InputJSON["meta"] = [
  { name: "id", type: "UInt32" },
  { name: "name", type: "String" },
];

await client.insert({
  table: "events",
  format: "JSONCompact",
  values: {
    meta,
    data: [
      [19, "foo"],
      [20, "bar"],
    ],
  },
});

await client.insert({
  table: "events",
  format: "JSONObjectEachRow",
  values: {
    row_1: { id: 23, name: "foo" },
    row_2: { id: 24, name: "bar" },
  } satisfies InputJSONObjectEachRow<{ id: number; name: string }>,
});

Use case	Format
Insert plain JS objects	`JSONEachRow` (default)
Insert tuples / column-positional rows	`JSONCompactEachRow`
Insert with explicit column ordering / types	`JSONCompactEachRow*WithNames…`
Insert a single document with metadata	`JSON`, `JSONCompact`
Insert from a CSV / TSV / Parquet file	Raw format + Node stream → `examples/node/performance/`