## Dataset Dataset(\*, source: Annotated\[ibis.expr.types.relations.Table \| pyarrow.\_dataset.Dataset, \\]) Usage ``` python Dataset() ``` ## Attributes | Name | Description | |----|----| | [table](#table) | source as ibis table | ------------------------------------------------------------------------ #### table source as ibis table `table: ibis.Table` ## Methods | Name | Description | |----|----| | [any()](#any) | Whether there are at least `limit` rows. | | [asof_join()](#asof_join) | [As-of join](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.asof_join) on nearest key rather than equal keys. | | [cast()](#cast) | [Cast](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.cast) the columns of a table. | | [column()](#column) | Column of any type by name. | | [columns()](#columns) | Fields for each column. | | [cross_join()](#cross_join) | [Cross join](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.cross_join) with one or more tables. | | [difference()](#difference) | [Set difference](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.difference) of tables. | | [distinct()](#distinct) | [Remove duplicate](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.distinct) rows from table. | | [drop_null()](#drop_null) | [Drop](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.drop_null) rows with null values. | | [fill_null()](#fill_null) | [Fill null](https://ibis-project.org/reference/expression-tables.html#ibis.expr.types.relations.Table.fill_null) values. | | [filter()](#filter) | [Filter](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.filter) rows by predicates. | | [first()](#first) | Provisionally sort and filter by rank. | | [group()](#group) | [Group](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.group_by) table by columns. | | [intersect()](#intersect) | [Set intersection](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.intersect) of tables. | | [join()](#join) | [Join](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.join) two tables. | | [optional()](#optional) | Nullable field to stop error propagation, enabling partial query results. | | [order()](#order) | [Sort](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.order_by) table by columns. | | [project()](#project) | [Mutate](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.mutate) columns by expressions. | | [resolve()](#resolve) | Cache the table if it will be reused. | | [resolve_reference()](#resolve_reference) | Return table filtered by federated keys. | | [row()](#row) | Scalar values at index. | | [runs()](#runs) | Provisionally group table by adjacent values in columns. | | [select()](#select) | Return minimal schema needed to continue. | | [slice()](#slice) | [Limit](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.limit) row selection. | | [sql()](#sql) | [Run a SQL](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.sql) query against a table expression. | | [take()](#take) | [Take](https://arrow.apache.org/docs/python/generated/pyarrow.dataset.Dataset.html#pyarrow.dataset.Dataset.take) rows by index. | | [to_sql()](#to_sql) | [Compile to](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.to_sql) a formatted SQL string. | | [union()](#union) | [Set union](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.union) of tables. | | [unnest()](#unnest) | [Unnest](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.unnest) an array column from a table. | | [unpack()](#unpack) | [Unpack](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.unpack) the struct fields of each column. | ------------------------------------------------------------------------ #### any() Whether there are at least `limit` rows. Usage ``` python any(limit=BigInt(1)) ``` May be significantly faster than `count` for out-of-core data. ------------------------------------------------------------------------ #### asof_join() [As-of join](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.asof_join) on nearest key rather than equal keys. Usage ``` python asof_join( info, right, on, keys=[], rkeys=[], tolerance=None, scalar={}, lname="", rname="{name}_right" ) ``` ------------------------------------------------------------------------ #### cast() [Cast](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.cast) the columns of a table. Usage ``` python cast(info, schema, try_=False) ``` ------------------------------------------------------------------------ #### column() Column of any type by name. Usage ``` python column(name, cast="", try_=False, index=[]) ``` If the column is in the schema, [columns](Dataset.md#graphique.Dataset.columns) can be used instead. ------------------------------------------------------------------------ #### columns() Fields for each column. Usage ``` python columns(info) ``` ------------------------------------------------------------------------ #### cross_join() [Cross join](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.cross_join) with one or more tables. Usage ``` python cross_join(info, right, lname="", rname="{name}_right") ``` ------------------------------------------------------------------------ #### difference() [Set difference](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.difference) of tables. Usage ``` python difference(info, table, distinct=True) ``` ------------------------------------------------------------------------ #### distinct() [Remove duplicate](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.distinct) rows from table. Usage ``` python distinct(info, on=None, keep="first", counts="", order="") ``` Differs from [group](Dataset.md#graphique.Dataset.group) by keeping all columns, and defaulting to all keys. ------------------------------------------------------------------------ #### drop_null() [Drop](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.drop_null) rows with null values. Usage ``` python drop_null(info, subset=None, how="any") ``` ------------------------------------------------------------------------ #### fill_null() [Fill null](https://ibis-project.org/reference/expression-tables.html#ibis.expr.types.relations.Table.fill_null) values. Usage ``` python fill_null(info, name=None, value=UNSET, scalar={}) ``` ------------------------------------------------------------------------ #### filter() [Filter](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.filter) rows by predicates. Usage ``` python filter(info, where=None, **queries) ``` Schema derived fields provide syntax for simple queries; `where` supports complex queries. ------------------------------------------------------------------------ #### first() Provisionally sort and filter by rank. Usage ``` python first(info, by, rank=1, dense=False, over=[]) ``` ------------------------------------------------------------------------ #### group() [Group](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.group_by) table by columns. Usage ``` python group(info, by=[], counts="", order="", aggregate={}) ``` ------------------------------------------------------------------------ #### intersect() [Set intersection](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.intersect) of tables. Usage ``` python intersect(info, table, distinct=True) ``` ------------------------------------------------------------------------ #### join() [Join](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.join) two tables. Usage ``` python join(info, right, keys, rkeys=[], how="inner", lname="", rname="{name}_right") ``` ------------------------------------------------------------------------ #### optional() Nullable field to stop error propagation, enabling partial query results. Usage ``` python optional(info) ``` ------------------------------------------------------------------------ #### order() [Sort](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.order_by) table by columns. Usage ``` python order(info, by, limit=None, over=[], dense=False) ``` ------------------------------------------------------------------------ #### project() [Mutate](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.mutate) columns by expressions. Usage ``` python project(info, columns) ``` Renamed to not be confused with a mutation. ------------------------------------------------------------------------ #### resolve() Cache the table if it will be reused. Usage ``` python resolve(info, source) ``` ------------------------------------------------------------------------ #### resolve_reference() Return table filtered by federated keys. Usage ``` python resolve_reference(info, **keys) ``` ------------------------------------------------------------------------ #### row() Scalar values at index. Usage ``` python row(info, index=0) ``` ------------------------------------------------------------------------ #### runs() Provisionally group table by adjacent values in columns. Usage ``` python runs(info, by=[], split=[], counts="", order="_", aggregate={}) ``` ------------------------------------------------------------------------ #### select() Return minimal schema needed to continue. Usage ``` python select(info, source) ``` ------------------------------------------------------------------------ #### slice() [Limit](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.limit) row selection. Usage ``` python slice(info, offset=BigInt(0), limit=None) ``` ------------------------------------------------------------------------ #### sql() [Run a SQL](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.sql) query against a table expression. Usage ``` python sql(info, query, alias="", dialect=None) ``` ------------------------------------------------------------------------ #### take() [Take](https://arrow.apache.org/docs/python/generated/pyarrow.dataset.Dataset.html#pyarrow.dataset.Dataset.take) rows by index. Usage ``` python take(info, indices) ``` ------------------------------------------------------------------------ #### to_sql() [Compile to](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.to_sql) a formatted SQL string. Usage ``` python to_sql(dialect=None, pretty=True) ``` ------------------------------------------------------------------------ #### union() [Set union](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.union) of tables. Usage ``` python union(info, table, distinct=False) ``` ------------------------------------------------------------------------ #### unnest() [Unnest](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.unnest) an array column from a table. Usage ``` python unnest(info, name, offset="", keep_empty=False, order="") ``` ------------------------------------------------------------------------ #### unpack() [Unpack](https://ibis-project.org/reference/expression-tables#ibis.expr.types.relations.Table.unpack) the struct fields of each column. Usage ``` python unpack(info, names) ```