Skip to main content

Setup

Environment Variables​

Hysteria ORM can be configured using environment variables or direct options. Example .env:

DB_TYPE=postgres
DB_HOST=localhost
DB_PORT=5432
DB_USER=root
DB_PASSWORD=root
DB_DATABASE=test
MONGO_URL=mongodb://root:root@localhost:27017
REDIS_HOST=localhost
REDIS_PORT=6379
REDIS_PASSWORD=root

SQL Connection Example​

import { sql } from 'hysteria-orm';

await sql.connect(); // Uses env vars
// or
await sql.connect({
  type: 'postgres',
  host: 'localhost',
  username: 'root',
  password: 'root',
  database: 'test',
});

MongoDB Connection Example​

import { mongo } from 'hysteria-orm';

const mongoDataSource = await mongo.connect('mongodb://root:root@localhost:27017');

Redis Connection Example​

import { redis } from 'hysteria-orm';

await redis.connect({
  host: 'localhost',
  port: 6379,
  password: 'root',
});

Next: Environment