Struct ExecuteQueryRequest

pub struct ExecuteQueryRequest {
    pub instance_name: String,
    pub app_profile_id: String,
    pub query: String,
    pub resume_token: Vec<u8>,
    pub params: HashMap<String, Value>,
    pub data_format: Option<DataFormat>,
}

Request message for Bigtable.ExecuteQuery

Fields

instance_name: String

Required. The unique name of the instance against which the query should be executed. Values are of the form projects/<project>/instances/<instance>

app_profile_id: String

Optional. This value specifies routing for replication. If not specified, the default application profile will be used.

query: String

Required. The query string.

resume_token: Vec<u8>

Optional. If this request is resuming a previously interrupted query execution, resume_token should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the query execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token. Otherwise the request will fail.

params: HashMap<String, Value>

Required. params contains string type keys and Bigtable type values that bind to placeholders in the query string. In query string, a parameter placeholder consists of the @ character followed by the parameter name (for example, @firstName) in the query string.

For example, if params\["firstName"\] = bytes_value: "foo" type {bytes_type {}} then @firstName will be replaced with googlesql bytes value “foo” in the query string during query evaluation.

In case of Value.kind is not set, it will be set to corresponding null value in googlesql. params\["firstName"\] = type {string_type {}} then @firstName will be replaced with googlesql null string.

Value.type should always be set and no inference of type will be made from Value.kind. If Value.type is not set, we will return INVALID_ARGUMENT error.

data_format: Option<DataFormat>

Required. Requested data format for the response.

Trait Implementations

impl Clone for ExecuteQueryRequest

fn clone(&self) -> ExecuteQueryRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExecuteQueryRequest

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

Formats the value using the given formatter.

impl Default for ExecuteQueryRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ExecuteQueryRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ExecuteQueryRequest

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