Skip to content

Commit 3c646eb

Browse files
committed
docs(plpgsql-parser): add pretty headers and experimental warning
1 parent 1970b6b commit 3c646eb

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

packages/plpgsql-parser/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,32 @@
11
# plpgsql-parser
22

3+
<p align="center" width="100%">
4+
<img height="250" src="https://raw.githubusercontent.com/constructive-io/constructive/refs/heads/main/assets/outline-logo.svg" />
5+
</p>
6+
7+
<p align="center" width="100%">
8+
<a href="https://github.com/constructive-io/pgsql-parser/actions/workflows/run-tests.yaml">
9+
<img height="20" src="https://github.com/constructive-io/pgsql-parser/actions/workflows/run-tests.yaml/badge.svg" />
10+
</a>
11+
<a href="https://github.com/constructive-io/pgsql-parser/blob/main/LICENSE-MIT"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"/></a>
12+
<a href="https://www.npmjs.com/package/plpgsql-parser"><img height="20" src="https://img.shields.io/github/package-json/v/constructive-io/pgsql-parser?filename=packages%2Fplpgsql-parser%2Fpackage.json"/></a>
13+
</p>
14+
315
Combined SQL + PL/pgSQL parser with hydrated ASTs and transform API.
416

17+
> **⚠️ Experimental:** This package is currently experimental. If you're looking for just SQL parsing, see [`pgsql-parser`](https://www.npmjs.com/package/pgsql-parser). For just PL/pgSQL deparsing, see [`plpgsql-deparser`](https://www.npmjs.com/package/plpgsql-deparser).
18+
19+
## Overview
20+
21+
This package provides a unified API for parsing SQL scripts containing PL/pgSQL functions. It combines the SQL parser and PL/pgSQL parser, automatically detecting and hydrating PL/pgSQL function bodies.
22+
23+
Key features:
24+
25+
- Auto-detects `CREATE FUNCTION` statements with `LANGUAGE plpgsql`
26+
- Hydrates PL/pgSQL function bodies into structured ASTs
27+
- Transform API for parse → modify → deparse workflows
28+
- Re-exports underlying primitives for power users
29+
530
## Installation
631

732
```bash
@@ -80,3 +105,7 @@ For power users, the package re-exports underlying primitives:
80105
- `deparsePlpgsqlBody` - PL/pgSQL deparser from `plpgsql-deparser`
81106
- `hydratePlpgsqlAst` - Hydration utility from `plpgsql-deparser`
82107
- `dehydratePlpgsqlAst` - Dehydration utility from `plpgsql-deparser`
108+
109+
## License
110+
111+
MIT

0 commit comments

Comments
 (0)