feat/add support parition type by option (#31)

* add partition by option

* version bump, readme update

* revert options to private

* readme update

* deps update

Author: rohitkadhe

CHANGELOG.md

@@ -5,6 +5,7 @@
 ### Minor Changes
 
 - support for point type, tuple type and bug fixes
+- Add support for partition_by option
 
 ## 3.0.0
 

README.md

@@ -97,6 +97,22 @@ To start using ClickHouse-Schema in your projects, follow these steps:
     - Use `<your_schema>.GetOptions()` to access the options passed when creating the table schema.
     - Use `<your_schema>.GetCreateTableQueryAsList()` to get the `CREATE TABLE` query as a list of strings, which can be helpful for debugging or logging.
 
+## Schema Options
+
+When creating a schema, you can provide the following options:
+
+- **`table_name`** (required): The name of the table in ClickHouse
+- **`primary_key`** (optional): The primary key for the table. If not specified, `order_by` must be specified
+- **`order_by`** (optional): The ORDER BY clause for the table. If not specified, `primary_key` must be specified
+- **`database`** (optional): The database to use for the table
+- **`on_cluster`** (optional): The name of the cluster to use for the table
+- **`engine`** (optional): The engine to use for the table, default is `MergeTree()`
+- **`partition_by`** (optional): The partition expression for the table. Can be any valid ClickHouse expression:
+  - Single expression: `"toYYYYMM(visitDate)"` or `"visitDate"`
+  - Tuple of expressions: `"(toMonday(startDate), eventType)"`
+  - Complex expressions: `"sipHash64(userId) % 16"`
+- **`additional_options`** (optional): An array of strings that are appended to the end of the CREATE TABLE query (e.g., `['COMMENT \'Table comment\'']`)
+
 ## Supported Types
 
 - Integer (signed and unsigned integers): `UInt8, UInt16, UInt32, UInt64, UInt128, UInt256, Int8, Int16, Int32, Int64, Int128, Int256` types

core/clickhouse_schema.ts

@@ -1,17 +1,9 @@
 import { type ChDataType } from '@clickhouse-schema-data-types/index'
 
-type IsType<T, U> = T extends U ? true : false
-
-// Distributive conditional type that checks if T is of any type in union U
-type OmitKeysOfTypes<T extends ChSchemaDefinition, U> = {
-  [K in keyof T as IsType< T[K]['type']['typeStr'], U> extends true ? never : K]: T[K]
-}
-
 export interface SchemaValue {
-  type: ChDataType
+type: ChDataType
 }
-export type ChSchemaDefinition = Record<string, SchemaValue>
-
+export type ChSchemaDefinition = {[key: string]: SchemaValue}
 /**
  * ChSchemaOptions is used to define the options for a clickhouse table schema.
  *
@@ -21,15 +13,17 @@ export type ChSchemaDefinition = Record<string, SchemaValue>
  * @param primary_key is the primary key for the table. if not specified, order_by must be specified
  * @param order_by is the order by clause for the table. if not specified, primary_key must be specified
  * @param engine is the engine to use for the table, default is MergeTree()
+ * @param partition_by is the partition expression for the table. Can be any valid ClickHouse expression (e.g., "toYYYYMM(date_column)", "(toMonday(StartDate), EventType)", "sipHash64(userId) % 16")
  * @param additional_options is an string array of options that are appended to the end of the create table query
  */
 export interface ChSchemaOptions<T extends ChSchemaDefinition> {
   database?: string
   table_name: string
   on_cluster?: string
-  primary_key?: keyof OmitKeysOfTypes<T, 'Object(\'JSON\')' >
-  order_by?: keyof OmitKeysOfTypes<T, 'Object(\'JSON\')' >
+  primary_key?: keyof T
+  order_by?: keyof T
   engine?: string
+  partition_by?: string
   additional_options?: string[]
 }
 
@@ -98,11 +92,11 @@ export class ClickhouseSchema<SchemaDefinition extends ChSchemaDefinition> imple
     if (this.options.additional_options !== undefined) {
       additionalOptions = `${this.options.additional_options.join('\n')}`
     }
-
     const createTableQuery = [
       `CREATE TABLE IF NOT EXISTS ${this.options.database !== undefined ? `${this.options.database}.` : ''}${this.options.table_name}${this.options.on_cluster !== undefined ? ` ON CLUSTER ${this.options.on_cluster}` : ''}`,
       `(\n${columns}\n)`,
       `ENGINE = ${engine}`,
+      this.options.partition_by !== undefined ? `PARTITION BY ${this.options.partition_by}` : '',
       this.options.order_by !== undefined ? `ORDER BY ${this.options.order_by.toString()}` : '',
       this.options.primary_key !== undefined ? `PRIMARY KEY ${this.options.primary_key.toString()}` : '',
       additionalOptions

core/infer_schema_type.ts

@@ -5,4 +5,4 @@ import { type ChDataType } from '@clickhouse-schema-data-types/index'
 type Infer<T extends ChDataType> = T['typeScriptType']
 
 /**  InferSchemaClickhouseSchemaType is a type that takes a ClickhouseSchema and returns the typescript that it represents */
-export type InferClickhouseSchemaType<T extends ClickhouseSchema<ChSchemaDefinition>> = { [K in keyof T['schema']]: Infer<T['schema'][K]['type']> }
+export type InferClickhouseSchemaType<T extends ClickhouseSchema<any>> = { [K in keyof T['schema']]: Infer<T['schema'][K]['type']> }