Skip to main content

API Reference

A summary of all main exports from Hysteria ORM:

Core Classes​

  • Model: Base class for SQL models (docs)
  • Collection: Base class for MongoDB collections (docs)
  • QueryBuilder: SQL query builder (docs)
  • MongoQueryBuilder: MongoDB query builder (docs)
  • sql: SQL connection manager (docs)
  • MongoDataSource: MongoDB connection manager (docs)
  • RedisDataSource: Redis connection manager (docs)

Model & Collection Definitions​

  • defineModel: Define SQL models programmatically (docs)
  • defineCollection: Define MongoDB collections programmatically (docs)
  • col: Column type namespace (col.string(), col.integer(), col.boolean(), etc.) (docs)
  • rel: Inline relation namespace for single-file models (rel.hasOne(), rel.hasMany(), rel.belongsTo(), rel.manyToMany()) (docs)
  • defineRelations: Define relations separately to avoid circular imports — takes direct model references, type-checks foreign keys (docs)
  • createSchema: Combine models + relations into an augmented, fully-typed schema record (docs)

Utilities​

  • logger: Built-in and custom logging (docs)
  • withPerformance: Measure async execution (docs)
  • generateULID: Create unique, sortable IDs (docs)
  • generateKeyPair: Create RSA key pairs (docs)
  • HysteriaError: Custom error class (docs)

Data Sources​

  • sql: Default SQL data source (docs)
  • mongo: Default MongoDB data source (docs)
  • Redis: Default Redis data source (docs)

For detailed usage, see the linked documentation sections.