@hypequery/clickhouse 1.0.2 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -10,7 +10,6 @@
|
|
|
10
10
|
[](https://github.com/lukejreilly/hypequery/stargazers)
|
|
11
11
|
</div>
|
|
12
12
|
|
|
13
|
-
> **Note:** This package is published on npm as `@hypequery/core`. The unscoped package `hypequery-core` is unrelated and should not be used.
|
|
14
13
|
|
|
15
14
|
## Overview
|
|
16
15
|
|
|
@@ -28,21 +27,25 @@ hypequery is a typescript-first query builder for ClickHouse designed specifical
|
|
|
28
27
|
|
|
29
28
|
## Installation
|
|
30
29
|
|
|
30
|
+
### npm
|
|
31
31
|
```bash
|
|
32
|
-
|
|
33
|
-
|
|
32
|
+
npm install @hypequery/clickhouse
|
|
33
|
+
```
|
|
34
34
|
|
|
35
|
-
|
|
36
|
-
|
|
35
|
+
### yarn
|
|
36
|
+
```bash
|
|
37
|
+
yarn add @hypequery/clickhouse
|
|
38
|
+
```
|
|
37
39
|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
+
### pnpm
|
|
41
|
+
```bash
|
|
42
|
+
pnpm add @hypequery/clickhouse
|
|
40
43
|
```
|
|
41
44
|
|
|
42
45
|
## Quick Start
|
|
43
46
|
|
|
44
47
|
```typescript
|
|
45
|
-
import { createQueryBuilder } from '@hypequery/
|
|
48
|
+
import { createQueryBuilder } from '@hypequery/clickhouse';
|
|
46
49
|
import type { Schema } from './generated-schema';
|
|
47
50
|
|
|
48
51
|
// Initialize the query builder
|
|
@@ -69,7 +72,7 @@ hypequery provides a CLI tool to generate TypeScript types from your ClickHouse
|
|
|
69
72
|
|
|
70
73
|
```bash
|
|
71
74
|
# Install globally (optional)
|
|
72
|
-
npm install -g @hypequery/
|
|
75
|
+
npm install -g @hypequery/clickhouse
|
|
73
76
|
|
|
74
77
|
# Generate schema types
|
|
75
78
|
npx hypequery-generate --host your-clickhouse-host --database your-database
|
|
@@ -78,7 +81,7 @@ npx hypequery-generate --host your-clickhouse-host --database your-database
|
|
|
78
81
|
This creates a `generated-schema.ts` file that you can import in your application:
|
|
79
82
|
|
|
80
83
|
```typescript
|
|
81
|
-
import { createQueryBuilder } from '@hypequery/
|
|
84
|
+
import { createQueryBuilder } from '@hypequery/clickhouse';
|
|
82
85
|
import type { IntrospectedSchema } from './generated-schema';
|
|
83
86
|
|
|
84
87
|
const db = createQueryBuilder<IntrospectedSchema>({
|
|
@@ -108,7 +111,7 @@ db.table('trips').select(['non_existent_column']); // TypeScript error
|
|
|
108
111
|
Implement interactive dashboards with cross-filtering support:
|
|
109
112
|
|
|
110
113
|
```typescript
|
|
111
|
-
import { CrossFilter } from '@hypequery/
|
|
114
|
+
import { CrossFilter } from '@hypequery/clickhouse';
|
|
112
115
|
|
|
113
116
|
// Create a filter
|
|
114
117
|
const filter = new CrossFilter()
|
|
@@ -226,8 +229,8 @@ const db = createQueryBuilder<Schema>({
|
|
|
226
229
|
|
|
227
230
|
hypequery follows semantic versioning and provides multiple release channels:
|
|
228
231
|
|
|
229
|
-
- **Latest**: Stable releases (`npm install @hypequery/
|
|
230
|
-
- **Beta**: Pre-release versions (`npm install @hypequery/
|
|
232
|
+
- **Latest**: Stable releases (`npm install @hypequery/clickhouse`)
|
|
233
|
+
- **Beta**: Pre-release versions (`npm install @hypequery/clickhouse@beta`)
|
|
231
234
|
|
|
232
235
|
## Documentation
|
|
233
236
|
|