Project

General

Profile

1
#!/bin/bash -e
2
. "$(dirname "${BASH_SOURCE[0]}")"/util.sh
3

    
4
if self_not_included; then
5

    
6
# using prefixed connection vars
7
alias ssh2local='declare prefix=ssh_; import_vars; unset prefix
8
declare $(prefix=ssh_ get_prefix_vars); unset $(prefix=ssh_ get_prefix_vars)'
9
alias use_local='declare prefix=local_; import_vars; unset prefix'
10
alias use_remote='declare prefix=remote_; import_vars; unset prefix'
11
alias use_local_remote='{ use_local; use_remote; }'
12
	# *must* be run inside a function
13
alias use_root='declare prefix=root_; import_vars; unset prefix'
14

    
15
quote='"'
16

    
17
esc_name() { echo "$quote${1//$quote/$quote$quote}$quote"; }
18

    
19
mk_esc_name_alias() # usage: mk_esc_name_alias schema_esc
20
{ alias mk_"$1"='declare '"$1"'="${'"$1"':-$(esc_name "$'"${1%_esc}"'")}"; '\
21
'echo_vars '"$1"; }
22

    
23
mk_esc_name_alias schema_esc
24
mk_esc_name_alias table_esc
25

    
26
fi # load new aliases
27
if self_being_included; then
28

    
29
skip_table() # usage: create_table || table=... skip_table || return 0
30
{ what="table $table" already_exists_msg; }
31

    
32
: "${test=$(isset limit; exit2bool)}" # test mode when using limited # rows
33

    
34
# usage: (set_large_table; to_file db_cmd...) || return
35
alias set_large_table='declare del="${del-$(test "$limit"; exit2bool)}"
36
echo_vars del'
37

    
38
limit() # usage: "query... $([prefix=$'| |\n'] limit)"
39
{
40
	echo_func; kw_params prefix; local prefix="${prefix-
41
}"
42
	echo -n "${limit:+${prefix}LIMIT $limit}"
43
}
44

    
45
cols2list() # usage: cols2list col...
46
{ echo_func; cmd=esc_name foreach_arg; delim=', ' join "$@"; }
47

    
48
mk_select() # usage: {query=... | table=... [cols=...] [filter=...] \
49
# [order_by=...]} mk_select
50
{
51
	echo_func; kw_params query table cols filter; mk_table_esc
52
	if is_array cols    ; then cols="$(    cols2list "${cols[@]}"    )"; fi
53
	if is_array order_by; then order_by="$(cols2list "${order_by[@]}")"; fi
54
	echo "$(rtrim "${query:-SELECT ${cols:-*} ${cols:+
55
}FROM $table_esc
56
${filter:+WHERE $filter
57
}${order_by:+ORDER BY $order_by
58
}}")\
59
$(limit)"
60
}
61

    
62
# export func usage: export_func() { ...; mk_select_var; ... }
63
# caller usage: {query=... | table=... [cols=...] [filter=...]} export_func
64
# cmd line usage: [limit=...] caller
65
alias mk_select_var='declare query="$(mk_select)"'
66

    
67
fi # load new aliases
68
if self_being_included; then
69

    
70
mk_drop() # usage: table=... mk_drop|*sql_ANSI
71
{
72
	log++; echo_func; kw_params table; : "${table?}"; mk_table_esc
73
	echo "DROP TABLE IF EXISTS $table_esc"
74
}
75

    
76
mk_truncate() # usage: table=... mk_truncate|*sql_ANSI
77
{
78
	log++; echo_func; kw_params table; : "${table?}"; mk_table_esc
79
	echo "TRUNCATE $table_esc"
80
}
81

    
82

    
83
### MySQL
84

    
85
alias set_database=\
86
'if test "$schema"; then declare database="${database-$schema}"; fi'
87

    
88
fi # load new aliases
89
if self_being_included; then
90

    
91
# usage: mysql*() { ...; mysql_cmd "$@"; } (with alias)
92
function mysql_cmd() # usage: mysql*() { ...; mysql_cmd cmd "$@"; }
93
# auto-adds connection/login opts when specified
94
{
95
	echo_func
96
	local cmd="$1"; shift
97
	local ssh_server="$(localize_url "$ssh_server")"
98
	local server="$(localize_url "$server")"
99
	if test "$ssh_server"; then
100
		local ssh_dest="${ssh_dest-${ssh_user:+$ssh_user@}$ssh_server}"
101
	fi
102
	
103
	local var=ssh_dest; local_inv
104
	command "time" ${ssh_dest:+ssh "$ssh_dest" }"$cmd" \
105
${server:+ --host="$server" }${user:+--user="$user" } --password\
106
${password+="$password"} --quick "$@" # --quick: don't buffer entire result
107
}
108
alias mysql_cmd='mysql_cmd "$FUNCNAME"'
109

    
110
fi # load new aliases
111
if self_being_included; then
112

    
113
function mysql() # usage: [output_data=1] [data_only=1] [log_queries=] mysql ...
114
{
115
	echo_func; kw_params output_data data_only query_verbosity
116
	if test "$data_only"; then local output_data="${output_data-1}"; fi
117
	local log_queries="${log_queries-1}"
118
	set_database
119
	
120
	set -- ${database:+--database="$database" }--local-infile=1 \
121
--${data_only:+skip-}column-names "$@"
122
	if test "$output_data"; then echo_stdin|mysql_cmd --batch "$@"
123
	else cmd_log_fd=1 mysql_cmd ${log_queries:+--verbose --verbose --verbose }\
124
"$@" # --verbose*3: echo runtimes
125
	fi
126
}
127

    
128
mysql_ANSI()
129
{
130
	echo_func
131
	(echo "SET sql_mode = 'ANSI';"; cat)|mysql "$@"
132
}
133

    
134
# always use ANSI mode, to support "" identifiers. `` are *still* supported in
135
# this mode, so it also works with SHOW CREATE TABLE output and dumpfiles.
136
alias mysql='mysql_ANSI'
137

    
138
fi # load new aliases
139
if self_being_included; then
140

    
141
mysql_root() { echo_func; use_root; mysql "$@"; }
142

    
143
mysql_truncate() { echo_func; mk_truncate|mysql; }
144

    
145
mysql_import() # usage: table=... [cols=...] [append=1] mysql_import <file
146
# without append=1, first ensures the table is empty
147
{
148
	echo_func
149
	mk_table_esc
150
	local mysql_load_data_format="${mysql_load_data_format-\
151
FIELDS TERMINATED BY ','
152
OPTIONALLY ENCLOSED BY '\"'
153
}"
154
	
155
	if test ! "$append"; then mysql_truncate; fi
156
	mysql_load_data_format="${mysql_load_data_format%
157
}"
158
	ssh2local # ssh does not tunnel nonstandard fds
159
	mysql "$@" 40<&0 <<EOF
160
LOAD DATA LOCAL INFILE '/dev/fd/40'
161
${append:+IGNORE }INTO TABLE $table_esc
162
$mysql_load_data_format
163
IGNORE 1 LINES
164
EOF
165
}
166

    
167
mysql_export() # does not support CSV
168
# caller usage: {query=... | table=... [cols=...] [filter=...]} mysql_export
169
# cmd line usage: [limit=...] caller
170
{
171
	echo_func
172
	mk_select_var
173
	
174
	output_data=1 mysql "$@" <<<"$query"
175
}
176

    
177
mysql_export_outfile() # supports CSV, but requires the FILE privilege
178
{
179
	echo_func
180
	: "${file:?}"
181
	mk_select_var
182
	local mysql_load_data_format="${mysql_load_data_format-\
183
FIELDS TERMINATED BY ','
184
OPTIONALLY ENCLOSED BY '\"'
185
}"
186
	
187
	local head="${query%%FROM*}" # includes trailing newline
188
	head="${head%
189
}"
190
	local tail="${query#$head}"
191
	mysql_load_data_format="${mysql_load_data_format%
192
}"
193
	mysql "$@" <<EOF
194
$head
195
INTO OUTFILE '$file'
196
$mysql_load_data_format
197
$tail
198
EOF
199
}
200

    
201
mysqldump() # usage: [schema=1 | data=1] [create_db=1] mysqldump db [table...]
202
{
203
	echo_func
204
	echo_vars schema data create_db
205
	
206
	local var=create_db; local_inv
207
	mysql_cmd ${database:+--databases "$database" ${no_create_db:+--tables }} \
208
--lock-tables=false --set-charset \
209
${postgres_compat:+${data:+--compatible=postgresql }--add-locks=false }\
210
${schema:+--no-data }${data:+--no-create-info }"$@"
211
}
212

    
213
mysqldump_diffable()
214
{
215
	echo_func
216
	mysqldump "$@"|{ pipe_delay; echo_run sed 's/^(-- Dump completed).*$/\1/'; }
217
}
218

    
219
mysql_rm_privileged_statements()
220
{
221
	echo_func
222
	grep -vE -e '^/\*!40000 ALTER TABLE `.*` (DIS|EN)ABLE KEYS \*/;$' \
223
-e '^(UN)?LOCK TABLES( `.*` WRITE)?;$'
224
}
225

    
226
## permissions
227

    
228
mysql_seal_table() # usage: table=... user=... mysql_seal_table
229
# prevents further modifications to a table by a user
230
{
231
	echo_func; kw_params table user; : "${table:?}" "${user:?}"; mk_table_esc
232
	
233
	benign_error=1 mysql_root <<<"REVOKE ALL PRIVILEGES ON $table FROM '$user'@'%'" || true
234
	benign_error=1 mysql_root <<<"REVOKE GRANT OPTION   ON $table FROM '$user'@'%'" || true
235
}
236

    
237

    
238
### PostgreSQL
239

    
240
alias use_pg='declare prefix=pg_; import_vars; unset prefix'
241

    
242
fi # load new aliases
243
if self_being_included; then
244

    
245
# usage: pg_*() { ...; pg_cmd "$@"; } (uses alias)
246
function pg_cmd() # usage for fn: pg_*() { ...; pg_cmd cmd "$@"; }
247
# auto-adds connection/login opts when specified
248
{
249
	echo_func
250
	
251
	use_pg
252
	log- 2
253
	local PGHOST="$server";       export PGHOST
254
	local PGUSER="$user";         export PGUSER
255
	local PGPASSWORD="$password"; export PGPASSWORD
256
	local PGDATABASE="$database"; export PGDATABASE
257
	log+ 2
258
	
259
	command "time" "$@"
260
}
261
alias pg_cmd='"pg_cmd" "${FUNCNAME%%__*}"'
262

    
263
fi # load new aliases
264
if self_being_included; then
265

    
266
psql() # usage: [stdin=copy_pstdin_file] psql <<<"cmds, e.g. \copy from pstdin"
267
{
268
	echo_func; kw_params stdin
269
	
270
	if can_log; then set -- --echo-all --echo-hidden "$@"; fi
271
	local redirs=("${redirs[@]}" '40<&0' "0<${stdin:-&20}" '41>&1')
272
	(
273
		# hide stack traces/DETAIL sections of error messages at verbosity <2
274
		if ! clog++ can_log; then echo '\set VERBOSITY terse'; fi
275
		if can_log; then cat <<'EOF'
276
\timing on
277
SET client_min_messages = NOTICE;
278
EOF
279
		fi
280
		cat
281
	)|cmd_log_fd=1 pg_cmd --file /dev/fd/40 --output /dev/fd/41 \
282
--set ON_ERROR_STOP=1 --quiet "$@"
283
		# --output is for query *results*, not echoed statements
284
}
285

    
286
pg_export() # usage: mk_select_opts... [pg_copy_format=CSV...] pg_export >out
287
{
288
	echo_func
289
	mk_select_var
290
	local pg_copy_format="${pg_copy_format-CSV HEADER}"
291
	
292
	psql "$@" <<<"COPY ($query) TO STDOUT $pg_copy_format;"
293
}
294

    
295
pg_header()
296
{
297
	echo_func
298
	local pg_copy_format="CSV HEADER" limit=0
299
	pg_export "$@"|echo_stdout
300
}
301

    
302
pg_export_table_no_header()
303
{
304
	echo_func
305
	local pg_copy_format="CSV"
306
	pg_export "$@"
307
}
308

    
309
pg_export_table_to_dir()
310
{
311
	echo_func
312
	local table="$1"; shift; mk_table_esc
313
	stdout="$exports_dir/$table.csv" to_file pg_export "$@"
314
}
315

    
316
pg_export_table_to_dir_no_header()
317
{
318
	echo_func
319
	local table="$1"; shift; mk_table_esc
320
	stdout="$exports_dir/$table.no_header.cols=$(pg_header).csv" to_file \
321
pg_export_table_no_header "$@"
322
}
323

    
324
pg_dump() # usage: [schema=...] [struct=1 | data=1] [compress=1] [owners=1] \
325
# [create_schema=] pg_dump [opts...] >out
326
{
327
	echo_func; kw_params struct data plain owners create_schema
328
	local create_schema="${create_schema-1}"
329
	
330
	# subset
331
	if test "$schema"; then set -- --schema="\"$schema\"" "$@"; fi
332
	
333
	# format
334
	if test "$compress"; then set -- "$@" --format=c --compress=9
335
	                     else set -- "$@" --format=p --inserts # plain
336
	fi
337
	if test "$struct"  ; then set -- "$@" --schema-only; fi
338
	if test "$data"    ; then set -- "$@" --data-only  ; fi
339
	if test ! "$owners"; then set -- "$@" --no-owner   ; fi
340
	
341
	(
342
		# filter output
343
		if test ! "$create_schema"; then
344
			fd=1 redirs= filter_fd sed 's/^CREATE SCHEMA/--&/'
345
		fi
346
		
347
		pg_cmd "$@"
348
	)
349
}
350

    
351
fi
(4-4/11)