API specification

The API consists of dataframe, column and groupby classes, plus a small number of objects and functions in the top-level namespace. The latter are:

__dataframe_api_version__	String representing the version of the DataFrame API specification to which the conforming implementation adheres.
is_null	Check if an object is a null scalar.
null	A null object to represent missing data.
Int64	Integer type with 64 bits of precision.
Int32	Integer type with 32 bits of precision.
Int16	Integer type with 16 bits of precision.
Int8	Integer type with 8 bits of precision.
UInt64	Unsigned integer type with 64 bits of precision.
UInt32	Unsigned integer type with 32 bits of precision.
UInt16	Unsigned integer type with 16 bits of precision.
UInt8	Unsigned integer type with 8 bits of precision.
Float64	Floating point type with 64 bits of precision.
Float32	Floating point type with 32 bits of precision.
Bool	Boolean type with 8 bits of precision.
Date	Date type.
Datetime	Datetime type.
Duration	Duration type.
String	String type.
is_dtype	Indicate whether a provided dtype is of a specified data type "kind".
column_from_sequence	Construct Column from sequence of elements.
column_from_1d_array	Construct Column from 1D array.
dataframe_from_columns	Construct DataFrame from sequence of Columns.
dataframe_from_2d_array	Construct DataFrame from 2D array.

The DataFrame, Column and GroupBy objects have the following methods and attributes:

• Dataframe object
  • DataFrame
    • DataFrame.__abstractmethods__
    • DataFrame.__add__()
    • DataFrame.__and__()
    • DataFrame.__dataframe_namespace__()
    • DataFrame.__divmod__()
    • DataFrame.__eq__()
    • DataFrame.__floordiv__()
    • DataFrame.__ge__()
    • DataFrame.__gt__()
    • DataFrame.__init__()
    • DataFrame.__invert__()
    • DataFrame.__iter__()
    • DataFrame.__le__()
    • DataFrame.__lt__()
    • DataFrame.__mod__()
    • DataFrame.__mul__()
    • DataFrame.__ne__()
    • DataFrame.__or__()
    • DataFrame.__parameters__
    • DataFrame.__pow__()
    • DataFrame.__radd__()
    • DataFrame.__rand__()
    • DataFrame.__rfloordiv__()
    • DataFrame.__rmod__()
    • DataFrame.__rmul__()
    • DataFrame.__ror__()
    • DataFrame.__rpow__()
    • DataFrame.__rsub__()
    • DataFrame.__rtruediv__()
    • DataFrame.__sub__()
    • DataFrame.__subclasshook__()
    • DataFrame.__truediv__()
    • DataFrame.all()
    • DataFrame.any()
    • DataFrame.assign()
    • DataFrame.cast()
    • DataFrame.col()
    • DataFrame.column_names
    • DataFrame.dataframe
    • DataFrame.drop()
    • DataFrame.drop_nulls()
    • DataFrame.fill_nan()
    • DataFrame.fill_null()
    • DataFrame.filter()
    • DataFrame.group_by()
    • DataFrame.is_nan()
    • DataFrame.is_null()
    • DataFrame.iter_columns()
    • DataFrame.join()
    • DataFrame.max()
    • DataFrame.mean()
    • DataFrame.median()
    • DataFrame.min()
    • DataFrame.persist()
    • DataFrame.prod()
    • DataFrame.rename()
    • DataFrame.schema
    • DataFrame.select()
    • DataFrame.shape()
    • DataFrame.slice_rows()
    • DataFrame.sort()
    • DataFrame.std()
    • DataFrame.sum()
    • DataFrame.take()
    • DataFrame.to_array()
    • DataFrame.var()
• Column object
  • Column
    • Column.__abstractmethods__
    • Column.__add__()
    • Column.__and__()
    • Column.__column_namespace__()
    • Column.__divmod__()
    • Column.__eq__()
    • Column.__floordiv__()
    • Column.__ge__()
    • Column.__gt__()
    • Column.__init__()
    • Column.__invert__()
    • Column.__iter__()
    • Column.__le__()
    • Column.__lt__()
    • Column.__mod__()
    • Column.__mul__()
    • Column.__ne__()
    • Column.__or__()
    • Column.__parameters__
    • Column.__pow__()
    • Column.__radd__()
    • Column.__rand__()
    • Column.__rfloordiv__()
    • Column.__rmod__()
    • Column.__rmul__()
    • Column.__ror__()
    • Column.__rpow__()
    • Column.__rsub__()
    • Column.__rtruediv__()
    • Column.__sub__()
    • Column.__subclasshook__()
    • Column.__truediv__()
    • Column.all()
    • Column.any()
    • Column.cast()
    • Column.column
    • Column.cumulative_max()
    • Column.cumulative_min()
    • Column.cumulative_prod()
    • Column.cumulative_sum()
    • Column.day()
    • Column.dtype
    • Column.fill_nan()
    • Column.fill_null()
    • Column.filter()
    • Column.get_value()
    • Column.hour()
    • Column.is_in()
    • Column.is_nan()
    • Column.is_null()
    • Column.iso_weekday()
    • Column.len()
    • Column.max()
    • Column.mean()
    • Column.median()
    • Column.microsecond()
    • Column.min()
    • Column.minute()
    • Column.month()
    • Column.n_unique()
    • Column.name
    • Column.parent_dataframe
    • Column.persist()
    • Column.prod()
    • Column.rename()
    • Column.second()
    • Column.shift()
    • Column.slice_rows()
    • Column.sort()
    • Column.sorted_indices()
    • Column.std()
    • Column.sum()
    • Column.take()
    • Column.to_array()
    • Column.unique_indices()
    • Column.unix_timestamp()
    • Column.var()
    • Column.year()
• Groupby object
  • GroupBy
    • GroupBy.__abstractmethods__
    • GroupBy.__init__()
    • GroupBy.__parameters__
    • GroupBy.__subclasshook__()
    • GroupBy.aggregate()
    • GroupBy.all()
    • GroupBy.any()
    • GroupBy.max()
    • GroupBy.mean()
    • GroupBy.median()
    • GroupBy.min()
    • GroupBy.prod()
    • GroupBy.size()
    • GroupBy.std()
    • GroupBy.sum()
    • GroupBy.var()