Struct DynamicQueryRequest 

pub struct DynamicQueryRequest {
    pub request_type: DynamicQueryRequestType,
    pub query: BatchQuery,
    pub parameters: Option<BTreeMap<String, DynamicQueryValue>>,
    pub parameter_types: Option<BTreeMap<String, QueryParamType>>,
}

Full JSON payload accepted by the gateway dynamic query route.

Fields

request_type: DynamicQueryRequestType

Whether the inline query should execute as a read or write.

query: BatchQuery

Inline query AST payload.

parameters: Option<BTreeMap<String, DynamicQueryValue>>

Runtime parameters forwarded to the query engine.

parameter_types: Option<BTreeMap<String, QueryParamType>>

Optional parameter schema used by runtimes to coerce typed inputs.

Implementations

impl DynamicQueryRequest

pub fn read(query: ReadBatch) -> Self

Create a dynamic request payload for a read batch.

pub fn write(query: WriteBatch) -> Self

Create a dynamic request payload for a write batch.

pub fn insert_parameter_value( &mut self, name: impl Into<String>, value: DynamicQueryValue, )

Insert a named parameter value into the request payload.

pub fn insert_parameter_type( &mut self, name: impl Into<String>, ty: QueryParamType, )

Insert a named parameter type into the request payload.

pub fn with_parameter_value( self, name: impl Into<String>, value: DynamicQueryValue, ) -> Self

Insert a named parameter value and return the updated request.

pub fn with_parameter_type( self, name: impl Into<String>, ty: QueryParamType, ) -> Self

Insert a named parameter type and return the updated request.

pub fn to_json_bytes(&self) -> Result<Vec<u8>, DynamicQueryError>

Serialize the request payload to JSON bytes.

pub fn to_json_string(&self) -> Result<String, DynamicQueryError>

Serialize the request payload to a JSON string.

Trait Implementations

impl Clone for DynamicQueryRequest

fn clone(&self) -> DynamicQueryRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DynamicQueryRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DynamicQueryRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DynamicQueryRequest

fn eq(&self, other: &DynamicQueryRequest) -> 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 DynamicQueryRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DynamicQueryRequest