Wvlet TypeScript SDK

TypeScript/JavaScript SDK for Wvlet - A flow-style query language that compiles to SQL.

Installation

``bash
npm install @wvlet/wvlet


or

yarn add @wvlet/wvlet

or

pnpm add @wvlet/wvlet
`

Quick Start

`typescript
import { WvletCompiler } from '@wvlet/wvlet';

const compiler = new WvletCompiler();

// Compile a Wvlet query to SQL
const sql = compiler.compile('from users select name, email');
console.log(sql);
// Output: SELECT name, email FROM users
`

Usage

$3

`typescript
import { WvletCompiler } from '@wvlet/wvlet';

const compiler = new WvletCompiler({
target: 'duckdb' // or 'trino'
});

// Compile a query
const sql = compiler.compile('from users where age > 18 select *');
`

$3

`typescript
import { WvletCompiler, CompilationError } from '@wvlet/wvlet';

const compiler = new WvletCompiler();

try {
const sql = compiler.compile('invalid query syntax');
} catch (error) {
if (error instanceof CompilationError) {
console.error(Error at line ${error.location?.line}, column ${error.location?.column});
console.error(Message: ${error.message});
console.error(Status: ${error.statusCode});
}
}
`

$3

`typescript
import { compile } from '@wvlet/wvlet';

// Use the default compiler with a single function call
const sql = compile('from orders select count(*)');
`

API Reference

$3

#### Constructor

`typescript
new WvletCompiler(options?: CompileOptions)
`

Options:
- target: Target SQL dialect ('duckdb' | 'trino'). Default: 'duckdb'
- profile: Profile name for configuration

#### Methods

##### compile(query: string, options?: CompileOptions): string

Compiles a Wvlet query to SQL.

##### static getVersion(): string

Returns the version of the Wvlet compiler.

Examples

$3

`typescript
const sql = compiler.compile(
from users u
join orders o on u.id = o.user_id
select u.name, count(*) as order_count
group by u.name
);
`

$3

`typescript
const sql = compiler.compile(
with active_users as (
from users
where last_login > current_date - interval '30 days'
select *
)
from active_users
select name, email
);
``

Browser Support

This SDK works in both Node.js and modern browsers that support ES modules.

License

Apache License 2.0

Contributing

See the main Wvlet repository for contribution guidelines.