create_sql_patches.pl File Reference
Go to the source code of this file.
Functions | |
| public | usage () |
Function Documentation
◆ usage()
| public usage | ( | ) |
Undocumented method
Code:
click to view
sub usage {
print <<EOT;
Usage:
\t$0 [-date <day_of_the_patch>] [-driver <name_of_first_driver>] [-driver <name_of_second_driver>] ...
\t$0 -h
\t-date\n\t\tdate in ISO format, e.g. 2015-02-14. Defaults to the current date
\t-driver (can be repeated)\n\t\tdriver for which create a patch. Defaults to MySQL, SQLite, and Postgre
\t-h|--help\n\t\tdisplay this help text
EOT
}
Undocumented method
Code:
click to view
sub usage {
print q{
Usage: perl sql2html.pl [OPTION]
Convert the SQL documentation into an HTML document.
Options:
-help Print this message
-help_format Print the description of the documentation format in the SQL files
An input file must be specified. This file must be a SQL file, with the "Java-doc like documentation".
For more information, please visit the following page:
http://www.ebi.ac.uk/seqdb/confluence/display/EV/SQL+documentation
-i A SQL file name (Required)
-fk An external SQL file name with foreign keys statements (Optional)
-o An HTML output file name (Required)
-d The name of the database (e.g Core, Variation, Functional Genomics, ...)
-c A flag to display the colours associated with the tables (1) or not (0). By default, the value is set to 1.
-v Version of the schema. Replace the string ####DB_VERSION#### by the value of the parameter "-v", in the introduction text. (Optional)
-intro A html/text file to include in the Introduction section (Optional. If not provided a default text will be inserted)
-html_head A html/text file to include extra text inside the html <head></head> tags. (Optional)
-show_header A flag to display headers for a group of tables (1) or not (0). By default, the value is set to 1.
-embed_diagrams A flag to include schema diagrams as dot graphs
-sort_headers A flag to sort (1) or not (0) the headers by alphabetic order. By default, the value is set to 1.
-sort_tables A flag to sort (1) or not (0) the tables by alphabetic order. By default, the value is set to 1.
Other optional options:
# If you want to add some SQL query results as examples:
-url URL of the database that has some data
-skip_connection Avoid to run the MySQL queries contained in the "@example" tags.
} . "\n";
exit(0);
}
