Quick Start

Installation

Rust (Cargo)

cargo add bql-core

CLI

cargo install bql-cli

Node.js (Coming Soon)

npm install @bql/npm

Basic Usage

CLI

# Parse and show AST
bql parse -e 'select User { id, name }'

# Transpile to SQL
bql transpile -e 'select User { id, name }'

Rust Library

use bql_core::bql::AstExpressionParser;

fn main() {
    let parser = AstExpressionParser::new();
    let ast = parser.parse("select User { id, name }").unwrap();
    println!("{:#?}", ast);
}

Your First Query

SELECT

-- Select specific fields
select User { id, name, email }

-- With filtering
select User { id, name } filter active = true

-- With ordering and limit
select User { name } order by created_at desc limit 10

INSERT

insert User {
  name := "Alice",
  email := "alice@example.com",
  active := true
}

UPDATE

update User filter id = 1 set {
  name := "Alice Smith"
}

DELETE

delete User filter id = 1

Next Steps

• Learn about SELECT queries in detail
• Explore expressions and operators
• Try the Playground