Operations

Low level operation classes. Subject to change in non-major releases.

analytic

analytic

Operations for analytic window functions.

Classes

Name	Description
Analytic	Base class for analytic window function operations.
CumeDist	Compute the cumulative distribution function of a column over a window.
Lag	Shift a column forward.
Lead	Shift a column backward.
NTile	Compute the percentile of a column over a window.
NthValue	Retrieve the Nth element of a column over a window.
PercentRank	Compute the percentile rank over a window.
RankBase	Base class for ranking operations.
RowNumber	Compute the row number over a window, starting from 0.
ShiftBase	Base class for shift operations.

Analytic

Analytic(self, **kwargs)

Base class for analytic window function operations.

CumeDist

CumeDist(self, **kwargs)

Compute the cumulative distribution function of a column over a window.

Lag

Lag(self, **kwargs)

Shift a column forward.

Lead

Lead(self, **kwargs)

Shift a column backward.

NTile

NTile(self, **kwargs)

Compute the percentile of a column over a window.

NthValue

NthValue(self, **kwargs)

Retrieve the Nth element of a column over a window.

PercentRank

PercentRank(self, **kwargs)

Compute the percentile rank over a window.

RankBase

RankBase(self, **kwargs)

Base class for ranking operations.

RowNumber

RowNumber(self, **kwargs)

Compute the row number over a window, starting from 0.

ShiftBase

ShiftBase(self, **kwargs)

Base class for shift operations.

arrays

arrays

Operations for array expressions.

Classes

Name	Description
Array	Construct an array.
ArrayConcat	Concatenate two or more arrays into a single array.
ArrayContains	Return whether an array contains a specific value.
ArrayDistinct	Return the unique elements of an array.
ArrayFilter	Filter array elements with a function.
ArrayFlatten	Flatten a nested array one level.
ArrayIndex	Return the element of an array at some index.
ArrayIntersect	Return the intersection of two arrays.
ArrayLength	Compute the length of an array.
ArrayMap	Apply a function to every element of an array.
ArrayPosition	Return the position of a specific value in an array.
ArrayRemove	Remove an element from an array.
ArrayRepeat	Repeat the elements of an array.
ArraySlice	Slice an array element.
ArraySort	Sort the values of an array.
ArrayUnion	Return the union of two arrays.
ArrayZip	Zip two or more arrays into an array of structs.
IntegerRange	Produce an array of integers from start to stop, moving by step.
Range	Base class for range-generating operations.
TimestampRange	Produce an array of timestamps from start to stop, moving by step.
Unnest	Unnest an array value into a column.

Array

Array(self, **kwargs)

Construct an array.

ArrayConcat

ArrayConcat(self, **kwargs)

Concatenate two or more arrays into a single array.

ArrayContains

ArrayContains(self, **kwargs)

Return whether an array contains a specific value.

ArrayDistinct

ArrayDistinct(self, **kwargs)

Return the unique elements of an array.

ArrayFilter

ArrayFilter(self, **kwargs)

Filter array elements with a function.

ArrayFlatten

ArrayFlatten(self, **kwargs)

Flatten a nested array one level.

The input expression must have at least one level of nesting for flattening to make sense.

ArrayIndex

ArrayIndex(self, **kwargs)

Return the element of an array at some index.

ArrayIntersect

ArrayIntersect(self, **kwargs)

Return the intersection of two arrays.

ArrayLength

ArrayLength(self, **kwargs)

Compute the length of an array.

ArrayMap

ArrayMap(self, **kwargs)

Apply a function to every element of an array.

ArrayPosition

ArrayPosition(self, **kwargs)

Return the position of a specific value in an array.

ArrayRemove

ArrayRemove(self, **kwargs)

Remove an element from an array.

ArrayRepeat

ArrayRepeat(self, **kwargs)

Repeat the elements of an array.

ArraySlice

ArraySlice(self, **kwargs)

Slice an array element.

ArraySort

ArraySort(self, **kwargs)

Sort the values of an array.

ArrayUnion

ArrayUnion(self, **kwargs)

Return the union of two arrays.

ArrayZip

ArrayZip(self, **kwargs)

Zip two or more arrays into an array of structs.

IntegerRange

IntegerRange(self, **kwargs)

Produce an array of integers from start to stop, moving by step.

Range

Range(self, **kwargs)

Base class for range-generating operations.

TimestampRange

TimestampRange(self, **kwargs)

Produce an array of timestamps from start to stop, moving by step.

Unnest

Unnest(self, **kwargs)

Unnest an array value into a column.

generic

generic

Generic value operations.

Classes

Name	Description
Cast	Explicitly cast a value to a specific data type.
Coalesce	Return the first non-null expression from a tuple of expressions.
Constant	A function that produces a constant.
DateNow	Return the current date.
E	The mathematical constant e.
Greatest	Return the largest value from a tuple of expressions.
Hash	Return the hash of a value.
HexDigest	Return the hexadecimal digest of a value.
IsNull	Return true if values are null.
Least	Return the smallest value from a tuple of expressions.
Literal	A constant value.
NotNull	Returns true if values are not null.
NullIf	Return NULL if an expression equals some specific value.
Pi	The mathematical constant pi.
RandomScalar	Return a random scalar between 0 and 1.
RandomUUID	Return a random UUID.
RowID	The row number of the returned result.
SearchedCase	Searched case statement.
SimpleCase	Simple case statement.
TimestampNow	Return the current timestamp.
TryCast	Try to cast a value to a specific data type.
TypeOf	Return the database data type of the input expression.

Cast

Cast(self, **kwargs)

Explicitly cast a value to a specific data type.

Coalesce

Coalesce(self, **kwargs)

Return the first non-null expression from a tuple of expressions.

Constant

Constant()

A function that produces a constant.

DateNow

DateNow()

Return the current date.

E

E()

The mathematical constant e.

Greatest

Greatest(self, **kwargs)

Return the largest value from a tuple of expressions.

Hash

Hash(self, **kwargs)

Return the hash of a value.

HexDigest

HexDigest(self, **kwargs)

Return the hexadecimal digest of a value.

IsNull

IsNull(self, **kwargs)

Return true if values are null.

Least

Least(self, **kwargs)

Return the smallest value from a tuple of expressions.

Literal

Literal(self, value, dtype)

A constant value.

NotNull

NotNull(self, **kwargs)

Returns true if values are not null.

NullIf

NullIf(self, **kwargs)

Return NULL if an expression equals some specific value.

Pi

Pi()

The mathematical constant pi.

RandomScalar

RandomScalar(self, **kwargs)

Return a random scalar between 0 and 1.

RandomUUID

RandomUUID(self, **kwargs)

Return a random UUID.

RowID

RowID(self, **kwargs)

The row number of the returned result.

SearchedCase

SearchedCase(self, cases, results, default)

Searched case statement.

SimpleCase

SimpleCase(self, base, cases, results, default)

Simple case statement.

TimestampNow

TimestampNow()

Return the current timestamp.

TryCast

TryCast(self, **kwargs)

Try to cast a value to a specific data type.

TypeOf

TypeOf(self, **kwargs)

Return the database data type of the input expression.

geospatial

geospatial

Geospatial operations.

Classes

Name	Description
GeoArea	Area of the geo spatial data.
GeoAsBinary	Return the Well-Known Binary (WKB) representation of the input, without SRID meta data.
GeoAsEWKB	Return the Well-Known Binary representation of the input, with SRID meta data.
GeoAsEWKT	Return the Well-Known Text representation of the input, with SRID meta data.
GeoAsText	Return the Well-Known Text (WKT) representation of the input, without SRID metadata.
GeoAzimuth	Return the angle in radians from the horizontal of the vector defined by the two inputs.
GeoBuffer	Return all points whose distance from this geometry is less than or equal to radius.
GeoCentroid	Returns the geometric center of a geometry.
GeoContains	Check if the first geo spatial data contains the second one.
GeoContainsProperly	Check if the left value contains the right one, with no shared no boundary points.
GeoConvert	Returns a transformed version of the given geometry from source crs/srid to a target crs/srid.
GeoCoveredBy	Check if no point in the left operand is outside that of the right.
GeoCovers	Check if no point in the right operand is outside that of the left.
GeoCrosses	Check if the inputs have some but not all interior points in common.
GeoDFullyWithin	Check if the geometries are fully within distance of one another.
GeoDWithin	Check if the geometries are within distance of one another.
GeoDifference	Return a geometry that is the delta between the left and right inputs.
GeoDisjoint	Check if the Geometries do not spatially intersect.
GeoDistance	Returns minimum distance between two geospatial operands.
GeoEndPoint	Return the last point of a LINESTRING geometry as a POINT.
GeoEnvelope	The bounding box of the supplied geometry.
GeoEquals	Returns True if the given geometries represent the same geometry.
GeoFlipCoordinates	Returns a new geometry with the coordinates of the input geometry “flipped” so that x = y and y = x.
GeoGeometryN	Returns the Nth Geometry of a Multi geometry.
GeoGeometryType	Returns the type of the geometry.
GeoIntersection	Return a geometry that represents the point-set intersection of the inputs.
GeoIntersects	Returns True if the Geometries/Geography “spatially intersect in 2D”.
GeoIsValid	Returns true if the geometry is well-formed.
GeoLength	Length of geo spatial data.
GeoLineLocatePoint	Locate the distance a point falls along the length of a line.
GeoLineMerge	Merge a MultiLineString into a LineString.
GeoLineSubstring	Clip a substring from a LineString.
GeoMaxDistance	Returns the 2-dimensional max distance between two geometries in projected units.
GeoNPoints	Return the number of points in a geometry.
GeoNRings	Return the number of rings for polygons or multipolygons.
GeoOrderingEquals	Check if two geometries are equal and have the same point ordering.
GeoOverlaps	Check if the inputs are of the same dimension but are not completely contained by each other.
GeoPerimeter	Perimeter of the geo spatial data.
GeoPoint	Return a point constructed from the input coordinate values.
GeoPointN	Return the Nth point in a single linestring in the geometry.
GeoSRID	Returns the spatial reference identifier for the ST_Geometry.
GeoSetSRID	Set the spatial reference identifier for the ST_Geometry.
GeoSimplify	Returns a simplified version of the given geometry.
GeoSpatialBinOp	Geo Spatial base binary.
GeoSpatialUnOp	Geo Spatial base unary.
GeoStartPoint	Return the first point of a LINESTRING geometry as a POINT.
GeoTouches	Check if the inputs have at least one point in common but their interiors do not intersect.
GeoTransform	Returns a transformed version of the given geometry into a new SRID.
GeoUnaryUnion	Returns the pointwise union of the geometries in the column.
GeoUnion	Returns the pointwise union of the two geometries.
GeoWithin	Returns True if the geometry A is completely inside geometry B.
GeoX	Return the X coordinate of the point, or NULL if not available.
GeoXMax	Returns X maxima of a bounding box 2d or 3d or a geometry.
GeoXMin	Returns Y minima of a bounding box 2d or 3d or a geometry.
GeoY	Return the Y coordinate of the point, or NULL if not available.
GeoYMax	Returns Y maxima of a bounding box 2d or 3d or a geometry.
GeoYMin	Returns Y minima of a bounding box 2d or 3d or a geometry.

GeoArea

GeoArea(self, **kwargs)

Area of the geo spatial data.

GeoAsBinary

GeoAsBinary(self, **kwargs)

Return the Well-Known Binary (WKB) representation of the input, without SRID meta data.

GeoAsEWKB

GeoAsEWKB(self, **kwargs)

Return the Well-Known Binary representation of the input, with SRID meta data.

GeoAsEWKT

GeoAsEWKT(self, **kwargs)

Return the Well-Known Text representation of the input, with SRID meta data.

GeoAsText

GeoAsText(self, **kwargs)

Return the Well-Known Text (WKT) representation of the input, without SRID metadata.

GeoAzimuth

GeoAzimuth(self, **kwargs)

Return the angle in radians from the horizontal of the vector defined by the two inputs.

Angle is computed clockwise from down-to-up: on the clock: 12=0; 3=PI/2; 6=PI; 9=3PI/2.

GeoBuffer

GeoBuffer(self, **kwargs)

Return all points whose distance from this geometry is less than or equal to radius.

Calculations are in the Spatial Reference System of this geometry.

GeoCentroid

GeoCentroid(self, **kwargs)

Returns the geometric center of a geometry.

GeoContains

GeoContains(self, **kwargs)

Check if the first geo spatial data contains the second one.

GeoContainsProperly

GeoContainsProperly(self, **kwargs)

Check if the left value contains the right one, with no shared no boundary points.

GeoConvert

GeoConvert(self, **kwargs)

Returns a transformed version of the given geometry from source crs/srid to a target crs/srid.

GeoCoveredBy

GeoCoveredBy(self, **kwargs)

Check if no point in the left operand is outside that of the right.

GeoCovers

GeoCovers(self, **kwargs)

Check if no point in the right operand is outside that of the left.

GeoCrosses

GeoCrosses(self, **kwargs)

Check if the inputs have some but not all interior points in common.

GeoDFullyWithin

GeoDFullyWithin(self, **kwargs)

Check if the geometries are fully within distance of one another.

GeoDWithin

GeoDWithin(self, **kwargs)

Check if the geometries are within distance of one another.

GeoDifference

GeoDifference(self, **kwargs)

Return a geometry that is the delta between the left and right inputs.

GeoDisjoint

GeoDisjoint(self, **kwargs)

Check if the Geometries do not spatially intersect.

GeoDistance

GeoDistance(self, **kwargs)

Returns minimum distance between two geospatial operands.

GeoEndPoint

GeoEndPoint(self, **kwargs)

Return the last point of a LINESTRING geometry as a POINT.

Returns NULL if the input is not a LINESTRING.

GeoEnvelope

GeoEnvelope(self, **kwargs)

The bounding box of the supplied geometry.

GeoEquals

GeoEquals(self, **kwargs)

Returns True if the given geometries represent the same geometry.

GeoFlipCoordinates

GeoFlipCoordinates(self, **kwargs)

Returns a new geometry with the coordinates of the input geometry “flipped” so that x = y and y = x.

GeoGeometryN

GeoGeometryN(self, **kwargs)

Returns the Nth Geometry of a Multi geometry.

GeoGeometryType

GeoGeometryType(self, **kwargs)

Returns the type of the geometry.

GeoIntersection

GeoIntersection(self, **kwargs)

Return a geometry that represents the point-set intersection of the inputs.

GeoIntersects

GeoIntersects(self, **kwargs)

Returns True if the Geometries/Geography “spatially intersect in 2D”.

• (share any portion of space) and False if they don`t (they are Disjoint).

GeoIsValid

GeoIsValid(self, **kwargs)

Returns true if the geometry is well-formed.

GeoLength

GeoLength(self, **kwargs)

Length of geo spatial data.

GeoLineLocatePoint

GeoLineLocatePoint(self, **kwargs)

Locate the distance a point falls along the length of a line.

Returns a float between zero and one representing the location of the closest point on the linestring to the given point, as a fraction of the total 2d line length.

GeoLineMerge

GeoLineMerge(self, **kwargs)

Merge a MultiLineString into a LineString.

Returns a (set of) LineString(s) formed by sewing together the constituent line work of a multilinestring. If a geometry other than a linestring or multilinestring is given, this will return an empty geometry collection.

GeoLineSubstring

GeoLineSubstring(self, **kwargs)

Clip a substring from a LineString.

Returns a linestring that is a substring of the input one, starting and ending at the given fractions of the total 2d length. The second and third arguments are floating point values between zero and one. This only works with linestrings.

GeoMaxDistance

GeoMaxDistance(self, **kwargs)

Returns the 2-dimensional max distance between two geometries in projected units.

If g1 and g2 is the same geometry the function will return the distance between the two vertices most far from each other in that geometry

GeoNPoints

GeoNPoints(self, **kwargs)

Return the number of points in a geometry.

GeoNRings

GeoNRings(self, **kwargs)

Return the number of rings for polygons or multipolygons.

Outer rings are counted.

GeoOrderingEquals

GeoOrderingEquals(self, **kwargs)

Check if two geometries are equal and have the same point ordering.

Returns true if the two geometries are equal and the coordinates are in the same order.

GeoOverlaps

GeoOverlaps(self, **kwargs)

Check if the inputs are of the same dimension but are not completely contained by each other.

GeoPerimeter

GeoPerimeter(self, **kwargs)

Perimeter of the geo spatial data.

GeoPoint

GeoPoint(self, **kwargs)

Return a point constructed from the input coordinate values.

Constant coordinates result in construction of a POINT literal.

GeoPointN

GeoPointN(self, **kwargs)

Return the Nth point in a single linestring in the geometry.

Negative values are counted backwards from the end of the LineString, so that -1 is the last point. Returns NULL if there is no linestring in the geometry

GeoSRID

GeoSRID(self, **kwargs)

Returns the spatial reference identifier for the ST_Geometry.

GeoSetSRID

GeoSetSRID(self, **kwargs)

Set the spatial reference identifier for the ST_Geometry.

GeoSimplify

GeoSimplify(self, **kwargs)

Returns a simplified version of the given geometry.

GeoSpatialBinOp

GeoSpatialBinOp(self, **kwargs)

Geo Spatial base binary.

GeoSpatialUnOp

GeoSpatialUnOp(self, **kwargs)

Geo Spatial base unary.

GeoStartPoint

GeoStartPoint(self, **kwargs)

Return the first point of a LINESTRING geometry as a POINT.

Returns NULL if the input is not a LINESTRING.

GeoTouches

GeoTouches(self, **kwargs)

Check if the inputs have at least one point in common but their interiors do not intersect.

GeoTransform

GeoTransform(self, **kwargs)

Returns a transformed version of the given geometry into a new SRID.

GeoUnaryUnion

GeoUnaryUnion(self, **kwargs)

Returns the pointwise union of the geometries in the column.

GeoUnion

GeoUnion(self, **kwargs)

Returns the pointwise union of the two geometries.

GeoWithin

GeoWithin(self, **kwargs)

Returns True if the geometry A is completely inside geometry B.

GeoX

GeoX(self, **kwargs)

Return the X coordinate of the point, or NULL if not available.

Input must be a point

GeoXMax

GeoXMax(self, **kwargs)

Returns X maxima of a bounding box 2d or 3d or a geometry.

GeoXMin

GeoXMin(self, **kwargs)

Returns Y minima of a bounding box 2d or 3d or a geometry.

GeoY

GeoY(self, **kwargs)

Return the Y coordinate of the point, or NULL if not available.

Input must be a point

GeoYMax

GeoYMax(self, **kwargs)

Returns Y maxima of a bounding box 2d or 3d or a geometry.

GeoYMin

GeoYMin(self, **kwargs)

Returns Y minima of a bounding box 2d or 3d or a geometry.

histograms

histograms

Operations for computing histograms.

Classes

Name	Description
Bucket	Compute the bucket number of a numeric column.

Bucket

Bucket(self, buckets, include_under, include_over, **kwargs)

Compute the bucket number of a numeric column.

json

json

Operations for working with JSON data.

Classes

Name	Description
JSONGetItem	Get a value from a JSON object or array.
ToJSONArray	Convert a value to an array of JSON objects.
ToJSONMap	Convert a value to a map of string to JSON.
UnwrapJSONBoolean	Unwrap a JSON bool into an engine-native bool.
UnwrapJSONFloat64	Unwrap a JSON number into an engine-native float64.
UnwrapJSONInt64	Unwrap a JSON number into an engine-native int64.
UnwrapJSONString	Unwrap a JSON string into an engine-native string.

JSONGetItem

JSONGetItem()

Get a value from a JSON object or array.

ToJSONArray

ToJSONArray()

Convert a value to an array of JSON objects.

ToJSONMap

ToJSONMap()

Convert a value to a map of string to JSON.

UnwrapJSONBoolean

UnwrapJSONBoolean()

Unwrap a JSON bool into an engine-native bool.

UnwrapJSONFloat64

UnwrapJSONFloat64()

Unwrap a JSON number into an engine-native float64.

UnwrapJSONInt64

UnwrapJSONInt64()

Unwrap a JSON number into an engine-native int64.

UnwrapJSONString

UnwrapJSONString()

Unwrap a JSON string into an engine-native string.

logical

logical

Logical operations.

Classes

Name	Description
And	Logical AND.
Between	Check if a value is within a range.
Comparison	Base class for comparison operations.
Equals	Equality comparison.
Greater	Greater than comparison.
GreaterEqual	Greater than or equal to comparison.
IdenticalTo	Identity comparison. Considers two NULL values equal.
IfElse	Ternary case expression.
InValues	Check if a value is in a set of values.
Less	Less than comparison.
LessEqual	Less than or equal to comparison.
LogicalBinary	Base class for logical binary operations.
Not	Logical negation.
NotEquals	Inequality comparison.
Or	Logical OR.
Xor	Logical XOR.

And

And(self, **kwargs)

Logical AND.

Between

Between(self, arg, lower_bound, upper_bound)

Check if a value is within a range.

Comparison

Comparison(self, left, right)

Base class for comparison operations.

Equals

Equals(self, left, right)

Equality comparison.

Greater

Greater(self, left, right)

Greater than comparison.

GreaterEqual

GreaterEqual(self, left, right)

Greater than or equal to comparison.

IdenticalTo

IdenticalTo(self, left, right)

Identity comparison. Considers two NULL values equal.

IfElse

IfElse(self, **kwargs)

Ternary case expression.

Equivalent to

bool_expr.case().when(True, true_expr).else_(false_or_null_expr)

Many backends implement this as a built-in function.

InValues

InValues(self, **kwargs)

Check if a value is in a set of values.

Less

Less(self, left, right)

Less than comparison.

LessEqual

LessEqual(self, left, right)

Less than or equal to comparison.

LogicalBinary

LogicalBinary(self, **kwargs)

Base class for logical binary operations.

Not

Not(self, **kwargs)

Logical negation.

NotEquals

NotEquals(self, left, right)

Inequality comparison.

Or

Or(self, **kwargs)

Logical OR.

Xor

Xor(self, **kwargs)

Logical XOR.

maps

maps

Operations for working with maps.

Classes

Name	Description
Map	Construct a map.
MapContains	Check if a map contains a key.
MapGet	Get a value from a map by key.
MapKeys	Get the keys of a map as an array.
MapLength	Compute the number of unique keys in a map.
MapMerge	Combine two maps into one.
MapValues	Get the values of a map as an array.

Map

Map(self, **kwargs)

Construct a map.

MapContains

MapContains(self, **kwargs)

Check if a map contains a key.

MapGet

MapGet(self, **kwargs)

Get a value from a map by key.

MapKeys

MapKeys(self, **kwargs)

Get the keys of a map as an array.

MapLength

MapLength(self, **kwargs)

Compute the number of unique keys in a map.

MapMerge

MapMerge(self, **kwargs)

Combine two maps into one.

If a key is present in both maps, the value from the first is kept.

MapValues

MapValues(self, **kwargs)

Get the values of a map as an array.

numeric

numeric

Operations for numeric expressions.

Classes

Name	Description
Abs	Absolute value.
Acos	Returns the arc cosine of x.
Add	Add two values.
Asin	Returns the arc sine of x.
Atan	Returns the arc tangent of x.
Atan2	Returns the arc tangent of x and y.
BaseConvert	Convert a number from one base to another.
BitwiseAnd	Bitwise AND operation.
BitwiseBinary	Base class for bitwise binary operations.
BitwiseLeftShift	Bitwise left shift operation.
BitwiseNot	Bitwise NOT operation.
BitwiseOr	Bitwise OR operation.
BitwiseRightShift	Bitwise right shift operation.
BitwiseXor	Bitwise XOR operation.
Ceil	Round up to the nearest integer value greater than or equal to this value.
Clip	Clip a value to a specified range.
Cos	Returns the cosine of x.
Cot	Returns the cotangent of x.
Degrees	Converts radians to degrees.
Divide	Divide the left value by the right value.
Exp	Exponential function.
Floor	Round down to the nearest integer value less than or equal to this value.
FloorDivide	Divide the left value by the right value and round down to the nearest integer.
IsInf	Check if the value is infinite.
IsNan	Check if the value is NaN.
Ln	Natural logarithm.
Log	Logarithm with a specific base.
Log10	Logarithm base 10.
Log2	Logarithm base 2.
Logarithm	Base class for logarithmic operations.
MathUnary	Base class for unary math operations.
Modulus	Return the remainder after the division of the left value by the right value.
Multiply	Multiply two values.
Negate	Negate the value.
Power	Raise the left value to the power of the right value.
Radians	Converts degrees to radians.
Round	Round a value.
Sign	Sign of the value.
Sin	Returns the sine of x.
Sqrt	Square root of the value.
Subtract	Subtract the right value from the left value.
Tan	Returns the tangent of x.
TrigonometricBinary	Trigonometric base binary.
TrigonometricUnary	Trigonometric base unary.

Abs

Abs(self, **kwargs)

Absolute value.

Acos

Acos(self, **kwargs)

Returns the arc cosine of x.

Add

Add(self, **kwargs)

Add two values.

Asin

Asin(self, **kwargs)

Returns the arc sine of x.

Atan

Atan(self, **kwargs)

Returns the arc tangent of x.

Atan2

Atan2(self, **kwargs)

Returns the arc tangent of x and y.

BaseConvert

BaseConvert(self, **kwargs)

Convert a number from one base to another.

BitwiseAnd

BitwiseAnd(self, **kwargs)

Bitwise AND operation.

BitwiseBinary

BitwiseBinary(self, **kwargs)

Base class for bitwise binary operations.

BitwiseLeftShift

BitwiseLeftShift(self, **kwargs)

Bitwise left shift operation.

BitwiseNot

BitwiseNot(self, **kwargs)

Bitwise NOT operation.

BitwiseOr

BitwiseOr(self, **kwargs)

Bitwise OR operation.

BitwiseRightShift

BitwiseRightShift(self, **kwargs)

Bitwise right shift operation.

BitwiseXor

BitwiseXor(self, **kwargs)

Bitwise XOR operation.

Ceil

Ceil(self, **kwargs)

Round up to the nearest integer value greater than or equal to this value.

Clip

Clip(self, **kwargs)

Clip a value to a specified range.

Cos

Cos(self, **kwargs)

Returns the cosine of x.

Cot

Cot(self, **kwargs)

Returns the cotangent of x.

Degrees

Degrees(self, **kwargs)

Converts radians to degrees.

Divide

Divide(self, **kwargs)

Divide the left value by the right value.

Exp

Exp(self, **kwargs)

Exponential function.

Floor

Floor(self, **kwargs)

Round down to the nearest integer value less than or equal to this value.

FloorDivide

FloorDivide(self, **kwargs)

Divide the left value by the right value and round down to the nearest integer.

IsInf

IsInf(self, **kwargs)

Check if the value is infinite.

IsNan

IsNan(self, **kwargs)

Check if the value is NaN.

Ln

Ln(self, **kwargs)

Natural logarithm.

Log

Log(self, **kwargs)

Logarithm with a specific base.

Log10

Log10(self, **kwargs)

Logarithm base 10.

Log2

Log2(self, **kwargs)

Logarithm base 2.

Logarithm

Logarithm(self, **kwargs)

Base class for logarithmic operations.

MathUnary

MathUnary(self, **kwargs)

Base class for unary math operations.

Modulus

Modulus(self, **kwargs)

Return the remainder after the division of the left value by the right value.

Multiply

Multiply(self, **kwargs)

Multiply two values.

Negate

Negate(self, **kwargs)

Negate the value.

Power

Power(self, **kwargs)

Raise the left value to the power of the right value.

Radians

Radians(self, **kwargs)

Converts degrees to radians.

Round

Round(self, **kwargs)

Round a value.

Sign

Sign(self, **kwargs)

Sign of the value.

Sin

Sin(self, **kwargs)

Returns the sine of x.

Sqrt

Sqrt(self, **kwargs)

Square root of the value.

Subtract

Subtract(self, **kwargs)

Subtract the right value from the left value.

Tan

Tan(self, **kwargs)

Returns the tangent of x.

TrigonometricBinary

TrigonometricBinary(self, **kwargs)

Trigonometric base binary.

TrigonometricUnary

TrigonometricUnary(self, **kwargs)

Trigonometric base unary.

reductions

reductions

Reduction operations.

Classes

Name	Description
All	Check if all values in a column are true.
Any	Check if any value in a column is true.
ApproxCountDistinct	Approximate number of unique values.
ApproxMedian	Compute the approximate median of a set of comparable values.
Arbitrary	Retrieve an arbitrary element.
ArgMax	Compute the index of the maximum value in a column.
ArgMin	Compute the index of the minimum value in a column.
ArrayCollect	Collect values into an array.
BitAnd	Aggregate bitwise AND operation.
BitOr	Aggregate bitwise OR operation.
BitXor	Aggregate bitwise XOR operation.
Correlation	Correlation coefficient of two columns.
Count	Count the number of non-null elements of a column.
CountDistinct	Count the number of distinct values in a column.
CountDistinctStar	Count the number of distinct rows of a relation.
CountStar	Count the number of rows of a relation.
Covariance	Covariance of two columns.
First	Retrieve the first element.
GroupConcat	Concatenate strings in a group with a given separator character.
Last	Retrieve the last element.
Max	Compute the maximum of a column.
Mean	Compute the mean of a column.
Median	Compute the median of a column.
Min	Compute the minimum of a column.
Mode	Compute the mode of a column.
MultiQuantile	Compute multiple quantiles of a column.
Quantile	Compute the quantile of a column.
Reduction	Base class for reduction operations.
StandardDev	Compute the standard deviation of a column.
Sum	Compute the sum of a column.
Variance	Compute the variance of a column.
VarianceBase	Base class for variance and standard deviation.

All

All(self, **kwargs)

Check if all values in a column are true.

Any

Any(self, **kwargs)

Check if any value in a column is true.

ApproxCountDistinct

ApproxCountDistinct(self, **kwargs)

Approximate number of unique values.

ApproxMedian

ApproxMedian(self, **kwargs)

Compute the approximate median of a set of comparable values.

Arbitrary

Arbitrary(self, **kwargs)

Retrieve an arbitrary element.

Returns a non-null value unless the column is empty or all values are NULL.

ArgMax

ArgMax(self, **kwargs)

Compute the index of the maximum value in a column.

ArgMin

ArgMin(self, **kwargs)

Compute the index of the minimum value in a column.

ArrayCollect

ArrayCollect(self, **kwargs)

Collect values into an array.

BitAnd

BitAnd(self, **kwargs)

Aggregate bitwise AND operation.

All elements in an integer column are ANDed together.

This can be used to determine which bit flags are set on all elements.

See Also

• BigQuery BIT_AND
• MySQL BIT_AND

BitOr

BitOr(self, **kwargs)

Aggregate bitwise OR operation.

All elements in an integer column are ORed together. This can be used to determine which bit flags are set on any element.

See Also

• BigQuery BIT_OR
• MySQL BIT_OR

BitXor

BitXor(self, **kwargs)

Aggregate bitwise XOR operation.

All elements in an integer column are XORed together. This can be used as a parity checksum of element values.

See Also

• BigQuery BIT_XOR
• MySQL BIT_XOR

Correlation

Correlation(self, **kwargs)

Correlation coefficient of two columns.

Count

Count(self, **kwargs)

Count the number of non-null elements of a column.

CountDistinct

CountDistinct(self, **kwargs)

Count the number of distinct values in a column.

CountDistinctStar

CountDistinctStar(self, **kwargs)

Count the number of distinct rows of a relation.

CountStar

CountStar(self, **kwargs)

Count the number of rows of a relation.

Covariance

Covariance(self, **kwargs)

Covariance of two columns.

First

First(self, **kwargs)

Retrieve the first element.

GroupConcat

GroupConcat(self, **kwargs)

Concatenate strings in a group with a given separator character.

Last

Last(self, **kwargs)

Retrieve the last element.

Max

Max(self, **kwargs)

Compute the maximum of a column.

Mean

Mean(self, **kwargs)

Compute the mean of a column.

Median

Median(self, **kwargs)

Compute the median of a column.

Min

Min(self, **kwargs)

Compute the minimum of a column.

Mode

Mode(self, **kwargs)

Compute the mode of a column.

MultiQuantile

MultiQuantile(self, **kwargs)

Compute multiple quantiles of a column.

Quantile

Quantile(self, **kwargs)

Compute the quantile of a column.

Reduction

Reduction(self, **kwargs)

Base class for reduction operations.

StandardDev

StandardDev(self, **kwargs)

Compute the standard deviation of a column.

Sum

Sum(self, **kwargs)

Compute the sum of a column.

Variance

Variance(self, **kwargs)

Compute the variance of a column.

VarianceBase

VarianceBase(self, **kwargs)

Base class for variance and standard deviation.

relations

relations

Relational operations.

Classes

Name	Description
Aggregate	Aggregate a table by a set of group by columns and metrics.
DatabaseTable	A table that is bound to a specific backend.
Difference	Subtract one table from another.
Distinct	Compute the distinct rows of a table.
DropNull	Drop null values in the table.
DummyTable	A table constructed from literal values.
Field	A field of a relation.
FillNull	Fill null values in the table.
Filter	Filter a table by a set of predicates.
InMemoryTable	A table whose data is stored in memory.
Intersection	Intersect two tables.
Limit	Limit and/or offset the number of records in a table.
Namespace	Object to model namespaces for tables.
PhysicalTable	Base class for tables with a name.
Project	Project a subset of columns from a relation.
Relation	Base class for relational operations.
SQLQueryResult	A table sourced from the result set of a SQL SELECT statement.
SQLStringView	A view created from a SQL string.
Sample	Sample performs random sampling of records in a table.
Set	Base class for set operations.
Sort	Sort a table by a set of keys.
TableUnnest	Cross join unnest operation.
UnboundTable	A table that is not bound to a specific backend.
Union	Union two tables.
View	A view created from an expression.

Aggregate

Aggregate(self, parent, groups, metrics)

Aggregate a table by a set of group by columns and metrics.

DatabaseTable

DatabaseTable(self, **kwargs)

A table that is bound to a specific backend.

Difference

Difference(self, left, right, **kwargs)

Subtract one table from another.

Distinct

Distinct(self, **kwargs)

Compute the distinct rows of a table.

DropNull

DropNull(self, **kwargs)

Drop null values in the table.

DummyTable

DummyTable(self, **kwargs)

A table constructed from literal values.

Field

Field(self, rel, name)

A field of a relation.

FillNull

FillNull(self, **kwargs)

Fill null values in the table.

Filter

Filter(self, parent, predicates)

Filter a table by a set of predicates.

InMemoryTable

InMemoryTable(self, **kwargs)

A table whose data is stored in memory.

Intersection

Intersection(self, left, right, **kwargs)

Intersect two tables.

Limit

Limit(self, **kwargs)

Limit and/or offset the number of records in a table.

Namespace

Namespace(self, **kwargs)

Object to model namespaces for tables.

Maps to the concept of database and/or catalog in SQL databases that support them.

PhysicalTable

PhysicalTable(self, **kwargs)

Base class for tables with a name.

Project

Project(self, parent, values)

Project a subset of columns from a relation.

Relation

Relation(self, **kwargs)

Base class for relational operations.

Attributes

Name	Description
fields	A mapping of column names to fields of the relation.
schema	The schema of the relation.
values	A mapping of column names to expressions which build up the relation.

SQLQueryResult

SQLQueryResult(self, **kwargs)

A table sourced from the result set of a SQL SELECT statement.

SQLStringView

SQLStringView(self, **kwargs)

A view created from a SQL string.

Sample

Sample(self, **kwargs)

Sample performs random sampling of records in a table.

Set

Set(self, left, right, **kwargs)

Base class for set operations.

Sort

Sort(self, parent, keys)

Sort a table by a set of keys.

TableUnnest

TableUnnest(self, **kwargs)

Cross join unnest operation.

UnboundTable

UnboundTable(self, **kwargs)

A table that is not bound to a specific backend.

Union

Union(self, left, right, **kwargs)

Union two tables.

View

View(self, **kwargs)

A view created from an expression.

sortkeys

sortkeys

Sort key operations.

Classes

Name	Description
SortKey	A sort key.

SortKey

SortKey(self, **kwargs)

A sort key.

strings

strings

String operations.

Classes

Name	Description
ArrayStringJoin	Join strings in an array with a separator.
Capitalize	Capitalize the first letter of a string.
EndsWith	Check if a string ends with another string.
ExtractAuthority	Extract the authority from a URL.
ExtractFile	Extract the file from a URL.
ExtractFragment	Extract the fragment from a URL.
ExtractHost	Extract the host from a URL.
ExtractPath	Extract the path from a URL.
ExtractProtocol	Extract the protocol from a URL.
ExtractQuery	Extract the query from a URL.
ExtractUserInfo	Extract the user info from a URL.
FindInSet	Find the position of a string in a list of comma-separated strings.
LPad	Pad a string on the left.
LStrip	Strip leading whitespace.
Levenshtein	Compute the Levenshtein distance between two strings.
Lowercase	Convert a string to lowercase.
RPad	Pad a string on the right.
RStrip	Strip trailing whitespace.
RegexExtract	Extract a substring from a string using a regular expression.
RegexReplace	Replace a substring in a string using a regular expression.
RegexSearch	Search a string with a regular expression.
RegexSplit	Split a string using a regular expression.
Repeat	Repeat a string.
Reverse	Reverse a string.
StartsWith	Check if a string starts with another string.
StrRight	Extract a substring starting from the right of a string.
StringAscii	Compute the ASCII code of the first character of a string.
StringConcat	Concatenate strings.
StringContains	Check if a string contains a substring.
StringFind	Find the position of a substring in a string.
StringJoin	Join strings with a separator.
StringLength	Compute the length of a string.
StringReplace	Replace a substring in a string with another string.
StringSQLILike	Case-insensitive SQL LIKE string match operation.
StringSQLLike	SQL LIKE string match operation.
StringSlice	Extract a substring from a string.
StringSplit	Split a string using a delimiter.
StringUnary	Base class for string operations accepting one argument.
Strip	Strip leading and trailing whitespace.
Substring	Extract a substring from a string.
Translate	Translate characters in a string.
Uppercase	Convert a string to uppercase.

ArrayStringJoin

ArrayStringJoin(self, **kwargs)

Join strings in an array with a separator.

Capitalize

Capitalize(self, **kwargs)

Capitalize the first letter of a string.

EndsWith

EndsWith(self, **kwargs)

Check if a string ends with another string.

ExtractAuthority

ExtractAuthority(self, **kwargs)

Extract the authority from a URL.

ExtractFile

ExtractFile(self, **kwargs)

Extract the file from a URL.

ExtractFragment

ExtractFragment(self, **kwargs)

Extract the fragment from a URL.

ExtractHost

ExtractHost(self, **kwargs)

Extract the host from a URL.

ExtractPath

ExtractPath(self, **kwargs)

Extract the path from a URL.

ExtractProtocol

ExtractProtocol(self, **kwargs)

Extract the protocol from a URL.

ExtractQuery

ExtractQuery(self, **kwargs)

Extract the query from a URL.

ExtractUserInfo

ExtractUserInfo(self, **kwargs)

Extract the user info from a URL.

FindInSet

FindInSet(self, **kwargs)

Find the position of a string in a list of comma-separated strings.

LPad

LPad(self, **kwargs)

Pad a string on the left.

LStrip

LStrip(self, **kwargs)

Strip leading whitespace.

Levenshtein

Levenshtein(self, **kwargs)

Compute the Levenshtein distance between two strings.

Lowercase

Lowercase(self, **kwargs)

Convert a string to lowercase.

RPad

RPad(self, **kwargs)

Pad a string on the right.

RStrip

RStrip(self, **kwargs)

Strip trailing whitespace.

RegexExtract

RegexExtract(self, **kwargs)

Extract a substring from a string using a regular expression.

RegexReplace

RegexReplace(self, **kwargs)

Replace a substring in a string using a regular expression.

RegexSearch

RegexSearch(self, **kwargs)

Search a string with a regular expression.

RegexSplit

RegexSplit(self, **kwargs)

Split a string using a regular expression.

Repeat

Repeat(self, **kwargs)

Repeat a string.

Reverse

Reverse(self, **kwargs)

Reverse a string.

StartsWith

StartsWith(self, **kwargs)

Check if a string starts with another string.

StrRight

StrRight(self, **kwargs)

Extract a substring starting from the right of a string.

StringAscii

StringAscii(self, **kwargs)

Compute the ASCII code of the first character of a string.

StringConcat

StringConcat(self, **kwargs)

Concatenate strings.

StringContains

StringContains(self, **kwargs)

Check if a string contains a substring.

StringFind

StringFind(self, **kwargs)

Find the position of a substring in a string.

StringJoin

StringJoin(self, **kwargs)

Join strings with a separator.

StringLength

StringLength(self, **kwargs)

Compute the length of a string.

StringReplace

StringReplace(self, **kwargs)

Replace a substring in a string with another string.

StringSQLILike

StringSQLILike(self, **kwargs)

Case-insensitive SQL LIKE string match operation.

Similar to case-insensitive globbing.

StringSQLLike

StringSQLLike(self, **kwargs)

SQL LIKE string match operation.

Similar to globbing.

StringSlice

StringSlice(self, **kwargs)

Extract a substring from a string.

StringSplit

StringSplit(self, **kwargs)

Split a string using a delimiter.

StringUnary

StringUnary(self, **kwargs)

Base class for string operations accepting one argument.

Strip

Strip(self, **kwargs)

Strip leading and trailing whitespace.

Substring

Substring(self, **kwargs)

Extract a substring from a string.

Translate

Translate(self, **kwargs)

Translate characters in a string.

Uppercase

Uppercase(self, **kwargs)

Convert a string to uppercase.

structs

structs

Operations for working with structs.

Classes

Name	Description
StructColumn	Construct a struct column from literals or expressions.
StructField	Extract a field from a struct value.

StructColumn

StructColumn(self, names, values)

Construct a struct column from literals or expressions.

StructField

StructField(self, **kwargs)

Extract a field from a struct value.

subqueries

subqueries

Subquery operations.

Classes

Name	Description
ExistsSubquery	Check if a subquery returns any rows.
InSubquery	Check if a value is in the result of a subquery.
ScalarSubquery	A subquery that returns a single scalar value.
Subquery	Base class for subquery operations.

ExistsSubquery

ExistsSubquery(self, **kwargs)

Check if a subquery returns any rows.

InSubquery

InSubquery(self, rel, needle)

Check if a value is in the result of a subquery.

ScalarSubquery

ScalarSubquery(self, rel)

A subquery that returns a single scalar value.

Subquery

Subquery(self, **kwargs)

Base class for subquery operations.

temporal

temporal

Temporal operations.

Classes

Name	Description
BetweenTime	Check if a time is between two bounds.
Date	Extract the date from a timestamp.
DateAdd	Add an interval to a date.
DateDelta	Compute the difference between two dates as integer number of requested units.
DateDiff	Compute the difference between two dates.
DateFromYMD	Construct a date from year, month, and day.
DateSub	Subtract an interval from a date.
DateTruncate	Truncate a date to a specified unit.
DayOfWeekIndex	Extract the index of the day of the week from a date or timestamp.
DayOfWeekName	Extract the name of the day of the week from a date or timestamp.
ExtractDateField	Extract a field from a date.
ExtractDay	Extract the day from a date or timestamp.
ExtractDayOfYear	Extract the day of the year from a date or timestamp.
ExtractEpochSeconds	Extract seconds since the UNIX epoch from a date or timestamp.
ExtractHour	Extract the hour from a time or timestamp.
ExtractIsoYear	Extract the ISO year from a date or timestamp.
ExtractMicrosecond	Extract microseconds from a time or timestamp.
ExtractMillisecond	Extract milliseconds from a time or timestamp.
ExtractMinute	Extract the minute from a time or timestamp.
ExtractMonth	Extract the month from a date or timestamp.
ExtractQuarter	Extract the quarter from a date or timestamp.
ExtractSecond	Extract the second from a time or timestamp.
ExtractTemporalField	Extract a field from a temporal value.
ExtractTimeField	Extract a field from a time.
ExtractWeekOfYear	Extract the week of the year from a date or timestamp.
ExtractYear	Extract the year from a date or timestamp.
IntervalAdd	Add two intervals.
IntervalBinary	Base class for interval binary operations.
IntervalFloorDivide	Divide an interval by a scalar, rounding down.
IntervalFromInteger	Construct an interval from an integer.
IntervalMultiply	Multiply an interval by a scalar.
IntervalSubtract	Subtract one interval from another.
Strftime	Format a temporal value as a string.
StringToDate	Convert a string to a date.
StringToTimestamp	Convert a string to a timestamp.
TemporalDelta	Base class for temporal delta operations.
Time	Extract the time from a timestamp.
TimeAdd	Add an interval to a time.
TimeDelta	Compute the difference between two times as integer number of requested units.
TimeDiff	Compute the difference between two times.
TimeFromHMS	Construct a time from hours, minutes, and seconds.
TimeSub	Subtract an interval from a time.
TimeTruncate	Truncate a time to a specified unit.
TimestampAdd	Add an interval to a timestamp.
TimestampBucket	Bucketize a timestamp to a specified interval.
TimestampDelta	Compute the difference between two timestamps as integer number of requested units.
TimestampDiff	Compute the difference between two timestamps.
TimestampFromUNIX	Construct a timestamp from a UNIX timestamp.
TimestampFromYMDHMS	Construct a timestamp from components.
TimestampSub	Subtract an interval from a timestamp.
TimestampTruncate	Truncate a timestamp to a specified unit.

BetweenTime

BetweenTime(self, arg, lower_bound, upper_bound)

Check if a time is between two bounds.

Date

Date(self, **kwargs)

Extract the date from a timestamp.

DateAdd

DateAdd(self, **kwargs)

Add an interval to a date.

DateDelta

DateDelta(self, **kwargs)

Compute the difference between two dates as integer number of requested units.

DateDiff

DateDiff(self, **kwargs)

Compute the difference between two dates.

DateFromYMD

DateFromYMD(self, **kwargs)

Construct a date from year, month, and day.

DateSub

DateSub(self, **kwargs)

Subtract an interval from a date.

DateTruncate

DateTruncate(self, **kwargs)

Truncate a date to a specified unit.

DayOfWeekIndex

DayOfWeekIndex(self, **kwargs)

Extract the index of the day of the week from a date or timestamp.

DayOfWeekName

DayOfWeekName(self, **kwargs)

Extract the name of the day of the week from a date or timestamp.

ExtractDateField

ExtractDateField(self, **kwargs)

Extract a field from a date.

ExtractDay

ExtractDay(self, **kwargs)

Extract the day from a date or timestamp.

ExtractDayOfYear

ExtractDayOfYear(self, **kwargs)

Extract the day of the year from a date or timestamp.

ExtractEpochSeconds

ExtractEpochSeconds(self, **kwargs)

Extract seconds since the UNIX epoch from a date or timestamp.

ExtractHour

ExtractHour(self, **kwargs)

Extract the hour from a time or timestamp.

ExtractIsoYear

ExtractIsoYear(self, **kwargs)

Extract the ISO year from a date or timestamp.

ExtractMicrosecond

ExtractMicrosecond(self, **kwargs)

Extract microseconds from a time or timestamp.

ExtractMillisecond

ExtractMillisecond(self, **kwargs)

Extract milliseconds from a time or timestamp.

ExtractMinute

ExtractMinute(self, **kwargs)

Extract the minute from a time or timestamp.

ExtractMonth

ExtractMonth(self, **kwargs)

Extract the month from a date or timestamp.

ExtractQuarter

ExtractQuarter(self, **kwargs)

Extract the quarter from a date or timestamp.

ExtractSecond

ExtractSecond(self, **kwargs)

Extract the second from a time or timestamp.

ExtractTemporalField

ExtractTemporalField(self, **kwargs)

Extract a field from a temporal value.

ExtractTimeField

ExtractTimeField(self, **kwargs)

Extract a field from a time.

ExtractWeekOfYear

ExtractWeekOfYear(self, **kwargs)

Extract the week of the year from a date or timestamp.

ExtractYear

ExtractYear(self, **kwargs)

Extract the year from a date or timestamp.

IntervalAdd

IntervalAdd(self, **kwargs)

Add two intervals.

IntervalBinary

IntervalBinary(self, **kwargs)

Base class for interval binary operations.

IntervalFloorDivide

IntervalFloorDivide(self, **kwargs)

Divide an interval by a scalar, rounding down.

IntervalFromInteger

IntervalFromInteger(self, **kwargs)

Construct an interval from an integer.

IntervalMultiply

IntervalMultiply(self, **kwargs)

Multiply an interval by a scalar.

IntervalSubtract

IntervalSubtract(self, **kwargs)

Subtract one interval from another.

Strftime

Strftime(self, **kwargs)

Format a temporal value as a string.

StringToDate

StringToDate(self, **kwargs)

Convert a string to a date.

StringToTimestamp

StringToTimestamp(self, **kwargs)

Convert a string to a timestamp.

TemporalDelta

TemporalDelta(self, **kwargs)

Base class for temporal delta operations.

Time

Time(self, **kwargs)

Extract the time from a timestamp.

TimeAdd

TimeAdd(self, **kwargs)

Add an interval to a time.

TimeDelta

TimeDelta(self, **kwargs)

Compute the difference between two times as integer number of requested units.

TimeDiff

TimeDiff(self, **kwargs)

Compute the difference between two times.

TimeFromHMS

TimeFromHMS(self, **kwargs)

Construct a time from hours, minutes, and seconds.

TimeSub

TimeSub(self, **kwargs)

Subtract an interval from a time.

TimeTruncate

TimeTruncate(self, **kwargs)

Truncate a time to a specified unit.

TimestampAdd

TimestampAdd(self, **kwargs)

Add an interval to a timestamp.

TimestampBucket

TimestampBucket(self, **kwargs)

Bucketize a timestamp to a specified interval.

TimestampDelta

TimestampDelta(self, **kwargs)

Compute the difference between two timestamps as integer number of requested units.

TimestampDiff

TimestampDiff(self, **kwargs)

Compute the difference between two timestamps.

TimestampFromUNIX

TimestampFromUNIX(self, **kwargs)

Construct a timestamp from a UNIX timestamp.

TimestampFromYMDHMS

TimestampFromYMDHMS(self, **kwargs)

Construct a timestamp from components.

TimestampSub

TimestampSub(self, **kwargs)

Subtract an interval from a timestamp.

TimestampTruncate

TimestampTruncate(self, **kwargs)

Truncate a timestamp to a specified unit.

temporal_windows

temporal_windows

Temporal window operations.

udf

udf

User-defined functions (UDFs) implementation.

Classes

Name	Description
agg	Aggregate user-defined functions.
scalar	Scalar user-defined functions.

agg

agg()

Aggregate user-defined functions.

The agg class itself is not a public API, its methods are.

Methods

Name	Description
builtin	Construct an aggregate user-defined function that is built-in to the backend.

builtin

builtin(fn=None, *, name=None, database=None, catalog=None, signature=None, **kwargs)

Construct an aggregate user-defined function that is built-in to the backend.

Parameters

Name	Type	Description	Default
fn		The function to wrap.	None
name		The name of the UDF in the backend if different from the function name.	None
database		The database in which the builtin function resides.	None
catalog		The catalog in which the builtin function resides.	None
signature		If present, a tuple of the form ((arg0type, arg1type, ...), returntype). For example, a function taking an int and a float and returning a string would be ((int, float), str). If not present, the signature will be derived from the type annotations of the wrapped function.	None
kwargs		Additional backend-specific configuration arguments for the UDF.	{}

Examples

>>> import ibis
>>> ibis.options.interactive = True
>>> @ibis.udf.agg.builtin
... def favg(a: float) -> float:
...     '''Compute the average of a column using Kahan summation.'''
>>> t = ibis.examples.penguins.fetch()
>>> expr = favg(t.bill_length_mm)
>>> expr

┌──────────────────────────────┐
│ np.float64(43.9219298245614) │
└──────────────────────────────┘

scalar

scalar()

Scalar user-defined functions.

The scalar class itself is not a public API, its methods are.

Methods

Name	Description
builtin	Construct a scalar user-defined function that is built-in to the backend.
pandas	Construct a vectorized scalar user-defined function that accepts pandas Series’ as inputs.
pyarrow	Construct a vectorized scalar user-defined function that accepts PyArrow Arrays as input.
python	Construct a non-vectorized scalar user-defined function that accepts Python scalar values as inputs.

builtin

builtin(fn=None, *, name=None, database=None, catalog=None, signature=None, **kwargs)

Construct a scalar user-defined function that is built-in to the backend.

Parameters

Name	Type	Description	Default
fn		The function to wrap.	None
name		The name of the UDF in the backend if different from the function name.	None
database		The database in which the builtin function resides.	None
catalog		The catalog in which the builtin function resides.	None
signature		If present, a tuple of the form ((arg0type, arg1type, ...), returntype). For example, a function taking an int and a float and returning a string would be ((int, float), str). If not present, the signature will be derived from the type annotations of the wrapped function. For builtin UDFs, only the return type annotation is required. See the user guide for more information.	None
kwargs		Additional backend-specific configuration arguments for the UDF.	{}

Examples

>>> import ibis
>>> @ibis.udf.scalar.builtin
... def hamming(a: str, b: str) -> int:
...     '''Compute the Hamming distance between two strings.'''
>>> expr = hamming("duck", "luck")
>>> con = ibis.connect("duckdb://")
>>> con.execute(expr)

np.int64(1)

pandas

pandas(fn=None, *, name=None, database=None, catalog=None, signature=None, **kwargs)

Construct a vectorized scalar user-defined function that accepts pandas Series’ as inputs.

Parameters

Name	Type	Description	Default
fn		The function to wrap.	None
name		The name of the UDF in the backend if different from the function name.	None
database		The database in which to create the UDF.	None
catalog		The catalog in which to create the UDF.	None
signature		If present, a tuple of the form ((arg0type, arg1type, ...), returntype). For example, a function taking an int and a float and returning a string would be ((int, float), str). If not present, the signature will be derived from the type annotations of the wrapped function.	None
kwargs		Additional backend-specific configuration arguments for the UDF.	{}

Examples

>>> import ibis
>>> ibis.options.interactive = True
>>> t = ibis.memtable(dict(int_col=[1, 2, 3], str_col=["a", "b", "c"]))
>>> t
┏━━━━━━━━━┳━━━━━━━━━┓
┃ int_col ┃ str_col ┃
┡━━━━━━━━━╇━━━━━━━━━┩
│ int64   │ string  │
├─────────┼─────────┤
│       1 │ a       │
│       2 │ b       │
│       3 │ c       │
└─────────┴─────────┘
>>> @ibis.udf.scalar.pandas
... def str_cap(x: str) -> str:
...     # note usage of pandas `str` method
...     return x.str.capitalize()
>>> str_cap(t.str_col)  # doctest: +SKIP
┏━━━━━━━━━━━━━━━━━━━━━━━┓
┃ string_cap_0(str_col) ┃
┡━━━━━━━━━━━━━━━━━━━━━━━┩
│ string                │
├───────────────────────┤
│ A                     │
│ B                     │
│ C                     │
└───────────────────────┘

See Also

• python
• pyarrow

pyarrow

pyarrow(fn=None, *, name=None, database=None, catalog=None, signature=None, **kwargs)

Construct a vectorized scalar user-defined function that accepts PyArrow Arrays as input.

Parameters

Name	Type	Description	Default
fn		The function to wrap.	None
name		The name of the UDF in the backend if different from the function name.	None
database		The database in which to create the UDF.	None
catalog		The catalog in which to create the UDF.	None
signature		If present, a tuple of the form ((arg0type, arg1type, ...), returntype). For example, a function taking an int and a float and returning a string would be ((int, float), str). If not present, the signature will be derived from the type annotations of the wrapped function.	None
kwargs		Additional backend-specific configuration arguments for the UDF.	{}

Examples

>>> import ibis
>>> import pyarrow.compute as pc
>>> from datetime import date
>>> ibis.options.interactive = True
>>> t = ibis.memtable(
...     dict(start_col=[date(2024, 4, 29)], end_col=[date(2025, 4, 29)]),
... )
>>> @ibis.udf.scalar.pyarrow
... def weeks_between(start: date, end: date) -> int:
...     return pc.weeks_between(start, end)
>>> weeks_between(t.start_col, t.end_col)

┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ weeks_between_0(start_col, end_col) ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ int64                               │
├─────────────────────────────────────┤
│                                  52 │
└─────────────────────────────────────┘

See Also

• python
• pandas

python

python(fn=None, *, name=None, database=None, catalog=None, signature=None, **kwargs)

Construct a non-vectorized scalar user-defined function that accepts Python scalar values as inputs.

python UDFs are likely to be slow

python UDFs are not vectorized: they are executed row by row with one Python function call per row

This calling pattern tends to be much slower than pandas or pyarrow-based vectorized UDFs.

Parameters

Name	Type	Description	Default
fn		The function to wrap.	None
name		The name of the UDF in the backend if different from the function name.	None
database		The database in which to create the UDF.	None
catalog		The catalog in which to create the UDF.	None
signature		If present, a tuple of the form ((arg0type, arg1type, ...), returntype). For example, a function taking an int and a float and returning a string would be ((int, float), str). If not present, the signature will be derived from the type annotations of the wrapped function.	None
kwargs		Additional backend-specific configuration arguments for the UDF.	{}

Examples

>>> import ibis
>>> ibis.options.interactive = True
>>> t = ibis.memtable(dict(int_col=[1, 2, 3], str_col=["a", "b", "c"]))
>>> t

┏━━━━━━━━━┳━━━━━━━━━┓
┃ int_col ┃ str_col ┃
┡━━━━━━━━━╇━━━━━━━━━┩
│ int64   │ string  │
├─────────┼─────────┤
│       1 │ a       │
│       2 │ b       │
│       3 │ c       │
└─────────┴─────────┘

>>> @ibis.udf.scalar.python
... def str_magic(x: str) -> str:
...     return f"{x}_magic"
>>> @ibis.udf.scalar.python
... def add_one_py(x: int) -> int:
...     return x + 1
>>> str_magic(t.str_col)

┏━━━━━━━━━━━━━━━━━━━━━━┓
┃ str_magic_0(str_col) ┃
┡━━━━━━━━━━━━━━━━━━━━━━┩
│ string               │
├──────────────────────┤
│ a_magic              │
│ b_magic              │
│ c_magic              │
└──────────────────────┘

>>> add_one_py(t.int_col)

┏━━━━━━━━━━━━━━━━━━━━━━━┓
┃ add_one_py_0(int_col) ┃
┡━━━━━━━━━━━━━━━━━━━━━━━┩
│ int64                 │
├───────────────────────┤
│                     2 │
│                     3 │
│                     4 │
└───────────────────────┘

See Also

• pandas
• pyarrow

window

window

Window operations.

Classes

Name	Description
WindowBoundary	Window boundary object.
WindowFunction	Window function operation.

WindowBoundary

WindowBoundary(self, **kwargs)

Window boundary object.

WindowFunction

WindowFunction(self, how, start, end, **kwargs)

Window function operation.