Method updateField

api/src/services/fields.ts:503–656

(collection: string, field: RawField, opts?: FieldMutationOptions)

	}

	async updateField(collection: string, field: RawField, opts?: FieldMutationOptions): Promise<string> {
		if (this.accountability && this.accountability.admin !== true) {
			throw new ForbiddenError();
		}

		const runPostColumnChange = await this.helpers.schema.preColumnChange();
		const nestedActionEvents: ActionEventParams[] = [];

		// 'type' is required for further checks on schema update
		if (field.schema && !field.type) {
			const existingType = this.schema.collections[collection]?.fields[field.field]?.type;
			if (existingType) field.type = existingType;
		}

		try {
			const hookAdjustedField =
				opts?.emitEvents !== false
					? await emitter.emitFilter(
							`fields.update`,
							field,
							{
								keys: [field.field],
								collection: collection,
							},
							{
								database: this.knex,
								schema: this.schema,
								accountability: this.accountability,
							},
						)
					: field;

			const record = field.meta
				? await this.knex.select('id').from('directus_fields').where({ collection, field: field.field }).first()
				: null;

			if (
				hookAdjustedField.type &&
				(hookAdjustedField.type === 'alias' ||
					this.schema.collections[collection]!.fields[field.field]?.type === 'alias') &&
				hookAdjustedField.type !== (this.schema.collections[collection]!.fields[field.field]?.type ?? 'alias')
			) {
				throw new InvalidPayloadError({ reason: 'Alias type cannot be changed' });
			}

			if (hookAdjustedField.schema) {
				const existingColumn = await this.columnInfo(collection, hookAdjustedField.field);

				if (existingColumn.is_primary_key) {
					if (hookAdjustedField.schema?.is_nullable === true) {
						throw new InvalidPayloadError({ reason: 'Primary key cannot be null' });
					}
				}

				// Sanitize column only when applying snapshot diff as opts is only passed from /utils/apply-diff.ts
				const columnToCompare =
					opts?.bypassLimits && opts.autoPurgeSystemCache === false ? sanitizeColumn(existingColumn) : existingColumn;