Member Junction
    Preparing search index...

    Interface ExternalSchemaRelationship

    A foreign-key relationship discovered during schema introspection: this object's column(s) reference another object's column(s). Modeled on the referencing side (the object that holds the foreign key), mirroring how relational catalogs report constraints.

    interface ExternalSchemaRelationship {
        Columns: ExternalSchemaRelationshipColumn[];
        Name?: string;
        ReferencedObject: string;
        ReferencedSchema?: string;
    }
    Index

    Properties

    Columns Name? ReferencedObject ReferencedSchema?

    Properties

    Columns: ExternalSchemaRelationshipColumn[]

    Column pairings that make up the foreign key (an array to support composite keys).

    Name?: string

    Constraint name if the remote catalog supplies one.

    ReferencedObject: string

    Name of the object this relationship points to.

    ReferencedSchema?: string

    Schema/namespace of the referenced object, when applicable.

    Settings

    Member Visibility

    On This Page

    Properties