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=...]} mk_select
49
{
50
	echo_func; kw_params query table cols filter; mk_table_esc
51
	if is_array cols; then cols="$(cols2list "${cols[@]}")"; fi
52
	echo "$(rtrim "${query:-SELECT ${cols:-*} ${cols:+
53
}FROM $table_esc
54
${filter:+WHERE $filter
55
}}")\
56
$(limit)"
57
}
58

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

    
64
fi # load new aliases
65
if self_being_included; then
66

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

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

    
79

    
80
### MySQL
81

    
82
alias set_database=\
83
'if test "$schema"; then declare database="${database-$schema}"; fi'
84

    
85
fi # load new aliases
86
if self_being_included; then
87

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

    
107
fi # load new aliases
108
if self_being_included; then
109

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

    
125
mysql_ANSI()
126
{
127
	echo_func
128
	(echo "SET sql_mode = 'ANSI';"; cat)|mysql "$@"
129
}
130

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

    
135
fi # load new aliases
136
if self_being_included; then
137

    
138
mysql_root() { echo_func; use_root; mysql "$@"; }
139

    
140
mysql_truncate() { echo_func; mk_truncate|mysql; }
141

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

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

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

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

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

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

    
223
## permissions
224

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

    
234

    
235
### PostgreSQL
236

    
237
alias use_pg='declare prefix=pg_; import_vars; unset prefix'
238

    
239
fi # load new aliases
240
if self_being_included; then
241

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

    
260
fi # load new aliases
261
if self_being_included; then
262

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

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

    
292
pg_header()
293
{
294
	echo_func
295
	local pg_copy_format="CSV HEADER" limit=0
296
	pg_export "$@"|echo_stdout
297
}
298

    
299
pg_export_table_no_header()
300
{
301
	echo_func
302
	local pg_copy_format="CSV"
303
	pg_export "$@"
304
}
305

    
306
pg_export_table_to_dir_no_header()
307
{
308
	echo_func
309
	local table="$1"; shift; mk_table_esc
310
	stdout="$exports_dir/$table.no_header.cols=$(pg_header).csv" to_file \
311
pg_export_table_no_header "$@"
312
}
313

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

    
341
fi
(4-4/11)