drizzle-orm 0.9.0 → 0.9.4

package/README.md

@@ -1,147 +0,0 @@
-# DrizzleORM
-
-**Drizzle ORM** 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-cli
-yarn add drizzle-orm drizzle-cli
-bower install drizzle-orm drizzle-cli
-```
-
-## Connecting to database
-
-```tsx
-import { DbConnector } from "drizzle-orm";
-
-// connect via postgresql connection url
-
-// I would do import drizzle from 'drizzle-orm'
-// const db = await drizzle.connect(string|configobj);
-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();
-```
-
-## Creating your first table and first migration
-
-```tsx
-class UsersTable extends AbstractTable<UsersTable> {
-  public id = this.int("id").primaryKey().autoIncrement();
-  public name = this.varchar("name", { size: 512 });
-  public email = this.varchar("email", { size: 512 }).unique();
-
-  public tableName(): string {
-    return "users";
-  }
-}
-
-// lets create your first SQL migration to create initial schema
-// > npx drizzle migrate
-
-const migrator = new Migrator(db);
-await migrator.runMigrations('./drizzle_orm/migrations')
-// That's it!! No metaprogramming, no black magic, everything's imperative
-```
-
-## Inserting into tables
-Returned entity is of type ExtractModel<UsersTable> which does have a set of typed fields
-
-```tsx
-const email = 'email@example.com'
-const name = 'Full Name'
-
-// returns inserted user
-const user = await table.insert({ email, name }).first()
-```
-
-## Simple querying with/without filters
-__For more complex filtering - see `advanced querying`__
-
-```tsx
-const email = 'email@example.com'
-
-const allUsers = await table.select().all()
-const firstUser = await table.select().first()
-
-const userWithEmail = await table.select(eq(table.email, email)).first()
-
-// If you need to declare type explicitely
-type User = ExtractModel<UsersTable>
-
-const user: User = await table.select().first()
-user.email
-user.id
-
-// Works perfectly!
-```
-
-## Joins
-
-```tsx
-class ItemsTable extends AbstractTable<ItemsTable>{
-  id = this.int("id").primaryKey().autoIncrement();
-  name = this.varchar("name");
-	
-  // many to one relation
-  ownerId = this.int("owner_id").foreignKey(UsersTable, (t) => t.id); 
-}
-
-const query = usersTable.select().leftJoin(
-	ItemsTable, 
-	(ut) => ut.id,     // user id
-	(it) => it.ownerId // item owner id
-); 
-
-const result = (await query.execute()).map((user, item) => {
-	return { user, item };
-});
-
-// result would be
-[{
-    user: { id: 10, ... },
-    item: { id: 1, ... }
-},
-{
-    user: { id: 10, ... },
-    item: { id: 2, ... }
-},
-{
-    user: { id: 10, ... },
-    item: { id: 3, ... }
-},
-{
-    user: { id: 11, ... },
-    item: { id: 4, ... }
-},
-{
-    user: { id: 11, ... },
-    item: { id: 5, ... }
-}]
-```

package/src/builders/aggregators/abstractAggregator.ts

@@ -1,37 +0,0 @@
-import { Column } from '../../columns/column';
-import ColumnType from '../../columns/types/columnType';
-import { ecranate } from '../../utils/ecranate';
-
-export default class Aggregator {
-  protected _fields: Array<string> = [];
-  protected _tableName: string;
-  protected _columnsTypes: Column<ColumnType>[];
-
-  public constructor(tableName: string) {
-    this._tableName = tableName;
-  }
-
-  public appendFields = (columns: Column<ColumnType>[]) => {
-    this._fields = this.generateSelectArray(this._tableName, columns);
-    this._columnsTypes = columns;
-  };
-
-  protected generateSelectArray = (table: string, columns: Column<ColumnType>[]) => {
-    const selectFields: string[] = [];
-
-    columns.forEach((field: any) => {
-      if (field instanceof Column) {
-        selectFields.push(' ');
-        selectFields.push(table);
-        selectFields.push('.');
-        selectFields.push(ecranate(field.columnName));
-        selectFields.push(' AS ');
-        selectFields.push(ecranate(`${table.replace('.', '_')}_${field.columnName}`));
-        selectFields.push(',');
-      }
-    });
-
-    selectFields.pop();
-    return selectFields;
-  };
-}

package/src/builders/aggregators/deleteAggregator.ts

@@ -1,34 +0,0 @@
-import Expr from '../requestBuilders/where/where';
-import Aggregator from './abstractAggregator';
-
-export default class DeleteAggregator extends Aggregator {
-  private _from: Array<string> = [];
-  private _filters: Array<string> = [];
-  private _delete: Array<string> = ['DELETE'];
-
-  public constructor(tableName: string) {
-    super(tableName);
-  }
-
-  public filters = (filters: Expr): DeleteAggregator => {
-    this._filters.push('WHERE ');
-    this._filters.push(filters.toQuery());
-    return this;
-  };
-
-  public appendFrom = (tableName: string): DeleteAggregator => {
-    this._from.push(' FROM ');
-    this._from.push(tableName);
-    return this;
-  };
-
-  public 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(''));
-
-    return this._delete.join('');
-  };
-}

package/src/builders/aggregators/insertAggregator.ts

@@ -1,116 +0,0 @@
-import { Column } from '../../columns/column';
-import ColumnType from '../../columns/types/columnType';
-import { Indexing } from '../../tables/inferTypes';
-import UpdateExpr from '../requestBuilders/updates/updates';
-import Aggregator from './abstractAggregator';
-
-export default class InsertAggregator extends Aggregator {
-  private _onConflict: Array<string> = [];
-  private _columns: Array<string> = [];
-  private _values: Array<string> = [];
-  private _from: Array<string> = [];
-  private _insert: Array<string> = ['INSERT INTO'];
-
-  public constructor(tableName: string) {
-    super(tableName);
-  }
-
-  public appendFrom = (tableName: string): InsertAggregator => {
-    this._from.push(' ');
-    this._from.push(tableName);
-    this._tableName = tableName;
-    return this;
-  };
-
-  // @TODO refactor!!
-  public appendColumns = <T>(values: Array<T>) => {
-    // @TODO Check if values not empty
-    const columns = Object.keys(values[0]);
-
-    for (let i = 0; i < columns.length; i += 1) {
-      const column = columns[i];
-
-      this._columns.push('"');
-      this._columns.push(column);
-      this._columns.push('"');
-
-      if (i < columns.length - 1) {
-        this._columns.push(', ');
-      }
-    }
-  };
-
-  // @TODO refactor!!
-  public appendValues = <T>(mapper: {[name in keyof T]: Column<ColumnType>},
-    values: {[name: string]: any}[]) => {
-    // @TODO Check if values not empty
-    for (let i = 0; i < values.length; i += 1) {
-      const value = values[i];
-      const insertValues = Object.values(value);
-      const insertKeys = Object.keys(value);
-
-      this._values.push('(');
-      for (let j = 0; j < insertValues.length; j += 1) {
-        const insertValue = insertValues[j];
-        const insertKey = insertKeys[j];
-
-        const columnKey = Object.keys(mapper)
-          .find((it) => mapper[it as keyof T].columnName === insertKey)!;
-        const column = mapper[columnKey as keyof T];
-        if (insertValue !== undefined && insertValue !== null) {
-          this._values.push(column.columnType.insertStrategy(insertValue));
-        } else {
-          this._values.push('null');
-        }
-
-        if (j < insertValues.length - 1) {
-          this._values.push(', ');
-        }
-      }
-      if (i < values.length - 1) {
-        this._values.push('),\n');
-      } else {
-        this._values.push(')\n');
-      }
-    }
-  };
-
-  public appendOnConflict = (column: Indexing,
-    updates?: UpdateExpr) => {
-    const indexName = column instanceof Column ? column.columnName : column.indexName();
-
-    this._onConflict.push(`ON CONFLICT ON CONSTRAINT ${indexName}\n`);
-    if (updates) {
-      this._onConflict.push('DO UPDATE\n');
-      this._onConflict.push(`SET ${updates.toQuery()}`);
-    } else {
-      this._onConflict.push('DO NOTHING\n');
-    }
-
-    return this;
-  };
-
-  public 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._values.join(''));
-    this._insert.push('\n');
-    this._insert.push('\n');
-    this._insert.push('RETURNING');
-    this._insert.push('\n');
-    this._insert.push(this._fields.join(''));
-    this._insert.push('\n');
-    this._insert.push(this._onConflict.join(''));
-    // this._insert.push("ON CONFLICT ON CONSTRAINT \"");
-    // this._insert.push(this._table.tableName());
-    // this._insert.push("_");
-    // this._insert.push(this._table);
-    // this._insert.push("\n");
-    // this._insert.push(this._fields.join(''));
-
-    return this._insert.join('');
-  };
-}

package/src/builders/aggregators/selectAggregator.ts

@@ -1,102 +0,0 @@
-import { Column } from '../../columns';
-import ColumnType from '../../columns/types/columnType';
-import Order from '../highLvlBuilders/order';
-import Join from '../joinBuilders/join';
-import Expr from '../requestBuilders/where/where';
-import Aggregator from './abstractAggregator';
-
-export default class SelectAggregator extends Aggregator {
-  private _from: Array<string> = [];
-  private _filters: Array<string> = [];
-  private _select: Array<string> = ['SELECT'];
-  private _join: Array<string> = [];
-  private _limit: Array<string> = [];
-  private _offset: Array<string> = [];
-  // private _groupBy: Array<string> = [];
-  private _orderBy: Array<string> = [];
-
-  public constructor(tableName: string) {
-    super(tableName);
-  }
-
-  public filters = (filters: Expr): SelectAggregator => {
-    this._filters.push('WHERE ');
-    this._filters.push(filters.toQuery());
-    return this;
-  };
-
-  public limit = (limit: number): SelectAggregator => {
-    this._limit.push('LIMIT ');
-    this._limit.push(limit.toString());
-    return this;
-  };
-
-  public offset = (limit: number): SelectAggregator => {
-    this._offset.push('OFFSET ');
-    this._offset.push(limit.toString());
-    return this;
-  };
-
-  public orderBy = (column: Column<ColumnType, boolean, boolean>, order: Order)
-  : SelectAggregator => {
-    this._orderBy.push('ORDER BY ');
-    this._orderBy.push(`${column.columnName} `);
-    this._orderBy.push(Order[order]);
-    return this;
-  };
-
-  public appendFrom = (tableName: string): SelectAggregator => {
-    this._from.push('FROM ');
-    this._from.push(tableName);
-    return this;
-  };
-
-  // Add select generator for second table also
-  public join = <COLUMN extends ColumnType>(joins: Array<Join<COLUMN,
-  {}>>): SelectAggregator => {
-    joins.forEach((join: Join<COLUMN, {}>) => {
-      const tableFrom = join.fromColumn.getParent();
-      const tableTo = join.toColumn.getParent();
-      const { type } = join;
-
-      const selectString = this.generateSelectArray(tableTo, Object.values(join.mappedServiceToDb)).join('');
-      this._fields.push(', ');
-      this._fields.push(selectString);
-      this._join.push('\n');
-      this._join.push(type);
-      this._join.push(' ');
-      this._join.push(tableTo);
-      this._join.push('\n');
-      this._join.push('ON ');
-      this._join.push(tableFrom);
-      this._join.push('.');
-      this._join.push(join.fromColumn.columnName);
-      this._join.push(' = ');
-      this._join.push(tableTo);
-      this._join.push('.');
-      this._join.push(join.toColumn.columnName);
-    });
-
-    return this;
-  };
-
-  public buildQuery = () => {
-    this._select.push(this._fields.join(''));
-    this._select.push('\n');
-    this._select.push(this._from.join(''));
-    this._select.push('\n');
-    this._select.push(this._join.join(''));
-    if (this._join.length > 0) {
-      this._select.push('\n');
-    }
-    this._select.push(this._filters.join(''));
-    this._select.push('\n');
-    this._select.push(this._orderBy.join(''));
-    this._select.push('\n');
-    this._select.push(this._limit.join(''));
-    this._select.push('\n');
-    this._select.push(this._offset.join(''));
-
-    return this._select.join('');
-  };
-}

package/src/builders/aggregators/updateAggregator.ts

@@ -1,45 +0,0 @@
-import UpdateExpr from '../requestBuilders/updates/updates';
-import Expr from '../requestBuilders/where/where';
-import Aggregator from './abstractAggregator';
-
-export default class UpdateAggregator extends Aggregator {
-  private _updates: Array<string> = [];
-  private _filters: Array<string> = [];
-  private _from: Array<string> = [];
-  private _update: Array<string> = ['UPDATE'];
-
-  public constructor(tableName: string) {
-    super(tableName);
-  }
-
-  public where = (filters: Expr): UpdateAggregator => {
-    this._filters.push('WHERE ');
-    this._filters.push(filters.toQuery());
-    return this;
-  };
-
-  public appendFrom = (tableName: string): UpdateAggregator => {
-    this._from.push(' ');
-    this._from.push(tableName);
-    return this;
-  };
-
-  public set = (updates: UpdateExpr): UpdateAggregator => {
-    this._updates.push(`\nSET ${updates.toQuery()}`);
-    return this;
-  };
-
-  public buildQuery = () => {
-    this._update.push(this._from.join(''));
-    this._update.push('\n');
-    this._update.push(this._updates.join(''));
-    this._update.push('\n');
-    this._update.push(this._filters.join(''));
-    this._update.push('\n');
-    this._update.push('RETURNING');
-    this._update.push('\n');
-    this._update.push(this._fields.join(''));
-
-    return this._update.join('');
-  };
-}

package/src/builders/highLvlBuilders/abstractRequestBuilder.ts

@@ -1,37 +0,0 @@
-import { Column } from '../../columns/column';
-import ColumnType from '../../columns/types/columnType';
-import Session from '../../db/session';
-import BaseLogger from '../../logger/abstractLogger';
-import { ExtractModel } from '../../tables/inferTypes';
-
-export default abstract class TableRequestBuilder<TTable> {
-  protected _tableName: string;
-  protected _session: Session;
-  protected _mappedServiceToDb: { [name in keyof ExtractModel<TTable>]: Column<ColumnType>; };
-  protected _columns: Column<ColumnType>[];
-  protected _logger: BaseLogger;
-
-  public constructor(tableName: string,
-    session: Session,
-    mappedServiceToDb: { [name in keyof ExtractModel<TTable>]: Column<ColumnType>; },
-    logger: BaseLogger) {
-    this._mappedServiceToDb = mappedServiceToDb;
-    this._tableName = tableName;
-    this._session = session;
-    this._columns = Object.values(mappedServiceToDb);
-    this._logger = logger;
-  }
-
-  public all = async (): Promise<ExtractModel<TTable>[]> => {
-    const res = await this._execute();
-    return res;
-  };
-
-  public first = async (): Promise<ExtractModel<TTable>> => {
-    const executionRes = await this._execute();
-    // TODO add checks for undefined or null
-    return executionRes[0];
-  };
-
-  protected abstract _execute(): Promise<Array<ExtractModel<TTable>>>;
-}

package/src/builders/highLvlBuilders/deleteRequestBuilder.ts

@@ -1,59 +0,0 @@
-import { Column } from '../../columns/column';
-import ColumnType from '../../columns/types/columnType';
-import Session from '../../db/session';
-import BuilderError, { BuilderType } from '../../errors/builderError';
-import { DatabaseDeleteError } from '../../errors/dbErrors';
-import BaseLogger from '../../logger/abstractLogger';
-import QueryResponseMapper from '../../mappers/responseMapper';
-import { ExtractModel } from '../../tables/inferTypes';
-import Delete from '../lowLvlBuilders/delets/delete';
-import Expr from '../requestBuilders/where/where';
-import TableRequestBuilder from './abstractRequestBuilder';
-
-export default class DeleteTRB<TTable> extends TableRequestBuilder<TTable> {
-  private _filter: Expr;
-
-  public constructor(
-    tableName: string,
-    session: Session,
-    mappedServiceToDb: { [name in keyof ExtractModel<TTable>]: Column<ColumnType>; },
-    logger: BaseLogger,
-  ) {
-    super(tableName, session, mappedServiceToDb, logger);
-  }
-
-  public where = (expr: Expr): DeleteTRB<TTable> => {
-    this._filter = expr;
-    return this;
-  };
-
-  public execute = async () => {
-    await this._execute();
-  };
-
-  protected _execute = async (): Promise<ExtractModel<TTable>[]> => {
-    const queryBuilder = Delete.from(this._tableName);
-    if (this._filter) {
-      queryBuilder.filteredBy(this._filter);
-    }
-
-    let query = '';
-    try {
-      query = queryBuilder.build();
-    } catch (e) {
-      throw new BuilderError(BuilderType.DELETE, this._tableName, this._columns, e, this._filter);
-    }
-
-    if (this._logger) {
-      this._logger.info(`Deleting from ${this._tableName} using query:\n ${query}`);
-    }
-
-    const result = await this._session.execute(query);
-    if (result.isLeft()) {
-      const { reason } = result.value;
-      throw new DatabaseDeleteError(this._tableName, reason, query);
-    } else {
-      return QueryResponseMapper.map(this._mappedServiceToDb, result.value);
-    }
-  };
-}

package/src/builders/highLvlBuilders/insertRequestBuilder.ts

@@ -1,87 +0,0 @@
-import { Column } from '../../columns/column';
-import ColumnType from '../../columns/types/columnType';
-import Session from '../../db/session';
-import BuilderError, { BuilderType } from '../../errors/builderError';
-import { DatabaseInsertError } from '../../errors/dbErrors';
-import BaseLogger from '../../logger/abstractLogger';
-import QueryResponseMapper from '../../mappers/responseMapper';
-import { AbstractTable } from '../../tables';
-import { ExtractModel, Indexing } from '../../tables/inferTypes';
-import Insert from '../lowLvlBuilders/inserts/insert';
-import UpdateExpr from '../requestBuilders/updates/updates';
-import TableRequestBuilder from './abstractRequestBuilder';
-
-export default class InsertTRB<TTable> extends TableRequestBuilder<TTable> {
-  private _values: ExtractModel<TTable>[];
-  private _onConflict: UpdateExpr;
-  private _onConflictField: Indexing;
-  private _table: TTable;
-
-  public constructor(
-    values: ExtractModel<TTable>[],
-    tableName: string,
-    session: Session,
-    mappedServiceToDb: { [name in keyof ExtractModel<TTable>]: Column<ColumnType>; },
-    logger: BaseLogger,
-    table: AbstractTable<TTable>,
-  ) {
-    super(tableName, session, mappedServiceToDb, logger);
-    this._values = values;
-    this._table = table as unknown as TTable;
-  }
-
-  public execute = async () => {
-    await this._execute();
-  };
-
-  public onConflict = (
-    callback: (table: TTable) => Indexing,
-    expr: UpdateExpr,
-  ): InsertTRB<TTable> => {
-    this._onConflictField = callback(this._table);
-    this._onConflict = expr;
-    return this;
-  };
-
-  protected _execute = async (): Promise<ExtractModel<TTable>[]> => {
-    const queryBuilder = Insert.into(this._tableName, this._columns);
-    if (!this._values) throw Error('Values should be provided firestly\nExample: table.values().execute()');
-
-    const mappedRows: {[name: string]: any}[] = [];
-    const mapper = this._mappedServiceToDb;
-
-    this._values.forEach((valueToInsert) => {
-      const mappedValue: {[name: string]: any} = {};
-      Object.entries(valueToInsert).forEach(([key, value]) => {
-        const column = mapper[key as keyof ExtractModel<TTable>];
-        mappedValue[column.columnName] = value;
-      });
-      mappedRows.push(mappedValue);
-    });
-
-    const valuesQueryBiulder = queryBuilder.values(mappedRows, mapper);
-    if (this._onConflict) {
-      valuesQueryBiulder.onConflict(this._onConflict, this._onConflictField);
-    }
-
-    // @TODO refactor values() part!!
-    let query = '';
-    try {
-      query = queryBuilder.build();
-    } catch (e) {
-      throw new BuilderError(BuilderType.INSERT, this._tableName, this._columns, e);
-    }
-
-    if (this._logger) {
-      this._logger.info(`Inserting to ${this._tableName} using query:\n ${query}`);
-    }
-
-    const result = await this._session.execute(query);
-    if (result.isLeft()) {
-      const { reason } = result.value;
-      throw new DatabaseInsertError(this._tableName, reason, query);
-    } else {
-      return QueryResponseMapper.map(this._mappedServiceToDb, result.value);
-    }
-  };
-}

package/src/builders/highLvlBuilders/order.ts

@@ -1,4 +0,0 @@
-enum Order {
-  ASC,
-  DESC,
-} export default Order;