1PQ2(1) General Commands Manual PQ2(1)
2
6 pq2 - The command line interface to a dataset meta-repository based on
7 ROOT files
8
10 pq2 action options
11
13 This manual page documents briefly the pq2 program.
14 pq2 is a ROOT application providing an interface to a dataset meta-
16 repository based on ROOT files; the repository can be accessed via the
17 local file system or a remote file server daemon or a PROOF facility.
18 When working with a local or remote file system, pq2 instantiates a
20 TDataSetManagerFile class on the specified local or remote directory.
21 Remote access is done via the TFile interface, so any implementation of
22 TFile supported by the installation can in principle be used. When
23 working with PROOF server the TProof dataset manager interface is used
24 to access the dataset repository attached to the PROOF cluster.
25
27 ls list compact information about all or a sample dataset.
28 ls-files
30 list compact information about all the files of a given dataset.
31 ls-files-server
33 list the file content of a dataset on a given server or list of
34 servers.
35 info-server
37 display compact information about the datasets on a given server
38 or a set of servers.
39 ana-dist
41 analyse the file distribution of a dataset (or a set of
42 datasets) over the file servers, either in terms of files or of
43 file sizes. The output is a text file with the the file move‐
44 ments needed to make the file distribution even in the chosen
45 metrics to be used in input to pq2-redistribute. Optionally the
46 internal objects can be saved so that they can be used as start‐
47 ing point for a subsequent run. Also an histogram and a plot can
48 be saved to visualize the file distribution.
49 put register one or more datasets.
51 rm remove one or more datasets.
53 verify scan the content one or more datasets.
55 cache display or clear the local cache content.
57
60 Some of the options listed below have a slight different meaning
61 depending on the action. Please refer to the man pages of the script
62 interfaces to the actions for more details (see below).
63 -d <dataset>
65 For all action but put, the dataset to be processed. For listing
66 actions the wildcards '*' is supported. For action put, dataset
67 is the path to the file with the list of files in the dataset or
68 directory with the files containing the file lists of the
69 datasets to be registered; in the first case wildcards '*' can
70 be specified in the file name, i.e. '<dir>/fil*' is ok but
71 '<dir>/*/file' is not. In all cases the name of the dataset is
72 the name of the file finally used.
73 -u <serverurl>
75 URL of the PROOF master or data server providing the informa‐
76 tion; for data servers, it must include the directory. Can also
77 be specified via the environment variables PQ2PROOFURL or
78 PQ2DSSRVURL (see ENVIRONMENT VARIABLES)."
79 -o <options>
81 Specify a string of options to be passed to the instance actu‐
82 atlly performing the action; the exact meaning is action depen‐
83 dent.
84 -s <servers>
86 Specify a server or a comma-separated list of servers to be used
87 in the analysis when required by the action.
88 -k Keep the temporary files created during the analysis under
90 $TMPDIR
91 -v Verbose mode
93
95 The options listed below apply only to action 'verify'
96 -r <redirector>
98 Force re-location of the files via the specified redirector;
99 useful after a file redistribution on the same file server.
100
102 The options listed below apply only to action 'ana-dist'
103 -m <metrics>
105 Defines the metrics to be used in the distribution analysis. The
106 possibilities supported currently are: 'F' to use the number of
107 files, and 'S' to use the file size.
108 -f <result file>
110 Defines the file where to save the result of the analysis; by
111 the default the result is send to the screen. The output con‐
112 tains one line per each file that needs to be moved with the
113 format 'file source destination' where 'file' is the file name,
114 'source' is the source server URL and 'destination' is the des‐
115 tination server URL.
116 --outfile <output file>
118 Defines the file where to save the output of the analysis in
119 binary form (ROOT file); this output can be used as starting
120 point for a next run, allowing to run over many datasets in sep‐
121 arate steps.
122 --infile <input file>
124 Defines the ROOT file from where to fetch the output of a previ‐
125 ous run (saved with --outfile).
126 -i <ignored servers>
128 Specify a server or a comma-separated list of servers to be
129 ignored in the analysis; this allows to exclude, for example,
130 the redirector.
131 -e <excluded servers>
133 Specify a server or a comma-separated list of servers to be
134 excluded from the target servers; this can be used, for example,
135 to determine the files movements to drain a server.
136 --plot [<plot file>]
138 Defines the file with the output plot with the original distri‐
139 bution with the server names and the +-10% limits; the extension
140 (if known) defines the format; the default format is 'png' and
141 the default name 'plot.png'. The plot can also be obtained
142 directly from a binary output file (saved with '--outfile <out‐
143 file>.root') but just specifying '--infile <outfile>.root
144 --plot'
145
148 See setup-pq2(1).
149
151 setup-pq2(1), pq2-ls(1), pq2-ls-files(1), pq2-ls-files-server(1),
152 pq2-info-server(1), pq2-ana-dist(1), pq2-put(1), pq2-verify(1),
153 pq2-rm(1), pq2-cache(1)
154 For more information on the ROOT system, please refer to
156 http://root.cern.ch
157
159 Gerardo Ganis for the ROOT team.
160
162 This library is free software; you can redistribute it and/or modify it
163 under the terms of the GNU Lesser General Public License as published
164 by the Free Software Foundation; either version 2.1 of the License, or
165 (at your option) any later version.
166 This library is distributed in the hope that it will be useful, but
168 WITHOUT ANY WARRANTY; without even the implied warranty of MER‐
169 CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
170 General Public License for more details.
171 You should have received a copy of the GNU Lesser General Public
173 License along with this library; if not, write to the Free Software
174 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
175 USA
176
178 This manual page was originally written by Gerardo Ganis <ger‐
179 ardo.ganis@cern.ch>, for ROOT version 5.
180ROOT Version 5 PQ2(1)