@adonisjs/lucid/build/src/orm/relations/many_to_many/query_builder.d.ts

SQL ORM built on top of Active Record pattern

import { Knex } from 'knex';
import { QueryClientContract } from '../../../types/database.js';
import { LucidModel, LucidRow } from '../../../types/model.js';
import { ManyToManyQueryBuilderContract } from '../../../types/relations.js';
import { ManyToMany } from './index.js';
import { BaseQueryBuilder } from '../base/query_builder.js';
/**
 * Extends the model query builder for executing queries in scope
 * to the current relationship
 */
export declare class ManyToManyQueryBuilder extends BaseQueryBuilder implements ManyToManyQueryBuilderContract<LucidModel, LucidModel> {
    private parent;
    relation: ManyToMany;
    private pivotQuery;
    private relatedTable;
    private pivotHelpers;
    protected cherryPickingKeys: boolean;
    protected appliedConstraints: boolean;
    /**
     * A boolean to know if query build targets only the pivot
     * table or not
     */
    get isPivotOnlyQuery(): boolean;
    set isPivotOnlyQuery(pivotOnly: boolean);
    constructor(builder: Knex.QueryBuilder, client: QueryClientContract, parent: LucidRow | LucidRow[], relation: ManyToMany);
    /**
     * Profiler data for ManyToMany relationship
     */
    protected profilerData(): {
        type: "manyToMany";
        model: string;
        pivotTable: string;
        relatedModel: string;
    };
    /**
     * The keys for constructing the join query
     */
    protected getRelationKeys(): string[];
    /**
     * Prefixes the related table name to a column
     */
    private prefixRelatedTable;
    /**
     * Adds where constraint to the pivot table
     */
    private addWhereConstraints;
    /**
     * Transforms the selected column names by prefixing the
     * table name
     */
    private transformRelatedTableColumns;
    /**
     * Applying query constraints to scope them to relationship
     * only.
     */
    protected applyConstraints(): void;
    /**
     * Select keys from the related table
     */
    select(...args: any[]): this;
    /**
     * Add where clause with pivot table prefix
     */
    wherePivot(key: any, operator?: any, value?: any): this;
    /**
     * Add or where clause with pivot table prefix
     */
    orWherePivot(key: any, operator?: any, value?: any): this;
    /**
     * Alias for wherePivot
     */
    andWherePivot(key: any, operator?: any, value?: any): this;
    /**
     * Add where not pivot
     */
    whereNotPivot(key: any, operator?: any, value?: any): this;
    /**
     * Add or where not pivot
     */
    orWhereNotPivot(key: any, operator?: any, value?: any): this;
    /**
     * Alias for `whereNotPivot`
     */
    andWhereNotPivot(key: any, operator?: any, value?: any): this;
    /**
     * Adds where in clause
     */
    whereInPivot(key: any, value: any): this;
    /**
     * Adds or where in clause
     */
    orWhereInPivot(key: any, value: any): this;
    /**
     * Alias from `whereInPivot`
     */
    andWhereInPivot(key: any, value: any): this;
    /**
     * Adds where not in clause
     */
    whereNotInPivot(key: any, value: any): this;
    /**
     * Adds or where not in clause
     */
    orWhereNotInPivot(key: any, value: any): this;
    /**
     * Alias from `whereNotInPivot`
     */
    andWhereNotInPivot(key: any, value: any): this;
    /**
     * Same as "whereNull", but for the pivot table only
     */
    whereNullPivot(key: string): this;
    /**
     * Same as "orWhereNull", but for the pivot table only
     */
    orWhereNullPivot(key: string): this;
    /**
     * Same as "andWhereNull", but for the pivot table only
     */
    andWhereNullPivot(key: string): this;
    /**
     * Same as "whereNotNull", but for the pivot table only
     */
    whereNotNullPivot(key: string): this;
    /**
     * Same as "orWhereNotNull", but for the pivot table only
     */
    orWhereNotNullPivot(key: string): this;
    /**
     * Same as "andWhereNotNull", but for the pivot table only
     */
    andWhereNotNullPivot(key: string): this;
    /**
     * Select pivot columns
     */
    pivotColumns(columns: string[]): this;
    /**
     * Clones query
     */
    clone(): ManyToManyQueryBuilder;
    /**
     * Paginate through rows inside a given table
     */
    paginate(page: number, perPage?: number): Promise<any>;
    exec(): Promise<any[]>;
    /**
     * Returns the group limit query
     */
    getGroupLimitQuery(): import("../../../types/model.js").ModelQueryBuilderContract<LucidModel, LucidRow>;
}