Skip to content

Commit b7d8f35

Browse files
authored
support this project (#37)
1 parent f07a719 commit b7d8f35

File tree

1 file changed

+21
-16
lines changed

1 file changed

+21
-16
lines changed

README.md

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -97,22 +97,6 @@ To start using ClickHouse-Schema in your projects, follow these steps:
9797
- Use `<your_schema>.GetOptions()` to access the options passed when creating the table schema.
9898
- Use `<your_schema>.GetCreateTableQueryAsList()` to get the `CREATE TABLE` query as a list of strings, which can be helpful for debugging or logging.
9999
100-
## Schema Options
101-
102-
When creating a schema, you can provide the following options:
103-
104-
- **`table_name`** (required): The name of the table in ClickHouse
105-
- **`primary_key`** (optional): The primary key for the table. If not specified, `order_by` must be specified
106-
- **`order_by`** (optional): The ORDER BY clause for the table. If not specified, `primary_key` must be specified
107-
- **`database`** (optional): The database to use for the table
108-
- **`on_cluster`** (optional): The name of the cluster to use for the table
109-
- **`engine`** (optional): The engine to use for the table, default is `MergeTree()`
110-
- **`partition_by`** (optional): The partition expression for the table. Can be any valid ClickHouse expression:
111-
- Single expression: `"toYYYYMM(visitDate)"` or `"visitDate"`
112-
- Tuple of expressions: `"(toMonday(startDate), eventType)"`
113-
- Complex expressions: `"sipHash64(userId) % 16"`
114-
- **`additional_options`** (optional): An array of strings that are appended to the end of the CREATE TABLE query (e.g., `['COMMENT \'Table comment\'']`)
115-
116100
## Supported Types
117101
118102
- Integer (signed and unsigned integers): `UInt8, UInt16, UInt32, UInt64, UInt128, UInt256, Int8, Int16, Int32, Int64, Int128, Int256` types
@@ -131,3 +115,24 @@ When creating a schema, you can provide the following options:
131115
- IP Addresses - `IPv4` and `IPv6`
132116
133117
And support for more types is coming!
118+
119+
120+
## Schema Options
121+
122+
When creating a schema, you can provide the following options:
123+
124+
- `table_name` (required): The name of the table in ClickHouse
125+
- `primary_key` (optional): The primary key for the table. If not specified, `order_by` must be specified
126+
- `order_by` (optional): The ORDER BY clause for the table. If not specified, `primary_key` must be specified
127+
- `database` (optional): The database to use for the table
128+
- `on_cluster` (optional): The name of the cluster to use for the table
129+
- `engine` (optional): The engine to use for the table, default is `MergeTree()`
130+
- `partition_by` (optional): The partition expression for the table. Can be any valid ClickHouse
131+
- `additional_options` (optional): An array of strings that are appended to the end of the CREATE TABLE query (e.g., `['COMMENT \'Table comment\'']`)
132+
133+
## ☕ Support this project
134+
135+
If you find this project helpful, consider buying me a coffee.
136+
Your support helps me maintain and improve it.
137+
138+
[![Buy Me A Coffee](https://img.shields.io/badge/Donate-PayPal-blue.svg)](https://www.paypal.com/donate/?business=9U7SF754EBPZ2&no_recurring=1&currency_code=CAD)

0 commit comments

Comments
 (0)