Getting started & migration
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
order_by()
orderBy()
sort()
drop()
Internal & archive
col
col()
API reference
AsyncGroupedDataFrame
AsyncGroupedDataFrame.agg()
AsyncGroupedDataFrame.pivot()
AsyncPandasGroupBy
AsyncPandasGroupBy.agg()
AsyncPandasGroupBy.count()
AsyncPandasGroupBy.first()
AsyncPandasGroupBy.last()
AsyncPandasGroupBy.max()
AsyncPandasGroupBy.mean()
AsyncPandasGroupBy.min()
AsyncPandasGroupBy.nunique()
AsyncPandasGroupBy.size()
AsyncPandasGroupBy.sum()
AsyncPolarsGroupBy
AsyncPolarsGroupBy.agg()
AsyncPolarsGroupBy.count()
AsyncPolarsGroupBy.first()
AsyncPolarsGroupBy.last()
AsyncPolarsGroupBy.max()
AsyncPolarsGroupBy.mean()
AsyncPolarsGroupBy.min()
AsyncPolarsGroupBy.n_unique()
AsyncPolarsGroupBy.std()
AsyncPolarsGroupBy.sum()
AsyncPolarsGroupBy.var()
GroupedDataFrame
GroupedDataFrame.agg()
GroupedDataFrame.keys
GroupedDataFrame.parent
GroupedDataFrame.pivot()
GroupedDataFrame.plan
PandasGroupBy
PandasGroupBy.agg()
PandasGroupBy.count()
PandasGroupBy.first()
PandasGroupBy.last()
PandasGroupBy.max()
PandasGroupBy.mean()
PandasGroupBy.min()
PandasGroupBy.nunique()
PandasGroupBy.size()
PandasGroupBy.sum()
PolarsGroupBy
PolarsGroupBy.agg()
PolarsGroupBy.count()
PolarsGroupBy.first()
PolarsGroupBy.last()
PolarsGroupBy.max()
PolarsGroupBy.mean()
PolarsGroupBy.min()
PolarsGroupBy.n_unique()
PolarsGroupBy.std()
PolarsGroupBy.sum()
PolarsGroupBy.var()
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()
lit()
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.config
Database.dialect
Database.batch()
Database.close()
Database.compile_plan()
Database.connection_manager
Database.createDataFrame()
Database.create_dataframe()
Database.create_index()
Database.create_table()
Database.delete()
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.name
TableHandle.database
TableHandle.model
TableHandle.columns()
TableHandle.model_class
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.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.is_in_transaction()
AsyncDatabase.load
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()
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()
column()
decimal()
foreign_key()
json()
unique()
uuid()
QueryExecutor
QueryExecutor.execute()
QueryExecutor.execute_many()
QueryExecutor.fetch()
QueryResult
QueryResult.rowcount
QueryResult.rows
register_performance_hook()
unregister_performance_hook()
ConnectionManager
ConnectionManager.active_transaction
ConnectionManager.begin_transaction()
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