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

SQL ORM built on top of Active Record pattern

import { QueryClientContract } from '../../../types/database.js';
import { LucidRow, LucidModel } from '../../../types/model.js';
import { ManyToManyRelationOptions, ManyToManyRelationContract, ManyToMany as ModelManyToMany } from '../../../types/relations.js';
/**
 * Manages loading and persisting many to many relationship
 */
export declare class ManyToMany implements ManyToManyRelationContract<LucidModel, LucidModel> {
    relationName: string;
    relatedModel: () => LucidModel;
    private options;
    model: LucidModel;
    type: "manyToMany";
    booted: boolean;
    serializeAs: string | null;
    /**
     * Available after boot is invoked
     */
    localKey: string;
    localKeyColumnName: string;
    relatedKey: string;
    relatedKeyColumnName: string;
    pivotForeignKey: string;
    pivotRelatedForeignKey: string;
    pivotTable: string;
    pivotColumns: string[];
    pivotCreatedAtTimestamp: string | undefined;
    pivotUpdatedAtTimestamp: string | undefined;
    /**
     * Timestamp columns for the pivot table
     */
    get pivotTimestamps(): string[];
    /**
     * Reference to the onQuery hook defined by the user
     */
    onQueryHook: ((query: import("../../../types/relations.js").ManyToManyQueryBuilderContract<LucidModel, any> | import("../../../types/relations.js").ManyToManySubQueryBuilderContract<LucidModel>) => void) | undefined;
    meta?: any;
    /**
     * Computes the created at timestamps column name
     * for the pivot table
     */
    private computedCreatedAtTimestamp;
    /**
     * Computes the updated at timestamps column name
     * for the pivot table
     */
    private computedUpdatedAtTimestamp;
    constructor(relationName: string, relatedModel: () => LucidModel, options: ManyToManyRelationOptions<ModelManyToMany<LucidModel>>, model: LucidModel);
    /**
     * Returns the alias for the pivot key
     */
    pivotAlias(key: string): string;
    /**
     * Clone relationship instance
     */
    clone(parent: LucidModel): any;
    /**
     * Boot the relationship and ensure that all keys are in
     * place for queries to do their job.
     */
    boot(): void;
    /**
     * Set related model instances
     */
    setRelated(parent: LucidRow, related: LucidRow[]): void;
    /**
     * Push related model instance(s)
     */
    pushRelated(parent: LucidRow, related: LucidRow | LucidRow[]): void;
    /**
     * Finds and set the related model instances next to the parent
     * models.
     */
    setRelatedForMany(parent: LucidRow[], related: LucidRow[]): void;
    /**
     * Returns an instance of query client for invoking queries
     */
    client(parent: LucidRow, client: QueryClientContract): any;
    /**
     * Returns an instance of eager query builder
     */
    eagerQuery(parent: LucidRow[], client: QueryClientContract): import("./query_builder.js").ManyToManyQueryBuilder;
    /**
     * Returns instance of query builder
     */
    subQuery(client: QueryClientContract): ReturnType<ManyToManyRelationContract<LucidModel, LucidModel>['subQuery']>;
    /**
     * Returns key-value pair for the pivot table in relation to the parent model
     */
    getPivotPair(parent: LucidRow): [string, number | string];
    /**
     * Returns key-value pair for the pivot table in relation to the related model
     */
    getPivotRelatedPair(related: LucidRow): [string, number | string];
}