Skip to content

Documenting the custom field delete command #352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RCheesley merged 2 commits into from
Jun 5, 2025
Merged

Documenting the custom field delete command #352

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9b85be
Documenting the custom field delete command
escopecz Mar 7, 2025
818c134
wording improvement
escopecz Mar 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/configuration/command_line_interface.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,10 @@ These are the commands you may need to use in relation to your Mautic instance.
- Processes exports of Contacts to a CSV file and sends the results via Email.
-
* - ``mautic:custom-field:create-column``
- Creates the actual column in the table
- Creates the actual column in the table if the `create_custom_field_in_background` config option is set to true.
-
* - ``mautic:custom-field:delete-column``
- Deletes the actual column in the table if the `create_custom_field_in_background` config option is set to true.
-
* - ``mautic:email:fetch``
- Fetch and process monitored Email.
Expand Down
1 change: 1 addition & 0 deletions docs/configuration/cron_jobs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ Custom Field cron jobs
.. code-block:: php

php /path/to/mautic/bin/console mautic:custom-field:create-column
php /path/to/mautic/bin/console mautic:custom-field:delete-column

Optional
********
Expand Down
2 changes: 2 additions & 0 deletions docs/contacts/custom_fields.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,8 @@

If you configure this option, the new Custom Field becomes visible in the list of Custom Fields. The Custom Field remains unpublished until you run the command ``bin/console mautic:custom-field:create-column``. This command creates the actual column in the table and publishes the field metadata.

Similarly, the ``bin/console mautic:custom-field:delete-column`` command deletes the actual column in the table if you have turned on the ``create_custom_field_in_background`` config option. The column gets soft-deleted and removed from the user interface, but the data is still present in the database until you run the command to delete the column.

Check warning on line 105 in docs/contacts/custom_fields.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'User' instead of 'user'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'User' instead of 'user'.", "location": {"path": "docs/contacts/custom_fields.rst", "range": {"start": {"line": 105, "column": 242}}}, "severity": "INFO"}

This configuration helps prevent **http** request timeouts because it handles the long-running SQL query to create the new table column as a background task.

To mitigate the table lock issue, run the command only once daily when you know that most of your audience is offline. With less traffic going into Mautic, the chances of encountering a problem are lower.
Expand Down
Loading