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 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
use fallible_iterator::FallibleIterator; use futures::{Async, Future, Poll, Stream}; use std::io::{self, Read}; use tokio_postgres::tls::{MakeTlsConnect, TlsConnect}; use tokio_postgres::types::{ToSql, Type}; #[cfg(feature = "runtime")] use tokio_postgres::Socket; use tokio_postgres::{Error, Row, SimpleQueryMessage}; #[cfg(feature = "runtime")] use crate::Config; use crate::{CopyOutReader, QueryIter, SimpleQueryIter, Statement, ToStatement, Transaction}; /// A synchronous PostgreSQL client. /// /// This is a lightweight wrapper over the asynchronous tokio_postgres `Client`. pub struct Client(tokio_postgres::Client); impl Client { /// A convenience function which parses a configuration string into a `Config` and then connects to the database. /// /// See the documentation for [`Config`] for information about the connection syntax. /// /// Requires the `runtime` Cargo feature (enabled by default). /// /// [`Config`]: config/struct.Config.html #[cfg(feature = "runtime")] pub fn connect<T>(params: &str, tls_mode: T) -> Result<Client, Error> where T: MakeTlsConnect<Socket> + 'static + Send, T::TlsConnect: Send, T::Stream: Send, <T::TlsConnect as TlsConnect<Socket>>::Future: Send, { params.parse::<Config>()?.connect(tls_mode) } /// Returns a new `Config` object which can be used to configure and connect to a database. /// /// Requires the `runtime` Cargo feature (enabled by default). #[cfg(feature = "runtime")] pub fn configure() -> Config { Config::new() } /// Executes a statement, returning the number of rows modified. /// /// A statement may contain parameters, specified by `$n`, where `n` is the index of the parameter of the list /// provided, 1-indexed. /// /// If the statement does not modify any rows (e.g. `SELECT`), 0 is returned. /// /// The `query` argument can either be a `Statement`, or a raw query string. If the same statement will be /// repeatedly executed (perhaps with different query parameters), consider preparing the statement up front /// with the `prepare` method. /// /// # Panics /// /// Panics if the number of parameters provided does not match the number expected. /// /// # Example /// /// ```no_run /// use postgres::{Client, NoTls}; /// /// # fn main() -> Result<(), postgres::Error> { /// let mut client = Client::connect("host=localhost user=postgres", NoTls)?; /// /// let bar = 1i32; /// let baz = true; /// let rows_updated = client.execute( /// "UPDATE foo SET bar = $1 WHERE baz = $2", /// &[&bar, &baz], /// )?; /// /// println!("{} rows updated", rows_updated); /// # Ok(()) /// # } /// ``` pub fn execute<T>(&mut self, query: &T, params: &[&dyn ToSql]) -> Result<u64, Error> where T: ?Sized + ToStatement, { let statement = query.__statement(self)?; self.0.execute(&statement, params).wait() } /// Executes a statement, returning the resulting rows. /// /// A statement may contain parameters, specified by `$n`, where `n` is the index of the parameter of the list /// provided, 1-indexed. /// /// The `query` argument can either be a `Statement`, or a raw query string. If the same statement will be /// repeatedly executed (perhaps with different query parameters), consider preparing the statement up front /// with the `prepare` method. /// /// The `query_iter` method can be used to avoid buffering all rows in memory at once. /// /// # Panics /// /// Panics if the number of parameters provided does not match the number expected. /// /// # Examples /// /// ```no_run /// use postgres::{Client, NoTls}; /// /// # fn main() -> Result<(), postgres::Error> { /// let mut client = Client::connect("host=localhost user=postgres", NoTls)?; /// /// let baz = true; /// for row in client.query("SELECT foo FROM bar WHERE baz = $1", &[&baz])? { /// let foo: i32 = row.get("foo"); /// println!("foo: {}", foo); /// } /// # Ok(()) /// # } /// ``` pub fn query<T>(&mut self, query: &T, params: &[&dyn ToSql]) -> Result<Vec<Row>, Error> where T: ?Sized + ToStatement, { self.query_iter(query, params)?.collect() } /// Like `query`, except that it returns a fallible iterator over the resulting rows rather than buffering the /// response in memory. /// /// # Panics /// /// Panics if the number of parameters provided does not match the number expected. /// /// # Examples /// /// ```no_run /// use postgres::{Client, NoTls}; /// use fallible_iterator::FallibleIterator; /// /// # fn main() -> Result<(), postgres::Error> { /// let mut client = Client::connect("host=localhost user=postgres", NoTls)?; /// /// let baz = true; /// let mut it = client.query_iter("SELECT foo FROM bar WHERE baz = $1", &[&baz])?; /// /// while let Some(row) = it.next()? { /// let foo: i32 = row.get("foo"); /// println!("foo: {}", foo); /// } /// # Ok(()) /// # } /// ``` pub fn query_iter<T>( &mut self, query: &T, params: &[&dyn ToSql], ) -> Result<QueryIter<'_>, Error> where T: ?Sized + ToStatement, { let statement = query.__statement(self)?; Ok(QueryIter::new(self.0.query(&statement, params))) } /// Creates a new prepared statement. /// /// Prepared statements can be executed repeatedly, and may contain query parameters (indicated by `$1`, `$2`, etc), /// which are set when executed. Prepared statements can only be used with the connection that created them. /// /// # Examples /// /// ```no_run /// use postgres::{Client, NoTls}; /// /// # fn main() -> Result<(), postgres::Error> { /// let mut client = Client::connect("host=localhost user=postgres", NoTls)?; /// /// let statement = client.prepare("SELECT name FROM people WHERE id = $1")?; /// /// for id in 0..10 { /// let rows = client.query(&statement, &[&id])?; /// let name: &str = rows[0].get(0); /// println!("name: {}", name); /// } /// # Ok(()) /// # } /// ``` pub fn prepare(&mut self, query: &str) -> Result<Statement, Error> { self.0.prepare(query).wait() } /// Like `prepare`, but allows the types of query parameters to be explicitly specified. /// /// The list of types may be smaller than the number of parameters - the types of the remaining parameters will be /// inferred. For example, `client.prepare_typed(query, &[])` is equivalent to `client.prepare(query)`. /// /// # Examples /// /// ```no_run /// use postgres::{Client, NoTls}; /// use postgres::types::Type; /// /// # fn main() -> Result<(), postgres::Error> { /// let mut client = Client::connect("host=localhost user=postgres", NoTls)?; /// /// let statement = client.prepare_typed( /// "SELECT name FROM people WHERE id = $1", /// &[Type::INT8], /// )?; /// /// for id in 0..10 { /// let rows = client.query(&statement, &[&id])?; /// let name: &str = rows[0].get(0); /// println!("name: {}", name); /// } /// # Ok(()) /// # } /// ``` pub fn prepare_typed(&mut self, query: &str, types: &[Type]) -> Result<Statement, Error> { self.0.prepare_typed(query, types).wait() } /// Executes a `COPY FROM STDIN` statement, returning the number of rows created. /// /// The `query` argument can either be a `Statement`, or a raw query string. The data in the provided reader is /// passed along to the server verbatim; it is the caller's responsibility to ensure it uses the proper format. /// /// # Examples /// /// ```no_run /// use postgres::{Client, NoTls}; /// /// # fn main() -> Result<(), postgres::Error> { /// let mut client = Client::connect("host=localhost user=postgres", NoTls)?; /// /// client.copy_in("COPY people FROM stdin", &[], &mut "1\tjohn\n2\tjane\n".as_bytes())?; /// # Ok(()) /// # } /// ``` pub fn copy_in<T, R>( &mut self, query: &T, params: &[&dyn ToSql], reader: R, ) -> Result<u64, Error> where T: ?Sized + ToStatement, R: Read, { let statement = query.__statement(self)?; self.0 .copy_in(&statement, params, CopyInStream(reader)) .wait() } /// Executes a `COPY TO STDOUT` statement, returning a reader of the resulting data. /// /// The `query` argument can either be a `Statement`, or a raw query string. /// /// # Examples /// /// ```no_run /// use postgres::{Client, NoTls}; /// use std::io::Read; /// /// # fn main() -> Result<(), Box<std::error::Error>> { /// let mut client = Client::connect("host=localhost user=postgres", NoTls)?; /// /// let mut reader = client.copy_out("COPY people TO stdout", &[])?; /// let mut buf = vec![]; /// reader.read_to_end(&mut buf)?; /// # Ok(()) /// # } /// ``` pub fn copy_out<T>( &mut self, query: &T, params: &[&dyn ToSql], ) -> Result<CopyOutReader<'_>, Error> where T: ?Sized + ToStatement, { let statement = query.__statement(self)?; let stream = self.0.copy_out(&statement, params); CopyOutReader::new(stream) } /// Executes a sequence of SQL statements using the simple query protocol. /// /// Statements should be separated by semicolons. If an error occurs, execution of the sequence will stop at that /// point. The simple query protocol returns the values in rows as strings rather than in their binary encodings, /// so the associated row type doesn't work with the `FromSql` trait. Rather than simply returning the rows, this /// method returns a sequence of an enum which indicates either the completion of one of the commands, or a row of /// data. This preserves the framing between the separate statements in the request. /// /// This is a simple convenience method over `simple_query_iter`. /// /// # Warning /// /// Prepared statements should be use for any query which contains user-specified data, as they provided the /// functionality to safely imbed that data in the request. Do not form statements via string concatenation and pass /// them to this method! pub fn simple_query(&mut self, query: &str) -> Result<Vec<SimpleQueryMessage>, Error> { self.simple_query_iter(query)?.collect() } /// Like `simple_query`, except that it returns a fallible iterator over the resulting values rather than buffering /// the response in memory. /// /// # Warning /// /// Prepared statements should be use for any query which contains user-specified data, as they provided the /// functionality to safely imbed that data in the request. Do not form statements via string concatenation and pass /// them to this method! pub fn simple_query_iter(&mut self, query: &str) -> Result<SimpleQueryIter<'_>, Error> { Ok(SimpleQueryIter::new(self.0.simple_query(query))) } /// Begins a new database transaction. /// /// The transaction will roll back by default - use the `commit` method to commit it. /// /// # Examples /// /// ```no_run /// use postgres::{Client, NoTls}; /// /// # fn main() -> Result<(), postgres::Error> { /// let mut client = Client::connect("host=localhost user=postgres", NoTls)?; /// /// let mut transaction = client.transaction()?; /// transaction.execute("UPDATE foo SET bar = 10", &[])?; /// // ... /// /// transaction.commit()?; /// # Ok(()) /// # } /// ``` pub fn transaction(&mut self) -> Result<Transaction<'_>, Error> { self.simple_query("BEGIN")?; Ok(Transaction::new(self)) } /// Determines if the client's connection has already closed. /// /// If this returns `true`, the client is no longer usable. pub fn is_closed(&self) -> bool { self.0.is_closed() } /// Returns a shared reference to the inner nonblocking client. pub fn get_ref(&self) -> &tokio_postgres::Client { &self.0 } /// Returns a mutable reference to the inner nonblocking client. pub fn get_mut(&mut self) -> &mut tokio_postgres::Client { &mut self.0 } /// Consumes the client, returning the inner nonblocking client. pub fn into_inner(self) -> tokio_postgres::Client { self.0 } } impl From<tokio_postgres::Client> for Client { fn from(c: tokio_postgres::Client) -> Client { Client(c) } } struct CopyInStream<R>(R); impl<R> Stream for CopyInStream<R> where R: Read, { type Item = Vec<u8>; type Error = io::Error; fn poll(&mut self) -> Poll<Option<Vec<u8>>, io::Error> { let mut buf = vec![]; match self.0.by_ref().take(4096).read_to_end(&mut buf)? { 0 => Ok(Async::Ready(None)), _ => Ok(Async::Ready(Some(buf))), } } }