Struct CreateMacro

Source

pub struct CreateMacro<X: Extension = NoExt> {
    pub or_replace: bool,
    pub temporary: Option<TemporaryTableKind>,
    pub spelling: MacroSpelling,
    pub if_not_exists: bool,
    pub name: ObjectName,
    pub params: ThinVec<MacroParam<X>>,
    pub body: MacroBody<X>,
    pub meta: Meta,
}

Expand description

CREATE [OR REPLACE] [TEMP|TEMPORARY] {MACRO | FUNCTION} [IF NOT EXISTS] <name> (<param> [, ...]) AS <body> — DuckDB’s macro DDL (gated by StatementDdlGates::create_macro).

This is a distinct node from CreateFunction, not a variant of it: a DuckDB macro body is a live SQL expression or query (AS x + 1 / AS TABLE SELECT …), whereas a PostgreSQL/MySQL CREATE FUNCTION body is an opaque source string in a target language (AS 'RETURN 1'). The two share only the CREATE … (params) AS prefix; their bodies, parameter grammars (a macro parameter is a bare untyped name, a routine parameter is [name] <type>), and option tails are disjoint.

DuckDB spells the same feature with either the MACRO keyword or FUNCTION as an exact synonym; spelling records which so the source keyword round-trips (the tag pattern of TemporaryTableKind, not a semantic difference). Whole-statement gated to DuckDB (and Lenient): every other dialect either has no macro grammar (MACRO is left unconsumed and surfaces as an unknown statement) or spells CREATE FUNCTION as the incompatible string-body routine, so the gate is behaviour-accurate, not merely a modelling limitation. Boxed by the enclosing Statement::CreateMacro to keep the enum within its size budget.

The single-body surface — one (params) AS body per statement — is modelled; DuckDB additionally accepts a comma-separated overload list (… AS a, (x, y) AS b), a deliberate follow-up (no vendored corpus statement spells it) the shape would extend by lifting params/body into an overload sequence.

Fields§

§or_replace: bool

Whether the or replace form was present in the source.

§temporary: Option<TemporaryTableKind>

Optional temporary for this syntax.

§spelling: MacroSpelling

Exact source spelling retained for faithful rendering.

§if_not_exists: bool

Whether the if not exists form was present in the source.

§name: ObjectName

Name referenced by this syntax.

§params: ThinVec<MacroParam<X>>

params in source order.

§body: MacroBody<X>

Statement or query body governed by this node.

§meta: Meta

Source location and node identity.

CreateMacro

Struct CreateMacro Copy item path

Fields§

Trait Implementations§

impl<X: Clone + Extension> Clone for CreateMacro<X>

fn clone(&self) -> CreateMacro<X>

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

impl<X: Debug + Extension> Debug for CreateMacro<X>

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

impl<'de, X> Deserialize<'de> for CreateMacro<X>where X: Deserialize<'de> + Extension,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

impl<X: Eq + Extension> Eq for CreateMacro<X>

impl<X: Hash + Extension> Hash for CreateMacro<X>

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

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

impl<X: PartialEq + Extension> PartialEq for CreateMacro<X>

fn eq(&self, other: &CreateMacro<X>) -> bool

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

impl<X: Extension + Render> Render for CreateMacro<X>

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

fn operand_binding_power(&self) -> Option<BindingPower>

impl<X> Serialize for CreateMacro<X>where X: Serialize + Extension,

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

impl<X: Extension> Spanned for CreateMacro<X>

fn span(&self) -> Span

impl<X: PartialEq + Extension> StructuralPartialEq for CreateMacro<X>

Auto Trait Implementations§

impl<X> Freeze for CreateMacro<X>

impl<X> RefUnwindSafe for CreateMacro<X>where X: RefUnwindSafe,

impl<X> Send for CreateMacro<X>where X: Send,

impl<X> Sync for CreateMacro<X>where X: Sync,

impl<X> Unpin for CreateMacro<X>where X: Unpin,

impl<X> UnsafeUnpin for CreateMacro<X>

impl<X> UnwindSafe for CreateMacro<X>where X: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> CloneToUninit for Twhere T: Clone,

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

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,

impl<T> DynAstExt for Twhere T: Extension + Render + 'static,

fn as_any(&self) -> &(dyn Any + 'static)

fn dyn_clone(&self) -> Box<dyn DynAstExt>

fn dyn_eq(&self, other: &dyn DynAstExt) -> bool

fn dyn_hash(&self, state: &mut dyn Hasher)

impl<T> Extension for Twhere T: Clone + Debug + Eq + Hash + Spanned,

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> RenderExt for Twhere T: Render,

fn displayed<'a>(&'a self, ctx: &'a RenderCtx<'a>) -> Displayed<'a, T>

fn debug_sql<'a>(&'a self, resolver: &'a dyn Resolver) -> DebugSql<'a, Self>where Self: Sized,

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

Struct CreateMacro

impl<'de, X> Deserialize<'de> for CreateMacro<X>
where X: Deserialize<'de> + Extension,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

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

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

impl<X> Serialize for CreateMacro<X>
where X: Serialize + Extension,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

impl<X> RefUnwindSafe for CreateMacro<X>
where X: RefUnwindSafe,

impl<X> Send for CreateMacro<X>
where X: Send,

impl<X> Sync for CreateMacro<X>
where X: Sync,

impl<X> Unpin for CreateMacro<X>
where X: Unpin,

impl<X> UnwindSafe for CreateMacro<X>
where X: UnwindSafe,

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

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

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

impl<T> CloneToUninit for T
where T: Clone,

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> DynAstExt for T
where T: Extension + Render + 'static,

impl<T> Extension for T
where T: Clone + Debug + Eq + Hash + Spanned,

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

impl<T> RenderExt for T
where T: Render,

fn debug_sql<'a>(&'a self, resolver: &'a dyn Resolver) -> DebugSql<'a, Self>
where Self: Sized,

impl<T> ToOwned for T
where T: Clone,

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

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