1RT-DUMP-INITIALDATA(1)User Contributed Perl DocumentationRT-DUMP-INITIALDATA(1)
2
3
4
6 rt-dump-initialdata - Serialize an RT database to disk
7
9 rt-validator --check && rt-dump-initialdata
10
11 This script is used to write out the objects initialdata supports from
12 RT database to disk, for later import into a different RT instance. It
13 requires that the data in the database be self-consistent, in order to
14 do so; please make sure that the database being exported passes
15 validation by rt-validator before attempting to use
16 "rt-dump-initialdata".
17
18 While running, it will attempt to estimate the number of remaining
19 objects to be dumped; these estimates are pessimistic, and will be
20 incorrect if "--no-users" or "--no-groups" is used.
21
22 If the controlling terminal is large enough (more than 25 columns high)
23 and the "gnuplot" program is installed, it will also show a textual
24 graph of the queue size over time.
25
26 OPTIONS
27 --directory name
28 The name of the output directory to write data files to, which
29 should not exist yet; it is a fatal error if it does. Defaults to
30 "./$Organization:Date/", where $Organization is as set in
31 RT_SiteConfig.pm, and Date is today's date.
32
33 --force
34 Remove the output directory before starting.
35
36 --no-users
37 By default, all privileged users are dumped; passing "--no-users"
38 limits it to only those users which are referenced by dumped
39 tickets and history, and are thus necessary for internal
40 consistency.
41
42 --no-groups
43 By default, all groups are dumped; passing "--no-groups" limits it
44 to only system-internal groups, which are needed for internal
45 consistency.
46
47 --no-assets
48 By default, all assets are dumped; passing "--no-assets" skips
49 assets during serialization.
50
51 --no-disabled
52 By default, all queues, custom fields, etc, including disabled
53 ones, are dumped; passing "--no-disabled" skips such disabled
54 records during serialization.
55
56 --no-deleted
57 By default, all assets, including deleted ones, are dumped; passing
58 "--no-deleted" skips deleted assets.
59
60 --no-scrips
61 By default, all scrips and templates are dumped; passing
62 "--no-scrips" skips them.
63
64 --no-acls
65 By default, all ACLs are dumped; passing "--no-acls" skips them.
66
67 --no-queues
68 By default, all queues are dumped; passing "--no-queues" skips
69 them.
70
71 --limit-queues
72 Takes a list of queue IDs or names separated by commas. When
73 provided, only that set of queues will be dumped.
74
75 --sync
76 By default, record ids are ordinarily excluded. Pass "--sync" to
77 include record ids if you intend to use this for sync rather than
78 creating a generic initialdata.
79
80 --base file
81 The file path which the to be generated initialdata.json will
82 compare to. If there are any changes, they will be saved to
83 changes.json.
84
85 This option implies "--sync".
86
87 --gc n
88 Adjust how often the garbage collection sweep is done; lower
89 numbers are more frequent. It shares the same code with
90 "rt-serializer", See "GARBAGE COLLECTION" in rt-serializer.
91
92 --page n
93 Adjust how many rows are pulled from the database in a single
94 query. Disable paging by setting this to 0. Defaults to 100.
95
96 --quiet
97 Do not show graphical progress UI.
98
99 --verbose
100 Do not show graphical progress UI, but rather log was each row is
101 written out.
102
103
104
105perl v5.38.0 2023-10-22 RT-DUMP-INITIALDATA(1)