Properties

The schema for your source is defined a YAML file:

product_catalog.yaml
name: product_catalog
description: catalog of store products
  cols:
  ProductID: String
  Name: String
  Category: String
  Description: String
  Price: Float64
settings:
  engine: MergeTree()
  order_by: "`ProductID`"
  partition_by: tuple()
type
string

Type of source: Table or AITable, see more on AI table (Optional)

name
string

Name of source

description
string

A brief overview of the source’s content or purpose (optional)

cols
{name: type}
required

Defines the schema of the source as a list of columns where each column name is a key and its data type is the value (see Data Types)

settings
string | {key: value} | array

ClickHouse table configuration for the source, which can include ORDER BY, PARTITION BY, Table Engine, etc. The settings can be a String, a key-value pair, or an array comprising either or both. Optional.