|
0
|
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.22)
|
|
|
2 .\"
|
|
|
3 .\" Standard preamble:
|
|
|
4 .\" ========================================================================
|
|
|
5 .de Sp \" Vertical space (when we can't use .PP)
|
|
|
6 .if t .sp .5v
|
|
|
7 .if n .sp
|
|
|
8 ..
|
|
|
9 .de Vb \" Begin verbatim text
|
|
|
10 .ft CW
|
|
|
11 .nf
|
|
|
12 .ne \\$1
|
|
|
13 ..
|
|
|
14 .de Ve \" End verbatim text
|
|
|
15 .ft R
|
|
|
16 .fi
|
|
|
17 ..
|
|
|
18 .\" Set up some character translations and predefined strings. \*(-- will
|
|
|
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
|
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
|
|
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
|
|
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
|
|
23 .\" nothing in troff, for use with C<>.
|
|
|
24 .tr \(*W-
|
|
|
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
|
26 .ie n \{\
|
|
|
27 . ds -- \(*W-
|
|
|
28 . ds PI pi
|
|
|
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
|
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
|
31 . ds L" ""
|
|
|
32 . ds R" ""
|
|
|
33 . ds C` ""
|
|
|
34 . ds C' ""
|
|
|
35 'br\}
|
|
|
36 .el\{\
|
|
|
37 . ds -- \|\(em\|
|
|
|
38 . ds PI \(*p
|
|
|
39 . ds L" ``
|
|
|
40 . ds R" ''
|
|
|
41 'br\}
|
|
|
42 .\"
|
|
|
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
|
44 .ie \n(.g .ds Aq \(aq
|
|
|
45 .el .ds Aq '
|
|
|
46 .\"
|
|
|
47 .\" If the F register is turned on, we'll generate index entries on stderr for
|
|
|
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
|
|
49 .\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
|
50 .\" output yourself in some meaningful fashion.
|
|
|
51 .ie \nF \{\
|
|
|
52 . de IX
|
|
|
53 . tm Index:\\$1\t\\n%\t"\\$2"
|
|
|
54 ..
|
|
|
55 . nr % 0
|
|
|
56 . rr F
|
|
|
57 .\}
|
|
|
58 .el \{\
|
|
|
59 . de IX
|
|
|
60 ..
|
|
|
61 .\}
|
|
|
62 .\"
|
|
|
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
|
64 .\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
|
65 . \" fudge factors for nroff and troff
|
|
|
66 .if n \{\
|
|
|
67 . ds #H 0
|
|
|
68 . ds #V .8m
|
|
|
69 . ds #F .3m
|
|
|
70 . ds #[ \f1
|
|
|
71 . ds #] \fP
|
|
|
72 .\}
|
|
|
73 .if t \{\
|
|
|
74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
|
75 . ds #V .6m
|
|
|
76 . ds #F 0
|
|
|
77 . ds #[ \&
|
|
|
78 . ds #] \&
|
|
|
79 .\}
|
|
|
80 . \" simple accents for nroff and troff
|
|
|
81 .if n \{\
|
|
|
82 . ds ' \&
|
|
|
83 . ds ` \&
|
|
|
84 . ds ^ \&
|
|
|
85 . ds , \&
|
|
|
86 . ds ~ ~
|
|
|
87 . ds /
|
|
|
88 .\}
|
|
|
89 .if t \{\
|
|
|
90 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
|
91 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
|
92 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
|
93 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
|
94 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
|
95 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
|
96 .\}
|
|
|
97 . \" troff and (daisy-wheel) nroff accents
|
|
|
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
|
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
|
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
|
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
|
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
|
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
|
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
|
105 .ds ae a\h'-(\w'a'u*4/10)'e
|
|
|
106 .ds Ae A\h'-(\w'A'u*4/10)'E
|
|
|
107 . \" corrections for vroff
|
|
|
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
|
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
|
110 . \" for low resolution devices (crt and lpr)
|
|
|
111 .if \n(.H>23 .if \n(.V>19 \
|
|
|
112 \{\
|
|
|
113 . ds : e
|
|
|
114 . ds 8 ss
|
|
|
115 . ds o a
|
|
|
116 . ds d- d\h'-1'\(ga
|
|
|
117 . ds D- D\h'-1'\(hy
|
|
|
118 . ds th \o'bp'
|
|
|
119 . ds Th \o'LP'
|
|
|
120 . ds ae ae
|
|
|
121 . ds Ae AE
|
|
|
122 .\}
|
|
|
123 .rm #[ #] #H #V #F C
|
|
|
124 .\" ========================================================================
|
|
|
125 .\"
|
|
|
126 .IX Title "DBSQLTOTEXTFILES 1"
|
|
|
127 .TH DBSQLTOTEXTFILES 1 "2015-03-29" "perl v5.14.2" "MayaChemTools"
|
|
|
128 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
|
129 .\" way too many mistakes in technical documents.
|
|
|
130 .if n .ad l
|
|
|
131 .nh
|
|
|
132 .SH "NAME"
|
|
|
133 DBSQLToTextFiles.pl \- Export data from MySQL, Oracle or PostgreSQL database into CSV/TSV text files
|
|
|
134 .SH "SYNOPSIS"
|
|
|
135 .IX Header "SYNOPSIS"
|
|
|
136 DBSQLToTextFiles.pl SQLFileName(s) | SQLSelectStatement(s)...
|
|
|
137 .PP
|
|
|
138 DBSQLToTextFiles.pl [\fB\-d, \-\-dbdriver\fR mysql | Oracle | Postgres or Pg] [\fB\-\-dbhost \fR hostname]
|
|
|
139 [\fB\-\-dbname\fR databasename] [\fB\-\-dbpassword\fR password] [\fB\-\-dbusername\fR username]
|
|
|
140 [\fB\-\-exportdatalabels\fR yes | no] [\fB\-\-exportlobs\fR yes | no] [\fB\-h, \-\-help\fR]
|
|
|
141 [\fB\-m, \-\-mode\fR SQLStatement | SQLFile] [\fB\-o, \-\-overwrite\fR] [\fB\-\-outdelim\fR comma | tab | semicolon]
|
|
|
142 [\fB\-q, \-\-quote\fR yes | no] [\fB\-r, \-\-root\fR rootname] [\fB\-\-replacenullstr string\fR]
|
|
|
143 [\fB\-w \-\-workingdir\fR dirname] SQLFileName(s) | SQLSelectStatement(s)...
|
|
|
144 .SH "DESCRIPTION"
|
|
|
145 .IX Header "DESCRIPTION"
|
|
|
146 Export data from MySQL, Oracle or PostgreSQL database into \s-1CSV/TSV\s0 text files. Based on \fB\-m \-\-mode\fR
|
|
|
147 option value, two methods of data selection are availble: in line \s-1SQL\s0 select statement(s), or
|
|
|
148 \&\s-1SQL\s0 file name(s) containing \s-1SQL\s0 select statement(s). All command line parameters must
|
|
|
149 correspond to similar mode; mixing of parameters for different modes is not supported.
|
|
|
150 .SH "OPTIONS"
|
|
|
151 .IX Header "OPTIONS"
|
|
|
152 .IP "\fB\-d, \-\-dbdriver\fR \fImysql | Oracle | Postgres or Pg\fR" 4
|
|
|
153 .IX Item "-d, --dbdriver mysql | Oracle | Postgres or Pg"
|
|
|
154 Database driver name. Possible values: \fImysql, Oracle, Postgres or Pg\fR. Default: \fIMySQL\fR or value of
|
|
|
155 environment variable \s-1DBI_DRIVER\s0. This script has only been tested with MySQL, Oracle
|
|
|
156 and PostgreSQL drivers.
|
|
|
157 .IP "\fB\-\-dbhost \fR \fIhostname\fR" 4
|
|
|
158 .IX Item "--dbhost hostname"
|
|
|
159 Database host name. Default: \fI127.0.0.1\fR for both MySQL, Oracle and PostgreSQL. For remote
|
|
|
160 databases, specify complete remote host domain: \fIdbhostname.org\fR or something
|
|
|
161 like it.
|
|
|
162 .IP "\fB\-\-dbname\fR \fIdatabasename\fR" 4
|
|
|
163 .IX Item "--dbname databasename"
|
|
|
164 Database name. Default: mysql for MySQL, postgres for PostgreSQL and none for Oracle.
|
|
|
165 For connecting to local/remote Oracle databases, this value can be left undefined assuming
|
|
|
166 \&\fB\-\-dbhost\fR is correctly specified.
|
|
|
167 .IP "\fB\-\-dbpassword\fR \fIpassword\fR" 4
|
|
|
168 .IX Item "--dbpassword password"
|
|
|
169 Database user password. Default: \fInone\fR and value of environment variable \s-1DBI_PASS\s0
|
|
|
170 is used for connecting to database.
|
|
|
171 .IP "\fB\-\-dbusername\fR \fIusername\fR" 4
|
|
|
172 .IX Item "--dbusername username"
|
|
|
173 Database user name. Default: \fInone\fR and value of environment variable \s-1DBI_USER\s0 is
|
|
|
174 used for connecting to database.
|
|
|
175 .IP "\fB\-\-exportdatalabels\fR \fIyes | no\fR" 4
|
|
|
176 .IX Item "--exportdatalabels yes | no"
|
|
|
177 This option is mode specific and controls exporting of column data labels during
|
|
|
178 exportdata mode. Possible values: \fIyes or no\fR. Default: \fIyes\fR.
|
|
|
179 .IP "\fB\-\-exportlobs\fR \fIyes | no\fR" 4
|
|
|
180 .IX Item "--exportlobs yes | no"
|
|
|
181 This option is mode specific and controls exporting of \s-1CLOB/BLOB\s0 data columns during
|
|
|
182 exportdata mode. Possible values: \fIyes or no\fR. Default: \fIno\fR.
|
|
|
183 .IP "\fB\-h, \-\-help\fR" 4
|
|
|
184 .IX Item "-h, --help"
|
|
|
185 Print this help message.
|
|
|
186 .IP "\fB\-m, \-\-mode\fR \fISQLStatement | SQLFile\fR" 4
|
|
|
187 .IX Item "-m, --mode SQLStatement | SQLFile"
|
|
|
188 Data selection criterion from database. Two different command line parameter methods
|
|
|
189 are available: in line \s-1SQL\s0 statement(s) specification or file name(s) containing \s-1SQL\s0 select
|
|
|
190 statement(s). This value determines how command line parameters are processed.
|
|
|
191 .Sp
|
|
|
192 Possible values: \fISQLStatement or SQLFile\fR. Default value: \fISQLStatement\fR
|
|
|
193 .Sp
|
|
|
194 In SQLFile mode, \s-1SQL\s0 file contains select statements delimited by \fI;\fR. And the lines starting
|
|
|
195 with \fI#\fR or \fI\-\fR are ignored.
|
|
|
196 .IP "\fB\-o, \-\-overwrite\fR" 4
|
|
|
197 .IX Item "-o, --overwrite"
|
|
|
198 Overwrite existing files.
|
|
|
199 .IP "\fB\-\-outdelim\fR \fIcomma | tab | semicolon\fR" 4
|
|
|
200 .IX Item "--outdelim comma | tab | semicolon"
|
|
|
201 Output text file delimiter. Possible values: \fIcomma, tab, or semicolon\fR
|
|
|
202 Default value: \fIcomma\fR.
|
|
|
203 .IP "\fB\-q, \-\-quote\fR \fIyes | no\fR" 4
|
|
|
204 .IX Item "-q, --quote yes | no"
|
|
|
205 Put quotes around column values in output text file. Possible values: \fIyes or
|
|
|
206 no\fR. Default value: \fIyes\fR.
|
|
|
207 .IP "\fB\-r, \-\-root\fR \fIrootname\fR" 4
|
|
|
208 .IX Item "-r, --root rootname"
|
|
|
209 New file name is generated using the root:<Root><No>.<Ext>. Default new file
|
|
|
210 file names: SQLStatement<No>.<Ext>, or <SQLFileName><StatementNo>.<Ext>.
|
|
|
211 The csv and tsv <Ext> values are used for comma/semicolon, and tab delimited
|
|
|
212 text files respectively.This option is ignored for multiple input parameters.
|
|
|
213 .IP "\fB\-\-replacenullstr\fR \fIstring\fR" 4
|
|
|
214 .IX Item "--replacenullstr string"
|
|
|
215 Replace \s-1NULL\s0 or undefined row values with specified value. Default: \fInone\fR
|
|
|
216 .Sp
|
|
|
217 For importing output text files into MySQL database using \*(L"load data local infile '<tablename>.tsv'
|
|
|
218 into table <tablename>\*(R" command, use \fI\-\-raplacenullstr \*(L"\s-1NULL\s0\*(R"\fR in conjunction with \fI\-\-exportdatalabels no\fR,
|
|
|
219 \&\fI\-\-quote no\fR, and \fI\-\-outdelim tab\fR options: it'll generate files for direct import into MySQL assuming
|
|
|
220 tables already exists.
|
|
|
221 .IP "\fB\-w \-\-workingdir\fR \fIdirname\fR" 4
|
|
|
222 .IX Item "-w --workingdir dirname"
|
|
|
223 Location of working directory. Default: current directory.
|
|
|
224 .SH "EXAMPLES"
|
|
|
225 .IX Header "EXAMPLES"
|
|
|
226 To export all data in user_info table from a MySQL server running on a local machine
|
|
|
227 using username/password from \s-1DBI_USER\s0 and \s-1DBI_PASS\s0 environmental variables, type:
|
|
|
228 .PP
|
|
|
229 .Vb 1
|
|
|
230 \& % DBSQLToTextFiles.pl \-o "select * from user_info"
|
|
|
231 .Ve
|
|
|
232 .PP
|
|
|
233 To describe user table in a MySQL server running on a remote machine using explicit
|
|
|
234 username/password and capturing the output into a UserTable.csv file, type:
|
|
|
235 .PP
|
|
|
236 .Vb 3
|
|
|
237 \& % DBSQLToTextFiles.pl \-\-dbdriver mysql \-\-dbuser <name> \-\-dbpassword
|
|
|
238 \& <pasword> \-\-dbname mysql \-\-dbhost <mysqlhostname.org> \-r UserTable
|
|
|
239 \& \-m SQLStatement \-o "select * from user_info"
|
|
|
240 .Ve
|
|
|
241 .PP
|
|
|
242 To describe table all_tables in Oracle running on a remote machine using explicit
|
|
|
243 username/password and capturing the output into a AllTable.tsv file, type:
|
|
|
244 .PP
|
|
|
245 .Vb 3
|
|
|
246 \& % DBSQLToTextFiles.pl \-\-dbdriver Oracle \-\-dbuser <name> \-\-dbpassword
|
|
|
247 \& <pasword> \-\-dbhost <oraclehostname.com> \-r AllTable \-m SQLStatement
|
|
|
248 \& \-\-outdelim tab \-\-quote no \-o "select * from all_tables"
|
|
|
249 .Ve
|
|
|
250 .PP
|
|
|
251 To run all \s-1SQL\s0 statement in a file sample.sql on a local Oracle host and capturing output
|
|
|
252 in a SampleSQL.csv file, type:
|
|
|
253 .PP
|
|
|
254 .Vb 2
|
|
|
255 \& % DBSQLToTextFiles.pl \-\-dbdriver Oracle \-\-dbuser <name> \-\-dbpassword
|
|
|
256 \& <pasword> \-r SampleSQL \-m SQLFile \-o sample.sql
|
|
|
257 .Ve
|
|
|
258 .SH "AUTHOR"
|
|
|
259 .IX Header "AUTHOR"
|
|
|
260 Manish Sud <msud@san.rr.com>
|
|
|
261 .SH "SEE ALSO"
|
|
|
262 .IX Header "SEE ALSO"
|
|
|
263 DBSchemaTablesToTextFiles.pl, DBTablesToTextFiles.pl
|
|
|
264 .SH "COPYRIGHT"
|
|
|
265 .IX Header "COPYRIGHT"
|
|
|
266 Copyright (C) 2015 Manish Sud. All rights reserved.
|
|
|
267 .PP
|
|
|
268 This file is part of MayaChemTools.
|
|
|
269 .PP
|
|
|
270 MayaChemTools is free software; you can redistribute it and/or modify it under
|
|
|
271 the terms of the \s-1GNU\s0 Lesser General Public License as published by the Free
|
|
|
272 Software Foundation; either version 3 of the License, or (at your option)
|
|
|
273 any later version.
|
