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 360
use futures_core::future::BoxFuture;
use std::borrow::Cow;
use std::ops::{Deref, DerefMut};
use futures_core::stream::BoxStream;
use sqlx_core::bytes::{BufMut, Bytes};
use crate::connection::PgConnection;
use crate::error::{Error, Result};
use crate::ext::async_stream::TryAsyncStream;
use crate::io::{AsyncRead, AsyncReadExt};
use crate::message::{
CommandComplete, CopyData, CopyDone, CopyFail, CopyResponse, MessageFormat, Query,
};
use crate::pool::{Pool, PoolConnection};
use crate::Postgres;
impl PgConnection {
/// Issue a `COPY FROM STDIN` statement and transition the connection to streaming data
/// to Postgres. This is a more efficient way to import data into Postgres as compared to
/// `INSERT` but requires one of a few specific data formats (text/CSV/binary).
///
/// If `statement` is anything other than a `COPY ... FROM STDIN ...` command, an error is
/// returned.
///
/// Command examples and accepted formats for `COPY` data are shown here:
/// https://www.postgresql.org/docs/current/sql-copy.html
///
/// ### Note
/// [PgCopyIn::finish] or [PgCopyIn::abort] *must* be called when finished or the connection
/// will return an error the next time it is used.
pub async fn copy_in_raw(&mut self, statement: &str) -> Result<PgCopyIn<&mut Self>> {
PgCopyIn::begin(self, statement).await
}
/// Issue a `COPY TO STDOUT` statement and transition the connection to streaming data
/// from Postgres. This is a more efficient way to export data from Postgres but
/// arrives in chunks of one of a few data formats (text/CSV/binary).
///
/// If `statement` is anything other than a `COPY ... TO STDOUT ...` command,
/// an error is returned.
///
/// Note that once this process has begun, unless you read the stream to completion,
/// it can only be canceled in two ways:
///
/// 1. by closing the connection, or:
/// 2. by using another connection to kill the server process that is sending the data as shown
/// [in this StackOverflow answer](https://stackoverflow.com/a/35319598).
///
/// If you don't read the stream to completion, the next time the connection is used it will
/// need to read and discard all the remaining queued data, which could take some time.
///
/// Command examples and accepted formats for `COPY` data are shown here:
/// https://www.postgresql.org/docs/current/sql-copy.html
#[allow(clippy::needless_lifetimes)]
pub async fn copy_out_raw<'c>(
&'c mut self,
statement: &str,
) -> Result<BoxStream<'c, Result<Bytes>>> {
pg_begin_copy_out(self, statement).await
}
}
/// Implements methods for directly executing `COPY FROM/TO STDOUT` on a [`PgPool`].
///
/// This is a replacement for the inherent methods on `PgPool` which could not exist
/// once the Postgres driver was moved out into its own crate.
pub trait PgPoolCopyExt {
/// Issue a `COPY FROM STDIN` statement and begin streaming data to Postgres.
/// This is a more efficient way to import data into Postgres as compared to
/// `INSERT` but requires one of a few specific data formats (text/CSV/binary).
///
/// A single connection will be checked out for the duration.
///
/// If `statement` is anything other than a `COPY ... FROM STDIN ...` command, an error is
/// returned.
///
/// Command examples and accepted formats for `COPY` data are shown here:
/// https://www.postgresql.org/docs/current/sql-copy.html
///
/// ### Note
/// [PgCopyIn::finish] or [PgCopyIn::abort] *must* be called when finished or the connection
/// will return an error the next time it is used.
fn copy_in_raw<'a>(
&'a self,
statement: &'a str,
) -> BoxFuture<'a, Result<PgCopyIn<PoolConnection<Postgres>>>>;
/// Issue a `COPY TO STDOUT` statement and begin streaming data
/// from Postgres. This is a more efficient way to export data from Postgres but
/// arrives in chunks of one of a few data formats (text/CSV/binary).
///
/// If `statement` is anything other than a `COPY ... TO STDOUT ...` command,
/// an error is returned.
///
/// Note that once this process has begun, unless you read the stream to completion,
/// it can only be canceled in two ways:
///
/// 1. by closing the connection, or:
/// 2. by using another connection to kill the server process that is sending the data as shown
/// [in this StackOverflow answer](https://stackoverflow.com/a/35319598).
///
/// If you don't read the stream to completion, the next time the connection is used it will
/// need to read and discard all the remaining queued data, which could take some time.
///
/// Command examples and accepted formats for `COPY` data are shown here:
/// https://www.postgresql.org/docs/current/sql-copy.html
fn copy_out_raw<'a>(
&'a self,
statement: &'a str,
) -> BoxFuture<'a, Result<BoxStream<'static, Result<Bytes>>>>;
}
impl PgPoolCopyExt for Pool<Postgres> {
fn copy_in_raw<'a>(
&'a self,
statement: &'a str,
) -> BoxFuture<'a, Result<PgCopyIn<PoolConnection<Postgres>>>> {
Box::pin(async { PgCopyIn::begin(self.acquire().await?, statement).await })
}
fn copy_out_raw<'a>(
&'a self,
statement: &'a str,
) -> BoxFuture<'a, Result<BoxStream<'static, Result<Bytes>>>> {
Box::pin(async { pg_begin_copy_out(self.acquire().await?, statement).await })
}
}
/// A connection in streaming `COPY FROM STDIN` mode.
///
/// Created by [PgConnection::copy_in_raw] or [Pool::copy_out_raw].
///
/// ### Note
/// [PgCopyIn::finish] or [PgCopyIn::abort] *must* be called when finished or the connection
/// will return an error the next time it is used.
#[must_use = "connection will error on next use if `.finish()` or `.abort()` is not called"]
pub struct PgCopyIn<C: DerefMut<Target = PgConnection>> {
conn: Option<C>,
response: CopyResponse,
}
impl<C: DerefMut<Target = PgConnection>> PgCopyIn<C> {
async fn begin(mut conn: C, statement: &str) -> Result<Self> {
conn.wait_until_ready().await?;
conn.stream.send(Query(statement)).await?;
let response = match conn.stream.recv_expect(MessageFormat::CopyInResponse).await {
Ok(res) => res,
Err(e) => {
conn.stream.recv().await?;
return Err(e);
}
};
Ok(PgCopyIn {
conn: Some(conn),
response,
})
}
/// Returns `true` if Postgres is expecting data in text or CSV format.
pub fn is_textual(&self) -> bool {
self.response.format == 0
}
/// Returns the number of columns expected in the input.
pub fn num_columns(&self) -> usize {
assert_eq!(
self.response.num_columns as usize,
self.response.format_codes.len(),
"num_columns does not match format_codes.len()"
);
self.response.format_codes.len()
}
/// Check if a column is expecting data in text format (`true`) or binary format (`false`).
///
/// ### Panics
/// If `column` is out of range according to [`.num_columns()`][Self::num_columns].
pub fn column_is_textual(&self, column: usize) -> bool {
self.response.format_codes[column] == 0
}
/// Send a chunk of `COPY` data.
///
/// If you're copying data from an `AsyncRead`, maybe consider [Self::read_from] instead.
pub async fn send(&mut self, data: impl Deref<Target = [u8]>) -> Result<&mut Self> {
self.conn
.as_deref_mut()
.expect("send_data: conn taken")
.stream
.send(CopyData(data))
.await?;
Ok(self)
}
/// Copy data directly from `source` to the database without requiring an intermediate buffer.
///
/// `source` will be read to the end.
///
/// ### Note: Completion Step Required
/// You must still call either [Self::finish] or [Self::abort] to complete the process.
///
/// ### Note: Runtime Features
/// This method uses the `AsyncRead` trait which is re-exported from either Tokio or `async-std`
/// depending on which runtime feature is used.
///
/// The runtime features _used_ to be mutually exclusive, but are no longer.
/// If both `runtime-async-std` and `runtime-tokio` features are enabled, the Tokio version
/// takes precedent.
pub async fn read_from(&mut self, mut source: impl AsyncRead + Unpin) -> Result<&mut Self> {
// this is a separate guard from WriteAndFlush so we can reuse the buffer without zeroing
struct BufGuard<'s>(&'s mut Vec<u8>);
impl Drop for BufGuard<'_> {
fn drop(&mut self) {
self.0.clear()
}
}
let conn: &mut PgConnection = self.conn.as_deref_mut().expect("copy_from: conn taken");
loop {
let buf = conn.stream.write_buffer_mut();
// CopyData format code and reserved space for length
buf.put_slice(b"d\0\0\0\x04");
let read = match () {
// Tokio lets us read into the buffer without zeroing first
#[cfg(feature = "_rt-tokio")]
_ => source.read_buf(buf.buf_mut()).await?,
#[cfg(not(feature = "_rt-tokio"))]
_ => source.read(buf.init_remaining_mut()).await?,
};
if read == 0 {
// This will end up sending an empty `CopyData` packet but that should be fine.
break;
}
buf.advance(read);
// Write the length
let read32 = u32::try_from(read)
.map_err(|_| err_protocol!("number of bytes read exceeds 2^32: {}", read))?;
(&mut buf.get_mut()[1..]).put_u32(read32 + 4);
conn.stream.flush().await?;
}
Ok(self)
}
/// Signal that the `COPY` process should be aborted and any data received should be discarded.
///
/// The given message can be used for indicating the reason for the abort in the database logs.
///
/// The server is expected to respond with an error, so only _unexpected_ errors are returned.
pub async fn abort(mut self, msg: impl Into<String>) -> Result<()> {
let mut conn = self
.conn
.take()
.expect("PgCopyIn::fail_with: conn taken illegally");
conn.stream.send(CopyFail::new(msg)).await?;
match conn.stream.recv().await {
Ok(msg) => Err(err_protocol!(
"fail_with: expected ErrorResponse, got: {:?}",
msg.format
)),
Err(Error::Database(e)) => {
match e.code() {
Some(Cow::Borrowed("57014")) => {
// postgres abort received error code
conn.stream
.recv_expect(MessageFormat::ReadyForQuery)
.await?;
Ok(())
}
_ => Err(Error::Database(e)),
}
}
Err(e) => Err(e),
}
}
/// Signal that the `COPY` process is complete.
///
/// The number of rows affected is returned.
pub async fn finish(mut self) -> Result<u64> {
let mut conn = self
.conn
.take()
.expect("CopyWriter::finish: conn taken illegally");
conn.stream.send(CopyDone).await?;
let cc: CommandComplete = match conn
.stream
.recv_expect(MessageFormat::CommandComplete)
.await
{
Ok(cc) => cc,
Err(e) => {
conn.stream.recv().await?;
return Err(e);
}
};
conn.stream
.recv_expect(MessageFormat::ReadyForQuery)
.await?;
Ok(cc.rows_affected())
}
}
impl<C: DerefMut<Target = PgConnection>> Drop for PgCopyIn<C> {
fn drop(&mut self) {
if let Some(mut conn) = self.conn.take() {
conn.stream.write(CopyFail::new(
"PgCopyIn dropped without calling finish() or fail()",
));
}
}
}
async fn pg_begin_copy_out<'c, C: DerefMut<Target = PgConnection> + Send + 'c>(
mut conn: C,
statement: &str,
) -> Result<BoxStream<'c, Result<Bytes>>> {
conn.wait_until_ready().await?;
conn.stream.send(Query(statement)).await?;
let _: CopyResponse = conn
.stream
.recv_expect(MessageFormat::CopyOutResponse)
.await?;
let stream: TryAsyncStream<'c, Bytes> = try_stream! {
loop {
let msg = conn.stream.recv().await?;
match msg.format {
MessageFormat::CopyData => r#yield!(msg.decode::<CopyData<Bytes>>()?.0),
MessageFormat::CopyDone => {
let _ = msg.decode::<CopyDone>()?;
conn.stream.recv_expect(MessageFormat::CommandComplete).await?;
conn.stream.recv_expect(MessageFormat::ReadyForQuery).await?;
return Ok(())
},
_ => return Err(err_protocol!("unexpected message format during copy out: {:?}", msg.format))
}
}
};
Ok(Box::pin(stream))
}