sqlint/ast/function/
average.rs

1use super::Function;
2use crate::ast::Column;
3
4/// A representation of the `AVG` function in the database.
5#[derive(Debug, Clone, PartialEq)]
6pub struct Average<'a> {
7    pub(crate) column: Column<'a>,
8}
9
10/// Calculates the average value of a numeric column.
11///
12/// ```rust
13/// # use sqlint::{ast::*, visitor::{Visitor, Sqlite}};
14/// # fn main() -> Result<(), sqlint::error::Error> {
15/// let query = Select::from_table("users").value(avg("age"));
16/// let (sql, _) = Sqlite::build(query)?;
17/// assert_eq!("SELECT AVG(`age`) FROM `users`", sql);
18/// # Ok(())
19/// # }
20/// ```
21pub fn avg<'a, C>(col: C) -> Function<'a>
22where
23    C: Into<Column<'a>>,
24{
25    let fun = Average { column: col.into() };
26    fun.into()
27}