Migration Attributes

Signed-off-by: Maxence Lange <maxence@artificial-owl.com>

lib/public/Migration/Attributes/FieldAdd.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Migration\Attributes;
+
+use Attribute;
+
+#[Attribute]
+class FieldAdd extends FieldMigrationAttribute {
+}

lib/public/Migration/Attributes/FieldChange.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Migration\Attributes;
+
+use Attribute;
+
+#[Attribute]
+class FieldChange extends FieldMigrationAttribute {
+}

lib/public/Migration/Attributes/FieldMigrationAttribute.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Migration\Attributes;
+
+use Attribute;
+use JsonSerializable;
+
+class FieldMigrationAttribute extends MigrationAttribute implements JsonSerializable {
+	public function __construct(
+		string $table,
+		private readonly string $field,
+		private readonly ?FieldType $type = null,
+		MigrationWeight $weight = MigrationWeight::LIGHT,
+		string $description = '',
+		array $notes = [],
+	) {
+		parent::__construct($table, $weight, $description, $notes);
+	}
+
+	public function getField(): string {
+		return $this->field;
+	}
+
+	public function getType(): ?FieldType {
+		return $this->type;
+	}
+
+	public function jsonSerialize(): array {
+		return array_merge(
+			parent::jsonSerialize(),
+			[
+				'field' => $this->getField(),
+				'type' => $this->getType() ?? '',
+			]
+		);
+	}
+}

lib/public/Migration/Attributes/FieldRemove.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Migration\Attributes;
+
+use Attribute;
+
+#[Attribute]
+class FieldRemove extends FieldMigrationAttribute {
+}

lib/public/Migration/Attributes/FieldType.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Migration\Attributes;
+
+/**
+ * enum FieldType based on OCP\DB\Types
+ *
+ * @see \OCP\DB\Types
+ * @since 30.0.0
+ */
+enum FieldType : string {
+	/** @since 30.0.0 */
+	case BIGINT = 'bigint';
+	/** @since 30.0.0 */
+	case BINARY = 'binary';
+	/** @since 30.0.0 */
+	case BLOB = 'blob';
+	/** @since 30.0.0 */
+	case BOOLEAN = 'boolean';
+	/** @since 30.0.0 */
+	case DATE = 'date';
+	/** @since 30.0.0 */
+	case DATETIME = 'datetime';
+	/** @since 30.0.0 */
+	case DECIMAL = 'decimal';
+	/** @since 30.0.0 */
+	case FLOAT = 'float';
+	/** @since 30.0.0 */
+	case INTEGER = 'integer';
+	/** @since 30.0.0 */
+	case SMALLINT = 'smallint';
+	/** @since 30.0.0 */
+	case STRING = 'string';
+	/** @since 30.0.0 */
+	case TEXT = 'text';
+	/** @since 30.0.0 */
+	case TIME = 'time';
+	/** @since 30.0.0 */
+	case JSON = 'json';
+}

lib/public/Migration/Attributes/IndexAdd.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Migration\Attributes;
+
+use Attribute;
+
+#[Attribute]
+class IndexAdd extends IndexMigrationAttribute {
+}

lib/public/Migration/Attributes/IndexMigrationAttribute.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Migration\Attributes;
+
+use Attribute;
+use JsonSerializable;
+
+class IndexMigrationAttribute extends MigrationAttribute implements JsonSerializable {
+	public function __construct(
+		string $table,
+		private readonly ?IndexType $type = null,
+		MigrationWeight $weight = MigrationWeight::LIGHT,
+		string $description = '',
+		array $notes = [],
+	) {
+		parent::__construct($table, $weight, $description, $notes);
+	}
+
+	public function getType(): ?IndexType {
+		return $this->type;
+	}
+
+	public function jsonSerialize(): array {
+		return array_merge(
+			parent::jsonSerialize(),
+			[
+				'type' => $this->getType() ?? '',
+			]
+		);
+	}
+}

lib/public/Migration/Attributes/IndexRemove.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Migration\Attributes;
+
+use Attribute;
+
+#[Attribute]
+class IndexRemove extends IndexMigrationAttribute {
+}

lib/public/Migration/Attributes/IndexType.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Migration\Attributes;
+
+/**
+ * @since 30.0.0
+ */
+enum IndexType : string {
+	/** @since 30.0.0 */
+	case PRIMARY = 'primary'; // migration is estimated to require few minutes
+	/** @since 30.0.0 */
+	case INDEX = 'index'; // depends on setup, migration might require some time
+	/** @since 30.0.0 */
+	case UNIQUE = 'unique'; // migration should be light and quick
+}

lib/public/Migration/Attributes/MigrationAttribute.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Migration\Attributes;
+
+use JsonSerializable;
+
+class MigrationAttribute implements JsonSerializable {
+	public function __construct(
+		private readonly string $table,
+		private readonly MigrationWeight $weight = MigrationWeight::LIGHT,
+		private readonly string $description = '',
+		private readonly array $notes = [],
+	) {
+	}
+
+	public function getTable(): string {
+		return $this->table;
+	}
+
+	public function getWeight(): MigrationWeight {
+		return $this->weight;
+	}
+
+	public function getDescription(): string {
+		return $this->description;
+	}
+
+	public function getNotes(): array {
+		return $this->notes;
+	}
+
+	public function jsonSerialize(): array {
+		return [
+			'class' => get_class($this),
+			'table' => $this->getTable(),
+			'weight' => $this->getWeight()->value,
+			'description' => $this->getDescription(),
+			'notes' => $this->getNotes(),
+		];
+	}
+}

lib/public/Migration/Attributes/MigrationWeight.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Migration\Attributes;
+
+enum MigrationWeight : string {
+	/** @since 30.0.0 */
+	case LIGHT = 'light'; // migration should be light and quick
+	/** @since 30.0.0 */
+	case MEDIUM = 'medium'; // migration is estimated to require few minutes
+	/** @since 30.0.0 */
+	case SETUP_BASED = 'setup-based'; // depends on setup, migration might require some time
+	/** @since 30.0.0 */
+	case SIZE_RELATED = 'size-related'; // depends on setup, migration might require some time
+	/** @since 30.0.0 */
+	case HEAVY = 'heavy'; // migration is estimated to be heavy and time consuming
+}

lib/public/Migration/Attributes/TableCreation.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Migration\Attributes;
+
+use Attribute;
+
+#[Attribute]
+class TableCreation extends TableMigrationAttribute {
+}

lib/public/Migration/Attributes/TableDeletion.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Migration\Attributes;
+
+use Attribute;
+
+#[Attribute]
+class TableDeletion extends MigrationAttribute {
+}

lib/public/Migration/Attributes/TableMigrationAttribute.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Migration\Attributes;
+
+use Attribute;
+use JsonSerializable;
+
+class TableMigrationAttribute extends MigrationAttribute implements JsonSerializable {
+	public function __construct(
+		string $table,
+		private readonly array $fields = [],
+		MigrationWeight $weight = MigrationWeight::LIGHT,
+		string $description = '',
+		array $notes = [],
+	) {
+		parent::__construct($table, $weight, $description, $notes);
+	}
+
+	public function getFields(): array {
+		return $this->fields;
+	}
+
+	public function jsonSerialize(): array {
+		return array_merge(
+			parent::jsonSerialize(),
+			[
+				'fields' => $this->getFields(),
+			]
+		);
+	}
+}