1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
use crate::traits::CommandBuilder;
use crate::Settings;
use std::convert::AsRef;
use std::ffi::{OsStr, OsString};
use std::path::PathBuf;

/// pg_dumpall extracts a PostgreSQL database cluster into an SQL script file.
#[derive(Clone, Debug, Default)]
pub struct PgDumpAllBuilder {
    program_dir: Option<PathBuf>,
    file: Option<OsString>,
    verbose: bool,
    version: bool,
    lock_wait_timeout: Option<u16>,
    help: bool,
    data_only: bool,
    clean: bool,
    encoding: Option<OsString>,
    globals_only: bool,
    no_owner: bool,
    roles_only: bool,
    schema_only: bool,
    superuser: Option<OsString>,
    tablespaces_only: bool,
    no_privileges: bool,
    binary_upgrade: bool,
    column_inserts: bool,
    disable_dollar_quoting: bool,
    disable_triggers: bool,
    exclude_database: Option<OsString>,
    extra_float_digits: Option<OsString>,
    if_exists: bool,
    inserts: bool,
    load_via_partition_root: bool,
    no_comments: bool,
    no_publications: bool,
    no_role_passwords: bool,
    no_security_labels: bool,
    no_subscriptions: bool,
    no_sync: bool,
    no_table_access_method: bool,
    no_tablespaces: bool,
    no_toast_compression: bool,
    no_unlogged_table_data: bool,
    on_conflict_do_nothing: bool,
    quote_all_identifiers: bool,
    rows_per_insert: Option<OsString>,
    use_set_session_authorization: bool,
    dbname: Option<OsString>,
    host: Option<OsString>,
    database: Option<OsString>,
    port: Option<u16>,
    username: Option<OsString>,
    no_password: bool,
    password: bool,
    pg_password: Option<OsString>,
    role: Option<OsString>,
}

impl PgDumpAllBuilder {
    /// Create a new [PgDumpAllBuilder]
    pub fn new() -> Self {
        Self::default()
    }

    /// Create a new [PgDumpAllBuilder] from [Settings]
    pub fn from(settings: &dyn Settings) -> Self {
        Self::new()
            .program_dir(settings.get_binary_dir())
            .host(settings.get_host())
            .port(settings.get_port())
            .username(settings.get_username())
            .pg_password(settings.get_password())
    }

    /// Location of the program binary
    pub fn program_dir<P: Into<PathBuf>>(mut self, path: P) -> Self {
        self.program_dir = Some(path.into());
        self
    }

    /// output file name
    pub fn file<S: AsRef<OsStr>>(mut self, file: S) -> Self {
        self.file = Some(file.as_ref().to_os_string());
        self
    }

    /// verbose mode
    pub fn verbose(mut self) -> Self {
        self.verbose = true;
        self
    }

    /// output version information, then exit
    pub fn version(mut self) -> Self {
        self.version = true;
        self
    }

    /// fail after waiting TIMEOUT for a table lock
    pub fn lock_wait_timeout(mut self, lock_wait_timeout: u16) -> Self {
        self.lock_wait_timeout = Some(lock_wait_timeout);
        self
    }

    /// show help, then exit
    pub fn help(mut self) -> Self {
        self.help = true;
        self
    }

    /// dump only the data, not the schema
    pub fn data_only(mut self) -> Self {
        self.data_only = true;
        self
    }

    /// clean (drop) database objects before recreating them
    pub fn clean(mut self) -> Self {
        self.clean = true;
        self
    }

    /// encoding for the dump
    pub fn encoding<S: AsRef<OsStr>>(mut self, encoding: S) -> Self {
        self.encoding = Some(encoding.as_ref().to_os_string());
        self
    }

    /// dump only global objects, not database-specific objects
    pub fn globals_only(mut self) -> Self {
        self.globals_only = true;
        self
    }

    /// do not output commands to set object ownership
    pub fn no_owner(mut self) -> Self {
        self.no_owner = true;
        self
    }

    /// dump only the roles, not the role memberships or privileges
    pub fn roles_only(mut self) -> Self {
        self.roles_only = true;
        self
    }

    /// dump only the object definitions (schema), not data
    pub fn schema_only(mut self) -> Self {
        self.schema_only = true;
        self
    }

    /// superuser user name to use in the dump
    pub fn superuser<S: AsRef<OsStr>>(mut self, superuser: S) -> Self {
        self.superuser = Some(superuser.as_ref().to_os_string());
        self
    }

    /// dump only the tablespace definitions
    pub fn tablespaces_only(mut self) -> Self {
        self.tablespaces_only = true;
        self
    }

    /// do not dump object privileges (grant/revoke commands)
    pub fn no_privileges(mut self) -> Self {
        self.no_privileges = true;
        self
    }

    /// dump in a format suitable for binary upgrade
    pub fn binary_upgrade(mut self) -> Self {
        self.binary_upgrade = true;
        self
    }

    /// dump data as INSERT commands with column names
    pub fn column_inserts(mut self) -> Self {
        self.column_inserts = true;
        self
    }

    /// disable dollar quoting, use SQL standard quoting
    pub fn disable_dollar_quoting(mut self) -> Self {
        self.disable_dollar_quoting = true;
        self
    }

    /// disable triggers during data-only restore
    pub fn disable_triggers(mut self) -> Self {
        self.disable_triggers = true;
        self
    }

    /// exclude the named database from the dump
    pub fn exclude_database<S: AsRef<OsStr>>(mut self, exclude_database: S) -> Self {
        self.exclude_database = Some(exclude_database.as_ref().to_os_string());
        self
    }

    /// set the number of digits displayed for floating-point values
    pub fn extra_float_digits<S: AsRef<OsStr>>(mut self, extra_float_digits: S) -> Self {
        self.extra_float_digits = Some(extra_float_digits.as_ref().to_os_string());
        self
    }

    /// use IF EXISTS when dropping objects
    pub fn if_exists(mut self) -> Self {
        self.if_exists = true;
        self
    }

    /// dump data as proper INSERT commands
    pub fn inserts(mut self) -> Self {
        self.inserts = true;
        self
    }

    /// load data via the partition root table
    pub fn load_via_partition_root(mut self) -> Self {
        self.load_via_partition_root = true;
        self
    }

    /// do not dump comments
    pub fn no_comments(mut self) -> Self {
        self.no_comments = true;
        self
    }

    /// do not dump publications
    pub fn no_publications(mut self) -> Self {
        self.no_publications = true;
        self
    }

    /// do not dump passwords for roles
    pub fn no_role_passwords(mut self) -> Self {
        self.no_role_passwords = true;
        self
    }

    /// do not dump security labels
    pub fn no_security_labels(mut self) -> Self {
        self.no_security_labels = true;
        self
    }

    /// do not dump subscriptions
    pub fn no_subscriptions(mut self) -> Self {
        self.no_subscriptions = true;
        self
    }

    /// do not wait for changes to be written safely to disk
    pub fn no_sync(mut self) -> Self {
        self.no_sync = true;
        self
    }

    /// do not dump table access method information
    pub fn no_table_access_method(mut self) -> Self {
        self.no_table_access_method = true;
        self
    }

    /// do not dump tablespace assignments
    pub fn no_tablespaces(mut self) -> Self {
        self.no_tablespaces = true;
        self
    }

    /// do not dump TOAST compression information
    pub fn no_toast_compression(mut self) -> Self {
        self.no_toast_compression = true;
        self
    }

    /// do not dump unlogged table data
    pub fn no_unlogged_table_data(mut self) -> Self {
        self.no_unlogged_table_data = true;
        self
    }

    /// use ON CONFLICT DO NOTHING for INSERTs
    pub fn on_conflict_do_nothing(mut self) -> Self {
        self.on_conflict_do_nothing = true;
        self
    }

    /// quote all identifiers, even if not key words
    pub fn quote_all_identifiers(mut self) -> Self {
        self.quote_all_identifiers = true;
        self
    }

    /// set the number of rows per INSERT command
    pub fn rows_per_insert<S: AsRef<OsStr>>(mut self, rows_per_insert: S) -> Self {
        self.rows_per_insert = Some(rows_per_insert.as_ref().to_os_string());
        self
    }

    /// use SET SESSION AUTHORIZATION commands instead of ALTER OWNER
    pub fn use_set_session_authorization(mut self) -> Self {
        self.use_set_session_authorization = true;
        self
    }

    /// database name to connect to
    pub fn dbname<S: AsRef<OsStr>>(mut self, dbname: S) -> Self {
        self.dbname = Some(dbname.as_ref().to_os_string());
        self
    }

    /// database server host or socket directory
    pub fn host<S: AsRef<OsStr>>(mut self, host: S) -> Self {
        self.host = Some(host.as_ref().to_os_string());
        self
    }

    /// database name to connect to
    pub fn database<S: AsRef<OsStr>>(mut self, database: S) -> Self {
        self.database = Some(database.as_ref().to_os_string());
        self
    }

    /// database server port number
    pub fn port(mut self, port: u16) -> Self {
        self.port = Some(port);
        self
    }

    /// user name to connect as
    pub fn username<S: AsRef<OsStr>>(mut self, username: S) -> Self {
        self.username = Some(username.as_ref().to_os_string());
        self
    }

    /// never prompt for password
    pub fn no_password(mut self) -> Self {
        self.no_password = true;
        self
    }

    /// force password prompt
    pub fn password(mut self) -> Self {
        self.password = true;
        self
    }

    /// user password
    pub fn pg_password<S: AsRef<OsStr>>(mut self, pg_password: S) -> Self {
        self.pg_password = Some(pg_password.as_ref().to_os_string());
        self
    }

    /// role name to use in the dump
    pub fn role<S: AsRef<OsStr>>(mut self, role: S) -> Self {
        self.role = Some(role.as_ref().to_os_string());
        self
    }
}

impl CommandBuilder for PgDumpAllBuilder {
    /// Get the program name
    fn get_program(&self) -> &'static OsStr {
        "pg_dumpall".as_ref()
    }

    /// Location of the program binary
    fn get_program_dir(&self) -> &Option<PathBuf> {
        &self.program_dir
    }

    /// Get the arguments for the command
    fn get_args(&self) -> Vec<OsString> {
        let mut args: Vec<OsString> = Vec::new();

        if let Some(file) = &self.file {
            args.push("--file".into());
            args.push(file.into());
        }

        if self.verbose {
            args.push("--verbose".into());
        }

        if self.version {
            args.push("--version".into());
        }

        if let Some(lock_wait_timeout) = &self.lock_wait_timeout {
            args.push("--lock-wait-timeout".into());
            args.push(lock_wait_timeout.to_string().into());
        }

        if self.help {
            args.push("--help".into());
        }

        if self.data_only {
            args.push("--data-only".into());
        }

        if self.clean {
            args.push("--clean".into());
        }

        if let Some(encoding) = &self.encoding {
            args.push("--encoding".into());
            args.push(encoding.into());
        }

        if self.globals_only {
            args.push("--globals-only".into());
        }

        if self.no_owner {
            args.push("--no-owner".into());
        }

        if self.roles_only {
            args.push("--roles-only".into());
        }

        if self.schema_only {
            args.push("--schema-only".into());
        }

        if let Some(superuser) = &self.superuser {
            args.push("--superuser".into());
            args.push(superuser.into());
        }

        if self.tablespaces_only {
            args.push("--tablespaces-only".into());
        }

        if self.no_privileges {
            args.push("--no-privileges".into());
        }

        if self.binary_upgrade {
            args.push("--binary-upgrade".into());
        }

        if self.column_inserts {
            args.push("--column-inserts".into());
        }

        if self.disable_dollar_quoting {
            args.push("--disable-dollar-quoting".into());
        }

        if self.disable_triggers {
            args.push("--disable-triggers".into());
        }

        if let Some(exclude_database) = &self.exclude_database {
            args.push("--exclude-database".into());
            args.push(exclude_database.into());
        }

        if let Some(extra_float_digits) = &self.extra_float_digits {
            args.push("--extra-float-digits".into());
            args.push(extra_float_digits.into());
        }

        if self.if_exists {
            args.push("--if-exists".into());
        }

        if self.inserts {
            args.push("--inserts".into());
        }

        if self.load_via_partition_root {
            args.push("--load-via-partition-root".into());
        }

        if self.no_comments {
            args.push("--no-comments".into());
        }

        if self.no_publications {
            args.push("--no-publications".into());
        }

        if self.no_role_passwords {
            args.push("--no-role-passwords".into());
        }

        if self.no_security_labels {
            args.push("--no-security-labels".into());
        }

        if self.no_subscriptions {
            args.push("--no-subscriptions".into());
        }

        if self.no_sync {
            args.push("--no-sync".into());
        }

        if self.no_table_access_method {
            args.push("--no-table-access-method".into());
        }

        if self.no_tablespaces {
            args.push("--no-tablespaces".into());
        }

        if self.no_toast_compression {
            args.push("--no-toast-compression".into());
        }

        if self.no_unlogged_table_data {
            args.push("--no-unlogged-table-data".into());
        }

        if self.on_conflict_do_nothing {
            args.push("--on-conflict-do-nothing".into());
        }

        if self.quote_all_identifiers {
            args.push("--quote-all-identifiers".into());
        }

        if let Some(rows_per_insert) = &self.rows_per_insert {
            args.push("--rows-per-insert".into());
            args.push(rows_per_insert.into());
        }

        if self.use_set_session_authorization {
            args.push("--use-set-session-authorization".into());
        }

        if let Some(dbname) = &self.dbname {
            args.push("--dbname".into());
            args.push(dbname.into());
        }

        if let Some(host) = &self.host {
            args.push("--host".into());
            args.push(host.into());
        }

        if let Some(database) = &self.database {
            args.push("--database".into());
            args.push(database.into());
        }

        if let Some(port) = &self.port {
            args.push("--port".into());
            args.push(port.to_string().into());
        }

        if let Some(username) = &self.username {
            args.push("--username".into());
            args.push(username.into());
        }

        if self.no_password {
            args.push("--no-password".into());
        }

        if self.password {
            args.push("--password".into());
        }

        if let Some(role) = &self.role {
            args.push("--role".into());
            args.push(role.into());
        }

        args
    }

    /// Get the environment variables for the command
    fn get_envs(&self) -> Vec<(OsString, OsString)> {
        let mut envs: Vec<(OsString, OsString)> = Vec::new();

        if let Some(password) = &self.pg_password {
            envs.push(("PGPASSWORD".into(), password.into()));
        }

        envs
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::traits::CommandToString;
    use crate::TestSettings;
    use test_log::test;

    #[test]
    fn test_builder_new() {
        let command = PgDumpAllBuilder::new().program_dir(".").build();
        assert_eq!(
            PathBuf::from(".").join("pg_dumpall"),
            PathBuf::from(command.to_command_string().replace("\"", ""))
        );
    }

    #[test]
    fn test_builder_from() {
        let command = PgDumpAllBuilder::from(&TestSettings).build();
        assert_eq!(
            r#"PGPASSWORD="password" "./pg_dumpall" "--host" "localhost" "--port" "5432" "--username" "postgres""#,
            command.to_command_string()
        )
    }

    #[test]
    fn test_builder() {
        let command = PgDumpAllBuilder::new()
            .file("dump.sql")
            .verbose()
            .version()
            .lock_wait_timeout(10)
            .help()
            .data_only()
            .clean()
            .encoding("UTF8")
            .globals_only()
            .no_owner()
            .roles_only()
            .schema_only()
            .superuser("postgres")
            .tablespaces_only()
            .no_privileges()
            .binary_upgrade()
            .column_inserts()
            .disable_dollar_quoting()
            .disable_triggers()
            .exclude_database("exclude")
            .extra_float_digits("2")
            .if_exists()
            .inserts()
            .load_via_partition_root()
            .no_comments()
            .no_publications()
            .no_role_passwords()
            .no_security_labels()
            .no_subscriptions()
            .no_sync()
            .no_table_access_method()
            .no_tablespaces()
            .no_toast_compression()
            .no_unlogged_table_data()
            .on_conflict_do_nothing()
            .quote_all_identifiers()
            .rows_per_insert("1000")
            .use_set_session_authorization()
            .dbname("postgres")
            .host("localhost")
            .database("postgres")
            .port(5432)
            .username("postgres")
            .no_password()
            .password()
            .pg_password("password")
            .role("postgres")
            .build();

        assert_eq!(
            r#"PGPASSWORD="password" "pg_dumpall" "--file" "dump.sql" "--verbose" "--version" "--lock-wait-timeout" "10" "--help" "--data-only" "--clean" "--encoding" "UTF8" "--globals-only" "--no-owner" "--roles-only" "--schema-only" "--superuser" "postgres" "--tablespaces-only" "--no-privileges" "--binary-upgrade" "--column-inserts" "--disable-dollar-quoting" "--disable-triggers" "--exclude-database" "exclude" "--extra-float-digits" "2" "--if-exists" "--inserts" "--load-via-partition-root" "--no-comments" "--no-publications" "--no-role-passwords" "--no-security-labels" "--no-subscriptions" "--no-sync" "--no-table-access-method" "--no-tablespaces" "--no-toast-compression" "--no-unlogged-table-data" "--on-conflict-do-nothing" "--quote-all-identifiers" "--rows-per-insert" "1000" "--use-set-session-authorization" "--dbname" "postgres" "--host" "localhost" "--database" "postgres" "--port" "5432" "--username" "postgres" "--no-password" "--password" "--role" "postgres""#,
            command.to_command_string()
        );
    }
}