Skip to main content

SqlParser

Struct SqlParser 

Source
pub struct SqlParser { /* private fields */ }
Expand description

SQL Parser with dialect awareness and caching support

§缓存优化

此实现包含 LRU 缓存,用于缓存已解析的 SQL 操作。 缓存可以显著提高重复 SQL 语句的解析性能。

§示例

use dbnexus::sql_parser::SqlParser;

let parser = SqlParser::new();
let result = parser.parse_operation("SELECT * FROM users");
// 第二次解析相同 SQL 会使用缓存
let cached = parser.parse_operation("SELECT * FROM users");

Implementations§

Source§

impl SqlParser

Source

pub async fn new() -> Self

Create a new SQL parser with generic dialect support and default cache

Source

pub async fn shared() -> Arc<SqlParser>

获取全局共享的 SqlParser 实例(推荐)

首次调用时初始化 parser + 缓存,后续调用直接返回 Arc 引用。 缓存跨所有 Session/DbPool 共享,避免重复创建开销。

性能对比

  • SqlParser::new().await:每次创建新 Cache(async + 内存分配)
  • SqlParser::shared().await:首次创建,后续 O(1) 返回 Arc clone
Source

pub async fn with_cache_size(cache_size: usize) -> Self

Create a parser with specific cache size

Source

pub async fn with_dialect(_db_type: &str) -> Self

Create a parser with specific database dialect

Source

pub async fn clear_cache(&self)

清空解析缓存

Source

pub fn cache_stats(&self) -> (u64, u64)

获取缓存命中率统计

返回 (命中次数, 未命中次数) 的元组

Source

pub async fn parse_single( &self, sql: &str, ) -> Result<ParsedSqlOperation, SqlParseError>

Parse and validate a single SQL statement

§缓存行为

解析结果会被缓存以提高重复查询的性能。 使用 clear_cache() 可手动清空缓存。

Source

pub fn parse_operation(&self, sql: &str) -> Option<(String, PermissionAction)>

Parse SQL and extract operation type (simplified version for backward compatibility)

§返回值
  • Some((table_name, action)) - 成功解析的 DML 操作
  • None - 不支持的语句类型(DDL/DCL/Transaction)或解析失败
§注意

此方法仅支持 DML 操作(SELECT, INSERT, UPDATE, DELETE)。 对于 DDL、DCL 和 Transaction 操作,返回 None

建议使用 parse_single() 获取完整的解析结果,包括操作类型信息。

§缓存行为

此方法使用内部缓存来加速重复查询。

§警告

此同步方法使用 block_on 来执行异步解析。 在异步上下文中(如 #[tokio::test])会导致运行时冲突。 请使用 parse_operation_async() 替代。

Source

pub async fn parse_operation_async( &self, sql: &str, ) -> Result<Option<(String, PermissionAction)>, SqlParseError>

Parse SQL and extract operation type (异步版本)

§返回值
  • Ok(Some((table_name, action))) - 成功解析的 DML 操作
  • Ok(None) - 不支持的语句类型(DDL/DCL/Transaction)
  • Err - 解析失败
§注意

此方法仅支持 DML 操作(SELECT, INSERT, UPDATE, DELETE)。 对于 DDL、DCL 和 Transaction 操作,返回 Ok(None)

§缓存行为

此方法使用内部缓存来加速重复查询。

Trait Implementations§

Source§

impl Default for SqlParser

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more