@spinajs/orm 1.2.44 → 1.2.50

package/lib/orm/src/builders.d.ts

@@ -1,429 +0,0 @@
-import { Container, Constructor } from '@spinajs/di';
-import { QueryMethod, SORT_ORDER, WhereBoolean, WhereOperators } 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';
-/**
- *  Trick typescript by using the inbuilt interface inheritance and declaration merging
- *  for builder classes.
- *
- *  We use mixins to extend functionality of builder eg. insert query builder uses function from columns builder
- *  and so on...
- */
-export interface InsertQueryBuilder extends IColumnsBuilder {
-}
-export interface DeleteQueryBuilder extends IWhereBuilder, ILimitBuilder {
-}
-export interface UpdateQueryBuilder extends IColumnsBuilder, IWhereBuilder {
-}
-export interface SelectQueryBuilder extends IColumnsBuilder, IOrderByBuilder, ILimitBuilder, IWhereBuilder, IJoinBuilder, IWithRecursiveBuilder, IGroupByBuilder {
-}
-export declare class Builder<T = any> {
-    protected _driver: OrmDriver;
-    protected _container: Container;
-    protected _model?: Constructor<ModelBase>;
-    protected _nonSelect: boolean;
-    protected _queryContext: QueryContext;
-    protected _middlewares: IBuilderMiddleware[];
-    protected _asRaw: boolean;
-    constructor(container: Container, driver: OrmDriver, model?: Constructor<ModelBase>);
-    middleware(middleware: IBuilderMiddleware): this;
-    /**
-     * Builds query that is ready to use in DB
-     */
-    toDB(): ICompilerOutput;
-    then(resolve: (rows: any[]) => void, reject: (err: Error) => void): Promise<T>;
-}
-/**
- * Base class for queires. Implements basic query functionality
- *
- */
-export declare class QueryBuilder<T = any> extends Builder<T> implements IQueryBuilder {
-    protected _method: QueryMethod;
-    protected _table: string;
-    protected _tableAlias: string;
-    protected _schema: string;
-    constructor(container: Container, driver: OrmDriver, model?: Constructor<ModelBase>);
-    /**
-     * SQL table name that query is executed on
-     *
-     * @example
-     * SELECT * FROM `users`
-     */
-    get Table(): string;
-    /**
-     * DB table alias
-     */
-    get TableAlias(): string;
-    /**
-     * SQL schema/database name that query is executed on.
-     *
-     * @example
-     * SELECT * FROM `spinejs`.`users` as u
-     */
-    get Schema(): string;
-    /**
-     * Sets schema to this query.
-     *
-     * @param schema - schema or database name in database
-     */
-    schema(schema: string): this;
-    /**
-     * Sets table that query is executed on
-     *
-     * @param table - sql table name
-     * @param alias - sql table alias
-     *
-     * @example
-     *
-     * this.setTable("user","u")
-     *
-     */
-    setTable(table: string, alias?: string): this;
-    /**
-     * Sets table alias for query
-     *
-     * @param alias - sql table alias
-     */
-    setAlias(alias: string): this;
-    from(table: string, alias?: string): this;
-}
-export declare class LimitBuilder implements ILimitBuilder {
-    protected _fail: boolean;
-    protected _first: boolean;
-    protected _limit: IQueryLimit;
-    constructor();
-    take(count: number): this;
-    skip(count: number): this;
-    first(): Promise<any>;
-    firstOrFail(): Promise<any>;
-    getLimits(): IQueryLimit;
-}
-export declare class OrderByBuilder implements IOrderByBuilder {
-    protected _sort: ISort;
-    constructor();
-    order(column: string, direction: SORT_ORDER): this;
-    orderBy(column: string): this;
-    orderByDescending(column: string): this;
-    getSort(): ISort;
-}
-export declare class ColumnsBuilder implements IColumnsBuilder {
-    protected _container: Container;
-    protected _columns: IQueryStatement[];
-    protected _tableAlias: string;
-    protected _model?: Constructor<ModelBase>;
-    constructor();
-    /**
-     * Clears all select clauses from the query.
-     *
-     * @example
-     *
-     * query.columns()
-     *
-     */
-    clearColumns(): this;
-    columns(names: string[]): this;
-    select(column: string | RawQuery | Map<string, string>, alias?: string): this;
-    getColumns(): IQueryStatement[];
-}
-export declare class RawQuery {
-    get Query(): string;
-    get Bindings(): any[];
-    static create(query: string, bindings?: any[]): RawQuery;
-    private _query;
-    private _bindings;
-    constructor(query: string, bindings?: any[]);
-}
-export declare class GroupByBuilder implements IGroupByBuilder {
-    protected _container: Container;
-    protected _groupStatements: IQueryStatement[];
-    get GroupStatements(): IQueryStatement[];
-    clearGroupBy(): this;
-    groupBy(expression: string | RawQuery): this;
-}
-export declare class JoinBuilder implements IJoinBuilder {
-    get JoinStatements(): IQueryStatement[];
-    protected _joinStatements: IQueryStatement[];
-    protected _container: Container;
-    protected _tableAlias: string;
-    constructor(container: Container);
-    clearJoins(): this;
-    innerJoin(query: RawQuery): this;
-    innerJoin(table: string, foreignKey: string, primaryKey: string): this;
-    leftJoin(query: RawQuery): this;
-    leftJoin(table: string, foreignKey: string, primaryKey: string): this;
-    leftOuterJoin(query: RawQuery): this;
-    leftOuterJoin(table: string, foreignKey: string, primaryKey: string): this;
-    rightJoin(query: RawQuery): this;
-    rightJoin(table: string, foreignKey: string, primaryKey: string): this;
-    rightOuterJoin(query: RawQuery): this;
-    rightOuterJoin(table: string, foreignKey: string, primaryKey: string): this;
-    fullOuterJoin(query: RawQuery): this;
-    fullOuterJoin(table: string, foreignKey: string, primaryKey: string): this;
-    crossJoin(query: RawQuery): this;
-    crossJoin(table: string, foreignKey: string, primaryKey: string): this;
-    private addJoinStatement;
-}
-export declare class WithRecursiveBuilder implements IWithRecursiveBuilder {
-    protected _container: Container;
-    protected _cteStatement: IQueryStatement;
-    get CteRecursive(): IQueryStatement;
-    withRecursive(rcKeyName: string, pkName: string): this;
-}
-export declare class WhereBuilder implements IWhereBuilder {
-    protected _statements: IQueryStatement[];
-    protected _boolean: WhereBoolean;
-    protected _container: Container;
-    protected _tableAlias: string;
-    get Statements(): IQueryStatement[];
-    get Op(): WhereBoolean;
-    constructor(container: Container, tableAlias?: string);
-    where(column: string | boolean | WhereFunction | RawQuery | WrapStatement | {}, operator?: WhereOperators | any, value?: any): this;
-    orWhere(column: string | boolean | WhereFunction | {}, ..._args: any[]): this;
-    andWhere(column: string | boolean | WhereFunction | {}, ..._args: any[]): this;
-    whereObject(obj: any): this;
-    whereNotNull(column: string): this;
-    whereNull(column: string): this;
-    whereNot(column: string, val: any): this;
-    whereIn(column: string, val: any[]): this;
-    whereNotIn(column: string, val: any[]): this;
-    whereExist(query: SelectQueryBuilder): this;
-    whereNotExists(query: SelectQueryBuilder): this;
-    whereBetween(column: string, val: any[]): this;
-    whereNotBetween(column: string, val: any[]): this;
-    whereInSet(column: string, val: any[]): this;
-    whereNotInSet(column: string, val: any[]): this;
-    clearWhere(): this;
-}
-export declare class SelectQueryBuilder<T = any> extends QueryBuilder<T> {
-    /**
-     * column query props
-     */
-    protected _distinct: boolean;
-    protected _columns: IQueryStatement[];
-    /**
-     * limit query props
-     */
-    protected _fail: boolean;
-    protected _first: boolean;
-    protected _limit: IQueryLimit;
-    /**
-     * order by query props
-     */
-    protected _sort: ISort;
-    /**
-     * where query props
-     */
-    protected _statements: IQueryStatement[];
-    protected _boolean: WhereBoolean;
-    protected _joinStatements: IQueryStatement[];
-    protected _groupStatements: IQueryStatement[];
-    protected _cteStatement: IQueryStatement;
-    protected _owner: IOrmRelation;
-    protected _relations: IOrmRelation[];
-    this: this;
-    get IsDistinct(): boolean;
-    get Owner(): IOrmRelation;
-    get Relations(): IOrmRelation[];
-    constructor(container: Container, driver: OrmDriver, model: Constructor<any>, owner?: IOrmRelation);
-    asRaw<T>(): Promise<T>;
-    setAlias(alias: string): this;
-    clone(): this;
-    populate<R = this>(relation: string, callback?: (this: SelectQueryBuilder<R>, relation: OrmRelation) => void): this;
-    mergeStatements(builder: SelectQueryBuilder): void;
-    min(column: string, as?: string): this;
-    max(column: string, as?: string): this;
-    count(column: string, as?: string): this;
-    sum(column: string, as?: string): this;
-    avg(column: string, as?: string): this;
-    distinct(): this;
-    toDB(): ICompilerOutput;
-    then(resolve: (rows: any[]) => void, reject: (err: Error) => void): Promise<T>;
-    execute(): Promise<T>;
-}
-export declare class DeleteQueryBuilder extends QueryBuilder {
-    /**
-     * 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[]);
-    getColumn(): string[];
-    getColumnsToUpdate(): (string | RawQuery)[];
-    getParent(): InsertQueryBuilder;
-    update(columns: string[] | RawQuery[]): this;
-    then(resolve: (rows: any[]) => void, reject: (err: Error) => void): Promise<any>;
-    toDB(): ICompilerOutput;
-}
-export declare class UpdateQueryBuilder extends QueryBuilder {
-    /**
-     * where query props
-     */
-    protected _statements: IQueryStatement[];
-    protected _boolean: WhereBoolean;
-    protected _value: {};
-    get Value(): {};
-    this: this;
-    constructor(container: Container, driver: OrmDriver, model: Constructor<any>);
-    in(name: string): this;
-    update(value: {}): this;
-    toDB(): ICompilerOutput;
-}
-export declare class InsertQueryBuilder extends QueryBuilder {
-    DuplicateQueryBuilder: OnDuplicateQueryBuilder;
-    protected _values: any[][];
-    protected _columns: ColumnStatement[];
-    protected _ignore: boolean;
-    this: this;
-    get Values(): any[][];
-    get Ignore(): boolean;
-    constructor(container: Container, driver: OrmDriver, model: Constructor<any>);
-    /**
-     * Sets insert to ignore on duplicate
-     */
-    ignore(): this;
-    values(data: {} | Array<{}>): this;
-    into(table: string, schema?: string): this;
-    onDuplicate(column?: string | string[]): OnDuplicateQueryBuilder;
-    toDB(): ICompilerOutput;
-}
-export declare class IndexQueryBuilder extends Builder {
-    Name: string;
-    Unique: boolean;
-    Table: string;
-    Columns: string[];
-    constructor(container: Container, driver: OrmDriver);
-    name(name: string): this;
-    unique(): this;
-    table(name: string): this;
-    columns(colNames: string[]): this;
-    toDB(): ICompilerOutput;
-}
-export declare class ForeignKeyBuilder {
-    ForeignKeyField: string;
-    Table: string;
-    PrimaryKey: string;
-    OnDeleteAction: ReferentialAction;
-    OnUpdateAction: ReferentialAction;
-    constructor();
-    /**
-     *
-     * Referenced field in child table
-     *
-     * @param fkName - name of foreign field in child table
-     */
-    foreignKey(fkName: string): this;
-    /**
-     *
-     * Referenced parent table & key
-     *
-     * @param table - parent table
-     * @param pKey - parant table key field
-     */
-    references(table: string, pKey: string): this;
-    /**
-     *
-     * On delete action
-     *
-     * @param action - action to take on delete
-     */
-    onDelete(action: ReferentialAction): this;
-    /**
-     *
-     * On update action
-     *
-     * @param action - action to take on update
-     */
-    onUpdate(action: ReferentialAction): this;
-    /**
-     * Shorhand for on update and on delete cascade settings
-     */
-    cascade(): this;
-}
-export declare class ColumnQueryBuilder {
-    Name: string;
-    Unique: boolean;
-    Unsigned: boolean;
-    AutoIncrement: boolean;
-    Default: string | RawQuery | number;
-    PrimaryKey: boolean;
-    Comment: string;
-    Charset: string;
-    Collation: string;
-    NotNull: boolean;
-    Type: string;
-    Args: any[];
-    constructor(name: string, type: string, ...args: any[]);
-    notNull(): this;
-    unique(): this;
-    unsigned(): this;
-    autoIncrement(): this;
-    default(val: string | RawQuery | number): this;
-    primaryKey(): this;
-    comment(comment: string): this;
-    charset(charset: string): this;
-    collation(collation: string): this;
-}
-export declare class TableQueryBuilder extends QueryBuilder {
-    int: (name: string) => ColumnQueryBuilder;
-    bigint: (name: string) => ColumnQueryBuilder;
-    tinyint: (name: string) => ColumnQueryBuilder;
-    smallint: (name: string) => ColumnQueryBuilder;
-    mediumint: (name: string) => ColumnQueryBuilder;
-    text: (name: string) => ColumnQueryBuilder;
-    tinytext: (name: string) => ColumnQueryBuilder;
-    mediumtext: (name: string) => ColumnQueryBuilder;
-    smalltext: (name: string) => ColumnQueryBuilder;
-    longtext: (name: string) => ColumnQueryBuilder;
-    string: (name: string, length?: number) => ColumnQueryBuilder;
-    float: (name: string, precision?: number, scale?: number) => ColumnQueryBuilder;
-    double: (name: string, precision?: number, scale?: number) => ColumnQueryBuilder;
-    decimal: (name: string, precision?: number, scale?: number) => ColumnQueryBuilder;
-    boolean: (name: string) => ColumnQueryBuilder;
-    bit: (name: string) => ColumnQueryBuilder;
-    date: (name: string) => ColumnQueryBuilder;
-    dateTime: (name: string) => ColumnQueryBuilder;
-    time: (name: string) => ColumnQueryBuilder;
-    timestamp: (name: string) => ColumnQueryBuilder;
-    enum: (name: string, values: any[]) => ColumnQueryBuilder;
-    json: (name: string) => ColumnQueryBuilder;
-    binary: (name: string, size: number) => ColumnQueryBuilder;
-    tinyblob: (name: string) => ColumnQueryBuilder;
-    mediumblob: (name: string) => ColumnQueryBuilder;
-    longblob: (name: string) => ColumnQueryBuilder;
-    set: (name: string, allowed: string[]) => ColumnQueryBuilder;
-    get Columns(): ColumnQueryBuilder[];
-    get ForeignKeys(): ForeignKeyBuilder[];
-    protected _columns: ColumnQueryBuilder[];
-    protected _foreignKeys: ForeignKeyBuilder[];
-    protected _comment: string;
-    protected _charset: string;
-    constructor(container: Container, driver: OrmDriver, name: string);
-    increments(name: string): ColumnQueryBuilder;
-    comment(comment: string): void;
-    charset(charset: string): void;
-    foreignKey(foreignKey: string): ForeignKeyBuilder;
-    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;
-}