Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# clickhouse-node-parser
# @clickhouse/parser

A TypeScript parser for ClickHouse SQL. Parses ClickHouse SQL into a typed AST, with support for formatting back to SQL.

Expand All @@ -7,15 +7,15 @@ A TypeScript parser for ClickHouse SQL. Parses ClickHouse SQL into a typed AST,
## Installation

```bash
npm install clickhouse-node-parser
npm install @clickhouse/parser
```

## Usage

### Parsing SQL to AST

```typescript
import { parse } from 'clickhouse-node-parser';
import { parse } from '@clickhouse/parser';

const ast = parse('SELECT id, name FROM users WHERE active = 1 ORDER BY name');
```
Expand Down Expand Up @@ -58,7 +58,7 @@ Each node has a `kind` discriminator field. See [ast.ts](src/ast.ts) for all nod
### Formatting AST back to SQL

```typescript
import { parse, format } from 'clickhouse-node-parser';
import { parse, format } from '@clickhouse/parser';

const ast = parse('SELECT id, name FROM users WHERE active = 1 ORDER BY name');
const sql = format(ast);
Expand All @@ -80,7 +80,7 @@ ORDER BY name ASC;
### EXPLAIN output

```typescript
import { parse, formatExplain } from 'clickhouse-node-parser';
import { parse, formatExplain } from '@clickhouse/parser';

const ast = parse('SELECT a + b FROM t WHERE x = 1');
const explain = formatExplain(ast);
Expand Down Expand Up @@ -112,7 +112,7 @@ SelectWithUnionQuery (children 1)
When parsing fails, `parse()` throws a `ParseError` with structured information about where and why the parse failed.

```typescript
import { parse, ParseError } from 'clickhouse-node-parser';
import { parse, ParseError } from '@clickhouse/parser';

try {
parse('SELECT ???');
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "clickhouse-node-parser",
"name": "@clickhouse/parser",
"version": "0.1.0",
"description": "A TypeScript parser for ClickHouse SQL",
"main": "dist/index.js",
Expand Down Expand Up @@ -61,4 +61,4 @@
"dependencies": {
"zod": "^4.3.6"
}
}
}
2 changes: 1 addition & 1 deletion src/find-nodes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import type { Statement, ASTNodeKind, ASTNodeKindMap } from './ast';
*
* @example
* ```ts
* import { parse, findNodes } from 'clickhouse-node-parser';
* import { parse, findNodes } from '@clickhouse/parser';
*
* const ast = parse('SELECT * FROM t WHERE id = {id:UInt64}');
*
Expand Down
2 changes: 1 addition & 1 deletion src/guards.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import type { ASTNode, ASTNodeKind, ASTNodeKindMap } from './ast';
*
* @example
* ```ts
* import { isNodeKind } from 'clickhouse-node-parser';
* import { isNodeKind } from '@clickhouse/parser';
*
* const node: ASTNode = ...;
* if (isNodeKind(node, 'literal')) {
Expand Down
2 changes: 1 addition & 1 deletion src/transform-nodes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ export interface NodePositionMap {
*
* @example
* ```ts
* import { parse, transformNodes } from 'clickhouse-node-parser';
* import { parse, transformNodes } from '@clickhouse/parser';
*
* const ast = parse('SELECT * FROM t WHERE id = {id:UInt64}');
*
Expand Down
Loading