1PQ2-PUT(1) General Commands Manual PQ2-PUT(1)
2
6 The PQ2 tools are deprecated and will be removed in ROOT v6.16/00.
7 Please contact the ROOT team at http://root.cern.ch in the unlikely
9 event this change is disruptive for your workflow.
10
12 pq2-put - Register one or more datasets in a dataset meta-repository
13 based on ROOT files
14
16 pq2-put [options] datasetfile
17
19 This manual page documents briefly the pq2-put program.
20 pq2-put is a script invoking the pq2 ROOT application to register one
22 or more datasets in a dataset meta-repository based on ROOT files; the
23 repository can be accessed via the local file system or a remote file
24 server daemon or a PROOF facility.
25 More details about the underlying 'pq2' application can be found in the
27 man page pq2(1).
28
30 datasetfile
31 Path to the file with the list of files in the dataset or direc‐
32 tory with the files containing the file lists of the datasets to
33 be registered; in the first case wildcards '*' can be specified
34 in the file name, i.e. '<dir>/fil*' is ok but '<dir>/*/file' is
35 not. In all cases the name of the dataset is the name of the
36 file finally used. The format of the file is described below.
37
39 -h, --help
40 Display help information.
41 -k, --keep
43 Keep the temporary files created during the analysis under
44 $TMPDIR
45 -v Verbose mode
47 -d <datasetfile>, --dataset <datasetfile>
49 Alternative way to define path to the file with the list of
50 files.
51 -o <options>
53 Options for registering datasets; a combination of:
54 O overwrite existing dataset
55 U add information to existing dataset, if any or create a new one
56 T Trust the information already present in the dataset
57 V verify (scan) information in the dataset (can be very slow)
58 --overwrite
60 Alternative to '-o O'.
61 --update
63 Alternative to '-o U'.
64 --trust
66 Alternative to '-o T'.
67 --tree=<default-tree-name>
69 Set the name of the default tree name to 'default-tree-name'
70 (option 'T' or --trust only); this allows to skip the tree name
71 specification during Process when more TTree (or derivative)
72 objects are available in the files.
73 --staged
75 Assume all files online or staged (option 'T' or --trust only).
76 -u <serverurl>, --url=<serverurl>
78 URL of the PROOF master or data server providing the informa‐
79 tion; for data servers, it must include the directory. Can also
80 be specified via the environment variables PQ2PROOFURL or
81 PQ2DSSRVURL (see ENVIRONMENT VARIABLES)."
82 -t <dir>, --tmpdir=<dir>
84 Directory for temporary files; default is /tmp/<username>.
85
87 The name of the file defining the dataset is the name of the dataset.
88 The files must contain one line per each file in the dataset with the
89 full file URL. If available, additional information can be specified
90 on the same line with the following keywords:
91 sz:<size> size of the file in bytes
93 md5:<md5_ascii> MD5 sum of the file in ASCII form
94 uuid:<uuid> UUID of the file
95 tree:<name>,<entries>,<first>,<last> meta-information about a tree in the file; the should be in the form
96 <subdir>/tree-name;'entries' is the number of entries in the tree;
97 'first' and 'last' define the entry range.
98 obj:<name>,<class>,<entries> meta-information about a generic object in the file; the should be in
99 the form <subdir>/obj-name; 'class' is the object class; 'entries' is
100 the number of occurrences for this object.
101 Multiple occurrences of 'tree:' or 'obj:' can be specified.
102
104 The following examples show how to register information corresponding
105 to the H1 example of the ROOT tutorials.
106 Minimal information
108 In this example the files are read from the ROOT HTTP server.
109 Detailed information about the content of the files is not
110 available, so only the URLs are given. If the file is called
111 h1-http, we get
112 $ cat h1-http
114 http://root.cern.ch/files/h1/dstarmb.root
115 http://root.cern.ch/files/h1/dstarp1a.root
116 http://root.cern.ch/files/h1/dstarp1b.root
117 http://root.cern.ch/files/h1/dstarp2.root
118 The dataset is registered and verification required:
120 $ pq2-put -o "V" h1-http
121 pq2-put: 1 dataset(s) registered
122 Full information
124 In this example the files are read from the local /data/h1
125 directory. Detailed information about the content of the files
126 is available. If the file is called h1-local, we get
127 $ cat h1-local
128 file:/data/h1/dstarmb.root sz:21330730 md5:0a60055370e16d954f90fb50c2d1a801 tree:h42,21920,0,-1
129 file:/data/h1/dstarp1a.root md5:e2f959b15235214be3c973c3e7a9ff2c sz:71464503 tree:h42,73243
130 file:/data/h1/dstarp1b.root md5:169ea4799661696a25e73257fe8a833d sz:83827959 tree:h42,85597
131 file:/data/h1/dstarp2.root md5:907d10b401a35c0240cfa76bedc31420 sz:100675234 tree:h42,103053
132 The dataset is registered trusting the passed information:
134 $ pq2-put -o T --tree=h42 --staged h1-local
135 pq2-put: 1 dataset(s) registered
136
138 See setup-pq2(1).
139
141 pq2(1), setup-pq2(1), pq2-ls(1), pq2-ls-files(1), pq2-ls-files-
142 server(1), pq2-info-server(1), pq2-ana-dist(1), pq2-verify(1),
143 pq2-rm(1), pq2-cache(1)
144 For more information on the ROOT system, please refer to
146 http://root.cern.ch
147
149 Gerardo Ganis for the ROOT team.
150
152 This library is free software; you can redistribute it and/or modify it
153 under the terms of the GNU Lesser General Public License as published
154 by the Free Software Foundation; either version 2.1 of the License, or
155 (at your option) any later version.
156 This library is distributed in the hope that it will be useful, but
158 WITHOUT ANY WARRANTY; without even the implied warranty of MER‐
159 CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
160 General Public License for more details.
161 You should have received a copy of the GNU Lesser General Public
163 License along with this library; if not, write to the Free Software
164 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
165 USA
166
168 This manual page was originally written by Gerardo Ganis <ger‐
169 ardo.ganis@cern.ch>, for ROOT version 5.
170ROOT Version 5 PQ2-PUT(1)