Struct RpcRequest

Source

pub struct RpcRequest { /* private fields */ }

Expand description

RPC request builder.

Implementations§

Source §

impl RpcRequest

Source

pub fn named(proc_name: impl Into<String>) -> Self

Create a new RPC request for a named procedure.

Source

pub fn by_id(proc_id: ProcId) -> Self

Create a new RPC request for a well-known procedure.

Source

pub fn execute_sql(sql: &str, params: Vec<RpcParam>) -> Self

Create an sp_executesql request.

This is the primary method for parameterized queries.

§Example

use tds_protocol::rpc::{RpcRequest, RpcParam};

let rpc = RpcRequest::execute_sql(
    "SELECT * FROM users WHERE id = @p1 AND name = @p2",
    vec![
        RpcParam::int("@p1", 42),
        RpcParam::nvarchar("@p2", "Alice"),
    ],
);

Source

pub fn build_param_declarations(params: &[RpcParam]) -> String

Build parameter declaration string for sp_executesql. Build the sp_executesql @params declaration string for params.

An Always Encrypted parameter declares its plaintext column type (its EncryptedParamMetadata::base_type_info), not the BIGVARBINARY transport type its value is carried as, so the declaration matches what sp_describe_parameter_encryption was asked about.

Source

pub fn prepare(sql: &str, params: &[RpcParam]) -> Self

Create an sp_prepare request.

Source

pub fn execute(handle: i32, params: Vec<RpcParam>) -> Self

Create an sp_execute request.

Source

pub fn unprepare(handle: i32) -> Self

Create an sp_unprepare request.

Source

pub fn with_options(self, options: RpcOptionFlags) -> Self

Set option flags.

Source

pub fn param(self, param: RpcParam) -> Self

Add a parameter.

Source

pub fn encode(&self) -> Bytes

Encode the RPC request to bytes (auto-commit mode).

For requests within an explicit transaction, use Self::encode_with_transaction.

Source

pub fn encode_with_transaction(&self, transaction_descriptor: u64) -> Bytes

Encode the RPC request with a transaction descriptor.

Per MS-TDS spec, when executing within an explicit transaction:

The transaction_descriptor MUST be the value returned by the server in the BeginTransaction EnvChange token.
For auto-commit mode (no explicit transaction), use 0.