@spinajs/orm 1.2.77 → 1.2.83

package/lib/builders.d.ts

@@ -1,11 +1,12 @@
-import { Container, Constructor } from '@spinajs/di';
-import { QueryMethod, SORT_ORDER, WhereBoolean, WhereOperators } from './enums';
+import { Container, Constructor, IContainer } from '@spinajs/di';
+import { ColumnType, QueryMethod, SORT_ORDER, WhereBoolean, SqlOperator } from './enums';
 import { IColumnsBuilder, ICompilerOutput, ILimitBuilder, IOrderByBuilder, IQueryBuilder, IQueryLimit, ISort, IWhereBuilder, QueryContext, IJoinBuilder, IBuilderMiddleware, IWithRecursiveBuilder, ReferentialAction, IGroupByBuilder } from './interfaces';
 import { ColumnStatement, IQueryStatement, WrapStatement } from './statements';
 import { WhereFunction } from './types';
 import { OrmDriver } from './driver';
 import { ModelBase } from './model';
 import { OrmRelation, IOrmRelation } from './relations';
+import { ColumnAlterationType, IUpdateResult } from '.';
 /**
  *  Trick typescript by using the inbuilt interface inheritance and declaration merging
  *  for builder classes.
@@ -21,21 +22,24 @@ export interface UpdateQueryBuilder extends IColumnsBuilder, IWhereBuilder {
 }
 export interface SelectQueryBuilder extends IColumnsBuilder, IOrderByBuilder, ILimitBuilder, IWhereBuilder, IJoinBuilder, IWithRecursiveBuilder, IGroupByBuilder {
 }
-export declare class Builder<T = any> {
+export declare class Builder<T = any> implements PromiseLike<T> {
     protected _driver: OrmDriver;
-    protected _container: Container;
+    protected _container: IContainer;
     protected _model?: Constructor<ModelBase>;
     protected _nonSelect: boolean;
-    protected _queryContext: QueryContext;
-    protected _middlewares: IBuilderMiddleware[];
+    protected _middlewares: IBuilderMiddleware<T>[];
     protected _asRaw: boolean;
-    constructor(container: Container, driver: OrmDriver, model?: Constructor<ModelBase>);
-    middleware(middleware: IBuilderMiddleware): this;
+    QueryContext: QueryContext;
+    get Driver(): OrmDriver;
+    get Container(): IContainer;
+    get Model(): Constructor<ModelBase> | undefined;
+    constructor(container: IContainer, driver: OrmDriver, model?: Constructor<ModelBase>);
+    then<TResult1 = T, TResult2 = never>(onfulfilled?: (value: T) => TResult1 | PromiseLike<TResult1>, onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2>): PromiseLike<TResult1 | TResult2>;
+    middleware(middleware: IBuilderMiddleware<T>): this;
     /**
      * Builds query that is ready to use in DB
      */
-    toDB(): ICompilerOutput;
-    then(resolve: (rows: any[]) => void, reject: (err: Error) => void): Promise<T>;
+    toDB(): ICompilerOutput | ICompilerOutput[];
 }
 /**
  * Base class for queires. Implements basic query functionality
@@ -45,8 +49,8 @@ export declare class QueryBuilder<T = any> extends Builder<T> implements IQueryB
     protected _method: QueryMethod;
     protected _table: string;
     protected _tableAlias: string;
-    protected _schema: string;
-    constructor(container: Container, driver: OrmDriver, model?: Constructor<ModelBase>);
+    protected _database: string;
+    constructor(container: IContainer, driver: OrmDriver, model?: Constructor<ModelBase>);
     /**
      * SQL table name that query is executed on
      *
@@ -64,13 +68,13 @@ export declare class QueryBuilder<T = any> extends Builder<T> implements IQueryB
      * @example
      * SELECT * FROM `spinejs`.`users` as u
      */
-    get Schema(): string;
+    get Database(): string;
     /**
      * Sets schema to this query.
      *
-     * @param schema - schema or database name in database
+     * @param database - schema or database name in database
      */
-    schema(schema: string): this;
+    database(database: string): this;
     /**
      * Sets table that query is executed on
      *
@@ -92,7 +96,6 @@ export declare class QueryBuilder<T = any> extends Builder<T> implements IQueryB
     from(table: string, alias?: string): this;
 }
 export declare class LimitBuilder implements ILimitBuilder {
-    protected _fail: boolean;
     protected _first: boolean;
     protected _limit: IQueryLimit;
     constructor();
@@ -100,6 +103,8 @@ export declare class LimitBuilder implements ILimitBuilder {
     skip(count: number): this;
     first(): Promise<any>;
     firstOrFail(): Promise<any>;
+    orThrow(error: Error): Promise<any>;
+    firstOrThrow(error: Error): Promise<any>;
     getLimits(): IQueryLimit;
 }
 export declare class OrderByBuilder implements IOrderByBuilder {
@@ -181,7 +186,7 @@ export declare class WhereBuilder implements IWhereBuilder {
     get Statements(): IQueryStatement[];
     get Op(): WhereBoolean;
     constructor(container: Container, tableAlias?: string);
-    where(column: string | boolean | WhereFunction | RawQuery | WrapStatement | {}, operator?: WhereOperators | any, value?: any): this;
+    where(column: string | boolean | WhereFunction | RawQuery | WrapStatement | {}, operator?: SqlOperator | any, value?: any): this;
     orWhere(column: string | boolean | WhereFunction | {}, ..._args: any[]): this;
     andWhere(column: string | boolean | WhereFunction | {}, ..._args: any[]): this;
     whereObject(obj: any): this;
@@ -228,7 +233,7 @@ export declare class SelectQueryBuilder<T = any> extends QueryBuilder<T> {
     get IsDistinct(): boolean;
     get Owner(): IOrmRelation;
     get Relations(): IOrmRelation[];
-    constructor(container: Container, driver: OrmDriver, model: Constructor<any>, owner?: IOrmRelation);
+    constructor(container: IContainer, driver: OrmDriver, model?: Constructor<any>, owner?: IOrmRelation);
     asRaw<T>(): Promise<T>;
     setAlias(alias: string): this;
     clone(): this;
@@ -241,37 +246,34 @@ export declare class SelectQueryBuilder<T = any> extends QueryBuilder<T> {
     avg(column: string, as?: string): this;
     distinct(): this;
     toDB(): ICompilerOutput;
-    then(resolve: (rows: any[]) => void, reject: (err: Error) => void): Promise<T>;
+    then<TResult1 = T, TResult2 = never>(onfulfilled?: (value: T) => TResult1 | PromiseLike<TResult1>, onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2>): PromiseLike<TResult1 | TResult2>;
     execute(): Promise<T>;
 }
-export declare class DeleteQueryBuilder extends QueryBuilder {
+export declare class DeleteQueryBuilder extends QueryBuilder<IUpdateResult> {
     /**
      * where query props
      */
     protected _statements: IQueryStatement[];
     protected _boolean: WhereBoolean;
-    protected _truncate: boolean;
     protected _limit: IQueryLimit;
-    get Truncate(): boolean;
     private this;
     constructor(container: Container, driver: OrmDriver, model: Constructor<any>);
     toDB(): ICompilerOutput;
-    truncate(): this;
 }
 export declare class OnDuplicateQueryBuilder {
     protected _column: string[];
     protected _parent: InsertQueryBuilder;
     protected _columnsToUpdate: Array<string | RawQuery>;
-    protected _container: Container;
-    constructor(container: Container, insertQueryBuilder: InsertQueryBuilder, column?: string | string[]);
+    protected _container: IContainer;
+    constructor(container: IContainer, insertQueryBuilder: InsertQueryBuilder, column?: string | string[]);
     getColumn(): string[];
     getColumnsToUpdate(): (string | RawQuery)[];
     getParent(): InsertQueryBuilder;
     update(columns: string[] | RawQuery[]): this;
-    then(resolve: (rows: any[]) => void, reject: (err: Error) => void): Promise<any>;
+    then<TResult1, TResult2 = never>(onfulfilled?: (value: any) => TResult1 | PromiseLike<TResult1>, onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2>): PromiseLike<TResult1 | TResult2>;
     toDB(): ICompilerOutput;
 }
-export declare class UpdateQueryBuilder extends QueryBuilder {
+export declare class UpdateQueryBuilder extends QueryBuilder<IUpdateResult> {
     /**
      * where query props
      */
@@ -285,19 +287,24 @@ export declare class UpdateQueryBuilder extends QueryBuilder {
     update(value: {}): this;
     toDB(): ICompilerOutput;
 }
-export declare class InsertQueryBuilder extends QueryBuilder {
+export declare class InsertQueryBuilder extends QueryBuilder<IUpdateResult> {
     DuplicateQueryBuilder: OnDuplicateQueryBuilder;
     protected _values: any[][];
     protected _columns: ColumnStatement[];
     protected _ignore: boolean;
+    protected _update: boolean;
+    protected _replace: boolean;
     this: this;
     get Values(): any[][];
     get Ignore(): boolean;
+    get Update(): boolean;
+    get Replace(): boolean;
     constructor(container: Container, driver: OrmDriver, model: Constructor<any>);
     /**
      * Sets insert to ignore on duplicate
      */
-    ignore(): this;
+    orIgnore(): this;
+    orReplace(): this;
     values(data: {} | Array<{}>): this;
     into(table: string, schema?: string): this;
     onDuplicate(column?: string | string[]): OnDuplicateQueryBuilder;
@@ -367,9 +374,9 @@ export declare class ColumnQueryBuilder {
     Charset: string;
     Collation: string;
     NotNull: boolean;
-    Type: string;
+    Type: ColumnType;
     Args: any[];
-    constructor(name: string, type: string, ...args: any[]);
+    constructor(name: string, type: ColumnType, ...args: any[]);
     notNull(): this;
     unique(): this;
     unsigned(): this;
@@ -380,10 +387,61 @@ export declare class ColumnQueryBuilder {
     charset(charset: string): this;
     collation(collation: string): this;
 }
+export declare class AlterColumnQueryBuilder extends ColumnQueryBuilder {
+    AlterType: ColumnAlterationType;
+    AfterColumn: string;
+    OldName: string;
+    constructor(name: string, type: ColumnType, ...args: any[]);
+    addColumn(): this;
+    modify(): this;
+    rename(newName: string): this;
+    after(columnName: string): this;
+}
 export declare class TableExistsQueryBuilder extends QueryBuilder {
     constructor(container: Container, driver: OrmDriver, name: string);
     toDB(): ICompilerOutput;
 }
+export declare class AlterTableQueryBuilder extends QueryBuilder {
+    protected _columns: ColumnQueryBuilder[];
+    NewTableName: string;
+    DroppedColumns: string[];
+    get Columns(): ColumnQueryBuilder[];
+    constructor(container: Container, driver: OrmDriver, name: string);
+    int: (name: string) => AlterColumnQueryBuilder;
+    bigint: (name: string) => AlterColumnQueryBuilder;
+    tinyint: (name: string) => AlterColumnQueryBuilder;
+    smallint: (name: string) => AlterColumnQueryBuilder;
+    mediumint: (name: string) => AlterColumnQueryBuilder;
+    text: (name: string) => AlterColumnQueryBuilder;
+    tinytext: (name: string) => AlterColumnQueryBuilder;
+    mediumtext: (name: string) => AlterColumnQueryBuilder;
+    smalltext: (name: string) => AlterColumnQueryBuilder;
+    longtext: (name: string) => AlterColumnQueryBuilder;
+    string: (name: string, length?: number) => AlterColumnQueryBuilder;
+    float: (name: string, precision?: number, scale?: number) => AlterColumnQueryBuilder;
+    double: (name: string, precision?: number, scale?: number) => AlterColumnQueryBuilder;
+    decimal: (name: string, precision?: number, scale?: number) => AlterColumnQueryBuilder;
+    boolean: (name: string) => AlterColumnQueryBuilder;
+    bit: (name: string) => AlterColumnQueryBuilder;
+    date: (name: string) => AlterColumnQueryBuilder;
+    dateTime: (name: string) => AlterColumnQueryBuilder;
+    time: (name: string) => AlterColumnQueryBuilder;
+    timestamp: (name: string) => AlterColumnQueryBuilder;
+    enum: (name: string, values: any[]) => AlterColumnQueryBuilder;
+    json: (name: string) => AlterColumnQueryBuilder;
+    binary: (name: string, size: number) => AlterColumnQueryBuilder;
+    tinyblob: (name: string) => AlterColumnQueryBuilder;
+    mediumblob: (name: string) => AlterColumnQueryBuilder;
+    longblob: (name: string) => AlterColumnQueryBuilder;
+    /**
+     * Renames table
+     *
+     * @param newTableName - new table name
+     */
+    rename(newTableName: string): void;
+    dropColumn(column: string): void;
+    toDB(): ICompilerOutput[];
+}
 export declare class TableQueryBuilder extends QueryBuilder {
     int: (name: string) => ColumnQueryBuilder;
     bigint: (name: string) => ColumnQueryBuilder;
@@ -412,6 +470,7 @@ export declare class TableQueryBuilder extends QueryBuilder {
     mediumblob: (name: string) => ColumnQueryBuilder;
     longblob: (name: string) => ColumnQueryBuilder;
     ifExists(): TableQueryBuilder;
+    temporary(): TableQueryBuilder;
     set: (name: string, allowed: string[]) => ColumnQueryBuilder;
     get Columns(): ColumnQueryBuilder[];
     get ForeignKeys(): ForeignKeyBuilder[];
@@ -420,7 +479,9 @@ export declare class TableQueryBuilder extends QueryBuilder {
     protected _comment: string;
     protected _charset: string;
     protected _checkExists: boolean;
+    protected _temporary: boolean;
     get CheckExists(): boolean;
+    get Temporary(): boolean;
     constructor(container: Container, driver: OrmDriver, name: string);
     increments(name: string): ColumnQueryBuilder;
     comment(comment: string): void;
@@ -428,10 +489,48 @@ export declare class TableQueryBuilder extends QueryBuilder {
     foreignKey(foreignKey: string): ForeignKeyBuilder;
     toDB(): ICompilerOutput;
 }
+export declare class TruncateTableQueryBuilder extends QueryBuilder {
+    protected container: Container;
+    protected driver: OrmDriver;
+    constructor(container: Container, driver: OrmDriver);
+    toDB(): ICompilerOutput;
+}
+export declare class CloneTableQueryBuilder extends QueryBuilder {
+    protected container: Container;
+    protected driver: OrmDriver;
+    protected _cloneSrc: string;
+    protected _temporary: boolean;
+    protected _shallow: boolean;
+    protected _filter: SelectQueryBuilder;
+    get CloneSource(): string;
+    get Temporary(): boolean;
+    get Shallow(): boolean;
+    get Filter(): SelectQueryBuilder<any>;
+    constructor(container: Container, driver: OrmDriver);
+    /**
+     * Clones table structure without data
+     * Shorthand for createTable(( table) => table.clone("new"));
+     *
+     * @param srcTable - source table name
+     * @param newTable - target table name
+     */
+    shallowClone(srcTable: string, newTable: string): this;
+    /**
+     * Clones table with data
+     *
+     * @param srcTable - source table name
+     * @param newTable - target table name
+     * @param filter - data filter, set null if all data is to be cloned
+     */
+    deepClone(srcTable: string, newTable: string, filter?: (query: SelectQueryBuilder) => void): Promise<any>;
+    toDB(): ICompilerOutput[];
+}
 export declare class SchemaQueryBuilder {
     protected container: Container;
     protected driver: OrmDriver;
     constructor(container: Container, driver: OrmDriver);
     createTable(name: string, callback: (table: TableQueryBuilder) => void): TableQueryBuilder;
-    tableExists(name: string): Promise<boolean>;
+    cloneTable(callback: (clone: CloneTableQueryBuilder) => void): CloneTableQueryBuilder;
+    alterTable(name: string, callback: (table: AlterTableQueryBuilder) => void): AlterTableQueryBuilder;
+    tableExists(name: string, schema?: string): Promise<boolean>;
 }