@polyglot-sql/sdk 0.4.3 → 0.5.0

package/README.md

@@ -25,6 +25,22 @@ const result = transpile(
 console.log(result.sql[0]); // SELECT COALESCE(a, b) FROM t
 ```
 
+Use `unsupportedLevel: 'raise'` when you want transpilation to fail instead of
+silently preserving known unsupported target-dialect constructs.
+
+```typescript
+const strict = transpile(
+  'SELECT ARRAY_AGG(x) FROM t',
+  Dialect.PostgreSQL,
+  Dialect.Fabric,
+  { unsupportedLevel: 'raise' },
+);
+
+if (!strict.success) {
+  console.error(strict.error);
+}
+```
+
 ### Parse + Generate
 
 ```typescript
@@ -561,6 +577,11 @@ if (tables.success) {
 }
 ```
 
+Lineage nodes include `source_kind` and optional `source_alias` metadata. Table
+columns are marked as `table`, CTEs as `cte`, derived queries as
+`derived_table`, and virtual sources such as BigQuery `UNNEST(...) AS alias`
+are marked as `virtual`.
+
 ## OpenLineage Output
 
 Generate OpenLineage-compatible JSON payloads from SQL analysis. The SDK only
@@ -659,7 +680,7 @@ const formattedSafe = pg.formatWithOptions('SELECT a,b FROM t', Dialect.Generic,
 
 | Function | Description |
 |----------|-------------|
-| `transpile(sql, read, write)` | Transpile SQL between dialects |
+| `transpile(sql, read, write, options?)` | Transpile SQL between dialects |
 | `parse(sql, dialect?)` | Parse SQL into AST |
 | `generate(ast, dialect?)` | Generate SQL from AST |
 | `format(sql, dialect?)` | Pretty-print SQL |