drizzle-orm 0.10.26 → 0.10.27

package/README.md

@@ -0,0 +1,439 @@
+# DrizzleORM
+
+**DrizzleORM** is an ORM framework for 
+[TypeScript](https://www.typescriptlang.org/).
+It offers you several levels of Database communication:
+* Typesafe Table View approach 
+* Typesafe Query Builder
+* Simple SQL query execution
+
+Drizzle ORM is highly influenced by [Exposed](https://github.com/JetBrains/Exposed) and Jetbrains development methodology
+
+## Supported Databases
+
+* PostgreSQL
+
+## Links
+
+In Progress
+
+## Installing
+
+```bash
+npm install drizzle-orm drizzle-kit
+```
+#### **In Progress**
+```bash
+yarn add drizzle-orm drizzle-kit
+bower install drizzle-orm drizzle-kit
+```
+
+## Connecting to database
+
+```tsx
+import { DbConnector } from "drizzle-orm";
+
+// connect via postgresql connection url
+const db = await new DbConnector()
+	.connectionString("postgres://user:password@host:port/db")
+	.connect();
+
+// or by params
+const db = await new DbConnector()
+	.params({
+		host: '0.0.0.0',
+		port: 5432,
+		user: 'user',
+		password: 'password',
+		db: 'optional_db_name'
+	}).connect();
+```
+## Project structure
+- tables folder
+- migrations folder
+
+## Create tables
+### Users Table
+---
+```typescript
+
+export const rolesEnum = createEnum({ alias: 'test-enum', values: ['user', 'guest', 'admin'] });
+
+export default class UsersTable extends AbstractTable<UsersTable> {
+  public id = this.serial('id').primaryKey();
+  public fullName = this.text('full_name');
+
+  public phone = this.varchar('phone', { size: 256 });
+  public media = this.jsonb<string[]>('media');
+  public decimalField = this.decimal('test', { precision: 100, scale: 2 }).notNull();
+  public bigIntField = this.bigint('test1', 'max_bytes_53');
+  public role = this.type(rolesEnum, 'name_in_table').notNull();
+
+  public createdAt = this.timestamp('created_at').notNull();
+
+  public createdAtWithTimezone = this.timestamptz('created_at_time_zone');
+
+  public updatedAt = this.timestamp('updated_at').defaultValue(Defaults.CURRENT_TIMESTAMP);
+  public isArchived = this.bool('is_archived').defaultValue(false);
+
+  public phoneFullNameIndex = this.index([this.phone, this.fullName]);
+  public phoneIndex = this.uniqueIndex(this.phone);
+
+  public tableName(): string {
+    return 'users';
+  }
+}
+```
+### Cities Table
+---
+```typescript
+interface CityMeta {
+  population: number,
+  connection: string,
+}
+
+export default class CitiesTable extends AbstractTable<CitiesTable> {
+  public id = this.serial('id').primaryKey();
+
+  public foundationDate = this.timestamp('name').notNull();
+  public location = this.varchar('page', { size: 256 });
+
+  public userId = this.int('user_id').foreignKey(UsersTable, (table) => table.id, { onUpdate: 'CASCADE' });
+
+  public metadata = this.jsonb<CityMeta>('metadata');
+
+  public tableName(): string {
+    return 'cities';
+  }
+}
+```
+### User Groups Table
+---
+```typescript
+export default class UserGroupsTable extends AbstractTable<UserGroupsTable> {
+  public id = this.serial('id').primaryKey();
+
+  public name = this.varchar('name');
+  public description = this.varchar('description');
+
+  public tableName(): string {
+    return 'user_groups';
+  }
+}
+```
+### User to User Groups Table
+---
+#### Many to many connection between Users and User Groups
+```typescript
+export default class UsersToUserGroupsTable extends AbstractTable<UsersToUserGroupsTable> {
+  public groupId = this.int('city_id').foreignKey(UserGroupsTable, (table) => table.id, { onDelete: 'CASCADE' });
+  public userId = this.int('user_id').foreignKey(UsersTable, (table) => table.id, { onDelete: 'CASCADE' });
+
+  public manyToManyIndex = this.index([this.groupId, this.userId]);
+
+  public tableName(): string {
+    return 'users_to_user_groups';
+  }
+}
+```
+
+## CRUD
+### **SELECT**
+---
+```typescript
+const db = await new DbConnector()
+  .connectionString('postgresql://postgres@127.0.0.1/drizzle')
+  .connect();
+
+const usersTable = new UsersTable(db);
+
+// select all
+const allSelect = await usersTable.select().all();
+
+// select first
+const firstSelect = await usersTable.select().findOne();
+```
+#### **Sorting and Filtering**
+---
+##### Select all records from `Users` where phone is `"hello"`
+```typescript
+const eqSelect = await usersTable.select().where(
+  eq(usersTable.phone, 'hello')
+).all();
+```
+##### Select all records from `Users` where **both** phone is `"hello"` **and** phone is `"hello"`
+```typescript
+const andSelect = await usersTable.select().where(
+  and([
+    eq(usersTable.phone, 'hello'),
+    eq(usersTable.phone, 'hello')
+  ]),
+).all();
+```
+##### Select all records from `Users` where **either** phone is `"hello"` **or** phone is `"hello"`
+```typescript
+const orSelect = await usersTable.select().where(
+  or([eq(usersTable.phone, 'hello')]),
+).all();
+```
+##### Select all records from `Users` using **LIMIT** and **OFFSET**
+```typescript
+const limitOffsetSelect = await usersTable.select().limit(10).offset(10).all();
+```
+##### Select all records from `Users` where `phone` contains `"hello"`
+```typescript
+const likeSelect = await usersTable.select().where(
+  like(usersTable.phone, '%hello%')
+).all();
+```
+##### Select all records from `Users` where `phone` equals to some of values from array
+```typescript
+const inArraySelect = usersTable.select().where(
+  inArray(usersTable.phone, ['hello'])
+).all();
+```
+##### Select all records from `Users` where `phone` greater(**>**) than `"hello"`
+```typescript
+const greaterSelect = usersTable.select().where(
+  greater(usersTable.phone, 'hello')
+).all();
+```
+##### Select all records from `Users` where `phone` less(**<**) than `"hello"`
+```typescript
+const lessSelect = usersTable.select().where(
+  less(usersTable.phone, 'hello')
+).all();
+```
+##### Select all records from `Users` where `phone` greater or equals(**>=**) than `"hello"`
+```typescript
+const greaterEqSelect = usersTable.select().where(
+  greaterEq(usersTable.phone, 'hello')
+).all();
+```
+##### Select all records from `Users` where `phone` less or equals(**<=**) 
+```typescript
+const lessEqSelect = usersTable.select().where(
+  lessEq(usersTable.phone, 'hello')
+).all();
+```
+##### Select all records from `Users` where `phone` is **NULL**
+```typescript
+const isNullSelect = usersTable.select().where(
+  isNull(usersTable.phone)
+).all();
+```
+##### Select all records from `Users` where `phone` not equals to `"hello"`
+```typescript
+const notEqSelect = usersTable.select().where(
+  notEq(usersTable.phone, 'hello')
+).all();
+```
+##### Select all records from `Users` ordered by `phone` in ascending order
+```typescript
+const ordered = await usersTable.select().orderBy((table) => table.phone, Order.ASC).all();
+```
+#### **Partial Selecting**
+ ```typescript
+    const partialSelect = await usersTable.select({
+      mappedId: usersTable.id,
+      mappedPhone: usersTable.phone,
+    }).all();
+
+    // Usage
+    const { mappedId, mappedPhone } = partialSelect;
+ ```
+
+
+### **Update**
+---
+##### Update `fullName` to `newName` in `Users` where phone is `"hello"`
+```typescript
+await usersTable.update()
+  .where(eq(usersTable.phone, 'hello'))
+  .set({ fullName: 'newName' })
+  .execute();
+```
+##### Update `fullName` to `newName` in `Users` where phone is `"hello"` returning updated `User` model
+```typescript
+await usersTable.update()
+  .where(eq(usersTable.phone, 'hello'))
+  .set({ fullName: 'newName' })
+  .all();
+```
+##### Update `fullName` to `newName` in `Users` where phone is `"hello"` returning updated `User` model
+```typescript
+await usersTable.update()
+  .where(eq(usersTable.phone, 'hello'))
+  .set({ fullName: 'newName' })
+  .findOne();
+```
+
+### **Delete**
+##### Delete `user` where phone is `"hello"`
+```typescript
+await usersTable.delete()
+      .where(eq(usersTable.phone, 'hello'))
+      .execute();
+```
+##### Delete `user` where phone is `"hello"` returning updated `User` model
+```typescript
+await usersTable.delete()
+      .where(eq(usersTable.phone, 'hello'))
+      .all();
+```
+##### Delete `user` where phone is `"hello"` returning updated `User` model
+```typescript
+await usersTable.delete()
+      .where(eq(usersTable.phone, 'hello'))
+      .findOne();
+```
+
+### **Insert**
+##### Insert `user` with required fields
+```typescript
+await usersTable.insert({
+  test: 1,
+  createdAt: new Date(),
+}).execute();
+```
+##### Insert `user` with required fields and get all rows as array
+```typescript
+const user = await usersTable.insert({
+  test: 1,
+  createdAt: new Date(),
+}).all();
+```
+##### Insert `user` with required fields and get inserted entity
+```typescript
+const user = await usersTable.insert({
+  test: 1,
+  createdAt: new Date(),
+}).findOne();
+```
+##### Insert many `users` with required fields and get all inserted entities
+```typescript
+const users = await usersTable.insertMany([{
+      test: 1,
+      createdAt: new Date(),
+    }, {
+      test: 2,
+      createdAt: new Date(),
+    }]).all();
+```
+##### Insert many `users` with required fields and get all inserted entities. If such user already exists - update `phone` field
+```typescript
+await usersTable.insertMany([{
+      test: 1,
+      createdAt: new Date(),
+    }, {
+      test: 2,
+      createdAt: new Date(),
+    }])
+      .onConflict(
+        (table) => table.phoneIndex,
+        { phone: 'confilctUpdate' },
+      ).all();
+```
+
+## Joins
+### Join One-To-Many Tables
+##### Join Cities with Users and map to city object with full user
+```typescript
+const usersTable = new UsersTable(db);
+const citiesTable = new CitiesTable(db);
+
+ const userWithCities = await citiesTable.select()
+      .where(eq(citiesTable.id, 1))
+      .leftJoin(UsersTable,
+        (city) => city.userId,
+        (users) => users.id)
+      .execute();
+
+const citiesWithUserObject = userWithCities.map((city, user) => ({ ...city, user }));
+```
+
+### Join Many-To-Many Tables
+##### Join User Groups with Users, using many-to-many table and map response to get user object with groups array
+```typescript
+    const usersWithUserGroups = await usersToUserGroupsTable.select()
+      .where(eq(userGroupsTable.id, 1))
+      .leftJoin(UsersTable,
+        (userToGroup) => userToGroup.userId,
+        (users) => users.id)
+      .leftJoin(UsersToUserGroupsTable, UserGroupsTable,
+        (userToGroup) => userToGroup.groupId,
+        (users) => users.id)
+      .execute();
+
+    const userGroupWithUsers = usersWithUserGroups.group({
+      one: (_, dbUser, dbUserGroup) => dbUser!,
+      many: (_, dbUser, dbUserGroup) => dbUserGroup!,
+    });
+
+    const userWithGroups: ExtractModel<UsersTable> & { groups: ExtractModel<UserGroupsTable>[] } = {
+      ...userGroupWithUsers.one,
+      groups: userGroupWithUsers.many,
+    };
+```
+##### Join User Groups with Users, using many-to-many table and map response to get user group object with users array
+```typescript
+    const usersWithUserGroups = await usersToUserGroupsTable.select()
+      .where(eq(userGroupsTable.id, 1))
+      .leftJoin(UsersTable,
+        (userToGroup) => userToGroup.userId,
+        (users) => users.id)
+      .leftJoin(UsersToUserGroupsTable, UserGroupsTable,
+        (userToGroup) => userToGroup.groupId,
+        (users) => users.id)
+      .execute();
+
+    const userGroupWithUsers = usersWithUserGroups.group({
+      one: (_, dbUser, dbUserGroup) => dbUserGroup!,
+      many: (_, dbUser, dbUserGroup) => dbUser!,
+    });
+
+    const userWithGroups: ExtractModel<UserGroupsTable> & { users: ExtractModel<UsersTable>[] } = {
+      ...userGroupWithUsers.one,
+      users: userGroupWithUsers.many,
+    };
+```
+### Join using partial field select
+##### Join Cities with Users getting only needed fields form request
+```typescript
+await citiesTable.select({
+      id: citiesTable.id,
+      userId: citiesTable.userId,
+    })
+    .where(eq(citiesTable.id, 1))
+    .leftJoin(UsersTable,
+        (city) => city.userId,
+        (users) => users.id,
+        {
+          id: usersTable.id,
+        })
+    .execute();
+
+const citiesWithUserObject = userWithCities.map((city, user) => ({ ...city, user }));
+```
+
+
+## Migrations
+#### To run migrations generated by drizzle-kit you could use `Migrator` class
+##### Provide drizzle-kit config path
+```typescript
+await drizzle.migrator(db).migrate('src/drizzle.config.yaml');
+```
+##### Another possibility is to provide object with path to folder with migrations
+```typescript
+await drizzle.migrator(db).migrate({ migrationFolder: 'drizzle' });
+```
+
+
+## Raw query usage
+#### If you have some complex queries to execute and drizzle-orm can't handle them yet, then you could use `rawQuery` execution
+
+
+##### Execute custom raw query
+```typescript
+const res: QueryResult<any> = await db.session().execute('SELECT * FROM users WHERE user.id = $1', [1]);
+```

package/dist/builders/aggregators/abstractAggregator.d.ts

@@ -0,0 +1,11 @@
+import { AbstractColumn } from '../../columns/column';
+import ColumnType from '../../columns/types/columnType';
+import { AbstractTable } from '../../tables';
+export default class Aggregator {
+    protected _fields: Array<string>;
+    protected _table: AbstractTable<any>;
+    constructor(table: AbstractTable<any>, partial?: {
+        [name: string]: AbstractColumn<ColumnType<any>, boolean, boolean, AbstractTable<any>>;
+    });
+    protected generateSelectArray: (table: string, columns: AbstractColumn<ColumnType>[], id?: number | undefined) => string[];
+}

package/dist/builders/aggregators/abstractAggregator.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable max-len */
+const column_1 = require("../../columns/column");
+const ecranate_1 = require("../../utils/ecranate");
+// eslint-disable-next-line max-len
+class Aggregator {
+    constructor(table, partial) {
+        this._fields = [];
+        this.generateSelectArray = (table, columns, id) => {
+            const selectFields = [];
+            columns.forEach((field) => {
+                if (field instanceof column_1.Column) {
+                    selectFields.push(' ');
+                    selectFields.push(table);
+                    selectFields.push('.');
+                    selectFields.push(ecranate_1.ecranate(field.getColumnName()));
+                    selectFields.push(' AS ');
+                    selectFields.push(ecranate_1.ecranate(`${field.getAlias()}${id ? `_${id}` : ''}`));
+                    selectFields.push(',');
+                }
+            });
+            selectFields.pop();
+            return selectFields;
+        };
+        this._table = table;
+        if (!partial) {
+            this._fields = this.generateSelectArray(this._table.tableName(), Object.values(this._table.mapServiceToDb()));
+        }
+        else {
+            this._fields = this.generateSelectArray(this._table.tableName(), Object.values(partial));
+        }
+    }
+}
+exports.default = Aggregator;

package/dist/builders/aggregators/deleteAggregator.d.ts

@@ -0,0 +1,16 @@
+import { AbstractTable } from '../../tables';
+import Expr from '../requestBuilders/where/where';
+import Aggregator from './abstractAggregator';
+export default class DeleteAggregator extends Aggregator {
+    private _from;
+    private _filters;
+    private _values;
+    private _delete;
+    constructor(table: AbstractTable<any>);
+    filters: (filters: Expr) => DeleteAggregator;
+    appendFrom: (tableName: string) => DeleteAggregator;
+    buildQuery: () => {
+        query: string;
+        values: Array<any>;
+    };
+}

package/dist/builders/aggregators/deleteAggregator.js

@@ -0,0 +1,42 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const abstractAggregator_1 = __importDefault(require("./abstractAggregator"));
+class DeleteAggregator extends abstractAggregator_1.default {
+    constructor(table) {
+        super(table);
+        this._from = [];
+        this._filters = [];
+        this._values = [];
+        this._delete = ['DELETE'];
+        this.filters = (filters) => {
+            if (filters) {
+                const filterQuery = filters.toQuery();
+                this._filters.push('WHERE ');
+                this._filters.push(filterQuery.query);
+                this._values = filterQuery.values;
+            }
+            return this;
+        };
+        this.appendFrom = (tableName) => {
+            this._from.push(' FROM ');
+            this._from.push(tableName);
+            return this;
+        };
+        this.buildQuery = () => {
+            // this._delete.push(this._fields.join(''));
+            this._delete.push('\n');
+            this._delete.push(this._from.join(''));
+            this._delete.push('\n');
+            this._delete.push(this._filters.join(''));
+            this._delete.push('\n');
+            this._delete.push('RETURNING');
+            this._delete.push('\n');
+            this._delete.push(this._fields.join(''));
+            return { query: this._delete.join(''), values: this._values };
+        };
+    }
+}
+exports.default = DeleteAggregator;

package/dist/builders/aggregators/insertAggregator.d.ts

@@ -0,0 +1,22 @@
+import { AbstractTable } from '../../tables';
+import { Indexing } from '../../tables/inferTypes';
+import { UpdateExpr } from '../requestBuilders/updates/updates';
+import Aggregator from './abstractAggregator';
+export default class InsertAggregator extends Aggregator {
+    private _onConflict;
+    private _columns;
+    private _query;
+    private _values;
+    private _from;
+    private _insert;
+    constructor(table: AbstractTable<any>);
+    appendColumns: () => void;
+    appendValues: (values: {
+        [name: string]: any;
+    }[]) => void;
+    appendOnConflict: (column: Indexing, updates?: UpdateExpr | undefined) => this;
+    buildQuery: () => {
+        query: string;
+        values: Array<any>;
+    };
+}

package/dist/builders/aggregators/insertAggregator.js

@@ -0,0 +1,106 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/no-loop-func */
+const column_1 = require("../../columns/column");
+const abstractAggregator_1 = __importDefault(require("./abstractAggregator"));
+class InsertAggregator extends abstractAggregator_1.default {
+    constructor(table) {
+        super(table);
+        this._onConflict = [];
+        this._columns = [];
+        this._query = [];
+        this._values = [];
+        this._from = [];
+        this._insert = ['INSERT INTO'];
+        this.appendColumns = () => {
+            const mapper = this._table.mapServiceToDb();
+            const columns = Object.values(mapper);
+            for (let i = 0; i < columns.length; i += 1) {
+                const column = columns[i];
+                this._columns.push('"');
+                this._columns.push(column.getColumnName());
+                this._columns.push('"');
+                if (i < columns.length - 1) {
+                    this._columns.push(', ');
+                }
+            }
+        };
+        this.appendValues = (values) => {
+            // @TODO Check if values not empty
+            const mapper = this._table.mapServiceToDb();
+            let position = 0;
+            for (let i = 0; i < values.length; i += 1) {
+                const value = values[i];
+                this._query.push('(');
+                const entries = Object.entries(mapper);
+                entries.forEach(([key], index) => {
+                    const valueToInsert = value[key];
+                    const isKeyExistsInValue = key.toString() in value;
+                    const column = mapper[key];
+                    if (isKeyExistsInValue) {
+                        if (valueToInsert !== undefined && valueToInsert !== null) {
+                            position += 1;
+                            this._query.push(`$${position}`);
+                            this._values.push(column.getColumnType().insertStrategy(valueToInsert));
+                        }
+                        else {
+                            this._query.push('null');
+                        }
+                    }
+                    else {
+                        this._query.push('DEFAULT');
+                    }
+                    if (index < entries.length - 1) {
+                        this._query.push(', ');
+                    }
+                });
+                if (i < values.length - 1) {
+                    this._query.push('),\n');
+                }
+                else {
+                    this._query.push(')\n');
+                }
+            }
+        };
+        this.appendOnConflict = (column, updates) => {
+            if (column) {
+                const indexName = column instanceof column_1.IndexedColumn
+                    ? column.getColumnName() : column.getColumns().map((it) => it.getColumnName()).join(',');
+                this._onConflict.push(`ON CONFLICT (${indexName})\n`);
+                if (updates) {
+                    const currentPointerPosition = this._values.length > 0
+                        ? this._values.length + 1 : undefined;
+                    const updatesQuery = updates.toQuery(currentPointerPosition);
+                    this._onConflict.push('DO UPDATE\n');
+                    this._onConflict.push(`SET ${updatesQuery.query}`);
+                    this._values.push(...updatesQuery.values);
+                }
+                else {
+                    this._onConflict.push('DO NOTHING\n');
+                }
+            }
+            return this;
+        };
+        this.buildQuery = () => {
+            this._insert.push(this._from.join(''));
+            this._insert.push(' (');
+            this._insert.push(this._columns.join(''));
+            this._insert.push(') ');
+            this._insert.push('VALUES\n');
+            this._insert.push(this._query.join(''));
+            this._insert.push('\n');
+            this._insert.push(this._onConflict.join(''));
+            this._insert.push('\n');
+            this._insert.push('RETURNING');
+            this._insert.push('\n');
+            this._insert.push(this._fields.join(''));
+            return { query: this._insert.join(''), values: this._values };
+        };
+        this._from.push(' ');
+        this._from.push(table.tableName());
+    }
+}
+exports.default = InsertAggregator;