@dpkit/core/schema/ForeignKey.ts

Fast TypeScript data management framework built on top of the Data Package standard and Polars DataFrames

/**
 * Foreign key definition for Table Schema
 * Based on the specification at https://datapackage.org/standard/table-schema/#foreign-keys
 */
export interface ForeignKey {
  /**
   * Source field(s) in this schema
   */
  fields: string[]

  /**
   * Reference to fields in another resource
   */
  reference: {
    /**
     * Target resource name (optional)
     */
    resource?: string

    /**
     * Target field(s) in the referenced resource
     */
    fields: string[]
  }
}