Start here
moltres
col
column
moltres.dataframe
moltres.expressions
moltres.engine
moltres.io.records
moltres.integrations
Getting started & migration
union
unionAll
db.load.*
db.read.*
Guides & how-to
.str
.dt
when().then().otherwise()
Integrations
to_sqlalchemy()
execute_with_connection()
execute_with_session()
table()
with_model()
moltres_dataframe(df, show_query_info=True, **kwargs)
query_builder(db)
cached_query(ttl=None, max_entries=None)
get_db_from_session(key="db")
init_db_connection(dsn, key="db")
close_db_connection(key="db")
visualize_query(df, show_sql=True, show_plan=True, show_metrics=False)
display_moltres_error(error)
clear_moltres_cache()
invalidate_query_cache(query_sql)
moltres_db
moltres_async_db
test_data
create_test_df()
assert_dataframe_equal()
assert_schema_equal()
assert_query_results()
query_logger
get_moltres_connection()
moltres_ref()
moltres_source()
moltres_var()
Concepts & operations
Comparisons (reference)
order_by()
orderBy()
sort()
drop()
API reference
connect()
async_connect()
col()
lit()
column()
create_config()
register_performance_hook()
unregister_performance_hook()
AsyncLazyRecords
AsyncLazyRecords._read_func
AsyncLazyRecords._database
AsyncLazyRecords._schema
AsyncLazyRecords._options
AsyncLazyRecords._materialized
AsyncLazyRecords.collect()
AsyncLazyRecords.first()
AsyncLazyRecords.head()
AsyncLazyRecords.insert_into()
AsyncLazyRecords.iter()
AsyncLazyRecords.last()
AsyncLazyRecords.rename()
AsyncLazyRecords.rows()
AsyncLazyRecords.schema
AsyncLazyRecords.select()
AsyncLazyRecords.tail()
AsyncRecords
AsyncRecords.first()
AsyncRecords.from_dataframe()
AsyncRecords.from_dicts()
AsyncRecords.from_list()
AsyncRecords.head()
AsyncRecords.insert_into()
AsyncRecords.iter()
AsyncRecords.last()
AsyncRecords.rename()
AsyncRecords.rows()
AsyncRecords.schema
AsyncRecords.select()
AsyncRecords.tail()
LazyRecords
LazyRecords._read_func
LazyRecords._database
LazyRecords._schema
LazyRecords._options
LazyRecords._materialized
LazyRecords.collect()
LazyRecords.first()
LazyRecords.head()
LazyRecords.insert_into()
LazyRecords.iter()
LazyRecords.last()
LazyRecords.rename()
LazyRecords.rows()
LazyRecords.schema
LazyRecords.select()
LazyRecords.tail()
Records
Records.first()
Records.from_dataframe()
Records.from_dicts()
Records.from_list()
Records.head()
Records.insert_into()
Records.iter()
Records.last()
Records.rename()
Records.rows()
Records.schema
Records.select()
Records.tail()
DataFrame
DataFrame.anti_join()
DataFrame.collect()
DataFrame.columns
DataFrame.count()
DataFrame.crossJoin()
DataFrame.cross_join()
DataFrame.cte()
DataFrame.database
DataFrame.describe()
DataFrame.distinct()
DataFrame.drop()
DataFrame.dropDuplicates()
DataFrame.drop_duplicates()
DataFrame.dropna()
DataFrame.dtypes
DataFrame.except_()
DataFrame.explain()
DataFrame.explode()
DataFrame.fillna()
DataFrame.filter()
DataFrame.first()
DataFrame.from_sqlalchemy()
DataFrame.from_table()
DataFrame.groupBy()
DataFrame.group_by()
DataFrame.head()
DataFrame.help()
DataFrame.intersect()
DataFrame.join()
DataFrame.limit()
DataFrame.model
DataFrame.na
DataFrame.nunique()
DataFrame.orderBy()
DataFrame.order_by()
DataFrame.performance_hints()
DataFrame.pivot()
DataFrame.plan
DataFrame.plan_summary()
DataFrame.polars()
DataFrame.printSchema()
DataFrame.print_schema()
DataFrame.recursive_cte()
DataFrame.sample()
DataFrame.schema
DataFrame.select()
DataFrame.selectExpr()
DataFrame.select_expr()
DataFrame.select_for_share()
DataFrame.select_for_update()
DataFrame.semi_join()
DataFrame.show()
DataFrame.show_sql()
DataFrame.sort()
DataFrame.sql
DataFrame.sql_preview()
DataFrame.suggest_next()
DataFrame.summary()
DataFrame.tail()
DataFrame.take()
DataFrame.to_sql()
DataFrame.to_sqlalchemy()
DataFrame.union()
DataFrame.unionAll()
DataFrame.union_all()
DataFrame.validate()
DataFrame.visualize_plan()
DataFrame.where()
DataFrame.withColumn()
DataFrame.withColumnRenamed()
DataFrame.withColumns()
DataFrame.with_column()
DataFrame.with_column_renamed()
DataFrame.with_columns()
DataFrame.with_model()
DataFrame.write
NullHandling
NullHandling.drop()
NullHandling.fill()
AsyncDataFrame
AsyncDataFrame.anti_join()
AsyncDataFrame.collect()
AsyncDataFrame.columns
AsyncDataFrame.count()
AsyncDataFrame.crossJoin()
AsyncDataFrame.cross_join()
AsyncDataFrame.cte()
AsyncDataFrame.database
AsyncDataFrame.describe()
AsyncDataFrame.distinct()
AsyncDataFrame.drop()
AsyncDataFrame.dropDuplicates()
AsyncDataFrame.drop_duplicates()
AsyncDataFrame.dropna()
AsyncDataFrame.dtypes
AsyncDataFrame.except_()
AsyncDataFrame.explode()
AsyncDataFrame.fillna()
AsyncDataFrame.filter()
AsyncDataFrame.first()
AsyncDataFrame.from_sqlalchemy()
AsyncDataFrame.from_table()
AsyncDataFrame.groupBy()
AsyncDataFrame.group_by()
AsyncDataFrame.head()
AsyncDataFrame.intersect()
AsyncDataFrame.join()
AsyncDataFrame.limit()
AsyncDataFrame.model
AsyncDataFrame.na
AsyncDataFrame.nunique()
AsyncDataFrame.orderBy()
AsyncDataFrame.order_by()
AsyncDataFrame.pivot()
AsyncDataFrame.plan
AsyncDataFrame.printSchema()
AsyncDataFrame.print_schema()
AsyncDataFrame.recursive_cte()
AsyncDataFrame.sample()
AsyncDataFrame.schema
AsyncDataFrame.select()
AsyncDataFrame.selectExpr()
AsyncDataFrame.select_expr()
AsyncDataFrame.select_for_share()
AsyncDataFrame.select_for_update()
AsyncDataFrame.semi_join()
AsyncDataFrame.show()
AsyncDataFrame.sort()
AsyncDataFrame.summary()
AsyncDataFrame.take()
AsyncDataFrame.to_sql()
AsyncDataFrame.to_sqlalchemy()
AsyncDataFrame.union()
AsyncDataFrame.unionAll()
AsyncDataFrame.union_all()
AsyncDataFrame.where()
AsyncDataFrame.withColumn()
AsyncDataFrame.withColumnRenamed()
AsyncDataFrame.withColumns()
AsyncDataFrame.with_column()
AsyncDataFrame.with_column_renamed()
AsyncDataFrame.with_columns()
AsyncDataFrame.with_model()
AsyncDataFrame.write
AsyncNullHandling
AsyncNullHandling.drop()
AsyncNullHandling.fill()
AsyncNullHandling.pandas()
AsyncNullHandling.polars()
GroupedDataFrame
GroupedDataFrame.agg()
GroupedDataFrame.keys
GroupedDataFrame.parent
GroupedDataFrame.pivot()
GroupedDataFrame.plan
PivotedGroupedDataFrame
PivotedGroupedDataFrame.agg()
PivotedGroupedDataFrame.keys
PivotedGroupedDataFrame.parent
PivotedGroupedDataFrame.pivot_column
PivotedGroupedDataFrame.pivot_values
PivotedGroupedDataFrame.plan
Column
Column.alias()
Column.asc()
Column.between()
Column.cast()
Column.contains()
Column.desc()
Column.endswith()
Column.filter()
Column.ilike()
Column.is_not_null()
Column.is_null()
Column.isin()
Column.like()
Column.over()
Column.source
Column.startswith()
ensure_column()
literal()
abs()
acos()
add_months()
array()
array_append()
array_contains()
array_distinct()
array_length()
array_max()
array_min()
array_position()
array_prepend()
array_remove()
array_sort()
array_sum()
asin()
atan()
atan2()
avg()
base64()
ceil()
coalesce()
collect_list()
collect_set()
concat()
corr()
cos()
count()
count_distinct()
covar()
crc32()
cume_dist()
current_date()
current_timestamp()
date_add()
date_format()
date_sub()
date_trunc()
datediff()
day()
dayofweek()
dayofyear()
dense_rank()
exists()
exp()
explode()
first_value()
floor()
from_json()
from_unixtime()
greatest()
hash()
hour()
hypot()
initcap()
instr()
isinf()
isnan()
isnotnull()
isnull()
json_array_length()
json_extract()
json_tuple()
lag()
last_day()
last_value()
lead()
least()
length()
locate()
log()
log10()
log2()
lower()
lpad()
ltrim()
max()
md5()
min()
minute()
monotonically_increasing_id()
month()
months_between()
not_exists()
nth_value()
ntile()
percent_rank()
percentile_cont()
percentile_disc()
pow()
power()
quarter()
rand()
randn()
rank()
regexp_extract()
regexp_replace()
replace()
round()
row_number()
rpad()
rtrim()
scalar_subquery()
second()
sha1()
sha2()
sign()
signum()
sin()
soundex()
split()
sqrt()
stddev()
substring()
sum()
tan()
to_date()
to_json()
to_timestamp()
translate()
trim()
unix_timestamp()
upper()
variance()
week()
weekofyear()
when()
year()
Window
Window.orderBy()
Window.order_by()
Window.partitionBy()
Window.partition_by()
Window.rangeBetween()
Window.range_between()
Window.rowsBetween()
Window.rows_between()
WindowSpec
WindowSpec.orderBy()
WindowSpec.order_by
WindowSpec.partitionBy()
WindowSpec.partition_by
WindowSpec.rangeBetween()
WindowSpec.range_between
WindowSpec.rowsBetween()
WindowSpec.rows_between
Database
Database.batch()
Database.close()
Database.compile_plan()
Database.connection_manager
Database.createDataFrame()
Database.create_dataframe()
Database.create_index()
Database.create_table()
Database.delete()
Database.dialect
Database.drop_index()
Database.drop_table()
Database.execute_plan()
Database.execute_plan_stream()
Database.execute_sql()
Database.executor
Database.explain()
Database.from_connection()
Database.from_engine()
Database.from_session()
Database.get_columns()
Database.get_table_names()
Database.get_transaction_status()
Database.get_view_names()
Database.insert()
Database.is_in_transaction()
Database.load
Database.merge()
Database.read
Database.reflect()
Database.reflect_table()
Database.scan_csv()
Database.scan_json()
Database.scan_jsonl()
Database.scan_parquet()
Database.scan_text()
Database.schema()
Database.show_schema()
Database.show_tables()
Database.sql()
Database.table()
Database.tables()
Database.transaction()
Database.update()
TableHandle
TableHandle.columns()
TableHandle.database
TableHandle.model
TableHandle.model_class
TableHandle.name
TableHandle.pandas()
TableHandle.polars()
TableHandle.select()
Transaction
Transaction.commit()
Transaction.is_active()
Transaction.is_readonly()
Transaction.isolation_level()
Transaction.release_savepoint()
Transaction.rollback()
Transaction.rollback_to_savepoint()
Transaction.savepoint()
AsyncDatabase
AsyncDatabase.close()
AsyncDatabase.compile_plan()
AsyncDatabase.connection_manager
AsyncDatabase.createDataFrame()
AsyncDatabase.create_dataframe()
AsyncDatabase.create_index()
AsyncDatabase.create_table()
AsyncDatabase.delete()
AsyncDatabase.dialect
AsyncDatabase.drop_index()
AsyncDatabase.drop_table()
AsyncDatabase.execute_plan()
AsyncDatabase.execute_plan_stream()
AsyncDatabase.execute_sql()
AsyncDatabase.executor
AsyncDatabase.from_async_connection()
AsyncDatabase.from_async_engine()
AsyncDatabase.from_async_session()
AsyncDatabase.get_columns()
AsyncDatabase.get_table_names()
AsyncDatabase.get_transaction_status()
AsyncDatabase.get_view_names()
AsyncDatabase.insert()
AsyncDatabase.is_in_transaction()
AsyncDatabase.load
AsyncDatabase.merge()
AsyncDatabase.read
AsyncDatabase.reflect()
AsyncDatabase.reflect_table()
AsyncDatabase.scan_csv()
AsyncDatabase.scan_json()
AsyncDatabase.scan_jsonl()
AsyncDatabase.scan_parquet()
AsyncDatabase.scan_text()
AsyncDatabase.sql()
AsyncDatabase.table()
AsyncDatabase.transaction()
AsyncDatabase.update()
AsyncTableHandle
AsyncTableHandle.database
AsyncTableHandle.model
AsyncTableHandle.model_class
AsyncTableHandle.name
AsyncTableHandle.pandas()
AsyncTableHandle.polars()
AsyncTableHandle.select()
AsyncTransaction
AsyncTransaction.commit()
AsyncTransaction.is_active()
AsyncTransaction.is_readonly()
AsyncTransaction.isolation_level()
AsyncTransaction.release_savepoint()
AsyncTransaction.rollback()
AsyncTransaction.rollback_to_savepoint()
AsyncTransaction.savepoint()
CheckConstraint
CheckConstraint.expression
CheckConstraint.name
ColumnDef
ColumnDef.default
ColumnDef.name
ColumnDef.nullable
ColumnDef.precision
ColumnDef.primary_key
ColumnDef.scale
ColumnDef.type_name
ForeignKeyConstraint
ForeignKeyConstraint.columns
ForeignKeyConstraint.name
ForeignKeyConstraint.on_delete
ForeignKeyConstraint.on_update
ForeignKeyConstraint.references_columns
ForeignKeyConstraint.references_table
TableSchema
TableSchema.columns
TableSchema.constraints
TableSchema.if_not_exists
TableSchema.name
TableSchema.temporary
UniqueConstraint
UniqueConstraint.columns
UniqueConstraint.name
check()
decimal()
foreign_key()
json()
unique()
uuid()
QueryExecutor
QueryExecutor.execute()
QueryExecutor.execute_many()
QueryExecutor.fetch()
QueryResult
QueryResult.rowcount
QueryResult.rows
ConnectionManager
ConnectionManager.active_transaction
ConnectionManager.begin_transaction()
ConnectionManager.close()
ConnectionManager.commit_transaction()
ConnectionManager.connect()
ConnectionManager.create_savepoint()
ConnectionManager.engine
ConnectionManager.release_savepoint()
ConnectionManager.rollback_to_savepoint()
ConnectionManager.rollback_transaction()
ConnectionManager.savepoint_stack
ConnectionManager.transaction_metadata
moltres.dataframe.core.async_dataframe
moltres.dataframe.core.dataframe
moltres.dataframe.groupby.groupby
moltres.engine.connection
moltres.engine.execution
moltres.expressions.column
moltres.expressions.functions
moltres.expressions.window
moltres.table.async_table
moltres.table.schema
moltres.table.table
