vastorbit.VastColumn.sum¶

VastColumn.sum() → Annotated[bool | float | str | timedelta | datetime, 'Python Scalar']¶

Aggregates the VastFrame using SUM aggregation, which computes the total sum of values for the specified columns, providing a cumulative view of numerical data.

Returns:: sum
Return type:: PythonScalar

Examples

For this example, let’s generate a dataset and calculate the sum of a column:

import vastorbit as vo

data = vo.VastFrame(
    {
        "x": [1, 2, 4, 9, 10, 15, 20, 22],
        "y": [1, 2, 1, 2, 1, 1, 2, 1],
        "z": [10, 12, 2, 1, 9, 8, 1, 3],
    }
)
data["x"].sum()

Note

All the calculations are pushed to the database.

Hint

For more precise control, please refer to the aggregate method.