Struct AdhocQueryArgs

pub struct AdhocQueryArgs {
    pub sql: String,
    pub format: AdHocResultFormat,
}

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.

Fields

sql: String

The SQL query to run.

format: AdHocResultFormat

In what format the data is sent to the client.

Trait Implementations

impl Clone for AdhocQueryArgs

fn clone(&self) -> AdhocQueryArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AdhocQueryArgs

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

Formats the value using the given formatter.

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.

impl PartialEq for AdhocQueryArgs

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl<'__s> ToSchema<'__s> for AdhocQueryArgs

fn schema() -> (&'__s str, RefOr<Schema>)

Return a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

fn aliases() -> Vec<(&'__s str, Schema)>

Optional set of alias schemas for the ToSchema::schema.

impl StructuralPartialEq for AdhocQueryArgs