Zymonic Toolkit Data: Difference between revisions
Content added Content deleted
(Added data) |
(Added link to the system toolkit man page from ztsm (via mq2's public link)) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 3: | Line 3: | ||
sudo zymonic_toolkit.pl Data |
sudo zymonic_toolkit.pl Data |
||
</pre> |
</pre> |
||
See the [https://mq2-public.zednax.com/man/ztsm/Toolkit/Data.html manual page for the data toolkit] for further details. |
|||
| Line 14: | Line 16: | ||
<li> |
<li> |
||
==Table ZName== |
==Table ZName== |
||
The ZName of the table. |
The ZName of the table, or all tables if left empty. |
||
<pre> |
<pre> |
||
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --table ZNAME |
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --table ZNAME |
||
| Line 22: | Line 24: | ||
<li> |
<li> |
||
==Field ZName== |
==Field ZName== |
||
The ZName of the field. |
The ZName of the field, or all fields present on each table if left empty. |
||
<pre> |
<pre> |
||
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --field ZNAME |
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --field ZNAME |
||
| Line 30: | Line 32: | ||
<li> |
<li> |
||
==System== |
==System== |
||
The system to be inspected. This is required for the command to work. |
The system to be inspected. This parameter is required for the command to work. |
||
<pre> |
<pre> |
||
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --system SYSTEM |
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --system SYSTEM |
||
| Line 38: | Line 40: | ||
<li> |
<li> |
||
==End Page== |
==End Page== |
||
Last page to process (50 records per page) |
Last page to process (50 records per page). |
||
<pre> |
<pre> |
||
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --end_page PAGE |
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --end_page PAGE |
||
| Line 46: | Line 48: | ||
<li> |
<li> |
||
==Start Page== |
==Start Page== |
||
First page to process (50 records per page) |
First page to process (50 records per page). |
||
<pre> |
<pre> |
||
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --start_page PAGE |
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --start_page PAGE |
||
| Line 63: | Line 65: | ||
<li> |
<li> |
||
==System== |
==System== |
||
The system to be inspected. This is required for the command to work. |
The system to be inspected. This parameter is required for the command to work. |
||
<pre> |
<pre> |
||
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --system SYSTEM |
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --system SYSTEM |
||
| Line 71: | Line 73: | ||
<li> |
<li> |
||
==Table ZNames== |
==Table ZNames== |
||
Comma separated list of ZNames of the tables, or all tables |
Comma separated list of ZNames of the tables, or '*' for all tables. This parameter is required for the command to work. |
||
<pre> |
<pre> |
||
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --tables ZNAME1,ZNAME2,ZNAME3 |
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --tables ZNAME1,ZNAME2,ZNAME3 |
||
| Line 79: | Line 81: | ||
<li> |
<li> |
||
==Username== |
==Username== |
||
The name of the user with which to get auth for sql database changes |
The name of the user with which to get auth for sql database changes. This parameter is required for the command to work. |
||
<pre> |
<pre> |
||
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --user USERNAME |
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --user USERNAME |
||
</pre> |
|||
</li> |
|||
<li> |
|||
==Password== |
|||
The password of the user with which to get auth for sql database changes. Use '!' to capture from standard input instead without displaying the password in the shell. This parameter is required for the command to work. |
|||
<pre> |
|||
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --password PASSWORD |
|||
</pre> |
</pre> |
||
</li> |
</li> |
||
| Line 87: | Line 97: | ||
<li> |
<li> |
||
==Orphan Record Action== |
==Orphan Record Action== |
||
Action to take on orphan records: i (ignore), d (delete), m (mark as deleted or n (create new parent) |
Action to take on orphan records: i (ignore), d (delete), m (mark as deleted) or n (create new parent). |
||
<pre> |
<pre> |
||
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --orphan_record_action ARGUMENT |
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --orphan_record_action ARGUMENT |
||
| Line 114: | Line 124: | ||
When using a terminal to run zymonic_toolkit.pl the user will see prompts that contain the same information that is found within this manual. |
When using a terminal to run zymonic_toolkit.pl the user will see prompts that contain the same information that is found within this manual. |
||
<pre> |
<pre> |
||
sudo zymonic_toolkit.pl |
sudo zymonic_toolkit.pl Data help |
||
</pre> |
</pre> |
||
| Line 122: | Line 132: | ||
The specific command to show help for. If not set then shows help for all commands. |
The specific command to show help for. If not set then shows help for all commands. |
||
<pre> |
<pre> |
||
sudo zymonic_toolkit.pl |
sudo zymonic_toolkit.pl Data help --command COMMAND |
||
</pre> |
</pre> |
||
</li> |
</li> |
||
Latest revision as of 14:38, 11 June 2020
This page contains all of the options for:
sudo zymonic_toolkit.pl Data
See the manual page for the data toolkit for further details.
Check Database for Valid Characters[edit]
Checks tables and fields for invalid characters - if no table or field are specified the command will process the whole DB or table.
sudo zymonic_toolkit.pl Data check_db_for_valid_characters
-
Table ZName[edit]
The ZName of the table, or all tables if left empty.
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --table ZNAME
-
Field ZName[edit]
The ZName of the field, or all fields present on each table if left empty.
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --field ZNAME
-
System[edit]
The system to be inspected. This parameter is required for the command to work.
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --system SYSTEM
-
End Page[edit]
Last page to process (50 records per page).
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --end_page PAGE
-
Start Page[edit]
First page to process (50 records per page).
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --start_page PAGE
Clean Database[edit]
Removes autocreated records, deleted records and handles orphan records from tables in system.
sudo zymonic_toolkit.pl Data db_clean
-
System[edit]
The system to be inspected. This parameter is required for the command to work.
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --system SYSTEM
-
Table ZNames[edit]
Comma separated list of ZNames of the tables, or '*' for all tables. This parameter is required for the command to work.
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --tables ZNAME1,ZNAME2,ZNAME3
-
Username[edit]
The name of the user with which to get auth for sql database changes. This parameter is required for the command to work.
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --user USERNAME
-
Password[edit]
The password of the user with which to get auth for sql database changes. Use '!' to capture from standard input instead without displaying the password in the shell. This parameter is required for the command to work.
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --password PASSWORD
-
Orphan Record Action[edit]
Action to take on orphan records: i (ignore), d (delete), m (mark as deleted) or n (create new parent).
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --orphan_record_action ARGUMENT
-
Remove Autocreated Records[edit]
Whether to remove autocreated records: y/n
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --remove_autocreated ARGUMENT
-
Remove Deleted Records[edit]
Whether to remove deleted records: y/n
sudo zymonic_toolkit.pl Data check_db_for_valid_characters --remove_deleted ARGUMENT
Help[edit]
When using a terminal to run zymonic_toolkit.pl the user will see prompts that contain the same information that is found within this manual.
sudo zymonic_toolkit.pl Data help
-
Command[edit]
The specific command to show help for. If not set then shows help for all commands.
sudo zymonic_toolkit.pl Data help --command COMMAND