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)
  • SqlDataSource: SQL connection manager (docs)
  • MongoDataSource: MongoDB connection manager (docs)
  • RedisDataSource: Redis connection manager (docs)

Decorators​

  • @column: Define SQL model fields (docs)
  • @property: Define MongoDB collection fields (docs)
  • @hasOne, @hasMany, @belongsTo, @manyToMany: Define SQL relations (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.