argmax
Return the value of key when the expression is at its maximum value. If awhere condition is specified, method only considers rows meeting the where condition.
argmin
Return the value of key when the expression is at its minimum value. If awhere condition is specified, method only considers rows meeting the where condition.
as_scalar
Convert the expression to a scalar value. Note that the execution of the scalar subquery will fail if the column expression contains more than one value.between
Check if this expression is between lower and upper, inclusive.cast
Cast expression to indicated data type. Type inputs can include strings, python type annotations, numpy dtypes, pandas dtypes, and pyarrow dtypes. If try_ is True, then the cast will return null if the cast fails, otherwise it will raise an error.coalesce
Return the first non-null value in the expression list.Parameters
Parameters
Value
required
collect
Collect the expression into an array. If awhere condition is specified, method only considers rows meeting the where condition.
Parameters
Parameters
BooleanValue | None
combine
Combine the expression into a single string using the specified separator. If awhere condition is specified, method only considers rows meeting the where condition.
count
Return the number of non-null values in the expression, only including values when thewhere condition is true.
If distinct is True, then the number of unique values will be returned instead of the total count.
If approx is True and distinct is True, method will use approximate count distinct function, which is faster but less accurate. This is only available for count distinct.
epoch_seconds
Return the number of seconds since the Unix epoch.equivalent
Null-aware version of ==. Returns true if both expressions are equal or both are null.Parameters
Parameters
Value
required
first
Return the first value in the expression. If awhere condition is specified, method only considers rows meeting the where condition.
Parameters
Parameters
BooleanValue | None
hash
Compute an integer hash value of the expression. The hashing function used is dependent on the backend, so usage across dialect will likely return a different number.in_
Check if this expression is in the provided set of values. Exists in place of the pythonin operator because of its requirement to evaluate to a python boolean.
Parameters
Parameters
Value | Sequence[Value]
required
lag
Return the row located at offset rows before the current row. If no row exists at offset, the default value is returned.last
Return the last value in the expression. If awhere condition is specified, method only considers rows meeting the where condition.
Parameters
Parameters
BooleanValue | None
lead
Return the row located at offset rows after the current row. If no row exists at offset, the default value is returned.like
This function is modeled after SQL’sLIKE and ILIKE directives. Use % as a
multiple-character wildcard or _ as a single-character wildcard.
For regular expressions, use re.search.
match
Return a value based on the first matching condition in the expression. The default value is returned if no conditions are met, otherwise null is returned.max
Return the maximum value of the expression If awhere condition is specified, method only considers rows meeting the where condition.
Parameters
Parameters
BooleanValue | None
mean
Return the mean of the expression If awhere condition is specified, method only considers rows meeting the where condition.
Parameters
Parameters
BooleanValue | None
median
Return the median value of the expression. If awhere condition is specified, method only considers rows meeting the where condition.
If approx is True, method will use the approximate median function, which is faster but less accurate.
min
Return the minimum value of the expression If awhere condition is specified, method only considers rows meeting the where condition.
Parameters
Parameters
BooleanValue | None
mode
Return the mode value of the expression If awhere condition is specified, method only considers rows meeting the where condition.
Parameters
Parameters
BooleanValue | None
nth
Return the nth value of the expressionParameters
Parameters
int | IntegerValue
required
quantile
Return value at the given quantile. If multiple quantiles are specified, then the output will be an array of values. The output of this method a discrete quantile if the input is an float, otherwise it is a continuous quantile.strftime
Format string may depend on the backend, but we try to conform to ANSI strftime.Parameters
Parameters
str | StringValue
required
sum
Return the sum of the expression If awhere condition is specified, method only considers rows meeting the where condition.
Parameters
Parameters
BooleanValue | None
type
Return the string name of the datatype of the expression. If db_type is True, then the string will be the name of the datatype in the specific backend (e.g. duckdb), otherwise it will be cross-dialect data type name from Vinyl.Parameters
Parameters
bool
default:"True"