Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,090 of 9,090 pages
About the help in other languages
All help pages

Schritte von YAML-Migrationen

Diese Seite ist die Anleitung zu den Schritttypen von YAML-Migrationen: was die Schritttypen des Kernels tun, wie sie finden, was sie ändern, wie ein Schritt in mehreren Sprachen arbeitet, welche Schritte sich selbst…

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/guides/migrations-yaml-steps.md

On this page

This page is a translation. Read the English original

Schritte von YAML-Migrationen

Diese Seite ist die Anleitung zu den Schritttypen von YAML-Migrationen: was die Schritttypen des Kernels tun, wie sie finden, was sie ändern, wie ein Schritt in mehreren Sprachen arbeitet, welche Schritte sich selbst zurücknehmen und wie eine Erweiterung einen eigenen Schritttyp hinzufügt. Die Engine um die Schritte (Platzhalter, Bedingungen, Schleifen, die ID-Zuordnung) beschreibt das Dateiformat; jeden Schlüssel jedes Schritttyps nennt seine erzeugte Referenzseite (alle Schritttypen).

Anleitungen · Migrationen · Siehe auch: Das Tutorial, PHP-Migrationen, Zurücknehmen und Sicherungspunkte

Die Schritttypen des Kernels

SchritttypWas er tutModi
referencesetzt Referenzen für die Schritte nach ihm
assertlässt die Migration scheitern, wenn eine Bedingung falsch ist
contentlegt ein Inhaltsobjekt an, ändert, sichert oder löscht escreate, update, ensure, delete
locationfügt einen Knoten hinzu, ändert, entfernt, verschiebt, kopiert, verbirgt oder zeigt ihncreate, update, delete, move, copy, hide, unhide
content_versionstellt eine frühere Version wieder her oder entfernt alte Versionenrestore, cleanup
content_classlegt eine Klasse mit ihren Attributen an, ändert, sichert oder löscht siecreate, update, ensure, delete
content_class_grouplegt eine Klassengruppe an, benennt sie um, sichert oder löscht siecreate, update, ensure, delete
userlegt ein Benutzerkonto an, ändert, sichert oder löscht escreate, update, ensure, delete
user_grouplegt eine Benutzergruppe an, ändert, sichert oder löscht siecreate, update, ensure, delete
roleeine Rolle mit ihren Richtlinien und Einschränkungen, und ihre Zuweisungencreate, update, ensure, delete, assign, unassign
sectioneine Sektion, und ihre Zuweisung an einen Teil des Baumscreate, update, ensure, delete, assign
languagefügt eine Sprache der Inhalte hinzu, benennt sie um, sichert oder entfernt siecreate, update, ensure, delete
object_state_groupeine Objektzustandsgruppe mit ihren Zuständencreate, update, ensure, delete
tagein Tag von eztags mit seinen Übersetzungen und Synonymencreate, update, ensure, delete, move, merge
url_aliasein eigener URL-Alias eines Knotens, ein globaler URL-Alias oder ein URL-Platzhaltercreate, ensure, delete
trashverschiebt Inhalte in den Papierkorb, stellt sie wieder her, löscht sie endgültigmove, restore, purge
filehängt eine Datei aus dem Migrationsordner an ein Dateiattribut
imageein Bild aus dem Migrationsordner, sein Alternativtext, Fokuspunkt und Zuschnitt
cacheleert Caches von ezcache nach ID oder Tag und die Ansichtscaches von Objekten
searchindiziert Objekte oder alle Objekte in der Suchmaschine neureindex, full
autoloaderzeugt das Autoload-Array der Erweiterungen oder der Kernel-Überschreibungen neu
layoutein Layout von Exponential Layouts mit seinen Zonen, geteilt oder mit einem geteilten verknüpftcreate, update, ensure, delete
layout_blockein Block in einer Zone eines Layouts, mit seinen Parameterncreate, update, ensure, delete
layout_ruleeine Regel, die Seiten einem Layout zuordnetcreate, update, ensure, delete
httpeine HTTP-Anfrage an ein anderes System, Geheimnisse über ihren Namen, auf Wunsch signiert
maileine E-Mail über den Mailtransport der Installation
commandein exp:*-Konsolenbefehl aus der Positivliste, ohne Shell
schemaeine Tabelle, eine Spalte oder ein Index auf jeder Engine (SQL und Einstellungen)create_table, drop_table, add_column, drop_column, add_index, drop_index
dataZeilen einer Tabelle, die Werte von der Verbindung in Anführungszeichen gesetztinsert, ensure, update, delete
sqlAnweisungen der Engine, im Schritt oder in Dateien neben der Migration
settingseine INI-Datei von settings/override oder eines Siteaccess, mit Sicherungskopie
graphqleine Abfrage oder Mutation der GraphQL-API, im Prozess als Benutzer des Laufs
code_fileeine Code- oder Designdatei unterhalb der erlaubten Ordner, mit Sicherung und Prüfsummen (Pakete, Deploys und lange Läufe)create, update, ensure, delete

Jeder Schritt geht über die eigene API des Kernels, so wie die Administration: Ein neues Objekt entsteht über seine Klasse (eZContentClass::instantiate()), eine neue Version über createNewVersionIn(), und beide veröffentlicht die Operation publish; Orte ändern sich über die Operationen addlocation, removelocation, delete, move, hide, sort, updatepriority und updatemainassignment. So folgen URL-Aliase, Suchindex, Caches und Audit-Log einem Schritt wie einer Bearbeitung in der Administration.

Benennen, was ein Schritt ändert

Schlüssel vom Typ identifier nehmen eine ID, eine Remote-ID, einen Pfad oder einen Namen, und an ihrer Stelle einen Platzhalter:

parent: 2                          # die Knoten-ID
parent: remote:news-root           # der Knoten mit dieser Remote-ID
parent: object-remote:news-folder  # der Hauptknoten des Objekts mit dieser Remote-ID
parent: path:media/images          # der Knoten unter diesem URL-Pfad
class: article                     # eine Klasse über ihren Bezeichner (oder ihre ID, oder remote:<Remote-ID der Klasse>)
section: standard                  # eine Sektion über ihren Bezeichner oder ihre ID
tag: path:Topics/Sport             # ein Tag über seinen Schlagwortpfad (oder seine ID, oder remote:<Remote-ID des Tags>)
parent: "${idmap.node.news}"       # die ID-Zuordnung der Umgebung
parent: "${ref.news}"              # ein Wert, den ein früherer Schritt mit references: behalten hat

IDs unterscheiden sich zwischen Installationen, Remote-IDs und Pfade nicht. Geben Sie den Objekten, die eine Migration anlegt, eine remote_id, dann finden spätere Migrationen sie auf jeder Installation.

Inhalte

- type: content
  mode: ensure
  class: folder
  parent: object-remote:news-folder
  remote_id: news-archive
  language: eng-GB
  fields:
      name: Archive
      short_description: "<p>Older news.</p>"
  translations:
      ger-DE: { name: Archiv }
  references: { archive: node_id }
  • create legt ein neues Objekt an und scheitert, wenn die remote_id vergeben ist. ensure sucht das Objekt über die remote_id: Es legt es an, wenn es fehlt, und ändert sonst nur die Felder, deren Text abweicht; der Schritt kann also immer wieder laufen. update ändert ein Objekt, das object: oder node: nennt; delete entfernt es mit allen Orten (trash: true legt es in den Papierkorb).
  • fields: werden in der Sprache von language: geschrieben (Standard: die Standardsprache für Inhalte). Jeder Wert geht durch fromString() des Datentyps des Attributs, das Format des Paketimports: Text so, wie er ist, XML-Text als XML, eine Relationsliste als mit - verbundene IDs, eine Checkbox als 1 oder 0.
  • translations: hat einen Block je weiterer Sprache. Jeder Block wird als eigene Version veröffentlicht, wie es ein Übersetzer in der Administration täte; eine Sprache, die das Objekt noch nicht hat, kommt hinzu.
  • Anlegen und Ändern erzeugen eine neue Version und veröffentlichen sie. in_place: true schreibt stattdessen in die veröffentlichte Version, ohne neue Version und ohne die Workflows der Operation publish: eine Korrektur, die der Versionsverlauf nicht zeigt. Name des Objekts, Caches und Suchindex werden nachgeführt.
  • missing: skip lässt ein Ändern oder Löschen durch, wenn das Objekt nicht da ist.

Orte

- type: location
  mode: create
  object: remote:news-archive
  parent: path:frontpage
  priority: 10
  references: { archive_on_front: node_id }
- type: location
  mode: move
  node: object-remote:news-archive
  parent: path:media/archive

create fügt einen Ort hinzu (und ändert nichts, wenn das Objekt schon unter diesem Elternknoten liegt), update setzt priority, sort_field/sort_order und main, delete entfernt einen Ort (mit dem letzten geht das Objekt mit, trash: true in den Papierkorb), move und copy bringen einen Knoten unter einen anderen Elternknoten, hide und unhide verbergen oder zeigen einen Knoten mit seinem Teilbaum. copy kopiert das Objekt des Knotens (seine veröffentlichte Version, alle Sprachen).

Versionen

content_version mit mode: restore veröffentlicht eine Kopie einer früheren Version als neue Version (was „Kopieren und bearbeiten“ und Veröffentlichen im Versionsverlauf tun), mode: cleanup entfernt archivierte Versionen, sodass keep: davon bleiben, und mit drafts: true auch die Entwürfe.

Klassen und Klassengruppen

- type: content_class_group
  mode: ensure
  name: News
- type: content_class
  mode: ensure
  identifier: news_article
  language: eng-GB
  name: News article
  names: { ger-DE: Nachrichtenartikel }
  name_pattern: "<title>"
  groups: [ News ]
  attributes:
    - { identifier: title, type: ezstring, name: Title, names: { ger-DE: Titel }, required: true, settings: { data_int1: 255 } }
    - { identifier: body, type: ezxmltext, name: Body }

Eine Klasse entsteht mit ihren Namen in jeder Sprache (name: in der Sprache von language:, names: für die anderen), ihren Gruppen (über den Namen) und ihren Attributen. Ein Attribut nennt seinen Datentyp (type:), seine Namen und Beschreibungen, die Schalter required, searchable, translatable und information_collector, eine category, eine placement und seine Datentyp-Einstellungen in den Spalten, in denen die Klassenbearbeitung des Datentyps sie speichert (settings: { data_int1: 255 }: data_int1 bis data_int4, data_float1 bis data_float4, data_text1 bis data_text5; die Referenz jedes Datentyps sagt, welche Spalte was hält). ensure legt eine fehlende Klasse an und ergänzt sonst die fehlenden Attribute und ändert, was abweicht; update ändert eine Klasse mit add_attributes:, update_attributes: (über den Bezeichner) und remove_attributes:. Ein Attribut wird so hinzugefügt, wie der Setup-Assistent eines hinzufügt (eZSiteInstaller::addClassAttributes()): Jedes Objekt der Klasse bekommt es in jeder seiner Versionen und Sprachen. Ein entferntes Attribut nimmt seine Daten in jedem Objekt mit. Ein Datentyp lässt sich nicht ändern; entfernen Sie das Attribut und fügen Sie ein neues hinzu. Eine Klasse mit Objekten wird nur mit with_objects: true gelöscht, und ihre Objekte mit ihr.

Benutzer, Gruppen und Rollen

- type: user_group
  mode: ensure
  parent: 5
  remote_id: news-editors
  name: News editors
  references: { editors: node_id }
- type: user
  mode: ensure
  login: editor
  email: [email protected]
  password: "${ref.editor_password}"
  groups: [ "${ref.editors}" ]
  fields: { first_name: News, last_name: Editor }
- type: role
  mode: ensure
  name: News editor
  policies:
    - { module: content, function: read }
    - { module: content, function: edit, limitations: { Class: [ news_article ], Subtree: [ "path:news" ] } }
- type: role
  mode: assign
  role: News editor
  groups: [ "remote:news-editors" ]
  subtree: "path:news"

Eine Benutzergruppe ist ein Inhaltsobjekt der Klasse user_group, also legt user_group sie an, übersetzt und löscht sie so wie content. Ein Benutzer ist ein Objekt der Klasse user in einer oder mehreren Gruppen (groups: nennt ihre Knoten, die erste ist der Hauptort); sein Konto entsteht aus login: und email:, sein Passwort wird gehasht, wie der Kernel es hasht. Schreiben Sie nie ein Passwort in eine Migrationsdatei: Nehmen Sie es aus einer Referenz oder der Umgebung, oder geben Sie einen vorhandenen Hash mit password_hash: und password_hash_type:. Kein Plan, kein Log und keine Aufzeichnung zeigt ein Passwort. ensure lässt das Passwort eines vorhandenen Kontos unverändert.

Richtlinien werden geschrieben wie in der Administration, und ihre Einschränkungswerte dürfen das, worauf sie einschränken, so nennen wie der Rest der Migration: Class und ParentClass nehmen Klassenbezeichner, Section und UserSection Sektionsbezeichner, Node Knotenbezeichner, Subtree und UserSubtree Knotenbezeichner (gespeichert als Pfad des Knotens), SiteAccess Siteaccess-Namen, StateGroup_<Gruppe> Zustandsbezeichner. mode: assign gibt die Rolle Benutzern (users:, über das Login) und Gruppen (groups:, Objektbezeichner), eingeschränkt auf einen Teilbaum, eine Sektion oder gar nicht; mode: unassign nimmt sie zurück.

Sektionen, Sprachen und Objektzustände

section legt eine Sektion an (identifier, name, navigation_part) und weist sie mit mode: assign dem Objekt eines Knotens zu und, nach scope:, den Objekten darunter (subtree), nur denen, die dieselbe Sektion hatten (inherited), oder nur dem Objekt (object), so wie section/assign in der Administration. language fügt eine Sprache der Inhalte hinzu (das Locale muss eines sein, das die Installation kennt); welche Sprachen ein Siteaccess zeigt, bleibt eine Einstellung. Eine Sektion oder Sprache in Gebrauch wird nicht gelöscht. object_state_group legt eine Gruppe mit ihren Zuständen und deren Namen in jeder Sprache an; der erste Zustand ist der Zustand jedes Objekts, und die Objekte eines entfernten Zustands bekommen den ersten verbleibenden. Die Gruppen des Kernels (ez_lock und die anderen Bezeichner, die mit ez beginnen) werden nicht geändert.

Tags, URL-Aliase und der Papierkorb

tag braucht die Erweiterung eztags; ohne sie scheitert ein Tag-Schritt und sagt das, und missing: skip lässt ihn durch. Ein Tag wird über seine ID, remote:<Remote-ID> oder path:<Schlagwortpfad> genannt (die Schlagwörter von oben, path:Topics/Sport). Ein neuer Tag bekommt sein Schlagwort in der Sprache von language: (seiner Hauptsprache) und weitere Übersetzungen in keywords:; synonyms: ergänzt die fehlenden Schlagwörter als Synonyme. ensure findet den Tag über remote_id oder über sein Schlagwort unterhalb von parent:. move setzt ihn (mit seinen Synonymen und den Tags unter ihm) unter einen anderen übergeordneten Tag, merge gibt seine Objekte, Kinder und Synonyme an into: ab und entfernt ihn, delete entfernt ihn mit allem unter ihm. Jede Änderung geschieht so, wie die Tag-Seiten von eztags sie machen.

- type: tag
  mode: ensure
  parent: "path:Topics"
  remote_id: topic-sport
  keyword: Sport
  keywords: { ger-DE: Sport }
  synonyms: [ Sports ]

url_alias schreibt die eigenen Adressen der URL-Alias-Seiten der Administration: path: (die Adresse ab der Wurzel) führt zu einem Knoten (node:) oder zu einer Modul-URL oder einer anderen Adresse (destination:); redirect: false zeigt die Seite unter dem Alias, statt auf ihre eigene Adresse weiterzuleiten, below_parent: true legt den Alias unter die Adresse des übergeordneten Knotens, wie es die Administration macht. wildcard: mit destination: schreibt einen URL-Platzhalter (old-news/* nach news/{1}). mode: delete entfernt eine Adresse (path:), jede eigene Adresse eines Knotens (node: mit which: all) oder einen Platzhalter. Die Adresse, die ein Knoten aus seinem Namen hat, folgt dem Namen und wird vom Schritt nie gelöscht.

trash verschiebt ein Objekt mit allen seinen Orten in den Papierkorb (mode: move, über object: oder node:), stellt es unter seinem früheren übergeordneten Knoten oder unter parent: wieder her (mode: restore) und löscht es endgültig (mode: purge, oder all: true leert den ganzen Papierkorb). Jeder Modus prüft danach, dass das Objekt dort ist, wohin der Schritt es gebracht hat.

Dateien und Bilder

file und image lesen eine Datei neben der Migration: file: ist ein Pfad unterhalb des Ordners der Migrationsdatei, nie .., ein absoluter Pfad, eine URL oder ein Link aus dem Ordner hinaus. Legen Sie die Dateien mit der Migration, die sie braucht, in das Migrations-Repository:

- type: file
  object: remote:annual-report
  field: file
  file: files/annual-report-2026.pdf
  name: Annual report 2026.pdf
- type: image
  object: remote:news-welcome
  field: image
  file: images/welcome.jpg
  alt: The team at the opening
  focal: { x: 0.3, y: 0.4 }
  crop: { x: 0, y: 0.1, width: 1, height: 0.8 }

file schreibt ein Attribut ezbinaryfile oder ezmedia, image ein Attribut ezimage; wie bei einer Inhaltsänderung ist das eine neue Version, die über die Veröffentlichungsoperation veröffentlicht wird, oder in_place: true. focal: und crop: setzen Fokuspunkt und Zuschnitt des Bildes wie der Bildeditor (Anteile von Breite und Höhe des Originals); null entfernt einen davon, und ein Schritt nur mit focal: oder crop: behält das Bild.

Caches, der Suchindex und Autoloads

Ein Lauf leert die Caches, die seine Migrationen berührt haben, und nur diese: Jeder Schritttyp nennt die Caches, die seine Schritte berühren (ein Inhaltsschritt content, ein Klassenschritt classid, content und sortkey, ein URL-Alias content und urlalias ...; jede Referenzseite listet sie), und nach einem Lauf, der Migrationen angewendet hat, oder einem Zurücknehmen, das welche rückgängig gemacht hat, leert der Kernel diese Liste einmal über ezcache (migration.ini [RunSettings] ClearCaches). Der Bericht des Laufs listet die Caches (caches) mit dem Deploy, das genau sie auch auf einem Server mit PHP-FPM und Velocity leert (deploy):

./console exp:velocity deploy --caches=classid,content,template-block,urlalias --apply

Auch die Objekte, die die Schritte angelegt oder geändert haben, werden nach dem Lauf neu indiziert: standardmäßig für den Cronjob indexcontent vorgemerkt ([RunSettings] Reindex=queue), sofort indiziert (now) oder nicht angefasst (disabled). Der Bericht sagt, wie viele (reindex).

Drei Schritttypen sind für das, was die genannten Caches und das Neuindizieren nicht abdecken:

- type: cache
  caches: [ template-block ]        # IDs von ezcache
  tags: [ ini ]                     # Tags von ezcache (jeder Cache mit dem Tag)
  objects: [ "remote:home" ]        # die Inhaltsansichtscaches dieser Objekte, sofort
  when: now                         # end (Standard): mit der Liste des Laufs nach dem Lauf
- type: search
  objects: [ "remote:home" ]        # ohne: die Objekte, die der Lauf bis hierher geändert hat
  queue: false                      # sofort indizieren statt vormerken
- type: search
  mode: full                        # jedes veröffentlichte Objekt ...
  classes: [ article ]              # ... dieser Klassen
- type: autoload
  scope: extension                  # var/autoload/ezp_extension.php; kernel-override: ezp_override.php

Die Caches eines cache-Schritts kommen in die Liste des Laufs (ein Tag als tag:<Name>, denn content, template und ini sind ID und Tag zugleich); mit when: now werden sie sofort geleert, für einen späteren Schritt, der das braucht. search indiziert Objekte neu, die ein Schritt geändert hat, ohne es zu sagen (eine PHP-Migration, eine SQL-Änderung), oder alles nach einem Wechsel der Suchmaschine. autoload startet den Autoload-Generator in einem eigenen Prozess und prüft die Datei, die er schreibt; PHP-FPM und Velocity laden die neuen Klassen nach ./console exp:velocity deploy --apply. Das eigene Autoload-Array des Kernels gehört zum Code eines Releases und wird nie von einer Migration geschrieben. Alle drei nehmen sich selbst zurück: Ein Zurücknehmen leert die Caches erneut, braucht keine eigene Indexänderung und erzeugt das Array aus den Klassen, die da sind, neu.

Layouts

layout, layout_block und layout_rule ändern Exponential Layouts (die Erweiterungen explayouts und explayouts_core) über seine Dienste, so wie der Layout-Editor: Eine Änderung geschieht im Entwurf des Layouts, und der Entwurf wird am Ende des Schritts veröffentlicht (publish: false lässt ihn der Redaktion zum Ansehen). Ohne die Erweiterungen scheitern die Schritte und sagen es; missing: skip lässt sie durch.

- type: layout
  mode: ensure
  identifier: header_footer
  name: Header / Footer
  shared: true                         # andere Layouts können die Blöcke seiner Zonen übernehmen
  zones: { header: {}, footer: {} }
- type: layout
  mode: ensure
  identifier: landing_page
  name: Landing page
  layout_type: layout_2                # die Zonen des Typs werden hinzugefügt
  zones:
    header: { link: "header_footer/header" }   # die Blöcke der Zone header des geteilten Layouts
    main: {}
- type: layout_block
  mode: ensure
  layout: landing_page
  zone: main
  name: Welcome                        # wie der Schritt den Block in der Zone findet
  definition: title
  view_type: title
  parameters: { title: Welcome, tag: h1 }
- type: layout_rule
  mode: ensure
  layout: landing_page
  targets: [ { type: node, value: "remote:landing" } ]   # node und subtree nehmen jeden Bezeichner eines Knotens
  conditions: [ { type: siteaccess, value: site } ]
  priority: 50

Ein Layout wird über seinen Bezeichner genannt, ein Block über seinen Namen in einer Zone (Namen in einer Zone müssen sich unterscheiden), eine Regel über ihr Layout und ihre Ziele. Eine Zone, die mit einem geteilten Layout verknüpft ist, hat keine eigenen Blöcke: Ändern Sie sie im geteilten Layout. { link: none } gibt einer Zone wieder eigene Blöcke. Ein Anlegen jedes der drei nimmt sich beim Zurücknehmen ohne down: selbst zurück; die Schritte nennen die Caches content und template-block, und die Dienste leeren den eigenen Cache des Layout-Resolvers.

HTTP-Anfragen, E-Mails und Konsolenbefehle

Drei Schritttypen reichen aus der Installation hinaus. Keiner sendet, mailt oder führt in einem Probelauf etwas aus, jeder wird im Prüfprotokoll festgehalten (system.migration.http, system.migration.mail, system.migration.command), und keiner lässt sich zurücknehmen: Eine Migration mit einem davon braucht down: (das die Anfrage senden kann, die es rückgängig macht) oder eine Rücknahme auf ihren Sicherungspunkt.

- type: http
  method: POST
  url: https://cdn.example.com/purge
  bearer: cdn.token                    # der Name eines Geheimnisses (Setup > Geheimnisse, oder env:VARIABLE)
  secret_headers: { X-Api-Key: cdn.api_key }
  json: { paths: [ "/news/*" ] }
  sign: migration.webhook              # signiert, wie Webhooks von Exponential signiert werden
  expect: [ 200, 202 ]
  references: { purge_status: status } # status, body, json
- type: mail
  to: [ [email protected] ]
  subject: The news section has a teaser image now
  body: From today on, news items have a teaser image.
- type: command
  command: exp:services:compile        # ein exp:*-Befehl aus [StepSettings] CommandAllowList[]
  arguments: [ --quiet ]

Geheimnisse werden genannt, nie in die Migration oder ihr Protokoll geschrieben; eine URL mit Benutzer oder Passwort wird abgelehnt, keiner Weiterleitung wird gefolgt, und Protokoll und Prüfprotokoll zeigen die URL ohne ihre Abfrage. Eine E-Mail geht über den Mailtransport der Installation (transport: file schreibt sie stattdessen unter var/log/mail), also gelten das Mail-Gate und die Mail-Einstellungen; sie trägt die E-Mail-Kategorie admin (notwendig, wird wie bisher gesendet), außer category: nennt eine andere, und eine optionale Kategorie erreicht nur die Empfänger, deren E-Mail-Einstellungen es erlauben. command führt nur die exp:*-Befehle aus migration.ini [StepSettings] CommandAllowList[] aus (ein Name, oder ein Name mit * am Ende für eine Gruppe), nie exp:migration:* oder exp:upgrade*, und übergibt Befehl und Argumente PHP als Liste: Es gibt keine Shell, also ist ein ; oder ein $ in einem Argument ein Zeichen.

GraphQL-Abfragen und -Mutationen

graphql führt eine Abfrage oder Mutation der GraphQL-API der Installation im Prozess aus, als der Benutzer, als der die Migration läuft: keine HTTP-Anfrage, kein Token, kein Netz. Geben Sie genau eines von persisted (eine gespeicherte Abfrage über Name oder SHA-256), query (der Text) oder file (eine .graphql-Datei neben der Migration) an. Ihre Antwort bleibt für Referenzen: data, result (der Wert des ersten Wurzelfelds) und errors.

- type: graphql
  persisted: news-root                 # gespeichert mit ./console exp:graphql:persist
  variables: { id: 2 }
  references: { root: result }
- type: graphql
  query: |
    mutation New($parent: Int!, $name: String) {
      createContent(parentId: $parent, classIdentifier: "folder", fields: [ { identifier: "name", value: $name } ]) { contentId nodeId }
    }
  variables: { parent: 2, name: "Below ${ref.root.name}" }
  references: { folder: result }       # ${ref.folder.nodeId}

Eine Antwort mit Fehlern lässt den Schritt scheitern (allow_errors: true lässt ihn bestehen, wenn sie Daten hat). Eine Mutation braucht graphql.ini [GraphQLSettings] MutationsEnabled=enabled und prüft die Rechte des Benutzers wie für jeden Client; ihre Änderungen gehören zur Transaktion der Migration und werden von down: oder der Rücknahme zum Sicherungspunkt zurückgenommen, nie vom Schritt selbst. In einem Probelauf läuft nichts. Ohne webonyx/graphql-php scheitert der Schritt und sagt es. Die Inhaltsereignisse einer Migration gehen mit ihr gekennzeichnet in das Ereignisjournal; der Kopf events: (each, summary, none) entscheidet, wie viele (das Dateiformat).

Workflows und Benachrichtigungen

Ein Schritt führt die Operation ohne die Workflows ihres Auslösers aus und veröffentlicht ohne Benachrichtigungsereignis: Eine Migration soll keine Mails senden und auf keine Freigabe warten. workflows: true führt die Workflows aus workflow.ini aus wie die Administration, notify: true erzeugt das Benachrichtigungsereignis. Ein Workflow, der die Operation abbricht oder aufschiebt, lässt den Schritt scheitern.

Eine Migration zurücknehmen

Eine Migration ohne down: lässt sich von selbst zurücknehmen, wenn jeder ihrer Schritte das kann:

SchrittNimmt sich selbst zurück
content create mit remote_iddas Objekt wird wieder entfernt
location createder Ort wird wieder entfernt
location hide / unhideder Knoten wird wieder gezeigt / verborgen
content_class, content_class_group, section, language, object_state_group, role, user createwird wieder entfernt (eine Klasse nur, solange sie keine Objekte hat, eine Sektion oder Sprache nur, solange sie unbenutzt ist)
user_group create mit remote_iddie Gruppe wird wieder entfernt
role assign / unassigndie Zuweisung wird zurückgenommen / wieder vorgenommen
tag createder Tag wird wieder entfernt, solange kein Objekt ihn nutzt
url_alias createdie Adresse oder der Platzhalter wird wieder entfernt, solange sie dorthin führen, wohin der Schritt sie gesetzt hat
trash move (über object:) / restoredas Objekt wird wiederhergestellt, wo es war / wieder in den Papierkorb verschoben
code_file (jeder Modus)die alte Datei wird zurückgelegt oder die neue entfernt, solange die Datei noch die ist, die die Migration geschrieben hat
reference, assertnichts zurückzunehmen

Jeder andere Schritt (ein Ändern, ein ensure, ein Löschen, ein Verschieben, eine Sektionszuweisung ...) kann nicht wissen, was vorher da war: Geben Sie der Migration eine down:-Liste, oder setzen Sie den Lauf auf den Sicherungspunkt vor ihm zurück. exp:migration:rollback lehnt eine Migration ab, die sich nicht zurücknehmen lässt, und sagt es.

Transaktionen

Der Runner führt jede Migration in einer Transaktion aus, wo die Engine welche hat (PostgreSQL, SQLite, und MySQL/MariaDB für Migrationen ohne Schemaänderungen); ein Schritt, der scheitert, rollt die ganze Migration zurück, samt den Objekten, die ihre früheren Schritte angelegt haben. MongoDB hat keine Transaktionen: Eine gescheiterte Migration lässt stehen, was ihre früheren Schritte getan haben, und der Sicherungspunkt vor dem Lauf ist der Weg zurück.

Ein eigener Schritttyp

Eine Erweiterung fügt einen Schritttyp mit einer Klasse und einer Zeile Einstellungen hinzu:

# extension/news/settings/migration.ini.append.php
[StepSettings]
StepTypeList[news_import]=expNewsImportStep

Die Klasse erweitert expMigrationStepTypeBase und schreibt name(), schema() und apply(); validate(), caches() und plan() haben Vorgaben. schema() nennt die Modi, die Schlüssel mit ihren Typen, die Werte, die references: nehmen kann, und ein Beispiel; die Engine prüft jeden Schritt daran, bevor etwas läuft. Ein Typ, der seine Schritte zurücknehmen kann, implementiert expMigrationRevertibleStepType (revert()), einer, der nur manche zurücknehmen kann, expMigrationPartlyRevertibleStepType (revertible() sagt, welche). ./console exp:help:examples --area=migration-steps erzeugt seine Referenzseite.

Weiterlesen

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x