@urban-toolkit/autk-db

---

@urban-toolkit/autk-db / LoadJsonParams

Interface: LoadJsonParams

Defined in: use-cases/load-json/interfaces.ts:71

Describes the inputs required to load JSON data into DuckDB.

Provide either jsonFileUrl or jsonObject — not both. The geometryColumns field is optional and controls spatial column creation.

Example

const params: LoadJsonParams = { jsonFileUrl: 'data.json', outputTableName: 'my_table' };
const paramsGeo: LoadJsonParams = { jsonObject: data, outputTableName: 'geo_table', geometryColumns: true };

Properties

geometryColumns?

optional geometryColumns?: JsonGeometryColumns

Defined in: use-cases/load-json/interfaces.ts:79

Optional geometry strategy used to create a spatial column while loading.

---

jsonFileUrl?

optional jsonFileUrl?: string

Defined in: use-cases/load-json/interfaces.ts:73

URL of the JSON file to fetch and load into DuckDB.

---

jsonObject?

optional jsonObject?: unknown[]

Defined in: use-cases/load-json/interfaces.ts:75

In-memory JSON array to serialize and load.

---

outputTableName

outputTableName: string

Defined in: use-cases/load-json/interfaces.ts:77

Name of the output table created inside the target workspace.

---

workspace?

optional workspace?: string

Defined in: use-cases/load-json/interfaces.ts:81

Optional workspace override used by higher-level callers when qualifying the table name.