← Cloudflare Durable Objects / durable-objects / reference

Migrace tříd Durable Object (zastaralé)

Migrace je proces mapování názvu třídy na stav za běhu. Tento proces sdělí změny běhovému prostředí Workers a poskytne mu instrukce, jak s těmito změnami naložit.

Chcete-li použít migraci, je potřeba:

1. Upravte konfigurační soubor Wrangler (viz Konfigurace migrace Wrangler).
2. Worker opětovně nasaďte pomocí npx wrangler deploy.

Proces migrace musíte zahájit, pokud:

• Vytvořte nový Třída Durable Object.
• Přejmenování třídy Durable Object.
• Odstraňte třídu Durable Object.
• Přenos existující třídy Durable Objects.

Nejběžnější je migrace typu nová třída, která runtime informuje, že se nahrává nová třída Durable Objects. Tuto migraci potřebujete i při vytváření vaší první třídy Durable Object.

Chcete-li použít migraci Create:

{
	// Creating a new Durable Object class
	"durable_objects": {
		"bindings": [
			{
				"name": "DURABLE_OBJECT_A",
				"class_name": "DurableObjectAClass"
			}
		]
	},
	// Add the lines below for a Create migration.
	"migrations": [
		{
			"tag": "v1",
			"new_sqlite_classes": [
				"DurableObjectAClass"
			]
		}
	]
}

[[durable_objects.bindings]]
name = "DURABLE_OBJECT_A"
class_name = "DurableObjectAClass"

[[migrations]]
tag = "v1"
new_sqlite_classes = [ "DurableObjectAClass" ]

Použijte new_classes u migrace v souboru Wrangler vašeho Workeru, čímž vytvoříte třídu Durable Object s úložištěm typu klíč-hodnota:

{
	"migrations": [
		{
			"tag": "v1", // Should be unique for each entry
			"new_classes": [
				// Array of new classes
				"MyDurableObject",
			],
		},
	],
}

[[migrations]]
tag = "v1"
new_classes = [ "MyDurableObject" ]

Spuštění migrace Delete odstraní všechny objekty Durable Objects přiřazené k odstraněné třídě, včetně veškerých uložených dat.

• Nespouštějte migraci pro odstranění třídy, aniž byste si nejprve ověřili, že se na Durable Objects v daném Workeru už nikde nespoléháte, tedy nejprve odstraňte binding z Workeru.
• Před odstraněním zkopírujte veškerá důležitá data na jiné místo.
• U třídy, která byla přejmenována nebo přenesena, není nutné spouštět migraci Delete.

Chcete-li použít migraci Delete:

{
	// Remove the binding for the DeprecatedObjectClass DO
	// {"durable_objects": {"bindings": [
	//   {
	//     "name": "DEPRECATED_OBJECT",
	//     "class_name": "DeprecatedObjectClass"
	//   }
	// ]}}
	"migrations": [
		{
			"tag": "v3", // Should be unique for each entry
			"deleted_classes": [ // Array of deleted classes
				"DeprecatedObjectClass"
			]
		}
	]
}

[[migrations]]
tag = "v3"
deleted_classes = [ "DeprecatedObjectClass" ]

Migrace přejmenování slouží k přesunu uložených Durable Objects mezi dvěma třídami Durable Object v rámci stejného souboru s kódem Workeru.

Chcete-li použít migraci Rename:

{
	"durable_objects": {
		"bindings": [
			{
				"name": "MY_DURABLE_OBJECT",
				// Update the binding to the new class name.
				"class_name": "UpdatedName"
			}
		]
	},
	// Renaming classes
	"migrations": [
		{
			"tag": "v3",
			"renamed_classes": [ // Array of rename directives
				{
					"from": "OldName",
					"to": "UpdatedName"
				}
			]
		}
	]
}

[[durable_objects.bindings]]
name = "MY_DURABLE_OBJECT"
class_name = "UpdatedName"

[[migrations]]
tag = "v3"

  [[migrations.renamed_classes]]
  from = "OldName"
  to = "UpdatedName"

Migrace Transfer slouží k přenosu uložených Durable Objects mezi dvěma třídami Durable Object v různých souborech kódu Workeru.

Pokud chcete přenést uložené Durable Objects mezi dvěma třídami Durable Object ve stejném souboru kódu Worker, použijte Migrace přejmenování místo toho.

Chcete-li použít migraci Transfer:

{
	// destination worker
	"durable_objects": {
		"bindings": [
			{
				"name": "MY_DURABLE_OBJECT",
				"class_name": "TransferredClass"
			}
		]
	},
	// Transferring class
	"migrations": [
		{
			"tag": "v4",
			"transferred_classes": [
				{
					"from": "DurableObjectExample",
					"from_script": "OldWorkerScript",
					"to": "TransferredClass"
				}
			]
		}
	]
}

[[durable_objects.bindings]]
name = "MY_DURABLE_OBJECT"
class_name = "TransferredClass"

[[migrations]]
tag = "v4"

  [[migrations.transferred_classes]]
  from = "DurableObjectExample"
  from_script = "OldWorkerScript"
  to = "TransferredClass"

• Migrace se provádějí prostřednictvím [[migrations]] klíč configurations ve vašem wrangler.toml soubor nebo migrations klíč ve vašem wrangler.jsonc .

• Migrace vyžadují migrační značku, která se definuje pomocí tag vlastnost v každé položce migrace.

• Migrační značky fungují jako jedinečné názvy a určují, které migrace už byly použity. Jakmile má daný kód Workeru migrační značku nastavenou, musí ji obsahovat i všechna jeho budoucí nasazení.

• Seznam migrací je seřazené pole tabulek, které se zadává jako klíč v konfiguračním souboru Wrangler.

• Migraci můžete definovat pro každé prostředí i na nejvyšší úrovni.

  • Migrace na nejvyšší úrovni se zadává na nejvyšší úrovni migrations klíč v konfiguračním souboru Wrangleru.
  • Migrace na úrovni prostředí se zadává pomocí migrations klíč uvnitř env klíč konfiguračního souboru Wrangleru ([env.<environment_name>.migrations]).
    • Příklad souboru Wrangler:
    wrangler.jsonc

    {
      // top-level default migrations
      "migrations": [
        { "tag": "v1", "new_sqlite_classes": ["MyDurableObject"] },
      ],
      "env": {
        "staging": {
          // migration override for staging
          "migrations": [
            { "tag": "v1-staging", "new_sqlite_classes": ["MyDurableObject"] },
          ],
        },
      },
    }

  • Pokud je migrace zadána pouze na nejvyšší úrovni, a ne na úrovni prostředí, prostředí migraci z nejvyšší úrovně zdědí.
  • Migrace na úrovni prostředí mají přednost před migracemi na nejvyšší úrovni.

• Všechny migrace se použijí při nasazení. Každou migraci lze použít jen jednou na prostředí.

• Každá migrace v seznamu může obsahovat více direktiv a s tím, jak projekt roste na složitosti, lze zadat i více migrací.

Úložiště typu SQLite nelze povolit u existující, již nasazené třídy Durable Object, proto nastavení new_sqlite_classes u pozdějších migrací selže s chybou. Automatická migrace nasazených tříd z úložiště typu klíč-hodnota na úložiště SQLite bude k dispozici později.