data
Inserts, updates or deletes rows of a table on every engine, the values quoted by the connection.
A step of a YAML migration with type: data. The class expMigrationStepData (kernel/classes/migration/steps/expmigrationstepdata.php) is registered in settings/migration.ini [StepSettings] StepTypeList[data].
Modes
mode: is one of insert, ensure, update, delete; every step names one.
Keys
| Key | Type | Modes | Default | What it is |
|---|---|---|---|---|
table | string | all | required | the table (a collection on MongoDB) |
rows | list | insert, ensure | required | the rows, each column => value |
key | list | ensure | required | the columns that find a row |
id_column | string | insert, ensure | the auto_increment column; its value of the last row inserted is the result's id | |
where | map | update, delete | column => value (a list: one of them; null: is null) | |
values | map | update | required | column => new value |
all | bool | update, delete | false | true: every row, without where |
Besides these, every step takes the keys of the engine: type, mode, if, references, environments, engines and comment (the file format). A key of type identifier names a node, an object or another part of the installation by id, remote id, path or name (identifiers).
Values for references
references: { <name>: <value> } keeps a value of the step's result as ${ref.<name>} for the steps and migrations after it:
| Value | What it is |
|---|---|
count | how many rows were inserted, updated or deleted |
id | insert, ensure: the id_column of the last row inserted (null when none was) |
Undoing
A step of this type does not undo itself: a migration with it needs down: or a rollback to its caption.
It touches no cache.
Example
- type: data
mode: ensure
table: ezsite_data
key: [ name ]
rows:
- { name: news_list_limit, value: "20" }Related
Generated by ./console exp:help:examples from settings/migration.ini, kernel/classes/migration/steps/expmigrationstepdata.php. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.