use std::str; use crate::{Error, Result, Row, Rows, Statement}; /// Information about a column of a SQLite query. #[derive(Debug)] pub struct Column<'stmt> { name: &'stmt str, decl_type: Option<&'stmt str>, } impl Column<'_> { /// Returns the name of the column. #[inline] pub fn name(&self) -> &str { self.name } /// Returns the type of the column (`None` for expression). #[inline] pub fn decl_type(&self) -> Option<&str> { self.decl_type } } impl Statement<'_> { /// Get all the column names in the result set of the prepared statement. pub fn column_names(&self) -> Vec<&str> { let n = self.column_count(); let mut cols = Vec::with_capacity(n as usize); for i in 0..n { let s = self.column_name_unwrap(i); cols.push(s); } cols } /// Return the number of columns in the result set returned by the prepared /// statement. #[inline] pub fn column_count(&self) -> usize { self.stmt.column_count() } #[inline] pub(super) fn column_name_unwrap(&self, col: usize) -> &str { // Just panic if the bounds are wrong for now, we never call this // without checking first. self.column_name(col).expect("Column out of bounds") } /// Returns the name assigned to a particular column in the result set /// returned by the prepared statement. /// /// ## Failure /// /// Returns an `Error::InvalidColumnIndex` if `idx` is outside the valid /// column range for this row. /// /// Panics when column name is not valid UTF-8. #[inline] pub fn column_name(&self, col: usize) -> Result<&str> { self.stmt .column_name(col) .ok_or(Error::InvalidColumnIndex(col)) .map(|slice| { str::from_utf8(slice.to_bytes()).expect("Invalid UTF-8 sequence in column name") }) } /// Returns the column index in the result set for a given column name. /// /// If there is no AS clause then the name of the column is unspecified and /// may change from one release of SQLite to the next. /// /// # Failure /// /// Will return an `Error::InvalidColumnName` when there is no column with /// the specified `name`. #[inline] pub fn column_index(&self, name: &str) -> Result { let bytes = name.as_bytes(); let n = self.column_count(); for i in 0..n { // Note: `column_name` is only fallible if `i` is out of bounds, // which we've already checked. if bytes.eq_ignore_ascii_case(self.stmt.column_name(i).unwrap().to_bytes()) { return Ok(i); } } Err(Error::InvalidColumnName(String::from(name))) } /// Returns a slice describing the columns of the result of the query. #[cfg(feature = "column_decltype")] pub fn columns(&self) -> Vec { let n = self.column_count(); let mut cols = Vec::with_capacity(n as usize); for i in 0..n { let name = self.column_name_unwrap(i); let slice = self.stmt.column_decltype(i); let decl_type = slice.map(|s| { str::from_utf8(s.to_bytes()).expect("Invalid UTF-8 sequence in column declaration") }); cols.push(Column { name, decl_type }); } cols } } impl<'stmt> Rows<'stmt> { /// Get all the column names. #[inline] pub fn column_names(&self) -> Option> { self.stmt.map(Statement::column_names) } /// Return the number of columns. #[inline] pub fn column_count(&self) -> Option { self.stmt.map(Statement::column_count) } /// Return the name of the column. #[inline] pub fn column_name(&self, col: usize) -> Option> { self.stmt.map(|stmt| stmt.column_name(col)) } /// Return the index of the column. #[inline] pub fn column_index(&self, name: &str) -> Option> { self.stmt.map(|stmt| stmt.column_index(name)) } /// Returns a slice describing the columns of the Rows. #[inline] #[cfg(feature = "column_decltype")] pub fn columns(&self) -> Option> { self.stmt.map(Statement::columns) } } impl<'stmt> Row<'stmt> { /// Get all the column names of the Row. #[inline] pub fn column_names(&self) -> Vec<&str> { self.stmt.column_names() } /// Return the number of columns in the current row. #[inline] pub fn column_count(&self) -> usize { self.stmt.column_count() } /// Return the name of the column. #[inline] pub fn column_name(&self, col: usize) -> Result<&str> { self.stmt.column_name(col) } /// Return the index of the column. #[inline] pub fn column_index(&self, name: &str) -> Result { self.stmt.column_index(name) } /// Returns a slice describing the columns of the Row. #[inline] #[cfg(feature = "column_decltype")] pub fn columns(&self) -> Vec { self.stmt.columns() } } #[cfg(test)] mod test { use crate::Connection; #[test] #[cfg(feature = "column_decltype")] fn test_columns() { use super::Column; let db = Connection::open_in_memory().unwrap(); let query = db.prepare("SELECT * FROM sqlite_master").unwrap(); let columns = query.columns(); let column_names: Vec<&str> = columns.iter().map(Column::name).collect(); assert_eq!( column_names.as_slice(), &["type", "name", "tbl_name", "rootpage", "sql"] ); let column_types: Vec> = columns.iter().map(Column::decl_type).collect(); assert_eq!( &column_types[..3], &[Some("text"), Some("text"), Some("text"),] ); } #[test] fn test_column_name_in_error() { use crate::{types::Type, Error}; let db = Connection::open_in_memory().unwrap(); db.execute_batch( "BEGIN; CREATE TABLE foo(x INTEGER, y TEXT); INSERT INTO foo VALUES(4, NULL); END;", ) .unwrap(); let mut stmt = db.prepare("SELECT x as renamed, y FROM foo").unwrap(); let mut rows = stmt.query([]).unwrap(); let row = rows.next().unwrap().unwrap(); match row.get::<_, String>(0).unwrap_err() { Error::InvalidColumnType(idx, name, ty) => { assert_eq!(idx, 0); assert_eq!(name, "renamed"); assert_eq!(ty, Type::Integer); } e => { panic!("Unexpected error type: {:?}", e); } } match row.get::<_, String>("y").unwrap_err() { Error::InvalidColumnType(idx, name, ty) => { assert_eq!(idx, 1); assert_eq!(name, "y"); assert_eq!(ty, Type::Null); } e => { panic!("Unexpected error type: {:?}", e); } } } }