From 6d92485ac88dc5e7450f1cab53825b6a8384e708 Mon Sep 17 00:00:00 2001 From: Matthieu Muffato <muffato@ebi.ac.uk> Date: Sun, 15 Dec 2013 21:39:12 +0000 Subject: [PATCH] Clearer documentation for DatabaseDumper --- .../EnsEMBL/Hive/RunnableDB/DatabaseDumper.pm | 35 +++++++++++-------- 1 file changed, 21 insertions(+), 14 deletions(-) diff --git a/modules/Bio/EnsEMBL/Hive/RunnableDB/DatabaseDumper.pm b/modules/Bio/EnsEMBL/Hive/RunnableDB/DatabaseDumper.pm index 9d75e2fa2..7ad45a23a 100644 --- a/modules/Bio/EnsEMBL/Hive/RunnableDB/DatabaseDumper.pm +++ b/modules/Bio/EnsEMBL/Hive/RunnableDB/DatabaseDumper.pm @@ -30,20 +30,27 @@ The following parameters are accepted: - output_file [string] : the file to write the dump to -The following table describes how the various options combine: -(T means table_list, EL exclude_list, EH exclude_ehive) -(l+ is the list of included tables, l- of excluded tables) - -T EL EH l+ l- - -+ 1 0 0 T = all except T -+ 0 0 TH 0 = T and H -0 0 0 0 0 = all -0 1 0 H 0 = H -+ 1 1 0 TH = all except T and H -+ 0 1 T H = T (minus H) -0 0 1 0 H = all except H -0 1 1 0 0 = nothing + +If "table_list" is undefined or maps to an empty list, the list +of tables to be dumped is decided accordingly to "exclude_list" (EL) +and "exclude_ehive" (EH). "exclude_list" controls the whole list of +non-eHive tables. + +EL EH List of tables to dump + +0 0 => all the tables +0 1 => all the tables, except the eHive ones +1 0 => all the tables, except the non-eHive ones = only the eHive tables +1 1 => both eHive and non-eHive tables are excluded = nothing is dumped + +If "table_list" is defined to non-empty list T, the table of decision is: + +EL EH List of tables to dump + +0 0 => all the tables in T + the eHive tables +0 1 => all the tables in T +1 0 => all the tables, except the ones in T +1 1 => all the tables, except the ones in T and the eHive ones =head1 LICENSE -- GitLab