From 78910af913c19a7cb9239c7d20643744da12ae75 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Tue, 11 Jun 2019 19:08:24 +0200 Subject: [PATCH] documentation for chill:person:move command --- source/bundles/person.rst | 45 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 44 insertions(+), 1 deletion(-) diff --git a/source/bundles/person.rst b/source/bundles/person.rst index 676dbd6cc..0a5640bd4 100644 --- a/source/bundles/person.rst +++ b/source/bundles/person.rst @@ -180,4 +180,47 @@ The bundle provide a way to add a list of accompanyied person on the homepage: # when the view is overriden, you can add some custom fields # to the view custom_fields: [school-2fb5440e-192c-11e6-b2fd-74d02b0c9b55] - + +Commands +******** + + +:code:`chill:person:move` +========================= + +.. code-block:: txt + + Usage: + chill:person:move [options] + + Options: + -f, --from=FROM The person id to delete, all associated data will be moved before + -t, --to=TO The person id which will received data + --dump-sql dump sql to stdout + --force execute sql instead of dumping it + -h, --help Display this help message + -q, --quiet Do not output any message + -V, --version Display this application version + --ansi Force ANSI output + --no-ansi Disable ANSI output + -n, --no-interaction Do not ask any interactive question + -e, --env=ENV The Environment name. [default: "dev"] + --no-debug Switches off debug mode. + -v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug + + Help: + Move all the associated entities on a "from" person to a "to" person and remove the old person + +Move all the entities associated to a person onto another one, and remove the old person. + +.. warning:: + + Some entities are ignored and will be deleted: + + - the accompanying periods ; + - the data attached to a person entity: name, address, date of birth, etc. Thos should be merge before the move. + +It is advised to run first the command with the :code:`dump-sql` option and, then, use the :code:`force` option. + + +