foreign method

ForeignKeyBuilder foreign(
  1. Iterable<String> columns, {
  2. required String references,
  3. required Iterable<String> referencedColumns,
  4. ReferenceAction onDelete = ReferenceAction.noAction,
  5. ReferenceAction onUpdate = ReferenceAction.noAction,
  6. String? name,
})

Adds a foreign key definition.

Implementation

ForeignKeyBuilder foreign(
  Iterable<String> columns, {
  required String references,
  required Iterable<String> referencedColumns,
  ReferenceAction onDelete = ReferenceAction.noAction,
  ReferenceAction onUpdate = ReferenceAction.noAction,
  String? name,
}) {
  final definition = ForeignKeyDefinition(
    name: name ?? _defaultConstraintName(columns, suffix: 'foreign'),
    columns: List.unmodifiable(columns),
    referencedTable: references,
    referencedColumns: List.unmodifiable(referencedColumns),
    onDelete: onDelete,
    onUpdate: onUpdate,
  );
  final entry = ForeignKeyEntry(definition);
  _foreignKeys.add(entry);
  return ForeignKeyBuilder(entry);
}