diff --git a/xCAT-client/pods/man8/runsqlcmd.8.pod b/xCAT-client/pods/man8/runsqlcmd.8.pod new file mode 100644 index 000000000..ae4633001 --- /dev/null +++ b/xCAT-client/pods/man8/runsqlcmd.8.pod @@ -0,0 +1,84 @@ +=head1 NAME + +B -Runs sql command files against the current xCAT database. + +=head1 SYNOPSIS + + +B + +B {B<-h>|B<--help>} + +B {B<-v>|B<--version>} + +B {B<-d>|B<--dir> I} + +B {B<-f>|B<--files> I} + + +=head1 DESCRIPTION + +The runsqlcmd routine, runs the sql statements contained in the *.sql files as input to the command against the current running xCAT database. Only DB2,MySQL and PostgreSQL databases are supported. SQLite is not supported. +If no directory or filelist is provided, the default /opt/xcat/lib/perl/xCAT_schema directory is used. +If the directory is input with the -d flag, that directory will be used. +If a comma separated list of files is input with the -f flag, those files will be used. + +=head1 OPTIONS + +=over 6 + +=item B<-h|--help> + +Displays the usage message. + +=item B<-v|--version> + +=item B<-d|--dir> + +To use a directory other than the default directory, enter the directory path here. + +=item B<-f|--files> + +Comma separated list of files (full path), wildcard (*) can be used. + + +=item B + +The files must be of the form .sql or _.sql where + + is mysql,pgsql, or db2. + + +=back + +=head1 EXAMPLES + +=over 2 + +=item * + +To run the database appropriate *.sql files in /opt/xcat/lib/perl/xCAT_schema : + +B + +=item * + +To run the database appropriate *.sql files in /tmp/mysql: + +B I<-d> I + + +=item * + +To run the database appropriate *.sql files in the input list: + +B I<-f> I<"/tmp/mysql/test*,/tmp/mysql/test1*"> + +=item * + +To checkout one DB2 sql file: + +B I<-f> I + + +=back