Python SDK Reference

See the Python Quickstart for a hands-on introduction.

hypermeshdb.connect(path)

Open a local database and return a Connection.

hypermeshdb.Client(url, api_key?)

Return a remote Client connected to a running hmdb serve instance. Exposes the same API as Connection.

Key methods

Method	Description
execute(cypher, parameters?)	Execute any Cypher statement
insert(*, event_ts, members, ...)	Insert a single hyperedge
delete(*, event_ts, members)	Write a tombstone
compact(*, ttl_seconds?, table?)	Compact WAL
begin() / commit() / rollback()	Transaction control
transaction()	Context manager for transactions
analytics(table)	Return an Analytics object
to_hypergraph(table)	Return a HypergraphPy sparse representation

hypermeshdb.Analytics

See the Analytics guide for all 25 measures.