1PQ2(1)                      General Commands Manual                     PQ2(1)
2
3
4

NOTA BENE

6       The PQ2 tools are deprecated and will be removed in ROOT v6.16/00.
7
8       Please  contact  the  ROOT  team at http://root.cern.ch in the unlikely
9       event this change is disruptive for your workflow.
10

NAME

12       pq2 - The command line interface to a dataset meta-repository based  on
13       ROOT files
14

SYNOPSIS

16       pq2 action options
17

DESCRIPTION

19       This manual page documents briefly the pq2 program.
20
21       pq2  is  a  ROOT  application providing an interface to a dataset meta-
22       repository based on ROOT files; the repository can be accessed via  the
23       local file system or a remote file server daemon or a PROOF facility.
24
25       When  working  with  a  local or remote file system, pq2 instantiates a
26       TDataSetManagerFile class on the specified local or  remote  directory.
27       Remote access is done via the TFile interface, so any implementation of
28       TFile supported by the installation can in  principle  be  used.   When
29       working  with PROOF server the TProof dataset manager interface is used
30       to access the dataset repository attached to the PROOF cluster.
31

ACTIONS

33       ls     list compact information about all or a sample dataset.
34
35       ls-files
36              list compact information about all the files of a given dataset.
37
38       ls-files-server
39              list the file content of a dataset on a given server or list  of
40              servers.
41
42       info-server
43              display compact information about the datasets on a given server
44              or a set of servers.
45
46       ana-dist
47              analyse the  file  distribution  of  a  dataset  (or  a  set  of
48              datasets)  over the file servers, either in terms of files or of
49              file sizes. The output is a text file with the  the  file  move‐
50              ments  needed  to  make the file distribution even in the chosen
51              metrics to be used in input to pq2-redistribute.  Optionally the
52              internal objects can be saved so that they can be used as start‐
53              ing point for a subsequent run. Also an histogram and a plot can
54              be saved to visualize the file distribution.
55
56       put    register one or more datasets.
57
58       rm     remove one or more datasets.
59
60       verify scan the content one or more datasets.
61
62       cache  display or clear the local cache content.
63
64

COMMON OPTIONS

66       Some  of  the  options  listed  below  have  a slight different meaning
67       depending on the action. Please refer to the man pages  of  the  script
68       interfaces to the actions for more details (see below).
69
70       -d <dataset>
71              For all action but put, the dataset to be processed. For listing
72              actions the wildcards '*' is supported.  For action put, dataset
73              is the path to the file with the list of files in the dataset or
74              directory with the  files  containing  the  file  lists  of  the
75              datasets  to  be registered; in the first case wildcards '*' can
76              be specified in the file  name,  i.e.  '<dir>/fil*'  is  ok  but
77              '<dir>/*/file'  is not.  In all cases the name of the dataset is
78              the name of the file finally used.
79
80       -u <serverurl>
81              URL of the PROOF master or data server  providing  the  informa‐
82              tion; for data servers, it must include the directory.  Can also
83              be  specified  via  the  environment  variables  PQ2PROOFURL  or
84              PQ2DSSRVURL (see ENVIRONMENT VARIABLES)."
85
86       -o <options>
87              Specify  a  string of options to be passed to the instance actu‐
88              ally performing the action; the exact meaning is  action  depen‐
89              dent.
90
91       -s <servers>
92              Specify a server or a comma-separated list of servers to be used
93              in the analysis when required by the action.
94
95       -k     Keep the temporary  files  created  during  the  analysis  under
96              $TMPDIR
97
98       -v     Verbose mode
99

OPTIONS for action verify

101       The options listed below apply only to action 'verify'
102
103       -r <redirector>
104              Force  re-location  of  the  files via the specified redirector;
105              useful after a file redistribution on the same file server.
106

OPTIONS for action ana-dist

108       The options listed below apply only to action 'ana-dist'
109
110       -m <metrics>
111              Defines the metrics to be used in the distribution analysis. The
112              possibilities  supported currently are: 'F' to use the number of
113              files, and 'S' to use the file size.
114
115       -f <result file>
116              Defines the file where to save the result of  the  analysis;  by
117              the  default  the result is send to the screen.  The output con‐
118              tains one line per each file that needs to  be  moved  with  the
119              format  'file source destination' where 'file' is the file name,
120              'source' is the source server URL and 'destination' is the  des‐
121              tination server URL.
122
123       --outfile <output file>
124              Defines  the  file  where  to save the output of the analysis in
125              binary form (ROOT file); this output can  be  used  as  starting
126              point for a next run, allowing to run over many datasets in sep‐
127              arate steps.
128
129       --infile <input file>
130              Defines the ROOT file from where to fetch the output of a previ‐
131              ous run (saved with --outfile).
132
133       -i <ignored servers>
134              Specify  a  server  or  a  comma-separated list of servers to be
135              ignored in the analysis; this allows to  exclude,  for  example,
136              the redirector.
137
138       -e <excluded servers>
139              Specify  a  server  or  a  comma-separated list of servers to be
140              excluded from the target servers; this can be used, for example,
141              to determine the files movements to drain a server.
142
143       --plot [<plot file>]
144              Defines  the file with the output plot with the original distri‐
145              bution with the server names and the +-10% limits; the extension
146              (if  known)  defines the format; the default format is 'png' and
147              the default name 'plot.png'.  The  plot  can  also  be  obtained
148              directly  from a binary output file (saved with '--outfile <out‐
149              file>.root')  but  just  specifying   '--infile   <outfile>.root
150              --plot'
151
152

ENVIRONMENT VARIABLES

154       See setup-pq2(1).
155

SEE ALSO

157       setup-pq2(1),   pq2-ls(1),   pq2-ls-files(1),   pq2-ls-files-server(1),
158       pq2-info-server(1),   pq2-ana-dist(1),    pq2-put(1),    pq2-verify(1),
159       pq2-rm(1), pq2-cache(1)
160
161       For   more   information   on   the   ROOT   system,  please  refer  to
162       http://root.cern.ch
163

ORIGINAL AUTHORS

165       Gerardo Ganis for the ROOT team.
166
168       This library is free software; you can redistribute it and/or modify it
169       under  the  terms of the GNU Lesser General Public License as published
170       by the Free Software Foundation; either version 2.1 of the License,  or
171       (at your option) any later version.
172
173       This  library  is  distributed  in the hope that it will be useful, but
174       WITHOUT ANY  WARRANTY;  without  even  the  implied  warranty  of  MER‐
175       CHANTABILITY  or  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser
176       General Public License for more details.
177
178       You should have received a  copy  of  the  GNU  Lesser  General  Public
179       License  along  with  this  library; if not, write to the Free Software
180       Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,  MA   02110-1301
181       USA
182

AUTHOR

184       This  manual  page  was  originally  written  by  Gerardo  Ganis  <ger‐
185       ardo.ganis@cern.ch>, for ROOT version 5.
186
187
188
189ROOT                               Version 5                            PQ2(1)
Impressum