Getting Started

This guide will help you set up an5 in your project in under 5 minutes for Typescript with Nbase.

For the current implementation and package maturity overview, see Feature Status.

Prerequisites

  • Node.js 18+ (Node 24 recommended for schema compiler and CLI)
  • TypeScript 5.0+ and npm / pnpm / yarn

  • Connection to Nbase (or local embedded setup)

Installation

npm install @an5/adapters @an5/orm
  • @an5/adapters: Database runtime, connection handling, dynamic table clients, transactions.
  • @an5/orm: Schema parser, multi-language generator, migrations (db:push, db:pull, db:migrate, db:seed).

Configuration

1. Set up Environment Variables

Edit .env and configure your database connection string:


DATABASE_URL=nbase://localhost:1307

2. Define Your Schema

Create .an5 files in the an5Schema/ directory:

// an5Schema/User.an5
model User {
  id        NVARCHAR(1000) @id @default(uuid())
  email     NVARCHAR(255)  @unique
  name      NVARCHAR(255)?
  createdAt DATETIME2      @default(now())
  
  @@map("users")
}

3. Generate Client Code

Run from the an5Orm/ repository directory:

npm run generate

This generates type-safe client code in an5Client/typescript/.

4. Push Schema to Database

npm run db:push

This creates the tables in your database.

Your First Query

import { createAn5Adapter } from '@an5/adapters';

// Initialize connection
const db = createAn5Adapter({
  connectionString: process.env.DATABASE_URL!,
});

async function main() {
  await db.$connect();

  // Create a user
  const user = await db.user.create({
    data: {
      email: 'john@example.com',
      name: 'John Doe'
    }
  });
  
  console.log('Created user:', user);
  
  // Find all users
  const users = await db.user.findMany();
  console.log('All users:', users);
}

main()
  .catch(console.error)
  .finally(() => db.$disconnect());

Project Structure

an5/
├── an5Schema/           # Schema definitions (.an5 files)
├── an5Client/           # Generated client code for all target languages
│   ├── typescript/
│   ├── python/
│   ├── dotnet/
│   ├── golang/
│   ├── rust/
│   ├── java/
│   ├── kotlin/
│   └── swift/
├── an5Orm.config.js     # ORM configuration & database mapping
└── .env                 # Environment variables & connection strings

Available Commands

Schema/database commands run from the an5Orm/ repository directory:

Command Where Description
npm run generate an5Orm/ Generate client code from schema
npm run db:push an5Orm/ Push schema to database
npm run db:pull an5Orm/ Pull schema from database
npm run db:seed an5Orm/ Seed database with sample data
npm run db:migrate diff an5Orm/ Compare schema with database
npm run db:migrate:generate an5Orm/ Generate migration SQL
npm run db:migrate:apply an5Orm/ Apply pending migration files
npm run db:migrate:rollback an5Orm/ Roll back migrations
npm run db:migrate:status an5Orm/ Show migration status

Next Steps