SQLer

An opinionated SQL formatter for consistent, read-at-a-glance SQL.

Features

• Formats SQL queries with customizable indentation
• Supports common SQL elements:
  • SELECT
  • WHERE
  • GROUP BY
  • aliasing
  • table and schema referencing
  • binary ops
• Feature-flag based SQL dialect delineation!

Installation

Add sqler to your project's deps:

sqler = "0.1.0"

Usage

use sqler::{Config, format_sql};

let sql = "SELECT id, name AS full_name FROM users WHERE age > 18";

// use default configuration
let config = Config::default();

match format_sql(sql, &config) {
  Ok(formatted) => println!("{}", formatted),
  Err(e) => eprintln!("Error: {}", e),
}

Configuration

You can customize the following formatting behavior:

use sqler::Config;

let config = Config {
  indent_char: " ".to_string(),
  indent_width: 2,
  max_line_length: 120,
};

Building from Source

1. Clone the repo
2. Build the project:

cargo build --release

Running in a CLI

1. Install rustup, cargo, and rust
2. Clone the repo
3. Build the project:

cargo build -p sqler-cli

4. Install the cli globally

cargo install --path sqler-cli

5. Echo in sql code to format:

echo "SELECT id AS user_id, name, * FROM users WHERE age > 25" | sqler