Skip to main content

Stmt

Enum Stmt 

Source
pub enum Stmt {
Show 24 variants Query(Box<QueryStmt>), Scroll(Box<ScrollStmt>), Upsert(Box<UpsertStmt>), CreateCollection(Box<CreateCollectionStmt>), CreateIndex(Box<CreateIndexStmt>), DropIndex(Box<DropIndexStmt>), CreateShardKey(Box<CreateShardKeyStmt>), DropShardKey(Box<DropShardKeyStmt>), AlterCollection(Box<AlterCollectionStmt>), DropCollection(Box<DropCollectionStmt>), ShowCollections, ShowCollection(String), ShowShardKeys(String), Delete(Box<DeleteStmt>), ClearPayload(Box<ClearPayloadStmt>), DeletePayload(Box<DeletePayloadStmt>), DeleteVector(Box<DeleteVectorStmt>), UpdateVector(Box<UpdateVectorStmt>), UpdatePayload(Box<UpdatePayloadStmt>), Count(Box<CountStmt>), Facet(Box<FacetStmt>), ShowQuotas, SetQuota(Box<SetQuotaStmt>), Batch(Box<BatchStmt>),
}
Expand description

Top-level QQL statement parsed from a script.

Variants§

§

Query(Box<QueryStmt>)

QUERY … retrieval (all QueryExpr forms).

§

Scroll(Box<ScrollStmt>)

SCROLL … cursor iteration.

§

Upsert(Box<UpsertStmt>)

UPSERT INTO … point write.

§

CreateCollection(Box<CreateCollectionStmt>)

CREATE COLLECTION … DDL.

§

CreateIndex(Box<CreateIndexStmt>)

CREATE INDEX … DDL.

§

DropIndex(Box<DropIndexStmt>)

DROP INDEX … DDL.

§

CreateShardKey(Box<CreateShardKeyStmt>)

CREATE SHARD KEY … DDL.

§

DropShardKey(Box<DropShardKeyStmt>)

DROP SHARD KEY … DDL.

§

AlterCollection(Box<AlterCollectionStmt>)

ALTER COLLECTION … DDL.

§

DropCollection(Box<DropCollectionStmt>)

DROP COLLECTION … DDL.

§

ShowCollections

SHOW COLLECTIONS listing.

§

ShowCollection(String)

SHOW COLLECTION <name> detail.

§

ShowShardKeys(String)

SHOW SHARD KEYS ON COLLECTION <name> listing.

§

Delete(Box<DeleteStmt>)

DELETE FROM … point removal.

§

ClearPayload(Box<ClearPayloadStmt>)

CLEAR PAYLOAD … payload wipe.

§

DeletePayload(Box<DeletePayloadStmt>)

DELETE PAYLOAD <keys> … payload key removal.

§

DeleteVector(Box<DeleteVectorStmt>)

DELETE VECTOR <names> … named vector removal.

§

UpdateVector(Box<UpdateVectorStmt>)

UPDATE … SET VECTOR … vector replacement.

§

UpdatePayload(Box<UpdatePayloadStmt>)

UPDATE … SET PAYLOAD … payload merge.

§

Count(Box<CountStmt>)

COUNT … point counting.

§

Facet(Box<FacetStmt>)

FACET … categorical aggregation.

§

ShowQuotas

SHOW QUOTAS listing.

§

SetQuota(Box<SetQuotaStmt>)

SET QUOTA (…) cluster quota replacement.

§

Batch(Box<BatchStmt>)

BATCH { … } single-RPC batch of homogeneous members.

Implementations§

Source§

impl Stmt

Source

pub fn stmt_kind(&self) -> &'static str

Return the canonical keyword name for this statement variant (e.g. “QUERY”, “CREATE COLLECTION”).

Source§

impl Stmt

Source

pub fn shard_key(&self) -> Option<&ShardKey>

Custom shard routing key for this statement, if any.

Corresponds to QQL SHARD on DML, lowered to request-level shard_key (REST) / ShardKeySelector (gRPC) — never inside Filter. Keyword and numeric forms are preserved (ShardKey::Number(101) reads back as a number, never coerced to "101").

Source

pub fn set_shard_key(&mut self, shard_key: Option<ShardKey>) -> bool

Set custom shard routing (same field as QQL SHARD).

Prefer writing the SHARD clause in the query when the tenant is known at authoring time. Use this setter only when the host resolves the key after parse (e.g. from auth context) without re-stringifying QQL.

On QUERY, recurses into CTEs and nested prefetch queries so routing matches a top-level SHARD clause. None (or an empty keyword) clears the key. Returns false for statement types that cannot carry routing (DDL, SHOW).

Trait Implementations§

Source§

impl Clone for Stmt

Source§

fn clone(&self) -> Stmt

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Stmt

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Stmt

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Stmt

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Stmt

Auto Trait Implementations§

§

impl Freeze for Stmt

§

impl RefUnwindSafe for Stmt

§

impl Send for Stmt

§

impl Sync for Stmt

§

impl Unpin for Stmt

§

impl UnsafeUnpin for Stmt

§

impl UnwindSafe for Stmt

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.