Function addFieldToSchema

lib/helpers/fields.ts:10–106

(
  table: any,
  fieldOptions: FieldOptions,
)

/** Add a model field to a table schema. */
export function addFieldToSchema(
  table: any,
  fieldOptions: FieldOptions,
) {
  const type = typeof fieldOptions.type === "string"
    ? fieldOptions.type
    : fieldOptions.type.type!;

  let instruction;

  if (typeof fieldOptions.type === "object") {
    if (fieldOptions.type.relationship) {
      const relationshipPKName = fieldOptions.type.relationship.model
        .getComputedPrimaryKey();

      const relationshipPKProps: FieldProps = fieldOptions.type.relationship
        .model
        .getComputedPrimaryProps();

      const relationshipPKType: FieldTypeString = fieldOptions.type.relationship
        .model
        .getComputedPrimaryType();

      if (relationshipPKType === "integer" || relationshipPKType === "bigInteger") {
        const foreignField = table[relationshipPKType](fieldOptions.name);

        if (!relationshipPKProps.allowNull) {
          foreignField.notNullable();
        }

        if (relationshipPKProps.autoIncrement) {
          foreignField.unsigned();
        }
      } else {
        table[relationshipPKType](fieldOptions.name);
      }

      table
        .foreign(fieldOptions.name)
        .references(
          fieldOptions.type.relationship.model
            .field(relationshipPKName),
        )
        .onDelete("CASCADE");

      return;
    }

    const fieldNameArgs: [string | number | (string | number)[]] = [
      fieldOptions.name,
    ];

    if (fieldOptions.type.length) {
      fieldNameArgs.push(fieldOptions.type.length);
    }

    if (fieldOptions.type.precision) {
      fieldNameArgs.push(fieldOptions.type.precision);