1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
use super::MySqlStream;
use crate::connection::stream::Waiting;
use crate::connection::MySqlConnection;
use crate::io::MySqlBufExt;
use crate::protocol::response::Status;
use crate::protocol::statement::{
BinaryRow, Execute as StatementExecute, Prepare, PrepareOk, StmtClose,
};
use crate::protocol::text::{ColumnDefinition, Query, TextRow};
use crate::query::MysqlQuery;
use crate::query_result::MySqlQueryResult;
use crate::result_set::{MySqlColumn, MySqlTypeInfo};
use crate::row::MySqlRow;
use crate::stmt::{MySqlArguments, MySqlStatement, MySqlStatementMetadata};
use crate::value::MySqlValueFormat;
use either::Either;
use futures_core::future::BoxFuture;
use futures_core::stream::BoxStream;
use futures_core::Stream;
use futures_util::{pin_mut, TryStreamExt};
use rbdc::ext::ustr::UStr;
use rbdc::{try_stream, Error};
use std::collections::HashMap;
use std::sync::Arc;
impl MySqlConnection {
async fn get_or_prepare<'c>(
&mut self,
sql: &str,
persistent: bool,
) -> Result<(u32, MySqlStatementMetadata), Error> {
if let Some(statement) = self.cache_statement.get_mut(sql) {
// <MySqlStatementMetadata> is internally reference-counted
return Ok((*statement).clone());
}
// https://dev.mysql.com/doc/internals/en/com-stmt-prepare.html
// https://dev.mysql.com/doc/internals/en/com-stmt-prepare-response.html#packet-COM_STMT_PREPARE_OK
self.stream.send_packet(Prepare { query: sql }).await?;
let ok: PrepareOk = self.stream.recv().await?;
// the parameter definitions are very unreliable so we skip over them
// as we have little use
if ok.params > 0 {
for _ in 0..ok.params {
let _def: ColumnDefinition = self.stream.recv().await?;
}
self.stream.maybe_recv_eof().await?;
}
// the column definitions are berefit the type information from the
// to-be-bound parameters; we will receive the output column definitions
// once more on execute so we wait for that
let mut columns = Vec::new();
let column_names = if ok.columns > 0 {
recv_result_metadata(&mut self.stream, ok.columns as usize, &mut columns).await?
} else {
Default::default()
};
let id = ok.statement_id;
let metadata = MySqlStatementMetadata {
parameters: ok.params as usize,
columns: Arc::new(columns),
column_names: Arc::new(column_names),
};
if persistent && self.cache_statement.is_enabled() {
// in case of the cache being full, close the least recently used statement
if let Some((id, _)) = self.cache_statement.insert(sql, (id, metadata.clone())) {
self.stream.send_packet(StmtClose { statement: id }).await?;
}
}
Ok((id, metadata))
}
#[allow(clippy::needless_lifetimes)]
async fn run<'e, 'q: 'e>(
&'e mut self,
sql: &'q str,
arguments: Option<MySqlArguments>,
persistent: bool,
) -> Result<impl Stream<Item = Result<Either<MySqlQueryResult, MySqlRow>, Error>> + 'e, Error>
{
self.stream.wait_until_ready().await?;
self.stream.waiting.push_back(Waiting::Result);
Ok(Box::pin(try_stream! {
// make a slot for the shared column data
// as long as a reference to a row is not held past one iteration, this enables us
// to re-use this memory freely between result sets
let mut columns = Arc::new(Vec::new());
let (mut column_names, format, mut needs_metadata) = if let Some(arguments) = arguments {
let (id, metadata) = self.get_or_prepare(
sql,
persistent,
)
.await?;
// https://dev.mysql.com/doc/internals/en/com-stmt-execute.html
self.stream
.send_packet(StatementExecute {
statement_id: id,
arguments: &arguments,
})
.await?;
(metadata.column_names, MySqlValueFormat::Binary, false)
} else {
// https://dev.mysql.com/doc/internals/en/com-query.html
self.stream.send_packet(Query(sql)).await?;
(Arc::default(), MySqlValueFormat::Text, true)
};
loop {
// query response is a meta-packet which may be one of:
// Ok, Err, ResultSet, or (unhandled) LocalInfileRequest
let mut packet = self.stream.recv_packet().await?;
if packet[0] == 0x00 || packet[0] == 0xff {
// first packet in a query response is OK or ERR
// this indicates either a successful query with no rows at all or a failed query
let ok = packet.ok()?;
let rows_affected = ok.affected_rows;
let done = MySqlQueryResult {
rows_affected,
last_insert_id: ok.last_insert_id,
};
r#yield!(Either::Left(done));
if ok.status.contains(Status::SERVER_MORE_RESULTS_EXISTS) {
// more result sets exist, continue to the next one
continue;
}
self.stream.waiting.pop_front();
return Ok(());
}
// otherwise, this first packet is the start of the result-set metadata,
*self.stream.waiting.front_mut().unwrap() = Waiting::Row;
let num_columns = packet.get_uint_lenenc() as usize; // column count
if needs_metadata {
column_names = Arc::new(recv_result_metadata(&mut self.stream, num_columns, Arc::make_mut(&mut columns)).await?);
} else {
// next time we hit here, it'll be a new result set and we'll need the
// full metadata
needs_metadata = true;
recv_result_columns(&mut self.stream, num_columns, Arc::make_mut(&mut columns)).await?;
}
// finally, there will be none or many result-rows
loop {
let packet = self.stream.recv_packet().await?;
if packet[0] == 0xfe && packet.len() < 9 {
let eof = packet.eof(self.stream.capabilities)?;
r#yield!(Either::Left(MySqlQueryResult {
rows_affected: 0,
last_insert_id: 0,
}));
if eof.status.contains(Status::SERVER_MORE_RESULTS_EXISTS) {
// more result sets exist, continue to the next one
*self.stream.waiting.front_mut().unwrap() = Waiting::Result;
break;
}
self.stream.waiting.pop_front();
return Ok(());
}
let row = match format {
MySqlValueFormat::Binary => packet.decode_with::<BinaryRow, _>(&columns)?.0,
MySqlValueFormat::Text => packet.decode_with::<TextRow, _>(&columns)?.0,
};
let v = Either::Right(MySqlRow {
row,
format,
columns: Arc::clone(&columns),
column_names: Arc::clone(&column_names),
});
r#yield!(v);
}
}
}))
}
}
impl MySqlConnection {
pub async fn execute(&mut self, sql: &str) -> Result<Option<MySqlRow>, Error> {
self.fetch_optional(MysqlQuery {
statement: Either::Left(sql.to_string()),
arguments: vec![],
persistent: false,
})
.await
}
pub fn fetch_many(
&mut self,
query: MysqlQuery,
) -> BoxStream<'_, Result<Either<MySqlQueryResult, MySqlRow>, Error>> {
let sql = query.sql().to_owned();
let persistent = query.persistent();
let arguments = query.take_arguments();
Box::pin(try_stream! {
let s = self.run(&sql, arguments, persistent).await?;
pin_mut!(s);
while let Some(v) = s.try_next().await? {
r#yield!(v);
}
Ok(())
})
}
pub fn fetch_optional(
&mut self,
query: MysqlQuery,
) -> BoxFuture<'_, Result<Option<MySqlRow>, Error>> {
let mut s = self.fetch_many(query);
Box::pin(async move {
while let Some(v) = s.try_next().await? {
if let Either::Right(r) = v {
return Ok(Some(r));
}
}
Ok(None)
})
}
pub fn prepare_with<'e>(
&'e mut self,
sql: &'e str,
_: &'e [MySqlTypeInfo],
) -> BoxFuture<'e, Result<MySqlStatement, Error>> {
let sql = sql.to_string();
Box::pin(async move {
self.stream.wait_until_ready().await?;
let (_, metadata) = self.get_or_prepare(&sql, true).await?;
Ok(MySqlStatement {
sql: sql,
// metadata has internal Arcs for expensive data structures
metadata: metadata.clone(),
})
})
}
// #[doc(hidden)]
// pub fn describe<'e, 'q: 'e>(mut self, sql: &'q str) -> BoxFuture<'e, Result<Describe, Error>> {
// Box::pin(async move {
// self.stream.wait_until_ready().await?;
//
// let (_, metadata) = self.get_or_prepare(sql, false).await?;
//
// let columns = (&*metadata.columns).clone();
//
// let nullable = columns
// .iter()
// // .map(|col| {
// // col.flags
// // .map(|flags| !flags.contains(ColumnFlags::NOT_NULL))
// // })
// .collect();
//
// Ok(Describe {
// parameters: Some(Either::Right(metadata.parameters)),
// columns,
// nullable,
// })
// })
// }
}
async fn recv_result_columns(
stream: &mut MySqlStream,
num_columns: usize,
columns: &mut Vec<MySqlColumn>,
) -> Result<(), Error> {
columns.clear();
columns.reserve(num_columns);
for ordinal in 0..num_columns {
columns.push(recv_next_result_column(&stream.recv().await?, ordinal)?);
}
if num_columns > 0 {
stream.maybe_recv_eof().await?;
}
Ok(())
}
fn recv_next_result_column(def: &ColumnDefinition, ordinal: usize) -> Result<MySqlColumn, Error> {
// if the alias is empty, use the alias
// only then use the name
let name = match (def.name()?, def.alias()?) {
(_, alias) if !alias.is_empty() => UStr::new(alias),
(name, _) => UStr::new(name),
};
let type_info = MySqlTypeInfo::from_column(&def);
Ok(MySqlColumn {
name,
type_info,
ordinal,
// flags: Some(def.flags),
})
}
async fn recv_result_metadata(
stream: &mut MySqlStream,
num_columns: usize,
columns: &mut Vec<MySqlColumn>,
) -> Result<HashMap<UStr, (usize, MySqlTypeInfo)>, Error> {
// the result-set metadata is primarily a listing of each output
// column in the result-set
let mut column_names = HashMap::with_capacity(num_columns);
columns.clear();
columns.reserve(num_columns);
for ordinal in 0..num_columns {
let def: ColumnDefinition = stream.recv().await?;
let column = recv_next_result_column(&def, ordinal)?;
column_names.insert(column.name.clone(), (ordinal, column.type_info.clone()));
columns.push(column);
}
stream.maybe_recv_eof().await?;
Ok(column_names)
}