Struct SqlLanguage 

pub struct SqlLanguage {
    pub case_sensitive: bool,
    pub quoted_identifiers: bool,
    pub backtick_identifiers: bool,
    pub bracket_identifiers: bool,
}

SQL language implementation.

Fields

case_sensitive: bool

Whether it is case sensitive.

quoted_identifiers: bool

Whether to allow double-quoted identifiers.

backtick_identifiers: bool

Whether to allow backtick identifiers.

bracket_identifiers: bool

Whether to allow bracket identifiers.

Implementations

impl SqlLanguage

pub fn new() -> Self

Creates a new SQL language instance.

pub fn standard() -> Self

Creates a standard SQL language instance.

pub fn mysql() -> Self

Creates a MySQL-style SQL language instance.

pub fn postgresql() -> Self

Creates a PostgreSQL-style SQL language instance.

pub fn sqlite() -> Self

SQLite configuration.

pub fn sqlserver() -> Self

Creates a SQL Server-style SQL language instance.

Trait Implementations

impl<'config> Builder<SqlLanguage> for SqlBuilder<'config>

fn build<'a, S: Source + ?Sized>( &self, source: &S, edits: &[TextEdit], cache: &'a mut impl BuilderCache<SqlLanguage>, ) -> BuildOutput<SqlLanguage>

Builds the SQL AST from the source text and edits.

This is the main entry point for the builder. It performs the following steps:

1. Initializes a SqlParser with the current configuration.
2. Executes the parser to produce a RedTree (Concrete Syntax Tree).
3. Converts the resulting green tree into a typed SqlRoot AST.
4. Handles incremental updates by passing edits to the parser.

Examples

use oak_core::{Builder, ParseSession, source::SourceText};
use oak_sql::{SqlBuilder, SqlLanguage};

let config = SqlLanguage::default();
let builder = SqlBuilder::new(&config);
let mut cache = ParseSession::default();
let source = "SELECT * FROM users";
let output = builder.build(&source, &[], &mut cache);

if let Ok(root) = output.result {
    assert_eq!(root.statements.len(), 1);
}

Errors

Returns an error if parsing fails or if the CST cannot be lowered to a valid AST.

impl Clone for SqlLanguage

fn clone(&self) -> SqlLanguage

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SqlLanguage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SqlLanguage

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SqlLanguage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for SqlLanguage

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl HoverProvider<SqlLanguage> for SqlHoverProvider

Available on crate feature lsp only.

fn hover( &self, node: &RedNode<'_, SqlLanguage>, _range: Range<usize>, ) -> Option<Hover>

Returns hover information at the given range.

impl Language for SqlLanguage

const NAME: &'static str = "sql"

The name of the language (e.g., “rust”, “sql”).

const CATEGORY: LanguageCategory = LanguageCategory::Dsl

The category of the language.

type TokenType = SqlTokenType

The token type used to represent different token and node types in the language.

type ElementType = SqlElementType

The element type used to represent composite structures in the parsed tree.

type TypedRoot = SqlRoot

The root type for the parsed tree that represents the top-level structure of the language.

impl<'config> Lexer<SqlLanguage> for SqlLexer<'config>

fn lex<'a, S: Source + ?Sized>( &self, text: &S, _edits: &[TextEdit], cache: &'a mut impl LexerCache<SqlLanguage>, ) -> LexOutput<SqlLanguage>

Tokenizes the given source text into a sequence of tokens.

impl<'config> Parser<SqlLanguage> for SqlParser<'config>

fn parse<'a, S: Source + ?Sized>( &self, text: &'a S, edits: &[TextEdit], cache: &'a mut impl ParseCache<SqlLanguage>, ) -> ParseOutput<'a, SqlLanguage>

The core parsing entry point.

impl PartialEq for SqlLanguage

fn eq(&self, other: &SqlLanguage) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'config> Pratt<SqlLanguage> for SqlParser<'config>

fn primary<'a, S: Source + ?Sized>( &self, state: &mut ParserState<'a, SqlLanguage, S>, ) -> &'a GreenNode<'a, SqlLanguage>

Parses a primary expression (e.g., literals, identifiers, group).

fn prefix<'a, S: Source + ?Sized>( &self, state: &mut ParserState<'a, SqlLanguage, S>, ) -> &'a GreenNode<'a, SqlLanguage>

Handles prefix operators and primary expressions.

fn infix<'a, S: Source + ?Sized>( &self, state: &mut ParserState<'a, SqlLanguage, S>, left: &'a GreenNode<'a, SqlLanguage>, min_precedence: u8, ) -> Option<&'a GreenNode<'a, SqlLanguage>>

Handles infix and postfix operators.

impl Serialize for SqlLanguage

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for SqlLanguage

impl Eq for SqlLanguage

impl StructuralPartialEq for SqlLanguage