Skip to content
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

Add new command reference #10775 #289

Merged
merged 5 commits into from
Jun 13, 2024
Merged

Add new command reference #10775 #289

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
39b1099
Add new command
RCheesley Apr 16, 2024
4193d83
Merge branch '5.x' into 10775
RCheesley Apr 17, 2024
0d318bb
Add clarification per review comments
RCheesley Apr 17, 2024
12fc488
Merge branch '10775' of https://github.com/RCheesley/user-documentati…
RCheesley Apr 17, 2024
3b667f4
Merge branch '5.x' into 10775
RCheesley Jun 13, 2024
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
3 changes: 3 additions & 0 deletions docs/configuration/command_line_interface.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,9 @@ These are the commands you may need to use in relation to your Mautic instance.
* - ``messenger:consume email``
- Processes mail queue
-
* - ``mautic:fields:analse``
- Analyze Custom Fields table and return table or file with results. See :doc:`/contacts/custom_fields`.
-
* - ``mautic:import``
- If the CSV import is configured to run in background then this command will pick up the pending import jobs and imports the data from CSV files to Mautic.
-
Expand Down
21 changes: 21 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 @@ -105,3 +105,24 @@
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.

Analyzing Custom Fields to optimize tables
******************************************

Since Mautic 5.1 there is a command which allows you to analyze the Custom Fields and optimize the tables. This command is useful when you have a lot of Custom Fields and you want to optimize the size of VARCHAR fields.

Using this command allows you to optimize the VARCHAR columns so that you can create more Custom Fields if you hit the hard limit on the Leads table and can't create more.

Check warning on line 114 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 'Contacts' instead of 'Leads'.

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

Use the command:

.. code-block:: bash

bin/console mautic:fields:analyse -t

Use the -t argument to see the output in tabulated form in the console.

Check warning on line 122 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 'Form' instead of 'form'.

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

Use the following to export the data to a file:

.. code-block:: bash

bin/console mautic:fields:analyse > path/to/file.csv
Loading