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
//! An asynchronous, runtime-independent, pure-rust Tabular Data Stream (TDS) //! implementation for Microsoft SQL Server. //! //! # Connecting with async-std //! //! Being not bound to any single runtime, a `TcpStream` must be created //! separately and injected to the [`Client`]. //! //! ```no_run //! use tiberius::{Client, Config, AuthMethod}; //! use async_std::net::TcpStream; //! //! #[async_std::main] //! async fn main() -> anyhow::Result<()> { //! // Using the builder method to construct the options. //! let mut config = Config::new(); //! //! config.host("localhost"); //! config.port(1433); //! //! // Using SQL Server authentication. //! config.authentication(AuthMethod::sql_server("SA", "<password>")); //! //! // Taking the address from the configuration, using async-std's //! // TcpStream to connect to the server. //! let tcp = TcpStream::connect(config.get_addr()).await?; //! //! // We'll disable the Nagle algorithm. Buffering is handled //! // internally with a `Sink`. //! tcp.set_nodelay(true)?; //! //! // Handling TLS, login and other details related to the SQL Server. //! let mut client = Client::connect(config, tcp).await?; //! //! // A response to a query is a stream of data, that must be //! // polled to the end before querying again. Using streams allows //! // fetching data in an asynchronous manner, if needed. //! let mut stream = client.query("SELECT @P1", &[&-4i32]).await?; //! //! // As long as the `next_resultset` returns true, the stream has //! // more results and can be polled. For each result set, the stream //! // returns rows until the end of that result. In a case where //! // `next_resultset` is true, polling again will return rows from //! // the next query. //! assert!(stream.next_resultset()); //! //! // In this case, we know we have only one query, returning one row //! // and one column, so calling `into_row` will consume the stream //! // and return us the first row of the first result. //! let row = stream.into_row().await?; //! //! assert_eq!(Some(-4i32), row.unwrap().get(0)); //! //! Ok(()) //! } //! ``` //! //! # Connecting with Tokio //! //! Tokio is using their own version of `AsyncRead` and `AsyncWrite` traits, //! meaning that when wanting to use Tiberius with Tokio, their `TcpStream` //! needs to be wrapped in Tokio's `Compat` module. //! //! ```no_run //! use tiberius::{Client, Config, AuthMethod}; //! use tokio::net::TcpStream; //! use tokio_util::compat::TokioAsyncWriteCompatExt; //! //! #[tokio::main] //! async fn main() -> anyhow::Result<()> { //! let mut config = Config::new(); //! //! config.host("localhost"); //! config.port(1433); //! config.authentication(AuthMethod::sql_server("SA", "<password>")); //! //! let tcp = TcpStream::connect(config.get_addr()).await?; //! tcp.set_nodelay(true)?; //! //! // To be able to use Tokio's tcp, we're using the `compat_write` from //! // the `TokioAsyncWriteCompatExt` to get a stream compatible with the //! // traits from the `futures` crate. //! let mut client = Client::connect(config, tcp.compat_write()).await?; //! # client.query("SELECT @P1", &[&-4i32]).await?; //! //! Ok(()) //! } //! ``` //! //! # Authentication //! //! Tiberius supports different [ways of authentication] to the SQL Server: //! //! - SQL Server authentication uses the facilities of the database to //! authenticate the user. //! - On Windows, you can authenticate using the currently logged in user or //! specified Windows credentials. //! - If enabling the `integrated-auth-gssapi` feature, it is possible to login //! with the currently active Kerberos credentials. //! //! # TLS //! //! When compiled using the default features, a TLS encryption will be available //! and by default, used for all traffic. TLS is handled with the given //! `TcpStream`. Please see the documentation for [`EncryptionLevel`] for //! details. //! //! # SQL Browser //! //! On Windows platforms, connecting to the SQL Server might require going through //! the SQL Browser service to get the correct port for the named instance. This //! feature requires either the `sql-browser-async-std` or `sql-browser-tokio` feature //! flag to be enabled and has a bit different way of connecting: //! //! ```no_run //! # #[cfg(any(feature = "sql-browser-async-std", feature = "sql-browser-tokio"))] //! use tiberius::{Client, Config, AuthMethod}; //! # #[cfg(any(feature = "sql-browser-async-std", feature = "sql-browser-tokio"))] //! use async_std::net::TcpStream; //! //! // An extra trait that allows connecting to a named instance with the given //! // `TcpStream`. //! # #[cfg(any(feature = "sql-browser-async-std", feature = "sql-browser-tokio"))] //! use tiberius::SqlBrowser; //! //! #[async_std::main] //! # #[cfg(any(feature = "sql-browser-async-std", feature = "sql-browser-tokio"))] //! async fn main() -> anyhow::Result<()> { //! let mut config = Config::new(); //! //! config.authentication(AuthMethod::sql_server("SA", "<password>")); //! config.host("localhost"); //! //! // The default port of SQL Browser //! config.port(1434); //! //! // The name of the database server instance. //! config.instance_name("INSTANCE"); //! //! // This will create a new `TcpStream` from `async-std`, connected to the //! // right port of the named instance. //! let tcp = TcpStream::connect_named(&config).await?; //! //! // And from here on continue the connection process in a normal way. //! let mut client = Client::connect(config, tcp).await?; //! # client.query("SELECT @P1", &[&-4i32]).await?; //! Ok(()) //! } //! # #[cfg(any(not(feature = "sql-browser-async-std"), not(feature = "sql-browser-tokio")))] //! # fn main() {} //! ``` //! //! # Other features //! //! - If using an [ADO.NET connection string], it is possible to create a //! [`Config`] from one. Please see the documentation for //! [`from_ado_string`] for details. //! - If wanting to use Tiberius with SQL Server version 2005, one must //! disable the `tds73` feature. //! //! [`EncryptionLevel`]: enum.EncryptionLevel.html //! [`Client`]: struct.Client.html //! [`Config`]: struct.Config.html //! [`from_ado_string`]: struct.Config.html#method.from_ado_string //! [`time`]: time/index.html //! [ways of authentication]: enum.AuthMethod.html //! [ADO.NET connection string]: https://docs.microsoft.com/en-us/dotnet/framework/data/adonet/connection-strings #![cfg_attr(feature = "docs", feature(doc_cfg))] #![recursion_limit = "512"] #![warn(missing_docs)] #![warn(missing_debug_implementations, rust_2018_idioms)] #![doc(test(attr(deny(rust_2018_idioms, warnings))))] #![doc(test(attr(allow(unused_extern_crates, unused_variables))))] #[cfg(feature = "bigdecimal")] pub(crate) extern crate bigdecimal_ as bigdecimal; #[macro_use] mod macros; mod client; mod from_sql; mod sql_read_bytes; mod to_sql; pub mod error; mod result; mod row; mod tds; mod sql_browser; pub use client::{AuthMethod, Client, Config}; pub(crate) use error::Error; pub use from_sql::{FromSql, FromSqlOwned}; pub use result::*; pub use row::{Column, ColumnType, Row}; pub use sql_browser::SqlBrowser; pub use tds::{codec::ColumnData, numeric, time, xml, EncryptionLevel}; pub use to_sql::{IntoSql, ToSql}; pub use uuid::Uuid; use sql_read_bytes::*; use tds::codec::*; /// An alias for a result that holds crate's error type as the error. pub type Result<T> = std::result::Result<T, Error>; pub(crate) fn get_driver_version() -> u64 { env!("CARGO_PKG_VERSION") .splitn(6, '.') .enumerate() .fold(0u64, |acc, part| match part.1.parse::<u64>() { Ok(num) => acc | num << (part.0 * 8), _ => acc | 0 << (part.0 * 8), }) }