typeorm/metadata/ExclusionMetadata.d.ts

Data-Mapper ORM for TypeScript and ES2023+. Supports MySQL/MariaDB, PostgreSQL, MS SQL Server, Oracle, SAP HANA, SQLite, MongoDB databases.

import type { EntityMetadata } from "./EntityMetadata";
import type { NamingStrategyInterface } from "../naming-strategy/NamingStrategyInterface";
import type { ExclusionMetadataArgs } from "../metadata-args/ExclusionMetadataArgs";
import type { DeferrableType } from "./types/DeferrableType";
/**
 * Exclusion metadata contains all information about table's exclusion constraints.
 */
export declare class ExclusionMetadata {
    /**
     * Entity metadata of the class to which this exclusion constraint is applied.
     */
    entityMetadata: EntityMetadata;
    /**
     * Target class to which metadata is applied.
     */
    target?: Function | string;
    /**
     * Exclusion expression.
     */
    expression: string;
    /**
     * Indicate if exclusion constraints can be deferred.
     */
    deferrable?: DeferrableType;
    /**
     * User specified exclusion constraint name.
     */
    givenName?: string;
    /**
     * Final exclusion constraint name.
     * If exclusion constraint name was given by a user then it stores normalized (by naming strategy) givenName.
     * If exclusion constraint name was not given then its generated.
     */
    name: string;
    constructor(options: {
        entityMetadata: EntityMetadata;
        args?: ExclusionMetadataArgs;
    });
    /**
     * Builds some depend exclusion constraint properties.
     * Must be called after all entity metadata's properties map, columns and relations are built.
     *
     * @param namingStrategy
     */
    build(namingStrategy: NamingStrategyInterface): this;
}