API Reference

This page lists the supported public surface of the hypermesh package — everything exported from hypermesh.__all__. Each name is stable and covered by the public-API contract test; anything not listed here is internal and may change without notice.

Connections

Name	Kind	Summary
`connect(target)`	function	Unified factory — local path opens the embedded engine, an `http(s)` URL returns a remote `Client`.
`Connection`	class	Embedded temporal-hypergraph store on local disk.
`Client`	class	Synchronous remote client over REST.
`AsyncClient`	class	Asynchronous remote client over REST.
`Database`	type	Protocol implemented by `Connection` / `Client`.

Configuration & logging

Name	Kind	Summary
`Config`	class	Runtime configuration object.
`enable_debug_logging()`	function	Turn on verbose engine logging.

Results & streaming

Name	Kind	Summary
`QueryResult`	class	Iterable result set with column metadata and `fetchmany(size)`.
`Row`	class	Per-row access by column name or position.
`QueryPlan`	class	Strategy, rows scanned/returned, predicates applied.
`HyperMeshEncoder`	class	JSON encoder for results and engine value types.
`scan_windows()`	function	Bounded-memory iteration of a time range, one TPI window at a time.
`scan_rows()`	function	Flatten `scan_windows` into a single `Row` stream.

Schema & bulk load

Name	Kind	Summary
`ColumnDef`	class	Typed column definition for schema DDL.
`CopyOptions`	class	Options for `COPY FROM` bulk loads.
`Loader`	class	Programmatic streaming loader for large ingests.

Ingestion

Name	Kind	Summary
`ingest_csv()`	function	Ingest a CSV file; auto-infers a mapping when no spec is given.
`ingest_dataframe()`	function	Ingest a pandas DataFrame.
`ingest_from_uri()`	function	Ingest from a `file://` / `rdbms://` source.
`infer_spec(source)`	function	Introspect a source and return a reviewable `MappingSpec`.
`infer_hypergraph(source)`	function	One-shot: infer the mapping, ingest, and return the result.
`MappingSpec`	class	Declarative source-to-hypergraph mapping.

See the Ingestion guide for end-to-end usage.

Connectors

Name	Kind	Summary
`build_connector(config)`	function	Construct a source connector from a config.
`ConnectorConfig`	class	Connector configuration.
`ConnectorBase`	class	Base class for custom connectors.

See Connector Authoring to build your own.

Analytics

Name	Kind	Summary
`Analytics`	class	Facade over the 25+ hypergraph measures.
`HypergraphPy`	class	In-memory sparse hypergraph snapshot.
`build_hypergraph()`	function	Materialise a `HypergraphPy` from a store/query.

See the Analytics Cookbook and Interoperability.

Reports

Name	Kind	Summary
`build_stix_bundle()`	function	Emit detections as a STIX 2.x bundle.
`render_html_report()`	function	Render a self-contained HTML detection report.

Errors

Name	Kind	Summary
`HyperMeshError`	class	Base class for the unified exception taxonomy.

The hypermesh.exceptions submodule also exposes ConnectionError, QueryError, SchemaError, IngestError, AuthError, TimeoutError, and EngineNotInstalledError, all subclasses of HyperMeshError.

Submodules

exceptions, types, analytics, interop, ingest, connectors, reports, config — plus the __version__ string.