=head1 NAME

B<tabdump> - display an xCAT database table in CSV format.

=head1 SYNOPSIS

B<tabdump> 

B<tabdump> [B<-d>] [I<table>]

B<tabdump> [I<table>]

B<tabdump> [B<-f> I<filename>] [I<table>]

B<tabdump> [B<-n> I<# of records>] [B<auditlog> | B<eventlog>]

B<tabdump> [B<-w> I<attr>==I<val>] [B<-w> I<attr>=~I<val>] ...] [I<table>]

B<tabdump> [B<-w> I<attr>==I<val>] [B<-w> I<attr>=~I<val>] ...] [B<-f> I<filename>] [I<table>]

B<tabdump> [B<-v> | B<--version>]

B<tabdump> [B<-?> | B<-h> | B<--help>]

=head1 DESCRIPTION

The tabdump command displays the header and all the rows of the specified table in CSV (comma separated values) format.
Only one table can be specified.  If no table is specified, the list of existing
tables will be displayed.

=head1 OPTIONS

=over 10

=item B<-?|-h|--help>

Display usage message.

=item B<-d>

Show descriptions of the tables, instead of the contents of the tables.  If a table name is also specified, descriptions of the columns (attributes) of the table will be displayed.  Otherwise, a summary of each table will be displayed.

=item B<-n>

Shows the most recent number of entries as supplied on the -n flag from the auditlog or eventlog table.  

=item B<-f>

File name or path to file in which to dump the table. Without this the table is dumped
to stdout.  Using the -f flag allows the table to be dumped one record at a time. If tables are very large, dumping to stdout can cause problems such as running out of memory. 

=item B<-w> I<'attr==val'> B<-w> I<'attr=~val'> ...

Use one or multiple -w flags to specify the selection string that can be used to select particular rows of the table. See examples.

Operator descriptions:

        ==        Select nodes where the attribute value is exactly this value.
        !=        Select nodes where the attribute value is not this specific value.
        >         Select nodes where the attribute value is greater than this  specific value.
        >=        Select nodes where the attribute value is greater than or equal to this  specific value.
        <         Select nodes where the attribute value is less than this  specific value.
        <=        Select nodes where the attribute value is less than or equal to this  specific value.
        =~        Select nodes where the attribute value matches the SQL LIKE value.
        !~        Select nodes where the attribute value matches the SQL NOT LIKE value.


=back

=head1 RETURN VALUE

=over 3

=item 0. 
The command completed successfully.

=item 1. 
An error has occurred.

=back

=head1 EXAMPLES

=over 2

=item 1.
To display the contents of the site table:

 tabdump site

=item 2.
To display the contents of the nodelist table where the groups attribute is compute :

 tabdump -w 'groups==compute' nodelist

=item 3.
To display the contents of the nodelist table where the groups attribute is comput% where % is a wildcard and can represent any string  and the status attribute is booted :

 tabdump -w 'groups=~comput%' -w 'status==booted' nodelist

=item 4.
To display the records of the auditlog on date  2011-04-18 11:30:00 :

 tabdump -w 'audittime==2011-04-18 11:30:00' auditlog

=item 5.
To display the records of the auditlog starting on 2011-04-18:

 tabdump -w 'audittime>2011-04-18 11:30:00' auditlog

=item 6.
To display the 10 most recent entries in the auditlog:

 tabdump -n 10 auditlog

=item 7.
To see what tables exist in the xCAT database:

 tabdump

=item 8.
To back up all the xCAT database tables, instead of running B<tabdump> multiple times, you can use the B<dumpxCATdb> command as follows:

 dumpxCATdb -p /tmp/xcatbak

See the B<dumpxCATdb> man page for details.

=item 9.
To display a summary description of each table:

 tabdump -d

=item 10.
To display a description of each column in the nodehm table:

 tabdump -d nodehm

=back

=head1 FILES

/opt/xcat/sbin/tabdump

=head1 SEE ALSO

L<tabrestore(8)|tabrestore.8>, L<tabedit(8)|tabedit.8>, L<dumpxCATdb(1)|dumpxCATdb.1>
