Enum mz_pgwire_common::message::FrontendMessage

source ·
pub enum FrontendMessage {
Show 15 variants Query { sql: String, }, Parse { name: String, sql: String, param_types: Vec<u32>, }, DescribeStatement { name: String, }, DescribePortal { name: String, }, Bind { portal_name: String, statement_name: String, param_formats: Vec<Format>, raw_params: Vec<Option<Vec<u8>>>, result_formats: Vec<Format>, }, Execute { portal_name: String, max_rows: i32, }, Flush, Sync, CloseStatement { name: String, }, ClosePortal { name: String, }, Terminate, CopyData(Vec<u8>), CopyDone, CopyFail(String), Password { password: String, },
}
Expand description

A decoded frontend pgwire message, representing instructions for the backend.

Variants§

§

Query

Execute the specified SQL.

This is issued as part of the simple query flow.

Fields

§sql: String

The SQL to execute.

§

Parse

Parse the specified SQL into a prepared statement.

This starts the extended query flow.

Fields

§name: String

The name of the prepared statement to create. An empty string specifies the unnamed prepared statement.

§sql: String

The SQL to parse.

§param_types: Vec<u32>

The OID of each parameter data type for which the client wants to prespecify types. A zero OID is equivalent to leaving the type unspecified.

The number of specified parameter data types can be less than the number of parameters specified in the query.

§

DescribeStatement

Describe an existing prepared statement.

This command is part of the extended query flow.

Fields

§name: String

The name of the prepared statement to describe.

§

DescribePortal

Describe an existing portal.

This command is part of the extended query flow.

Fields

§name: String

The name of the portal to describe.

§

Bind

Bind an existing prepared statement to a portal.

This command is part of the extended query flow.

Fields

§portal_name: String

The destination portal. An empty string selects the unnamed portal. The portal can later be executed with the Execute command.

§statement_name: String

The source prepared statement. An empty string selects the unnamed prepared statement.

§param_formats: Vec<Format>

The formats used to encode the parameters in raw_parameters.

§raw_params: Vec<Option<Vec<u8>>>

The value of each parameter, encoded using the formats described by parameter_formats.

§result_formats: Vec<Format>

The desired formats for the columns in the result set.

§

Execute

Execute a bound portal.

This command is part of the extended query flow.

Fields

§portal_name: String

The name of the portal to execute.

§max_rows: i32

The maximum number number of rows to return before suspending.

0 or negative means infinite.

§

Flush

Flush any pending output.

This command is part of the extended query flow.

§

Sync

Finish an extended query.

This command is part of the extended query flow.

§

CloseStatement

Close the named statement.

This command is part of the extended query flow.

Fields

§name: String
§

ClosePortal

Close the named portal.

Fields

§name: String
§

Terminate

Terminate a connection.

§

CopyData(Vec<u8>)

§

CopyDone

§

CopyFail(String)

§

Password

Fields

§password: String

Implementations§

source§

impl FrontendMessage

source

pub fn encode(&self, dst: &mut BytesMut) -> Result<(), Error>

Encodes self into dst.

source§

impl FrontendMessage

source

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

Trait Implementations§

source§

impl Debug for FrontendMessage

source§

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

Formats the value using the given formatter. 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<T, U> CastInto<U> for T
where U: CastFrom<T>,

source§

fn cast_into(self) -> U

Performs the cast.
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> IntoRequest<T> for T

source§

fn into_request(self) -> Request<T>

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

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
§

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<P, R> ProtoType<R> for P
where R: RustType<P>,

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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
source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,