JSPM – nukak-postgres@0.1.12

Package Exports

nukak-postgres
nukak-postgres/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (nukak-postgres) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

code

Powerful ORM for TypeScript and modern JavaScript ideated to be fast, safe, and simple to plug into any application. Inspired by other ORMs such as TypeORM and Mongo driver.

Features

Serializable queries: the syntax is valid JSON allowing the queries to be transported across platforms with ease, squeezing the strengths of TypeScript & modern JavaScript.
Type-safe queries: TypeScript auto-completes and validates the queries while coding.
Context-aware queries: TypeScript infers the appropriate operators on any level of the query, including relations and their fields.
High performance: the generated queries are fast, safe, and human-readable.
Combines the best elements of OOP (Object Oriented Programming) and FP (Functional Programming).
Declarative and imperative transactions for flexibility, and connection pooling for scalability.
Modern Pure ESM packages. ESM is natively supported by Node.js 12 and later.
soft-delete, virtual fields, repositories.
Supports the Data Mapper pattern for maintainability.
Transparent support for inheritance between entities.
Unified syntax across Databases: providing a standard API and transparently transforming queries according to the configured database.

Install

Install the core package:
```
npm install nukak --save
```
Install one of the specific adapters for your database:

Database	Driver	Nukak Adapter
`MySQL`	`mysql2`	`nukak-mysql`
`MariaDB`	`mariadb`	`nukak-maria`
`SQLite`	`sqlite sqlite3`	`nukak-sqlite`
`PostgreSQL`	`pg`	`nukak-postgres`
`MongoDB`	`mongodb`	`nukak-mongo`

For example, for Postgres:

npm install pg nukak-postgres --save

Additionally, your tsconfig.json may need the following flags:

"target": "es2020",
"experimentalDecorators": true,
"emitDecoratorMetadata": true

Configure

A default querier-pool can be set in any of the bootstrap files of your app (e.g. in the server.ts).

import { setQuerierPool } from 'nukak';
import { PgQuerierPool } from 'nukak-postgres';

export const querierPool = new PgQuerierPool(
  {
    host: 'localhost',
    user: 'theUser',
    password: 'thePassword',
    database: 'theDatabase',
  },
  // optionally, a logger can be passed to log the generated SQL queries
  { logger: console.log }
);

// the default querier pool that `nukak` will use
setQuerierPool(querierPool);

Define the entities

Take any dump class (aka DTO) and annotate it with the decorators from nukak/entity.

import { v4 as uuidv4 } from 'uuid';
import { Id, Field, Entity } from 'nukak/entity';

@Entity()
export class User {
  @Id({ onInsert: uuidv4 })
  id?: string;

  @Field()
  name?: string;

  @Field()
  email?: string;

  @Field()
  password?: string;
}

Manipulate the data

import { getQuerier } from 'nukak';
import { User } from './shared/models/index.js';

async function findLastUsers(limit = 10) {
  const querier = await getQuerier();
  const users = await querier.findMany(User, {
    $project: ['id', 'name', 'email'],
    $sort: { createdAt: -1 },
    $limit: limit,
  });
  await querier.release();
  return users;
}

async function createUser(body: User) {
  const querier = await getQuerier();
  const id = await querier.insertOne(User, body);
  await querier.release();
  return id;
}

Learn more about nukak at its website https://nukak.org