feldera_rest_api::types

Struct AdhocQueryArgs

pub struct AdhocQueryArgs {
    pub format: Option<AdHocResultFormat>,
    pub sql: Option<String>,
}

Expand description

Arguments to the /query endpoint.

The arguments can be provided in two ways:

In case a normal HTTP connection is established to the endpoint, these arguments are passed as URL-encoded parameters. Note: this mode is deprecated and will be removed in the future.
If a Websocket connection is opened to /query, the arguments are passed to the server over the websocket as a JSON encoded string.

JSON schema

{
 "description": "Arguments to the `/query` endpoint.\n\nThe arguments can be provided in two ways:\n\n- In case a normal HTTP connection is established to the endpoint,\nthese arguments are passed as URL-encoded parameters.\nNote: this mode is deprecated and will be removed in the future.\n\n- If a Websocket connection is opened to `/query`, the arguments are passed\nto the server over the websocket as a JSON encoded string.",
 "type": "object",
 "properties": {
   "format": {
     "$ref": "#/components/schemas/AdHocResultFormat"
   },
   "sql": {
     "description": "The SQL query to run.",
     "type": "string"
   }
 }
}

Fields§

§format: Option<AdHocResultFormat>§sql: Option<String>

The SQL query to run.

Implementations§

impl AdhocQueryArgs

pub fn builder() -> AdhocQueryArgs

Trait Implementations§

impl Clone for AdhocQueryArgs

fn clone(&self) -> AdhocQueryArgs

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for AdhocQueryArgs

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for AdhocQueryArgs

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

Deserialize this value from the given Serde deserializer. Read more

impl From<&AdhocQueryArgs> for AdhocQueryArgs

fn from(value: &AdhocQueryArgs) -> Self

Converts to this type from the input type.

impl From<AdhocQueryArgs> for AdhocQueryArgs

fn from(value: AdhocQueryArgs) -> Self

Converts to this type from the input type.

impl Serialize for AdhocQueryArgs

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

Serialize this value into the given Serde serializer. Read more

impl TryFrom<AdhocQueryArgs> for AdhocQueryArgs

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: AdhocQueryArgs) -> Result<Self, ConversionError>

Performs the conversion.

Auto Trait Implementations§

impl Freeze for AdhocQueryArgs

impl RefUnwindSafe for AdhocQueryArgs

impl Send for AdhocQueryArgs

impl Sync for AdhocQueryArgs

impl Unpin for AdhocQueryArgs

impl UnwindSafe for AdhocQueryArgs

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

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

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: 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

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Serialize for T
where T: Serialize + ?Sized,

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<Ok, Error>

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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.

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

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

impl<T> ErasedDestructor for T
where T: 'static,