option to keep an email address but not email it invoices, RT#17676
[freeside.git] / FS / FS / Schema.pm
1 package FS::Schema;
2
3 use vars qw(@ISA @EXPORT_OK $DEBUG $setup_hack %dbdef_cache);
4 use subs qw(reload_dbdef);
5 use Exporter;
6 use DBIx::DBSchema 0.40; #0.40 for mysql upgrade fixes
7 use DBIx::DBSchema::Table;
8 use DBIx::DBSchema::Column;
9 use DBIx::DBSchema::Index;
10
11 @ISA = qw(Exporter);
12 @EXPORT_OK = qw( dbdef dbdef_dist reload_dbdef );
13
14 $DEBUG = 0;
15 $me = '[FS::Schema]';
16
17 =head1 NAME
18
19 FS::Schema - Freeside database schema
20
21 =head1 SYNOPSYS
22
23     use FS::Schema qw(dbdef dbdef_dist reload_dbdef);
24
25     $dbdef = reload_dbdef;
26     $dbdef = reload_dbdef "/non/standard/filename";
27     $dbdef = dbdef;
28     $dbdef_dist = dbdef_dist;
29
30 =head1 DESCRIPTION
31
32 This class represents the database schema.
33
34 =head1 METHODS
35
36 =over 4
37
38 =item reload_dbdef([FILENAME])
39
40 Load a database definition (see L<DBIx::DBSchema>), optionally from a
41 non-default filename.  This command is executed at startup unless
42 I<$FS::Schema::setup_hack> is true.  Returns a DBIx::DBSchema object.
43
44 =cut
45
46 sub reload_dbdef {
47   my $file = shift;
48
49   unless ( exists $dbdef_cache{$file} ) {
50     warn "[debug]$me loading dbdef for $file\n" if $DEBUG;
51     $dbdef_cache{$file} = DBIx::DBSchema->load( $file )
52       or die "can't load database schema from $file: $DBIx::DBSchema::errstr\n";
53   } else {
54     warn "[debug]$me re-using cached dbdef for $file\n" if $DEBUG;
55   }
56   $dbdef = $dbdef_cache{$file};
57 }
58
59 =item dbdef
60
61 Returns the current database definition (represents the current database,
62 assuming it is up-to-date).  See L<DBIx::DBSchema>.
63
64 =cut
65
66 sub dbdef { $dbdef; }
67
68 =item dbdef_dist [ DATASRC ]
69
70 Returns the current canoical database definition as defined in this file.
71
72 Optionally, pass a DBI data source to enable syntax specific to that database.
73 Currently, this enables "ENGINE=InnoDB" for MySQL databases.
74
75 =cut
76
77 sub dbdef_dist {
78   my $datasrc = @_ ? shift : '';
79   
80   my $local_options = '';
81   if ( $datasrc =~ /^dbi:mysql/i ) {
82     $local_options = 'ENGINE=InnoDB';
83   }
84
85   ###
86   # create a dbdef object from the old data structure
87   ###
88
89   my $tables_hashref = tables_hashref();
90
91   #turn it into objects
92   my $dbdef = new DBIx::DBSchema map {  
93
94     my $tablename = $_;
95     my $indexnum = 1;
96
97     my @columns;
98     while (@{$tables_hashref->{$tablename}{'columns'}}) {
99       #my($name, $type, $null, $length, $default, $local) =
100       my @coldef = 
101         splice @{$tables_hashref->{$tablename}{'columns'}}, 0, 6;
102       my %hash = map { $_ => shift @coldef }
103                      qw( name type null length default local );
104
105       #can be removed once we depend on DBIx::DBSchema 0.39;
106       $hash{'type'} = 'LONGTEXT'
107         if $hash{'type'} =~ /^TEXT$/i && $datasrc =~ /^dbi:mysql/i;
108
109       unless ( defined $hash{'default'} ) {
110         warn "$tablename:\n".
111              join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
112       }
113
114       push @columns, new DBIx::DBSchema::Column ( \%hash );
115     }
116
117     #false laziness w/sub indices in DBIx::DBSchema::DBD (well, sorta)
118     #and sub sql_create_table in DBIx::DBSchema::Table (slighty more?)
119     my $unique = $tables_hashref->{$tablename}{'unique'};
120     warn "missing index for $tablename\n" unless defined $tables_hashref->{$tablename}{'index'};
121     my @index  = @{ $tables_hashref->{$tablename}{'index'} };
122
123     # kludge to avoid avoid "BLOB/TEXT column 'statustext' used in key
124     #  specification without a key length".
125     # better solution: teach DBIx::DBSchema to specify a default length for
126     #  MySQL indices on text columns, or just to support an index length at all
127     #  so we can pass something in.
128     # best solution: eliminate need for this index in cust_main::retry_realtime
129     @index = grep { @{$_}[0] ne 'statustext' } @index
130       if $datasrc =~ /^dbi:mysql/i;
131
132     my @indices = ();
133     push @indices, map {
134                          DBIx::DBSchema::Index->new({
135                            'name'    => $tablename. $indexnum++,
136                            'unique'  => 1,
137                            'columns' => $_,
138                          });
139                        }
140                        @$unique;
141     push @indices, map {
142                          DBIx::DBSchema::Index->new({
143                            'name'    => $tablename. $indexnum++,
144                            'unique'  => 0,
145                            'columns' => $_,
146                          });
147                        }
148                        @index;
149
150     DBIx::DBSchema::Table->new({
151       'name'          => $tablename,
152       'primary_key'   => $tables_hashref->{$tablename}{'primary_key'},
153       'columns'       => \@columns,
154       'indices'       => \@indices,
155       'local_options' => $local_options,
156     });
157
158   } keys %$tables_hashref;
159
160   if ( $DEBUG ) {
161     warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
162     warn "[debug]$me   $_\n" foreach $dbdef->tables;
163   }
164   
165   #add radius attributes to svc_acct
166   #
167   #my($svc_acct)=$dbdef->table('svc_acct');
168   # 
169   #my($attribute);
170   #foreach $attribute (@attributes) {
171   #  $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
172   #    'radius_'. $attribute,
173   #    'varchar',
174   #    'NULL',
175   #    $char_d,
176   #  ));
177   #}
178   # 
179   #foreach $attribute (@check_attributes) {
180   #  $svc_acct->addcolumn( new DBIx::DBSchema::Column (
181   #    'rc_'. $attribute,
182   #    'varchar',
183   #    'NULL',
184   #    $char_d,
185   #  ));
186   #}
187
188   my $tables_hashref_torrus = tables_hashref_torrus();
189
190   #create history tables (false laziness w/create-history-tables)
191   foreach my $table (
192     grep {    ! /^clientapi_session/
193            && ! /^h_/
194            && ! $tables_hashref_torrus->{$_}
195          }
196       $dbdef->tables
197   ) {
198     my $tableobj = $dbdef->table($table)
199       or die "unknown table $table";
200
201     my %h_indices = ();
202
203     unless ( $table eq 'cust_event' ) { #others?
204
205       my %indices = $tableobj->indices;
206     
207       %h_indices = map { 
208                          ( "h_$_" =>
209                              DBIx::DBSchema::Index->new({
210                                'name'    => 'h_'. $indices{$_}->name,
211                                'unique'  => 0,
212                                'columns' => [ @{$indices{$_}->columns} ],
213                              })
214                          );
215                        }
216                        keys %indices;
217
218       $h_indices{"h_${table}_srckey"} =
219         DBIx::DBSchema::Index->new({
220           'name'    => "h_${table}_srckey",
221           'unique'  => 0,
222           'columns' => [ 'history_action', #right?
223                          $tableobj->primary_key,
224                        ],
225         });
226
227       $h_indices{"h_${table}_srckey2"} =
228          DBIx::DBSchema::Index->new({
229            'name'    => "h_${table}_srckey2",
230            'unique'  => 0,
231            'columns' => [ 'history_date',
232                           $tableobj->primary_key,
233                         ],
234          });
235
236     }
237
238     my $h_tableobj = DBIx::DBSchema::Table->new( {
239       'name'          => "h_$table",
240       'primary_key'   => 'historynum',
241       'indices'       => \%h_indices,
242       'local_options' => $local_options,
243       'columns'       => [
244           DBIx::DBSchema::Column->new( {
245             'name'    => 'historynum',
246             'type'    => 'serial',
247             'null'    => 'NOT NULL',
248             'length'  => '',
249             'default' => '',
250             'local'   => '',
251           } ),
252           DBIx::DBSchema::Column->new( {
253             'name'    => 'history_date',
254             'type'    => 'int',
255             'null'    => 'NULL',
256             'length'  => '',
257             'default' => '',
258             'local'   => '',
259           } ),
260           DBIx::DBSchema::Column->new( {
261             'name'    => 'history_user',
262             'type'    => 'varchar',
263             'null'    => 'NOT NULL',
264             'length'  => '80',
265             'default' => '',
266             'local'   => '',
267           } ),
268           DBIx::DBSchema::Column->new( {
269             'name'    => 'history_action',
270             'type'    => 'varchar',
271             'null'    => 'NOT NULL',
272             'length'  => '80',
273             'default' => '',
274             'local'   => '',
275           } ),
276           map {
277             my $column = $tableobj->column($_);
278     
279             #clone so as to not disturb the original
280             $column = DBIx::DBSchema::Column->new( {
281               map { $_ => $column->$_() }
282                 qw( name type null length default local )
283             } );
284     
285             if ( $column->type =~ /^(\w*)SERIAL$/i ) {
286               $column->type(uc($1).'INT');
287               $column->null('NULL');
288             }
289             #$column->default('')
290             #  if $column->default =~ /^nextval\(/i;
291             #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
292             #$column->local($local);
293             $column;
294           } $tableobj->columns
295       ],
296     } );
297     $dbdef->addtable($h_tableobj);
298   }
299
300   if ( $datasrc =~ /^dbi:mysql/i ) {
301
302     my $dup_lock_table = DBIx::DBSchema::Table->new( {
303       'name'          => 'duplicate_lock',
304       'primary_key'   => 'duplocknum',
305       'local_options' => $local_options,
306       'columns'       => [
307         DBIx::DBSchema::Column->new( {
308           'name'    => 'duplocknum',
309           'type'    => 'serial',
310           'null'    => 'NOT NULL',
311           'length'  => '',
312           'default' => '',
313           'local'   => '',
314         } ),
315         DBIx::DBSchema::Column->new( {
316           'name'    => 'lockname',
317           'type'    => 'varchar',
318           'null'    => 'NOT NULL',
319           'length'  => '80',
320           'default' => '',
321           'local'   => '',
322         } ),
323       ],
324       'indices' => { 'duplicate_lock1' =>
325                        DBIx::DBSchema::Index->new({
326                          'name'    => 'duplicate_lock1',
327                          'unique'  => 1,
328                          'columns' => [ 'lockname' ],
329                        })
330                    },
331     } );
332
333     $dbdef->addtable($dup_lock_table);
334
335   }
336
337   $dbdef;
338
339 }
340
341 #torrus tables http://torrus.org/reporting_setup.pod.html#create_sql_tables
342 sub tables_hashref_torrus {
343
344   return {
345
346     # Collector export table. It usually grows at several megabytes
347     # per month, and is updated every 5 minutes
348     'srvexport' => {
349       'columns' => [
350         'id',         'serial', '', '', '', '',
351         'srv_date',     'date', '', '', '', '',#date and time of the data sample
352         'srv_time',     'time', '', '', '', '',
353         'serviceid', 'varchar', '', 64, '', '',#unique service ID per counter
354         'value',     'double precision', '', '', '', '',#collected rate or gauge value
355         'intvl', 'int', '', '', '', '', # collection interval - for counter volume calculation
356       ],
357       'primary_key' => 'id',
358       'unique' => [],
359       'index'  => [ ['srv_date'], ['srv_date', 'srv_time'], ['serviceid'], ],
360     },
361
362     #Tables for (currently monthly only) report contents.
363     #These are updated usually once per month, and read at the moment of
364     #rendering the report output (HTML now, PDF or XML or Excel or whatever
365     #in the future)
366
367     #DBIx::Sequence backend, theplatform-independent inplementation
368     #of sequences
369     'dbix_sequence_state' => {
370       'columns' => [
371         'id',       'serial', '', '', '', '',
372         'dataset', 'varchar', '', 50, '', '',
373         'state_id',    'int', '', '', '', '',
374       ],
375       'primary_key' => 'id',
376       #CONSTRAINT pk_dbix_sequence PRIMARY KEY (dataset, state_id)
377       'unique' => [ [ 'dataset', 'state_id' ], ],
378       'index'  => [],
379     },
380
381     'dbix_sequence_release' => {
382       'columns' => [
383         'id',       'serial', '', '', '', '',
384         'dataset', 'varchar', '', 50, '', '',
385         'released_id', 'int', '', '', '', '',
386       ],
387       'primary_key' => 'id',
388       #CONSTRAINT pk_dbi_release PRIMARY KEY (dataset, released_id)
389       'unique' => [ [ 'dataset', 'released_id', ] ],
390       'index'  => [],
391     },
392
393     #Each report is characterized by name, date and time.
394     #Monthly reports are automatically assigned 00:00 of the 1st day
395     #in the month. The report contains fields for every service ID
396     #defined across all datasource trees.
397     'reports' => {
398       'columns' => [
399         'id',          'serial', '', '', '', '',
400         'rep_date',      'date', '', '', '', '',#Start date of the report
401         'rep_time',      'time', '', '', '', '',#Start time of the report
402         'reportname', 'varchar', '', 64, '', '',#Report name, such as
403                                                 # MonthlyUsage
404         'iscomplete',     'int', '', '', '', '',#0 when the report is in
405                                                 # progress, 1 when it is ready
406       ],
407       'primary_key' => 'id',
408       'unique' => [ [ qw(rep_date rep_time reportname) ] ],
409       'index'  => [ [ 'rep_date' ] ],
410     },
411
412     #Each report contains fields. For each service ID,
413     #the report may contain several fields for various statistics.
414     #Each field contains information about the units of the value it
415     #contains
416     'reportfields' => {
417       'columns' => [
418         'id',              'serial',     '', '',    '', '',
419         'rep_id',             'int', 'NULL', '',    '', '',
420         'name',           'varchar',     '', 64,    '', '',#name of the field,
421                                                            # such as AVG or MAX
422         'serviceid',      'varchar',     '', 64,    '', '',#service ID
423         'value', 'double precision',     '', '',    '', '',#Numeric value
424         'units',          'varchar',     '', 64, \"''", '',#Units, such as bytes
425                                                            # or Mbps
426       ],
427       'primary_key', => 'id',
428       'unique' => [ [ qw(rep_id name serviceid) ] ],
429       'index'  => [],
430     },
431
432   };
433
434 }
435
436 sub tables_hashref {
437
438   my $char_d = 80; #default maxlength for text fields
439
440   #my(@date_type)  = ( 'timestamp', '', ''     );
441   my @date_type  = ( 'int', 'NULL', ''     );
442   my @perl_type = ( 'text', 'NULL', ''  ); 
443   my @money_type = ( 'decimal',   '', '10,2' );
444   my @money_typen = ( 'decimal',   'NULL', '10,2' );
445   my @taxrate_type  = ( 'decimal',   '',     '14,8' ); # requires pg 8 for 
446   my @taxrate_typen = ( 'decimal',   'NULL', '14,8' ); # fs-upgrade to work
447
448   my $username_len = 32; #usernamemax config file
449
450     # name type nullability length default local
451
452   return {
453
454     'agent' => {
455       'columns' => [
456         'agentnum',          'serial',    '',       '', '', '', 
457         'agent',            'varchar',    '',  $char_d, '', '', 
458         'typenum',              'int',    '',       '', '', '', 
459         'ticketing_queueid',    'int', 'NULL',      '', '', '', 
460         'invoice_template', 'varchar', 'NULL', $char_d, '', '',
461         'agent_custnum',        'int', 'NULL',      '', '', '',
462         'disabled',            'char', 'NULL',       1, '', '', 
463         'username',         'varchar', 'NULL', $char_d, '', '',
464         '_password',        'varchar', 'NULL', $char_d, '', '',
465         'freq',              'int', 'NULL', '', '', '', #deprecated (never used)
466         'prog',                     @perl_type, '', '', #deprecated (never used)
467       ],
468       'primary_key' => 'agentnum',
469       #'unique' => [ [ 'agent_custnum' ] ], #one agent per customer?
470                                             #insert is giving it a value, tho..
471       #'index' => [ ['typenum'], ['disabled'] ],
472       'unique' => [],
473       'index' => [ ['typenum'], ['disabled'], ['agent_custnum'] ],
474     },
475
476     'sales' => {
477       'columns' => [
478         'salesnum',          'serial',    '',       '', '', '', 
479         'salesperson',      'varchar',    '',  $char_d, '', '', 
480         'agentnum',             'int', 'NULL',      '', '', '', 
481         'disabled',            'char', 'NULL',       1, '', '', 
482       ],
483       'primary_key' => 'salesnum',
484       'unique' => [],
485       'index' => [ ['salesnum'], ['disabled'] ],
486     },
487
488     'agent_type' => {
489       'columns' => [
490         'typenum',   'serial',  '', '', '', '', 
491         'atype',     'varchar', '', $char_d, '', '', 
492       ],
493       'primary_key' => 'typenum',
494       'unique' => [],
495       'index' => [],
496     },
497
498     'type_pkgs' => {
499       'columns' => [
500         'typepkgnum', 'serial', '', '', '', '', 
501         'typenum',   'int',  '', '', '', '', 
502         'pkgpart',   'int',  '', '', '', '', 
503       ],
504       'primary_key' => 'typepkgnum',
505       'unique' => [ ['typenum', 'pkgpart'] ],
506       'index' => [ ['typenum'] ],
507     },
508
509     'cust_attachment' => {
510       'columns' => [
511         'attachnum', 'serial', '', '', '', '',
512         'custnum',   'int', '', '', '', '',
513         '_date',     @date_type, '', '',
514         'otaker',    'varchar', 'NULL', 32, '', '',
515         'usernum',   'int', 'NULL', '', '', '',
516         'filename',  'varchar', '', 255, '', '',
517         'mime_type', 'varchar', '', $char_d, '', '',
518         'title',     'varchar', 'NULL', $char_d, '', '',
519         'body',      'blob', 'NULL', '', '', '',
520         'disabled',  @date_type, '', '',
521       ],
522       'primary_key' => 'attachnum',
523       'unique'      => [],
524       'index'       => [ ['custnum'], ['usernum'], ],
525     },
526
527     'cust_bill' => {
528       'columns' => [
529         #regular fields
530         'invnum',    'serial',     '', '', '', '', 
531         'custnum',      'int',     '', '', '', '', 
532         '_date',        @date_type,        '', '', 
533         'charged',      @money_type,       '', '', 
534         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
535
536         #customer balance info at invoice generation time
537         'previous_balance',   @money_typen, '', '',  #eventually not nullable
538         'billing_balance',    @money_typen, '', '',  #eventually not nullable
539
540         #deprecated (unused by now, right?)
541         'printed',      'int',     '', '', '', '', 
542
543         #specific use cases
544         'closed',      'char', 'NULL',  1, '', '', #not yet used much
545         'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
546         'agent_invid',  'int', 'NULL', '', '', '', #(varchar?) importing legacy
547         'promised_date', @date_type,       '', '',
548       ],
549       'primary_key' => 'invnum',
550       'unique' => [ [ 'custnum', 'agent_invid' ] ], #agentnum?  huh
551       'index' => [ ['custnum'], ['_date'], ['statementnum'], ['agent_invid'] ],
552     },
553
554     #for importing invoices from a legacy system for display purposes only
555     # no effect upon balance
556     'legacy_cust_bill' => {
557       'columns' => [
558         'legacyinvnum',  'serial',     '',      '', '', '',
559         'legacyid',     'varchar', 'NULL', $char_d, '', '',
560         'custnum',          'int',     '',      '', '', '', 
561         '_date',       @date_type,                  '', '', 
562         'charged',    @money_type,                  '', '', 
563         'content_pdf',     'blob', 'NULL',      '', '', '',
564         'content_html',    'text', 'NULL',      '', '', '',
565         'locale',       'varchar', 'NULL',      16, '', '', 
566       ],
567       'primary_key' => 'legacyinvnum',
568       'unique' => [],
569       'index'  => [ ['legacyid', 'custnum', 'locale' ], ],
570     },
571
572     'cust_statement' => {
573       'columns' => [
574         'statementnum', 'serial', '', '', '', '',
575         'custnum',         'int', '', '', '', '',
576         '_date',           @date_type,    '', '',
577       ],
578       'primary_key' => 'statementnum',
579       'unique' => [],
580       'index' => [ ['custnum'], ['_date'], ],
581     },
582
583     'cust_bill_event' => {
584       'columns' => [
585         'eventnum',    'serial',  '', '', '', '', 
586         'invnum',   'int',  '', '', '', '', 
587         'eventpart',   'int',  '', '', '', '', 
588         '_date',     @date_type, '', '', 
589         'status', 'varchar', '', $char_d, '', '', 
590         'statustext', 'text', 'NULL', '', '', '', 
591       ],
592       'primary_key' => 'eventnum',
593       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
594       'unique' => [],
595       'index' => [ ['invnum'], ['status'], ['eventpart'],
596                    ['statustext'], ['_date'],
597                  ],
598     },
599
600     'part_bill_event' => {
601       'columns' => [
602         'eventpart',    'serial',  '', '', '', '', 
603         'freq',        'varchar',       'NULL',     $char_d, '', '', 
604         'payby',       'char',  '', 4, '', '', 
605         'event',       'varchar',           '',     $char_d, '', '', 
606         'eventcode',    @perl_type, '', '', 
607         'seconds',     'int', 'NULL', '', '', '', 
608         'weight',      'int', '', '', '', '', 
609         'plan',       'varchar', 'NULL', $char_d, '', '', 
610         'plandata',   'text', 'NULL', '', '', '', 
611         'reason',     'int', 'NULL', '', '', '', 
612         'disabled',     'char', 'NULL', 1, '', '', 
613       ],
614       'primary_key' => 'eventpart',
615       'unique' => [],
616       'index' => [ ['payby'], ['disabled'], ],
617     },
618
619     'part_event' => {
620       'columns' => [
621         'eventpart',   'serial',      '',      '', '', '', 
622         'agentnum',    'int',     'NULL',      '', '', '', 
623         'event',       'varchar',     '', $char_d, '', '', 
624         'eventtable',  'varchar',     '', $char_d, '', '',
625         'check_freq',  'varchar', 'NULL', $char_d, '', '', 
626         'weight',      'int',         '',      '', '', '', 
627         'action',      'varchar',     '', $char_d, '', '',
628         'disabled',     'char',   'NULL',       1, '', '', 
629       ],
630       'primary_key' => 'eventpart',
631       'unique' => [],
632       'index' => [ ['agentnum'], ['eventtable'], ['check_freq'], ['disabled'], ],
633     },
634
635     'part_event_option' => {
636       'columns' => [
637         'optionnum', 'serial', '', '', '', '', 
638         'eventpart', 'int', '', '', '', '', 
639         'optionname', 'varchar', '', $char_d, '', '', 
640         'optionvalue', 'text', 'NULL', '', '', '', 
641       ],
642       'primary_key' => 'optionnum',
643       'unique'      => [],
644       'index'       => [ [ 'eventpart' ], [ 'optionname' ] ],
645     },
646
647     'part_event_condition' => {
648       'columns' => [
649         'eventconditionnum', 'serial', '', '', '', '', 
650         'eventpart', 'int', '', '', '', '', 
651         'conditionname', 'varchar', '', $char_d, '', '', 
652       ],
653       'primary_key' => 'eventconditionnum',
654       'unique'      => [],
655       'index'       => [ [ 'eventpart' ], [ 'conditionname' ] ],
656     },
657
658     'part_event_condition_option' => {
659       'columns' => [
660         'optionnum', 'serial', '', '', '', '', 
661         'eventconditionnum', 'int', '', '', '', '', 
662         'optionname', 'varchar', '', $char_d, '', '', 
663         'optionvalue', 'text', 'NULL', '', '', '', 
664       ],
665       'primary_key' => 'optionnum',
666       'unique'      => [],
667       'index'       => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
668     },
669
670     'part_event_condition_option_option' => {
671       'columns' => [
672         'optionoptionnum', 'serial', '', '', '', '', 
673         'optionnum', 'int', '', '', '', '', 
674         'optionname', 'varchar', '', $char_d, '', '', 
675         'optionvalue', 'text', 'NULL', '', '', '', 
676       ],
677       'primary_key' => 'optionoptionnum',
678       'unique'      => [],
679       'index'       => [ [ 'optionnum' ], [ 'optionname' ] ],
680     },
681
682     'cust_event' => {
683       'columns' => [
684         'eventnum',    'serial',  '', '', '', '', 
685         'eventpart',   'int',  '', '', '', '', 
686         'tablenum',   'int',  '', '', '', '', 
687         '_date',     @date_type, '', '', 
688         'status', 'varchar', '', $char_d, '', '', 
689         'statustext', 'text', 'NULL', '', '', '', 
690       ],
691       'primary_key' => 'eventnum',
692       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
693       'unique' => [],
694       'index' => [ ['eventpart'], ['tablenum'], ['status'],
695                    ['statustext'], ['_date'],
696                  ],
697     },
698
699     'cust_bill_pkg' => {
700       'columns' => [
701         'billpkgnum',        'serial',     '',      '', '', '', 
702         'invnum',               'int',     '',      '', '', '', 
703         'pkgnum',               'int',     '',      '', '', '', 
704         'pkgpart_override',     'int', 'NULL',      '', '', '', 
705         'setup',               @money_type,             '', '', 
706         'recur',               @money_type,             '', '', 
707         'sdate',               @date_type,              '', '', 
708         'edate',               @date_type,              '', '', 
709         'itemdesc',         'varchar', 'NULL', $char_d, '', '', 
710         'itemcomment',      'varchar', 'NULL', $char_d, '', '', 
711         'section',          'varchar', 'NULL', $char_d, '', '', 
712         'freq',             'varchar', 'NULL', $char_d, '', '',
713         'quantity',             'int', 'NULL',      '', '', '',
714         'unitsetup',           @money_typen,            '', '', 
715         'unitrecur',           @money_typen,            '', '', 
716         'hidden',              'char', 'NULL',       1, '', '',
717       ],
718       'primary_key' => 'billpkgnum',
719       'unique' => [],
720       'index' => [ ['invnum'], [ 'pkgnum' ], [ 'itemdesc' ], ],
721     },
722
723     'cust_bill_pkg_detail' => {
724       'columns' => [
725         'detailnum', 'serial', '', '', '', '', 
726         'billpkgnum', 'int', 'NULL', '', '', '',        # should not be nullable
727         'pkgnum',  'int', 'NULL', '', '', '',           # deprecated
728         'invnum',  'int', 'NULL', '', '', '',           # deprecated
729         'amount',  'decimal', 'NULL', '10,4', '', '',
730         'format',  'char', 'NULL', 1, '', '',
731         'classnum', 'int', 'NULL', '', '', '',
732         'duration', 'int', 'NULL', '',  0, '',
733         'phonenum', 'varchar', 'NULL', 15, '', '',
734         'accountcode', 'varchar',  'NULL',      20, '', '',
735         'startdate',  @date_type, '', '', 
736         'regionname', 'varchar', 'NULL', $char_d, '', '',
737         'detail',  'varchar', '', 255, '', '', 
738       ],
739       'primary_key' => 'detailnum',
740       'unique' => [],
741       'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
742     },
743
744     'cust_bill_pkg_display' => {
745       'columns' => [
746         'billpkgdisplaynum', 'serial', '', '', '', '', 
747         'billpkgnum', 'int', '', '', '', '', 
748         'section',  'varchar', 'NULL', $char_d, '', '', 
749         #'unitsetup', @money_typen, '', '',     #override the linked real one?
750         #'unitrecur', @money_typen, '', '',     #this too?
751         'post_total', 'char', 'NULL', 1, '', '',
752         'type',       'char', 'NULL', 1, '', '',
753         'summary',    'char', 'NULL', 1, '', '',
754       ],
755       'primary_key' => 'billpkgdisplaynum',
756       'unique' => [],
757       'index' => [ ['billpkgnum'], ],
758     },
759
760     'cust_bill_pkg_tax_location' => {
761       'columns' => [
762         'billpkgtaxlocationnum', 'serial',      '', '', '', '',
763         'billpkgnum',               'int',      '', '', '', '',
764         'taxnum',                   'int',      '', '', '', '',
765         'taxtype',              'varchar',      '', $char_d, '', '',
766         'pkgnum',                   'int',      '', '', '', '',
767         'locationnum',              'int',      '', '', '', '', #redundant?
768         'amount',                   @money_type,        '', '',
769       ],
770       'primary_key' => 'billpkgtaxlocationnum',
771       'unique' => [],
772       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'pkgnum' ], [ 'locationnum' ] ],
773     },
774
775     'cust_bill_pkg_tax_rate_location' => {
776       'columns' => [
777         'billpkgtaxratelocationnum', 'serial',      '', '', '', '',
778         'billpkgnum',                   'int',      '', '', '', '',
779         'taxnum',                       'int',      '', '', '', '',
780         'taxtype',                  'varchar',      '', $char_d, '', '',
781         'locationtaxid',            'varchar',  'NULL', $char_d, '', '',
782         'taxratelocationnum',           'int',      '', '', '', '',
783         'amount',                       @money_type,        '', '',
784       ],
785       'primary_key' => 'billpkgtaxratelocationnum',
786       'unique' => [],
787       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'taxratelocationnum' ] ],
788     },
789
790     'cust_credit' => {
791       'columns' => [
792         'crednum',  'serial', '', '', '', '', 
793         'custnum',  'int', '', '', '', '', 
794         '_date',    @date_type, '', '', 
795         'amount',   @money_type, '', '', 
796         'otaker',   'varchar', 'NULL', 32, '', '', 
797         'usernum',   'int', 'NULL', '', '', '',
798         'reason',   'text', 'NULL', '', '', '', 
799         'reasonnum', 'int', 'NULL', '', '', '', 
800         'addlinfo', 'text', 'NULL', '', '', '',
801         'closed',    'char', 'NULL', 1, '', '', 
802         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
803         'eventnum', 'int', 'NULL', '', '', '', #triggering event for commission
804       ],
805       'primary_key' => 'crednum',
806       'unique' => [],
807       'index' => [ ['custnum'], ['_date'], ['usernum'], ['eventnum'] ],
808     },
809
810     'cust_credit_bill' => {
811       'columns' => [
812         'creditbillnum', 'serial', '', '', '', '', 
813         'crednum',  'int', '', '', '', '', 
814         'invnum',  'int', '', '', '', '', 
815         '_date',    @date_type, '', '', 
816         'amount',   @money_type, '', '', 
817         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
818       ],
819       'primary_key' => 'creditbillnum',
820       'unique' => [],
821       'index' => [ ['crednum'], ['invnum'] ],
822     },
823
824     'cust_credit_bill_pkg' => {
825       'columns' => [
826         'creditbillpkgnum', 'serial', '',      '', '', '',
827         'creditbillnum',       'int', '',      '', '', '',
828         'billpkgnum',          'int', '',      '', '', '',
829         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
830         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
831         'amount',            @money_type,          '', '',
832         'setuprecur',      'varchar', '', $char_d, '', '',
833         'sdate',   @date_type, '', '', 
834         'edate',   @date_type, '', '', 
835       ],
836       'primary_key' => 'creditbillpkgnum',
837       'unique'      => [],
838       'index'       => [ [ 'creditbillnum' ],
839                          [ 'billpkgnum' ], 
840                          [ 'billpkgtaxlocationnum' ],
841                          [ 'billpkgtaxratelocationnum' ],
842                        ],
843     },
844
845     'cust_main' => {
846       'columns' => [
847         'custnum',  'serial',  '',     '', '', '', 
848         'agentnum', 'int',  '',     '', '', '', 
849         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
850         'classnum', 'int', 'NULL', '', '', '',
851         'custbatch', 'varchar', 'NULL', $char_d, '', '',
852 #        'titlenum', 'int',  'NULL',   '', '', '', 
853         'last',     'varchar', '',   2*$char_d, '', '', 
854 #        'middle',   'varchar', 'NULL', $char_d, '', '', 
855         'first',    'varchar', '',     $char_d, '', '', 
856         'ss',       'varchar', 'NULL', 11, '', '', 
857         'stateid', 'varchar', 'NULL', $char_d, '', '', 
858         'stateid_state', 'varchar', 'NULL', $char_d, '', '', 
859         'birthdate' ,@date_type, '', '', 
860         'spouse_birthdate' ,@date_type, '', '', 
861         'signupdate',@date_type, '', '', 
862         'dundate',   @date_type, '', '', 
863         'company',  'varchar', 'NULL', $char_d, '', '', 
864         'address1', 'varchar', '',     $char_d, '', '', 
865         'address2', 'varchar', 'NULL', $char_d, '', '', 
866         'city',     'varchar', '',     $char_d, '', '', 
867         'county',   'varchar', 'NULL', $char_d, '', '', 
868         'state',    'varchar', 'NULL', $char_d, '', '', 
869         'zip',      'varchar', 'NULL', 10, '', '', 
870         'country',  'char', '',     2, '', '', 
871         'latitude', 'decimal', 'NULL', '10,7', '', '', 
872         'longitude','decimal', 'NULL', '10,7', '', '', 
873         'coord_auto',  'char', 'NULL',  1, '', '',
874         'daytime',  'varchar', 'NULL', 20, '', '', 
875         'night',    'varchar', 'NULL', 20, '', '', 
876         'fax',      'varchar', 'NULL', 12, '', '', 
877         'mobile',   'varchar', 'NULL', 12, '', '', 
878         'ship_last',     'varchar', 'NULL', 2*$char_d, '', '', 
879 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '', 
880         'ship_first',    'varchar', 'NULL', $char_d, '', '', 
881         'ship_company',  'varchar', 'NULL', $char_d, '', '', 
882         'ship_address1', 'varchar', 'NULL', $char_d, '', '', 
883         'ship_address2', 'varchar', 'NULL', $char_d, '', '', 
884         'ship_city',     'varchar', 'NULL', $char_d, '', '', 
885         'ship_county',   'varchar', 'NULL', $char_d, '', '', 
886         'ship_state',    'varchar', 'NULL', $char_d, '', '', 
887         'ship_zip',      'varchar', 'NULL', 10, '', '', 
888         'ship_country',  'char', 'NULL', 2, '', '', 
889         'ship_latitude', 'decimal', 'NULL', '10,7', '', '', 
890         'ship_longitude','decimal', 'NULL', '10,7', '', '', 
891         'ship_coord_auto',  'char', 'NULL',  1, '', '',
892         'ship_daytime',  'varchar', 'NULL', 20, '', '', 
893         'ship_night',    'varchar', 'NULL', 20, '', '', 
894         'ship_fax',      'varchar', 'NULL', 12, '', '', 
895         'ship_mobile',   'varchar', 'NULL', 12, '', '', 
896         'payby',    'char', '',     4, '', '', 
897         'payinfo',  'varchar', 'NULL', 512, '', '', 
898         'paycvv',   'varchar', 'NULL', 512, '', '', 
899         'paymask', 'varchar', 'NULL', $char_d, '', '', 
900         #'paydate',  @date_type, '', '', 
901         'paydate',  'varchar', 'NULL', 10, '', '', 
902         'paystart_month', 'int', 'NULL', '', '', '', 
903         'paystart_year',  'int', 'NULL', '', '', '', 
904         'payissue', 'varchar', 'NULL', 2, '', '', 
905         'payname',  'varchar', 'NULL', 2*$char_d, '', '', 
906         'paystate', 'varchar', 'NULL', $char_d, '', '', 
907         'paytype',  'varchar', 'NULL', $char_d, '', '', 
908         'payip',    'varchar', 'NULL', 15, '', '', 
909         'geocode',  'varchar', 'NULL', 20,  '', '',
910         'censustract', 'varchar', 'NULL', 20,  '', '', # 7 to save space?
911         'censusyear', 'char', 'NULL', 4, '', '',
912         'district', 'varchar', 'NULL', 20, '', '',
913         'tax',      'char', 'NULL', 1, '', '', 
914         'otaker',   'varchar', 'NULL',    32, '', '', 
915         'usernum',   'int', 'NULL', '', '', '',
916         'refnum',   'int',  '',     '', '', '', 
917         'referral_custnum', 'int',  'NULL', '', '', '', 
918         'comments', 'text', 'NULL', '', '', '', 
919         'spool_cdr','char', 'NULL', 1, '', '', 
920         'squelch_cdr','char', 'NULL', 1, '', '', 
921         'cdr_termination_percentage', 'decimal', 'NULL', '7,4', '', '',
922         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
923         'credit_limit', @money_typen, '', '',
924         'archived', 'char', 'NULL', 1, '', '',
925         'email_csv_cdr', 'char', 'NULL', 1, '', '',
926         'accountcode_cdr', 'char', 'NULL', 1, '', '',
927         'billday',   'int', 'NULL', '', '', '',
928         'edit_subject', 'char', 'NULL', 1, '', '',
929         'locale', 'varchar', 'NULL', 16, '', '', 
930         'calling_list_exempt', 'char', 'NULL', 1, '', '',
931         'invoice_noemail', 'char', 'NULL', 1, '', '',
932       ],
933       'primary_key' => 'custnum',
934       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
935       #'index' => [ ['last'], ['company'] ],
936       'index' => [
937                    [ 'agentnum' ], [ 'refnum' ], [ 'classnum' ], [ 'usernum' ],
938                    [ 'custbatch' ],
939                    [ 'referral_custnum' ],
940                    [ 'payby' ], [ 'paydate' ],
941                    [ 'archived' ],
942                    #billing
943                    [ 'last' ], [ 'company' ],
944                    [ 'county' ], [ 'state' ], [ 'country' ],
945                    [ 'zip' ],
946                    [ 'daytime' ], [ 'night' ], [ 'fax' ], [ 'mobile' ],
947                    #shipping
948                    [ 'ship_last' ], [ 'ship_company' ],
949                    [ 'ship_county' ], [ 'ship_state' ], [ 'ship_country' ],
950                    [ 'ship_zip' ],
951                    [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ], [ 'ship_mobile' ]
952                  ],
953     },
954
955     'cust_recon' => {  # (some sort of not-well understood thing for OnPac)
956       'columns' => [
957         'reconid',      'serial',  '',          '', '', '', 
958         'recondate',    @date_type,                 '', '', 
959         'custnum',      'int'   ,  '',          '', '', '', 
960         'agentnum',     'int',     '',          '', '', '', 
961         'last',         'varchar', '',     $char_d, '', '', 
962         'first',        'varchar', '',     $char_d, '', '', 
963         'address1',     'varchar', '',     $char_d, '', '', 
964         'address2',     'varchar', 'NULL', $char_d, '', '', 
965         'city',         'varchar', '',     $char_d, '', '', 
966         'state',        'varchar', 'NULL', $char_d, '', '', 
967         'zip',          'varchar', 'NULL',      10, '', '', 
968         'pkg',          'varchar', 'NULL', $char_d, '', '', 
969         'adjourn',      @date_type,                 '', '',
970         'status',       'varchar', 'NULL',      10, '', '', 
971         'agent_custid', 'varchar',  '',    $char_d, '', '',
972         'agent_pkg',    'varchar', 'NULL', $char_d, '', '', 
973         'agent_adjourn', @date_type,                '', '',
974         'comments',     'text',    'NULL',      '', '', '', 
975       ],
976       'primary_key' => 'reconid',
977       'unique' => [],
978       'index' => [],
979     },
980
981     'contact_class' => {
982       'columns' => [
983         'classnum',    'serial',   '',      '', '', '', 
984         'classname',   'varchar',  '', $char_d, '', '', 
985         'disabled',    'char', 'NULL',       1, '', '', 
986       ],
987       'primary_key' => 'classnum',
988       'unique' => [],
989       'index' => [ ['disabled'] ],
990     },
991
992     'contact' => {
993       'columns' => [
994         'contactnum', 'serial',     '',      '', '', '',
995         'prospectnum',   'int', 'NULL',      '', '', '',
996         'custnum',       'int', 'NULL',      '', '', '',
997         'locationnum',   'int', 'NULL',      '', '', '', #not yet
998         'classnum',      'int', 'NULL',      '', '', '',
999 #        'titlenum',      'int', 'NULL',      '', '', '', #eg Mr. Mrs. Dr. Rev.
1000         'last',      'varchar',     '', $char_d, '', '', 
1001 #        'middle',    'varchar', 'NULL', $char_d, '', '', 
1002         'first',     'varchar',     '', $char_d, '', '', 
1003         'title',     'varchar', 'NULL', $char_d, '', '', #eg Head Bottle Washer
1004         'comment',   'varchar', 'NULL', $char_d, '', '', 
1005         'disabled',     'char', 'NULL',       1, '', '', 
1006       ],
1007       'primary_key' => 'contactnum',
1008       'unique'      => [],
1009       'index'       => [ [ 'prospectnum' ], [ 'custnum' ], [ 'locationnum' ],
1010                          [ 'last' ], [ 'first' ],
1011                        ],
1012     },
1013
1014     'contact_phone' => {
1015       'columns' => [
1016         'contactphonenum', 'serial',     '', '', '', '',
1017         'contactnum',         'int',     '', '', '', '',
1018         'phonetypenum',       'int',     '', '', '', '',
1019         'countrycode',    'varchar',     '',  3, '', '', 
1020         'phonenum',       'varchar',     '', 14, '', '', 
1021         'extension',      'varchar', 'NULL',  7, '', '',
1022         #?#'comment',        'varchar',     '', $char_d, '', '', 
1023       ],
1024       'primary_key' => 'contactphonenum',
1025       'unique'      => [],
1026       'index'       => [],
1027     },
1028
1029     'phone_type' => {
1030       'columns' => [
1031         'phonetypenum',  'serial', '',      '', '', '',
1032         'typename',     'varchar', '', $char_d, '', '',
1033         'weight',           'int', '',      '', '', '', 
1034       ],
1035       'primary_key' => 'phonetypenum',
1036       'unique'      => [ [ 'typename' ], ],
1037       'index'       => [],
1038     },
1039
1040     'contact_email' => {
1041       'columns' => [
1042         'contactemailnum', 'serial', '',      '', '', '',
1043         'contactnum',         'int', '',      '', '', '',
1044         'emailaddress',   'varchar', '', $char_d, '', '',
1045       ],
1046       'primary_key' => 'contactemailnum',
1047       'unique'      => [ [ 'emailaddress' ], ],
1048       'index'       => [],
1049     },
1050
1051     'prospect_main' => {
1052       'columns' => [
1053         'prospectnum',  'serial',     '',      '', '', '',
1054         'agentnum',        'int',     '',      '', '', '',
1055         'company',     'varchar', 'NULL', $char_d, '', '',
1056         'add_date',   @date_type,                  '', '', 
1057         'disabled',       'char', 'NULL',       1, '', '', 
1058         'custnum',         'int', 'NULL',      '', '', '',
1059       ],
1060       'primary_key' => 'prospectnum',
1061       'unique'      => [],
1062       'index'       => [ [ 'company' ], [ 'agentnum' ], [ 'disabled' ] ],
1063     },
1064
1065     #eventually use for billing & ship from cust_main too
1066     #for now, just cust_pkg locations
1067     'cust_location' => { #'location' now that its prospects too, but...
1068       'columns' => [
1069         'locationnum',      'serial',     '',      '', '', '',
1070         'prospectnum',         'int', 'NULL',      '', '', '',
1071         'custnum',             'int', 'NULL',      '', '', '',
1072         'address1',        'varchar',     '', $char_d, '', '', 
1073         'address2',        'varchar', 'NULL', $char_d, '', '', 
1074         'city',            'varchar',     '', $char_d, '', '', 
1075         'county',          'varchar', 'NULL', $char_d, '', '', 
1076         'state',           'varchar', 'NULL', $char_d, '', '', 
1077         'zip',             'varchar', 'NULL',      10, '', '', 
1078         'latitude',        'decimal', 'NULL',  '10,7', '', '', 
1079         'longitude',       'decimal', 'NULL',  '10,7', '', '', 
1080         'coord_auto',         'char', 'NULL',       1, '', '',
1081         'country',            'char',     '',       2, '', '', 
1082         'geocode',         'varchar', 'NULL',      20, '', '',
1083         'district',        'varchar', 'NULL',      20, '', '',
1084         'location_type',   'varchar', 'NULL',      20, '', '',
1085         'location_number', 'varchar', 'NULL',      20, '', '',
1086         'location_kind',      'char', 'NULL',       1, '', '',
1087         'disabled',           'char', 'NULL',       1, '', '', 
1088       ],
1089       'primary_key' => 'locationnum',
1090       'unique'      => [],
1091       'index'       => [ [ 'prospectnum' ], [ 'custnum' ],
1092                          [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
1093                        ],
1094     },
1095
1096     'cust_main_invoice' => {
1097       'columns' => [
1098         'destnum',  'serial',  '',     '', '', '', 
1099         'custnum',  'int',  '',     '', '', '', 
1100         'dest',     'varchar', '',  $char_d, '', '', 
1101       ],
1102       'primary_key' => 'destnum',
1103       'unique' => [],
1104       'index' => [ ['custnum'], ],
1105     },
1106
1107     'cust_main_note' => {
1108       'columns' => [
1109         'notenum',  'serial',  '',     '', '', '', 
1110         'custnum',  'int',  '',     '', '', '', 
1111         'classnum',      'int',     'NULL', '', '', '', 
1112         '_date',    @date_type, '', '', 
1113         'otaker',   'varchar', 'NULL',    32, '', '', 
1114         'usernum',   'int', 'NULL', '', '', '',
1115         'comments', 'text', 'NULL', '', '', '', 
1116       ],
1117       'primary_key' => 'notenum',
1118       'unique' => [],
1119       'index' => [ [ 'custnum' ], [ '_date' ], [ 'usernum' ], ],
1120     },
1121     
1122     'cust_note_class' => {
1123       'columns' => [
1124         'classnum',    'serial',   '',      '', '', '', 
1125         'classname',   'varchar',  '', $char_d, '', '', 
1126         'disabled',    'char', 'NULL',       1, '', '', 
1127       ],
1128       'primary_key' => 'classnum',
1129       'unique' => [],
1130       'index' => [ ['disabled'] ],
1131     },
1132
1133     'cust_category' => {
1134       'columns' => [
1135         'categorynum',   'serial',  '', '', '', '', 
1136         'categoryname',  'varchar', '', $char_d, '', '', 
1137         'weight',         'int', 'NULL',  '', '', '',
1138         'disabled',      'char', 'NULL',   1, '', '', 
1139       ],
1140       'primary_key' => 'categorynum',
1141       'unique' => [],
1142       'index' => [ ['disabled'] ],
1143     },
1144
1145     'cust_class' => {
1146       'columns' => [
1147         'classnum',     'serial',     '',      '', '', '', 
1148         'classname',   'varchar',     '', $char_d, '', '', 
1149         'categorynum',     'int', 'NULL',      '', '', '', 
1150         'tax',            'char', 'NULL',       1, '', '', 
1151         'disabled',       'char', 'NULL',       1, '', '', 
1152       ],
1153       'primary_key' => 'classnum',
1154       'unique' => [],
1155       'index' => [ ['disabled'] ],
1156     },
1157  
1158     'cust_tag' => {
1159       'columns' => [
1160         'custtagnum', 'serial', '', '', '', '',
1161         'custnum',       'int', '', '', '', '',
1162         'tagnum',        'int', '', '', '', '',
1163       ],
1164       'primary_key' => 'custtagnum',
1165       'unique'      => [ [ 'custnum', 'tagnum' ] ],
1166       'index'       => [ [ 'custnum' ] ],
1167     },
1168
1169     'part_tag' => {
1170       'columns' => [
1171         'tagnum',    'serial',     '',      '', '', '',
1172         'tagname',  'varchar',     '', $char_d, '', '',
1173         'tagdesc',  'varchar', 'NULL', $char_d, '', '',
1174         'tagcolor', 'varchar', 'NULL',       6, '', '',
1175         'disabled',    'char', 'NULL',       1, '', '', 
1176       ],
1177       'primary_key' => 'tagnum',
1178       'unique'      => [], #[ [ 'tagname' ] ], #?
1179       'index'       => [ [ 'disabled' ] ],
1180     },
1181
1182     'cust_main_exemption' => {
1183       'columns' => [
1184         'exemptionnum',   'serial',     '',      '', '', '',
1185         'custnum',           'int',     '',      '', '', '', 
1186         'taxname',       'varchar',     '', $char_d, '', '',
1187         'exempt_number', 'varchar', 'NULL', $char_d, '', '',
1188         #start/end dates?  for reporting?
1189       ],
1190       'primary_key' => 'exemptionnum',
1191       'unique'      => [],
1192       'index'       => [ [ 'custnum' ] ],
1193     },
1194
1195     'cust_tax_adjustment' => {
1196       'columns' => [
1197         'adjustmentnum', 'serial',     '',      '', '', '',
1198         'custnum',          'int',     '',      '', '', '',
1199         'taxname',      'varchar',     '', $char_d, '', '',
1200         'amount',    @money_type,                   '', '', 
1201         'comment',     'varchar',  'NULL', $char_d, '', '', 
1202         'billpkgnum',       'int', 'NULL',      '', '', '',
1203         #more?  no cust_bill_pkg_tax_location?
1204       ],
1205       'primary_key' => 'adjustmentnum',
1206       'unique'      => [],
1207       'index'       => [ [ 'custnum' ], [ 'billpkgnum' ] ],
1208     },
1209
1210     'cust_main_county' => { #district+city+county+state+country are checked 
1211                             #off the cust_main_county for validation and to 
1212                             #provide a tax rate.
1213       'columns' => [
1214         'taxnum',   'serial',   '',    '', '', '', 
1215         'district', 'varchar',  'NULL',    20, '', '',
1216         'city',     'varchar',  'NULL',    $char_d, '', '',
1217         'county',   'varchar',  'NULL',    $char_d, '', '', 
1218         'state',    'varchar',  'NULL',    $char_d, '', '', 
1219         'country',  'char',  '', 2, '', '', 
1220         'taxclass',   'varchar', 'NULL', $char_d, '', '', 
1221         'exempt_amount', @money_type, '', '', 
1222         'tax',      'real',  '',    '', '', '', #tax %
1223         'taxname',  'varchar',  'NULL',    $char_d, '', '', 
1224         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
1225         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
1226       ],
1227       'primary_key' => 'taxnum',
1228       'unique' => [],
1229   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
1230       'index' => [ [ 'district' ], [ 'city' ], [ 'county' ], [ 'state' ], 
1231                    [ 'country' ],
1232                    [ 'taxclass' ],
1233                  ],
1234     },
1235
1236     'tax_rate'    => {
1237       'columns' => [
1238         'taxnum',       'serial',     '',      '', '', '', 
1239         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
1240         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
1241         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
1242         'taxclassnum', 'int',      '',      '', '', '', 
1243         'effective_date', @date_type, '', '', 
1244         'tax',        @taxrate_type,      '', '',        # tax %
1245         'excessrate', @taxrate_typen,     '', '',        # second tax %
1246         'taxbase',    @money_typen, '', '',              # amount at first tax rate
1247         'taxmax',     @money_typen, '', '',              # maximum about at both rates
1248         'usetax',        @taxrate_typen,     '', '',     # tax % when non-local
1249         'useexcessrate', @taxrate_typen,     '', '',     # second tax % when non-local
1250         'unittype',    'int',  'NULL', '', '', '',      # for fee
1251         'fee',         @taxrate_typen,     '', '',      # amount tax per unit
1252         'excessfee',   @taxrate_typen,     '', '',      # second amount tax per unit
1253         'feebase',     @taxrate_typen,     '', '',      # units taxed at first rate
1254         'feemax',      @taxrate_typen,     '', '',      # maximum number of unit taxed
1255         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
1256         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
1257         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
1258         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
1259         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
1260         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
1261         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
1262         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
1263         'inoutcity',   'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1264         'inoutlocal',  'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1265         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
1266         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
1267       ],
1268       'primary_key' => 'taxnum',
1269       'unique' => [],
1270       'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
1271     },
1272
1273     'tax_rate_location' => { 
1274       'columns' => [
1275         'taxratelocationnum', 'serial',  '',     '', '', '', 
1276         'data_vendor',        'varchar', 'NULL', $char_d, '', '',
1277         'geocode',            'varchar', '',     20,      '', '', 
1278         'city',               'varchar', 'NULL', $char_d, '', '',
1279         'county',             'varchar', 'NULL', $char_d, '', '',
1280         'state',              'char',    'NULL',       2, '', '', 
1281         'disabled',           'char',    'NULL', 1, '', '',
1282       ],
1283       'primary_key' => 'taxratelocationnum',
1284       'unique' => [],
1285       'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
1286     },
1287
1288     'cust_tax_location' => { 
1289       'columns' => [
1290         'custlocationnum', 'serial',  '',     '', '', '', 
1291         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
1292         'city',            'varchar', 'NULL', $char_d, '', '',
1293         'postalcity',      'varchar', 'NULL', $char_d, '', '',
1294         'county',          'varchar', 'NULL', $char_d, '', '',
1295         'zip',             'char',    '',     5,  '', '', 
1296         'state',           'char',    '',     2,  '', '', 
1297         'plus4hi',         'char',    'NULL', 4,  '', '', 
1298         'plus4lo',         'char',    'NULL', 4,  '', '', 
1299         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
1300         'cityflag',        'char',    'NULL', 1,  '', '', # I(n)/O(out)/B(oth)/NULL
1301         'geocode',         'varchar', '',    20,  '', '', 
1302       ],
1303       'primary_key' => 'custlocationnum',
1304       'unique' => [],
1305       'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
1306     },
1307
1308     'tax_class' => { 
1309       'columns' => [
1310         'taxclassnum',  'serial',  '',            '', '', '',
1311         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
1312         'taxclass',     'varchar', '',       $char_d, '', '',          
1313         'description',  'varchar', '',     2*$char_d, '', '',          
1314       ],
1315       'primary_key' => 'taxclassnum',
1316       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
1317       'index' => [],
1318     },
1319
1320     'cust_pay_pending' => {
1321       'columns' => [
1322         'paypendingnum','serial',      '',  '', '', '',
1323         'custnum',      'int',         '',  '', '', '', 
1324         'paid',         @money_type,            '', '', 
1325         '_date',        @date_type,             '', '', 
1326         'payby',        'char',        '',   4, '', '', #CARD/BILL/COMP, should
1327                                                         # be index into payby
1328                                                         # table eventually
1329         'payinfo',      'varchar', 'NULL', 512, '', '', #see cust_main above
1330         'paymask',      'varchar', 'NULL', $char_d, '', '', 
1331         'paydate',      'varchar', 'NULL', 10, '', '', 
1332         'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
1333         #'paybatch',     'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1334         'payunique',    'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1335
1336         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1337         'status',       'varchar',     '', $char_d, '', '', 
1338         'session_id',   'varchar', 'NULL', $char_d, '', '', #only need 32
1339         'statustext',   'text',    'NULL',  '', '', '', 
1340         'gatewaynum',   'int',     'NULL',  '', '', '',
1341         #'cust_balance', @money_type,            '', '',
1342         'paynum',       'int',     'NULL',  '', '', '',
1343         'jobnum',       'int',     'NULL',  '', '', '', 
1344       ],
1345       'primary_key' => 'paypendingnum',
1346       'unique'      => [ [ 'payunique' ] ],
1347       'index'       => [ [ 'custnum' ], [ 'status' ], ],
1348     },
1349
1350     'cust_pay' => {
1351       'columns' => [
1352         'paynum',   'serial',    '',   '', '', '',
1353         'custnum',  'int',    '',   '', '', '', 
1354         '_date',    @date_type, '', '', 
1355         'paid',     @money_type, '', '', 
1356         'otaker',   'varchar', 'NULL', 32, '', '',
1357         'usernum',   'int', 'NULL', '', '', '',
1358         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1359                                                  # index into payby table
1360                                                  # eventually
1361         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
1362         'paymask', 'varchar', 'NULL', $char_d, '', '', 
1363         'paydate',  'varchar', 'NULL', 10, '', '', 
1364         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1365         'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1366         'closed',    'char', 'NULL', 1, '', '', 
1367         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1368         # cash/check deposit info fields
1369         'bank',       'varchar', 'NULL', $char_d, '', '',
1370         'depositor',  'varchar', 'NULL', $char_d, '', '',
1371         'account',    'varchar', 'NULL', 20,      '', '',
1372         'teller',     'varchar', 'NULL', 20,      '', '',
1373       ],
1374       'primary_key' => 'paynum',
1375       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
1376       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ], [ 'usernum' ] ],
1377     },
1378
1379     'cust_pay_void' => {
1380       'columns' => [
1381         'paynum',    'int',    '',   '', '', '', 
1382         'custnum',   'int',    '',   '', '', '', 
1383         'paid',      @money_type, '', '', 
1384         '_date',     @date_type, '', '', 
1385         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1386                                                   # index into payby table
1387                                                   # eventually
1388         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
1389         'paymask', 'varchar', 'NULL', $char_d, '', '', 
1390         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1391         'closed',    'char', 'NULL', 1, '', '', 
1392         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1393         'void_date', @date_type, '', '', 
1394         'reason',    'varchar',   'NULL', $char_d, '', '', 
1395         'otaker',   'varchar', 'NULL', 32, '', '', 
1396         'usernum',   'int', 'NULL', '', '', '',
1397         'void_usernum',   'int', 'NULL', '', '', '',
1398       ],
1399       'primary_key' => 'paynum',
1400       'unique' => [],
1401       'index' => [ [ 'custnum' ], [ 'usernum' ], [ 'void_usernum' ] ],
1402     },
1403
1404     'cust_bill_pay' => {
1405       'columns' => [
1406         'billpaynum', 'serial',     '',   '', '', '', 
1407         'invnum',  'int',     '',   '', '', '', 
1408         'paynum',  'int',     '',   '', '', '', 
1409         'amount',  @money_type, '', '', 
1410         '_date',   @date_type, '', '', 
1411         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1412       ],
1413       'primary_key' => 'billpaynum',
1414       'unique' => [],
1415       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
1416     },
1417
1418     'cust_bill_pay_batch' => {
1419       'columns' => [
1420         'billpaynum', 'serial',     '',   '', '', '', 
1421         'invnum',  'int',     '',   '', '', '', 
1422         'paybatchnum',  'int',     '',   '', '', '', 
1423         'amount',  @money_type, '', '', 
1424         '_date',   @date_type, '', '', 
1425       ],
1426       'primary_key' => 'billpaynum',
1427       'unique' => [],
1428       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1429     },
1430
1431     'cust_bill_pay_pkg' => {
1432       'columns' => [
1433         'billpaypkgnum', 'serial', '', '', '', '',
1434         'billpaynum',       'int', '', '', '', '',
1435         'billpkgnum',       'int', '', '', '', '',
1436         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
1437         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
1438         'amount',         @money_type,     '', '',
1439         'setuprecur',      'varchar', '', $char_d, '', '',
1440         'sdate',   @date_type, '', '', 
1441         'edate',   @date_type, '', '', 
1442       ],
1443       'primary_key' => 'billpaypkgnum',
1444       'unique'      => [],
1445       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1446     },
1447
1448     'pay_batch' => { #batches of payments to an external processor
1449       'columns' => [
1450         'batchnum', 'serial',     '', '', '', '', 
1451         'agentnum',    'int', 'NULL', '', '', '', 
1452         'payby',      'char',     '',  4, '', '', # CARD/CHEK
1453         'status',     'char', 'NULL',  1, '', '', 
1454         'download',       @date_type,     '', '', 
1455         'upload',         @date_type,     '', '', 
1456       ],
1457       'primary_key' => 'batchnum',
1458       'unique' => [],
1459       'index' => [],
1460     },
1461
1462     'cust_pay_batch' => { #list of customers in current CARD/CHEK batch
1463       'columns' => [
1464         'paybatchnum',   'serial',    '',   '', '', '', 
1465         'batchnum',   'int',    '',   '', '', '', 
1466         'invnum',   'int',    '',   '', '', '', 
1467         'custnum',   'int',    '',   '', '', '', 
1468         'last',     'varchar', '',     $char_d, '', '', 
1469         'first',    'varchar', '',     $char_d, '', '', 
1470         'address1', 'varchar', '',     $char_d, '', '', 
1471         'address2', 'varchar', 'NULL', $char_d, '', '', 
1472         'city',     'varchar', '',     $char_d, '', '', 
1473         'state',    'varchar', 'NULL', $char_d, '', '', 
1474         'zip',      'varchar', 'NULL', 10, '', '', 
1475         'country',  'char', '',     2, '', '', 
1476         #        'trancode', 'int', '', '', '', ''
1477         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1478         'payinfo',  'varchar', '',     512, '', '', 
1479         #'exp',      @date_type, '', ''
1480         'exp',      'varchar', 'NULL',     11, '', '', 
1481         'payname',  'varchar', 'NULL', $char_d, '', '', 
1482         'amount',   @money_type, '', '', 
1483         'status',   'varchar', 'NULL',     $char_d, '', '', 
1484       ],
1485       'primary_key' => 'paybatchnum',
1486       'unique' => [],
1487       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1488     },
1489
1490     'fcc477map' => {
1491       'columns' => [
1492         'formkey',   'varchar',     '', 255, '', '',
1493         'formvalue',    'text', 'NULL',  '', '', '',
1494       ],
1495       'primary_key' => 'formkey',
1496       'unique'      => [],
1497       'index'       => [],
1498     },
1499
1500     'cust_pkg' => {
1501       'columns' => [
1502         'pkgnum',           'serial',     '', '', '', '', 
1503         'custnum',             'int',     '', '', '', '', 
1504         'pkgpart',             'int',     '', '', '', '', 
1505         'pkgbatch',        'varchar', 'NULL', $char_d, '', '',
1506         'locationnum',         'int', 'NULL', '', '', '',
1507         'otaker',          'varchar', 'NULL', 32, '', '', 
1508         'usernum',             'int', 'NULL', '', '', '',
1509         'order_date',     @date_type,             '', '', 
1510         'start_date',     @date_type,             '', '', 
1511         'setup',          @date_type,             '', '', 
1512         'bill',           @date_type,             '', '', 
1513         'last_bill',      @date_type,             '', '', 
1514         'susp',           @date_type,             '', '', 
1515         'adjourn',        @date_type,             '', '', 
1516         'resume',         @date_type,             '', '', 
1517         'cancel',         @date_type,             '', '', 
1518         'uncancel',       @date_type,             '', '', 
1519         'uncancel_pkgnum',     'int', 'NULL', '', '', '',
1520         'expire',         @date_type,             '', '', 
1521         'contract_end',   @date_type,             '', '',
1522         'dundate',        @date_type,             '', '',
1523         'change_date',    @date_type,             '', '',
1524         'change_pkgnum',       'int', 'NULL', '', '', '',
1525         'change_pkgpart',      'int', 'NULL', '', '', '',
1526         'change_locationnum',  'int', 'NULL', '', '', '',
1527         'manual_flag',        'char', 'NULL',  1, '', '', 
1528         'no_auto',            'char', 'NULL',  1, '', '', 
1529         'quantity',            'int', 'NULL', '', '', '',
1530         'agent_pkgid',         'int', 'NULL', '', '', '',
1531         'waive_setup',        'char', 'NULL',  1, '', '', 
1532         'recur_show_zero',    'char', 'NULL',  1, '', '',
1533         'setup_show_zero',    'char', 'NULL',  1, '', '',
1534       ],
1535       'primary_key' => 'pkgnum',
1536       'unique' => [],
1537       'index' => [ ['custnum'], ['pkgpart'], [ 'pkgbatch' ], [ 'locationnum' ],
1538                    [ 'usernum' ], [ 'agent_pkgid' ],
1539                    ['order_date'], [ 'start_date' ], ['setup'], ['bill'],
1540                    ['last_bill'], ['susp'], ['adjourn'], ['cancel'],
1541                    ['expire'], ['contract_end'], ['change_date'], ['no_auto'],
1542                  ],
1543     },
1544
1545     'cust_pkg_option' => {
1546       'columns' => [
1547         'optionnum', 'serial', '', '', '', '', 
1548         'pkgnum', 'int', '', '', '', '', 
1549         'optionname', 'varchar', '', $char_d, '', '', 
1550         'optionvalue', 'text', 'NULL', '', '', '', 
1551       ],
1552       'primary_key' => 'optionnum',
1553       'unique'      => [],
1554       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
1555     },
1556
1557     'cust_pkg_detail' => {
1558       'columns' => [
1559         'pkgdetailnum', 'serial', '',      '', '', '',
1560         'pkgnum',          'int', '',      '', '', '',
1561         'detail',      'varchar', '', $char_d, '', '', 
1562         'detailtype',     'char', '',       1, '', '', # "I"nvoice or "C"omment
1563         'weight',          'int', '',      '', '', '',
1564       ],
1565       'primary_key' => 'pkgdetailnum',
1566       'unique' => [],
1567       'index'  => [ [ 'pkgnum', 'detailtype' ] ],
1568     },
1569
1570     'cust_pkg_reason' => {
1571       'columns' => [
1572         'num',      'serial',    '',   '', '', '', 
1573         'pkgnum',   'int',    '',   '', '', '', 
1574         'reasonnum','int',    '',   '', '', '', 
1575         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
1576         'otaker',   'varchar', 'NULL', 32, '', '', 
1577         'usernum',   'int', 'NULL', '', '', '',
1578         'date',     @date_type, '', '', 
1579       ],
1580       'primary_key' => 'num',
1581       'unique' => [],
1582       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], [ 'usernum' ], ],
1583     },
1584
1585     'cust_pkg_discount' => {
1586       'columns' => [
1587         'pkgdiscountnum', 'serial', '',        '', '', '',
1588         'pkgnum',            'int', '',        '', '', '', 
1589         'discountnum',       'int', '',        '', '', '',
1590         'months_used',   'decimal', 'NULL', '7,4', '', '',
1591         'end_date',     @date_type,                '', '',
1592         'otaker',        'varchar', 'NULL',    32, '', '', 
1593         'usernum',           'int', 'NULL',    '', '', '',
1594         'disabled',         'char', 'NULL',     1, '', '', 
1595       ],
1596       'primary_key' => 'pkgdiscountnum',
1597       'unique' => [],
1598       'index'  => [ [ 'pkgnum' ], [ 'discountnum' ], [ 'usernum' ], ],
1599     },
1600
1601     'cust_bill_pkg_discount' => {
1602       'columns' => [
1603         'billpkgdiscountnum', 'serial',        '', '', '', '',
1604         'billpkgnum',            'int',        '', '', '', '', 
1605         'pkgdiscountnum',        'int',        '', '', '', '', 
1606         'amount',          @money_type,                '', '', 
1607         'months',            'decimal', 'NULL', '7,4', '', '',
1608       ],
1609       'primary_key' => 'billpkgdiscountnum',
1610       'unique' => [],
1611       'index' => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
1612     },
1613
1614     'discount' => {
1615       'columns' => [
1616         'discountnum', 'serial',     '',      '', '', '',
1617         #'agentnum',       'int', 'NULL',      '', '', '', 
1618         'name',       'varchar', 'NULL', $char_d, '', '',
1619         'amount',   @money_type,                  '', '', 
1620         'percent',    'decimal',     '',   '7,4', '', '',
1621         'months',     'decimal', 'NULL',   '7,4', '', '',
1622         'disabled',      'char', 'NULL',       1, '', '', 
1623         'setup',         'char', 'NULL',       1, '', '', 
1624         #'linked',        'char', 'NULL',       1, '', '',
1625       ],
1626       'primary_key' => 'discountnum',
1627       'unique' => [],
1628       'index'  => [], # [ 'agentnum' ], ],
1629     },
1630
1631     'cust_refund' => {
1632       'columns' => [
1633         'refundnum',    'serial',    '',   '', '', '', 
1634         'custnum',  'int',    '',   '', '', '', 
1635         '_date',        @date_type, '', '', 
1636         'refund',       @money_type, '', '', 
1637         'otaker',       'varchar',   'NULL',   32, '', '', 
1638         'usernum',   'int', 'NULL', '', '', '',
1639         'reason',       'varchar',   '',   $char_d, '', '', 
1640         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
1641                                                      # be index into payby
1642                                                      # table eventually
1643         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
1644         'paymask', 'varchar', 'NULL', $char_d, '', '', 
1645         'paybatch',     'varchar',   'NULL', $char_d, '', '', 
1646         'closed',    'char', 'NULL', 1, '', '', 
1647       ],
1648       'primary_key' => 'refundnum',
1649       'unique' => [],
1650       'index' => [ ['custnum'], ['_date'], [ 'usernum' ], ],
1651     },
1652
1653     'cust_credit_refund' => {
1654       'columns' => [
1655         'creditrefundnum', 'serial',     '',   '', '', '', 
1656         'crednum',  'int',     '',   '', '', '', 
1657         'refundnum',  'int',     '',   '', '', '', 
1658         'amount',  @money_type, '', '', 
1659         '_date',   @date_type, '', '', 
1660       ],
1661       'primary_key' => 'creditrefundnum',
1662       'unique' => [],
1663       'index' => [ ['crednum'], ['refundnum'] ],
1664     },
1665
1666
1667     'cust_svc' => {
1668       'columns' => [
1669         'svcnum',      'serial',     '', '', '', '', 
1670         'pkgnum',         'int', 'NULL', '', '', '', 
1671         'svcpart',        'int',     '', '', '', '', 
1672         'agent_svcid',    'int', 'NULL', '', '', '',
1673         'overlimit',           @date_type,   '', '', 
1674       ],
1675       'primary_key' => 'svcnum',
1676       'unique' => [],
1677       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'], [ 'agent_svcid' ] ],
1678     },
1679
1680     'cust_svc_option' => {
1681       'columns' => [
1682         'optionnum',   'serial', '', '', '', '', 
1683         'svcnum',      'int', '', '', '', '', 
1684         'optionname',  'varchar', '', $char_d, '', '', 
1685         'optionvalue', 'text', 'NULL', '', '', '', 
1686       ],
1687       'primary_key' => 'optionnum',
1688       'unique'      => [],
1689       'index'       => [ [ 'svcnum' ], [ 'optionname' ] ],
1690     },
1691
1692    'part_pkg' => {
1693       'columns' => [
1694         'pkgpart',       'serial',    '',   '', '', '', 
1695         'pkg',           'varchar',   '',   $char_d, '', '', 
1696         'comment',       'varchar',   '', 2*$char_d, '', '', 
1697         'promo_code',    'varchar', 'NULL', $char_d, '', '', 
1698         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
1699         'setuptax',      'char', 'NULL', 1, '', '', 
1700         'recurtax',      'char', 'NULL', 1, '', '', 
1701         'plan',          'varchar', 'NULL', $char_d, '', '', 
1702         'disabled',      'char', 'NULL', 1, '', '', 
1703         'custom',        'char', 'NULL', 1, '', '', 
1704         'taxclass',      'varchar', 'NULL', $char_d, '', '', 
1705         'classnum',      'int',     'NULL', '', '', '', 
1706         'addon_classnum','int',     'NULL', '', '', '', 
1707         'taxproductnum', 'int',     'NULL', '', '', '', 
1708         'setup_cost',    @money_typen,          '', '',
1709         'recur_cost',    @money_typen,          '', '',
1710         'pay_weight',    'real',    'NULL', '', '', '',
1711         'credit_weight', 'real',    'NULL', '', '', '',
1712         'agentnum',      'int',     'NULL', '', '', '', 
1713         'fcc_ds0s',      'int',     'NULL', '', '', '', 
1714         'no_auto',          'char', 'NULL',  1, '', '', 
1715         'recur_show_zero',  'char', 'NULL',  1, '', '',
1716         'setup_show_zero',  'char', 'NULL',  1, '', '',
1717         'successor',     'int',     'NULL', '', '', '',
1718         'family_pkgpart','int',     'NULL', '', '', '',
1719       ],
1720       'primary_key' => 'pkgpart',
1721       'unique' => [],
1722       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'classnum' ],
1723                    [ 'agentnum' ], ['no_auto'],
1724                  ],
1725     },
1726
1727     'part_pkg_link' => {
1728       'columns' => [
1729         'pkglinknum',  'serial',   '',      '', '', '',
1730         'src_pkgpart', 'int',      '',      '', '', '',
1731         'dst_pkgpart', 'int',      '',      '', '', '', 
1732         'link_type',   'varchar',  '', $char_d, '', '',
1733         'hidden',      'char', 'NULL',       1, '', '',
1734       ],
1735       'primary_key' => 'pkglinknum',
1736       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type', 'hidden' ] ],
1737       'index'  => [ [ 'src_pkgpart' ] ],
1738     },
1739     # XXX somewhat borked unique: we don't really want a hidden and unhidden
1740     # it turns out we'd prefer to use svc, bill, and invisibill (or something)
1741
1742     'part_pkg_discount' => {
1743       'columns' => [
1744         'pkgdiscountnum', 'serial',   '',      '', '', '',
1745         'pkgpart',        'int',      '',      '', '', '',
1746         'discountnum',    'int',      '',      '', '', '', 
1747       ],
1748       'primary_key' => 'pkgdiscountnum',
1749       'unique' => [ [ 'pkgpart', 'discountnum' ] ],
1750       'index'  => [],
1751     },
1752
1753     'part_pkg_taxclass' => {
1754       'columns' => [
1755         'taxclassnum',  'serial', '',       '', '', '',
1756         'taxclass',     'varchar', '', $char_d, '', '', 
1757         'disabled', 'char',   'NULL',         1, '', '', 
1758       ],
1759       'primary_key' => 'taxclassnum',
1760       'unique'      => [ [ 'taxclass' ] ],
1761       'index'       => [ [ 'disabled' ] ],
1762     },
1763
1764     'part_pkg_taxproduct' => {
1765       'columns' => [
1766         'taxproductnum', 'serial',      '',        '', '', '',
1767         'data_vendor',   'varchar', 'NULL',   $char_d, '', '', 
1768         'taxproduct',    'varchar',     '',   $char_d, '', '', 
1769         'description',   'varchar',     '', 3*$char_d, '', '', 
1770       ],
1771       'primary_key' => 'taxproductnum',
1772       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
1773       'index'       => [],
1774     },
1775
1776     'part_pkg_taxrate' => { 
1777       'columns' => [
1778         'pkgtaxratenum', 'serial',  '',     '',      '', '',
1779         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
1780         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
1781         'taxproductnum', 'int',  '',     '',       '', '',          
1782         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
1783         'county',           'varchar', 'NULL', $char_d, '', '', 
1784         'state',            'varchar', 'NULL', $char_d, '', '', 
1785         'local',            'varchar', 'NULL', $char_d, '', '', 
1786         'country',          'char',    'NULL', 2,       '', '',
1787         'taxclassnumtaxed', 'int',     'NULL', '',      '', '', 
1788         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '', 
1789         'taxclassnum',      'int',     'NULL', '',      '', '', 
1790         'effdate',          @date_type, '', '', 
1791         'taxable',          'char',    'NULL', 1,       '', '', 
1792       ],
1793       'primary_key' => 'pkgtaxratenum',
1794       'unique' => [],
1795       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1796     },
1797
1798     'part_pkg_taxoverride' => { 
1799       'columns' => [
1800         'taxoverridenum', 'serial', '', '', '', '',
1801         'pkgpart',           'int', '', '', '', '',
1802         'taxclassnum',       'int', '', '', '', '',
1803         'usage_class',    'varchar', 'NULL', $char_d, '', '', 
1804       ],
1805       'primary_key' => 'taxoverridenum',
1806       'unique' => [],
1807       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1808     },
1809
1810 #    'part_title' => {
1811 #      'columns' => [
1812 #        'titlenum',   'int',    '',   '',
1813 #        'title',      'varchar',   '',   $char_d,
1814 #      ],
1815 #      'primary_key' => 'titlenum',
1816 #      'unique' => [ [] ],
1817 #      'index' => [ [] ],
1818 #    },
1819
1820     'pkg_svc' => {
1821       'columns' => [
1822         'pkgsvcnum',  'serial', '',  '', '', '', 
1823         'pkgpart',    'int',    '',   '', '', '', 
1824         'svcpart',    'int',    '',   '', '', '', 
1825         'quantity',   'int',    '',   '', '', '', 
1826         'primary_svc','char', 'NULL',  1, '', '', 
1827         'hidden',     'char', 'NULL',  1, '', '',
1828       ],
1829       'primary_key' => 'pkgsvcnum',
1830       'unique' => [ ['pkgpart', 'svcpart'] ],
1831       'index' => [ ['pkgpart'], ['quantity'] ],
1832     },
1833
1834     'part_referral' => {
1835       'columns' => [
1836         'refnum',   'serial',     '',        '', '', '', 
1837         'referral', 'varchar',    '',   $char_d, '', '', 
1838         'disabled', 'char',   'NULL',         1, '', '', 
1839         'agentnum', 'int',    'NULL',        '', '', '', 
1840       ],
1841       'primary_key' => 'refnum',
1842       'unique' => [],
1843       'index' => [ ['disabled'], ['agentnum'], ],
1844     },
1845
1846     'part_svc' => {
1847       'columns' => [
1848         'svcpart',             'serial',     '',        '', '', '', 
1849         'svc',                'varchar',     '',   $char_d, '', '', 
1850         'svcdb',              'varchar',     '',   $char_d, '', '', 
1851         'disabled',              'char', 'NULL',         1, '', '', 
1852         'preserve',              'char', 'NULL',         1, '', '',
1853         'selfservice_access', 'varchar', 'NULL',   $char_d, '', '',
1854         'classnum',               'int', 'NULL',        '', '', '',
1855       ],
1856       'primary_key' => 'svcpart',
1857       'unique' => [],
1858       'index' => [ [ 'disabled' ] ],
1859     },
1860
1861     'part_svc_column' => {
1862       'columns' => [
1863         'columnnum',   'serial',      '',      '', '', '', 
1864         'svcpart',     'int',         '',      '', '', '', 
1865         'columnname',  'varchar',     '',      64, '', '', 
1866         'columnlabel', 'varchar', 'NULL', $char_d, '', '',
1867         'columnvalue', 'varchar', 'NULL',     512, '', '', 
1868         'columnflag',  'char',    'NULL',       1, '', '', 
1869       ],
1870       'primary_key' => 'columnnum',
1871       'unique' => [ [ 'svcpart', 'columnname' ] ],
1872       'index' => [ [ 'svcpart' ] ],
1873     },
1874
1875     'part_svc_class' => {
1876       'columns' => [
1877         'classnum',    'serial',   '',      '', '', '', 
1878         'classname',   'varchar',  '', $char_d, '', '', 
1879         'disabled',    'char', 'NULL',       1, '', '', 
1880       ],
1881       'primary_key' => 'classnum',
1882       'unique' => [],
1883       'index' => [ ['disabled'] ],
1884     },
1885
1886     #(this should be renamed to part_pop)
1887     'svc_acct_pop' => {
1888       'columns' => [
1889         'popnum',    'serial',    '',   '', '', '', 
1890         'city',      'varchar',   '',   $char_d, '', '', 
1891         'state',     'varchar',   '',   $char_d, '', '', 
1892         'ac',        'char',   '',   3, '', '', 
1893         'exch',      'char',   '',   3, '', '', 
1894         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
1895       ],
1896       'primary_key' => 'popnum',
1897       'unique' => [],
1898       'index' => [ [ 'state' ] ],
1899     },
1900
1901     'part_pop_local' => {
1902       'columns' => [
1903         'localnum',  'serial',     '',     '', '', '', 
1904         'popnum',    'int',     '',     '', '', '', 
1905         'city',      'varchar', 'NULL', $char_d, '', '', 
1906         'state',     'char',    'NULL', 2, '', '', 
1907         'npa',       'char',    '',     3, '', '', 
1908         'nxx',       'char',    '',     3, '', '', 
1909       ],
1910       'primary_key' => 'localnum',
1911       'unique' => [],
1912       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1913     },
1914     
1915     'qual' => {
1916       'columns' => [
1917         'qualnum',  'serial',     '',     '', '', '', 
1918         'custnum',    'int',     'NULL',     '', '', '',
1919         'prospectnum',    'int',     'NULL',     '', '', '',
1920         'locationnum',    'int',     'NULL',     '', '', '',
1921         'phonenum',     'varchar', 'NULL',       24, '', '',
1922         'exportnum',      'int', 'NULL', '', '', '', 
1923         'vendor_qual_id',      'varchar', 'NULL', $char_d, '', '', 
1924         'status',      'char', '', 1, '', '', 
1925       ],
1926       'primary_key' => 'qualnum',
1927       'unique' => [],
1928       'index' => [ [ 'locationnum' ], ['custnum'], ['prospectnum'],
1929                     ['phonenum'], ['vendor_qual_id'] ],
1930     },
1931     
1932     'qual_option' => {
1933       'columns' => [
1934         'optionnum', 'serial', '', '', '', '', 
1935         'qualnum',  'int',     '',     '', '', '', 
1936         'optionname', 'varchar', '', $char_d, '', '', 
1937         'optionvalue', 'text', 'NULL', '', '', '', 
1938       ],
1939       'primary_key' => 'optionnum',
1940       'unique' => [],
1941       'index' => [],
1942     },
1943
1944     'svc_acct' => {
1945       'columns' => [
1946         'svcnum',    'int',    '',   '', '', '', 
1947         'username',  'varchar',   '',   $username_len, '', '',
1948         '_password', 'varchar',   'NULL',  512, '', '',
1949         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1950         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '', 
1951         'popnum',    'int',    'NULL',   '', '', '', 
1952         'sectornum', 'int', 'NULL',      '', '', '',
1953         'uid',       'int', 'NULL',   '', '', '', 
1954         'gid',       'int', 'NULL',   '', '', '', 
1955         'finger',    'varchar',   'NULL',   2*$char_d, '', '', 
1956         'dir',       'varchar',   'NULL',   $char_d, '', '', 
1957         'shell',     'varchar',   'NULL',   $char_d, '', '', 
1958         'quota',     'varchar',   'NULL',   $char_d, '', '', 
1959         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
1960         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
1961         'seconds_threshold',   'int', 'NULL',   '', '', '',
1962         'upbytes',   'bigint', 'NULL',   '', '', '', 
1963         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
1964         'downbytes', 'bigint', 'NULL',   '', '', '',
1965         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
1966         'totalbytes','bigint', 'NULL',   '', '', '',
1967         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
1968         'domsvc',    'int',     '', '', '', '', 
1969         'pbxsvc',    'int', 'NULL', '', '', '',
1970         'last_login',  @date_type, '', '', 
1971         'last_logout', @date_type, '', '', 
1972         #cardfortress field(s)
1973         'cf_privatekey',      'text', 'NULL',      '', '', '',
1974         #communigate pro fields (quota = MaxAccountSize)
1975         'cgp_aliases',     'varchar', 'NULL',     255, '', '',
1976         #settings
1977         'cgp_type',        'varchar', 'NULL', $char_d, '', '', #AccountType
1978         'file_quota',      'varchar', 'NULL', $char_d, '', '', #MaxWebSize
1979         'file_maxnum',     'varchar', 'NULL', $char_d, '', '', #MaxWebFiles
1980         'file_maxsize',    'varchar', 'NULL', $char_d, '', '', #MaxFileSize
1981         'cgp_accessmodes', 'varchar', 'NULL',     255, '', '', #AccessModes
1982         'password_selfchange','char', 'NULL',       1, '', '', #PWDAllowed
1983         'password_recover',   'char', 'NULL',       1, 'Y','', #PasswordRecovery
1984         'cgp_rulesallowed','varchar', 'NULL', $char_d, '', '', #RulesAllowed
1985         'cgp_rpopallowed',    'char', 'NULL',       1, '', '', #RPOPAllowed
1986         'cgp_mailtoall',      'char', 'NULL',       1, '', '', #MailToAll
1987         'cgp_addmailtrailer', 'char', 'NULL',       1, '', '', #AddMailTrailer
1988         'cgp_archiveafter',    'int', 'NULL',      '', '', '', #ArchiveMessagesAfter
1989         #XXX mailing lists
1990         #preferences
1991         'cgp_deletemode',     'varchar', 'NULL', $char_d, '', '',#DeleteMode
1992         'cgp_emptytrash',     'varchar', 'NULL', $char_d, '', '',#EmptyTrash
1993         'cgp_language',       'varchar', 'NULL', $char_d, '', '',#Language
1994         'cgp_timezone',       'varchar', 'NULL', $char_d, '', '',#TimeZone
1995         'cgp_skinname',       'varchar', 'NULL', $char_d, '', '',#SkinName
1996         'cgp_prontoskinname', 'varchar', 'NULL', $char_d, '', '',#ProntoSkinName
1997         'cgp_sendmdnmode',    'varchar', 'NULL', $char_d, '', '',#SendMDNMode
1998         #mail
1999         #XXX RPOP settings
2000       ],
2001       'primary_key' => 'svcnum',
2002       #'unique' => [ [ 'username', 'domsvc' ] ],
2003       'unique' => [],
2004       'index' => [ ['username'], ['domsvc'], ['pbxsvc'] ],
2005     },
2006
2007     'acct_rt_transaction' => {
2008       'columns' => [
2009         'svcrtid',   'int',    '',   '', '', '', 
2010         'svcnum',    'int',    '',   '', '', '', 
2011         'transaction_id',       'int', '',   '', '', '', 
2012         '_date',   @date_type, '', '',
2013         'seconds',   'int', '',   '', '', '', #uhhhh
2014         'support',   'int', '',   '', '', '',
2015       ],
2016       'primary_key' => 'svcrtid',
2017       'unique' => [],
2018       'index' => [ ['svcnum', 'transaction_id'] ],
2019     },
2020
2021     #'svc_charge' => {
2022     #  'columns' => [
2023     #    'svcnum',    'int',    '',   '',
2024     #    'amount',    @money_type,
2025     #  ],
2026     #  'primary_key' => 'svcnum',
2027     #  'unique' => [ [] ],
2028     #  'index' => [ [] ],
2029     #},
2030
2031     'svc_domain' => {
2032       'columns' => [
2033         'svcnum',           'int',    '',        '', '', '',
2034         'domain',       'varchar',    '',   $char_d, '', '',
2035         'suffix',       'varchar', 'NULL',  $char_d, '', '',
2036         'catchall',         'int', 'NULL',       '', '', '',
2037         'parent_svcnum',    'int', 'NULL',       '', '', '',
2038         'registrarnum',     'int', 'NULL',       '', '', '',
2039         'registrarkey', 'varchar', 'NULL',      512, '', '',
2040         'setup_date',      @date_type, '', '',
2041         'renewal_interval', 'int', 'NULL',       '', '', '',
2042         'expiration_date', @date_type, '', '',
2043         'au_registrant_name',       'varchar', 'NULL',  $char_d, '', '',
2044         'au_eligibility_type',      'varchar', 'NULL',  $char_d, '', '',
2045         #communigate pro fields (quota = MaxAccountSize)
2046         'max_accounts',     'int', 'NULL',       '', '', '',
2047         'trailer',         'text', 'NULL',       '', '', '',
2048         'cgp_aliases',  'varchar', 'NULL',      255, '', '',
2049         'cgp_accessmodes','varchar','NULL',     255, '', '', #DomainAccessModes
2050         'cgp_certificatetype','varchar','NULL', $char_d, '', '',
2051         #settings
2052         'acct_def_password_selfchange',   'char', 'NULL',       1,  '', '', 
2053         'acct_def_password_recover',      'char', 'NULL',       1, 'Y', '', 
2054         'acct_def_cgp_accessmodes',    'varchar', 'NULL',     255,  '', '',
2055         'acct_def_quota',              'varchar', 'NULL', $char_d,  '', '',
2056         'acct_def_file_quota',         'varchar', 'NULL', $char_d,  '', '',
2057         'acct_def_file_maxnum',        'varchar', 'NULL', $char_d,  '', '',
2058         'acct_def_file_maxsize',       'varchar', 'NULL', $char_d,  '', '',
2059         'acct_def_cgp_rulesallowed',   'varchar', 'NULL', $char_d,  '', '',
2060         'acct_def_cgp_rpopallowed',       'char', 'NULL',       1,  '', '', 
2061         'acct_def_cgp_mailtoall',         'char', 'NULL',       1,  '', '', 
2062         'acct_def_cgp_addmailtrailer',    'char', 'NULL',       1,  '', '', 
2063         'acct_def_cgp_archiveafter',       'int', 'NULL',      '',  '', '',
2064         #preferences
2065         'acct_def_cgp_deletemode',     'varchar', 'NULL', $char_d,  '', '',
2066         'acct_def_cgp_emptytrash',     'varchar', 'NULL', $char_d,  '', '',
2067         'acct_def_cgp_language',       'varchar', 'NULL', $char_d,  '', '',
2068         'acct_def_cgp_timezone',       'varchar', 'NULL', $char_d,  '', '',
2069         'acct_def_cgp_skinname',       'varchar', 'NULL', $char_d,  '', '',
2070         'acct_def_cgp_prontoskinname', 'varchar', 'NULL', $char_d,  '', '',
2071         'acct_def_cgp_sendmdnmode',    'varchar', 'NULL', $char_d,  '', '',
2072       ],
2073       'primary_key' => 'svcnum',
2074       'unique' => [ ],
2075       'index' => [ ['domain'] ],
2076     },
2077     
2078     'svc_dsl' => {
2079       'columns' => [
2080         'svcnum',                    'int',    '',        '', '', '',
2081         'pushed',                    'int', 'NULL',       '', '', '',
2082         'desired_due_date',          'int', 'NULL',       '', '', '',
2083         'due_date',                  'int', 'NULL',       '', '', '',
2084         'vendor_order_id',       'varchar', 'NULL', $char_d,  '', '',
2085         'vendor_qual_id',        'varchar', 'NULL', $char_d,  '', '',
2086         'vendor_order_type',     'varchar', 'NULL', $char_d,  '', '',
2087         'vendor_order_status',   'varchar', 'NULL', $char_d,  '', '',
2088         'first',                 'varchar', 'NULL', $char_d,  '', '',
2089         'last',                  'varchar', 'NULL', $char_d,  '', '',
2090         'company',               'varchar', 'NULL', $char_d,  '', '',
2091         'phonenum',              'varchar', 'NULL',      24, '', '',
2092         'gateway_access_number', 'varchar', 'NULL',      24, '', '',
2093         'loop_type',                'char', 'NULL',       1, '', '', 
2094         'local_voice_provider',  'varchar', 'NULL', $char_d, '', '',
2095         'circuitnum',            'varchar', 'NULL', $char_d, '', '',
2096         'rate_band',             'varchar', 'NULL', $char_d, '', '',
2097         'vpi',                       'int', 'NULL',      '', '', '',
2098         'vci',                       'int', 'NULL',      '', '', '',
2099         'isp_chg',                  'char', 'NULL',       1, '', '', 
2100         'isp_prev',              'varchar', 'NULL', $char_d, '', '',
2101         'username',              'varchar', 'NULL', $char_d, '', '',
2102         'password',              'varchar', 'NULL', $char_d, '', '',
2103         'staticips',                'text', 'NULL',      '', '', '',
2104         'monitored',                'char', 'NULL',       1, '', '', 
2105         'last_pull',                 'int', 'NULL',      '', '', '',
2106       ],
2107       'primary_key' => 'svcnum',
2108       'unique' => [ ],
2109       'index' => [ ['phonenum'], ['vendor_order_id'] ],
2110     },
2111
2112     'dsl_device' => {
2113       'columns' => [
2114         'devicenum', 'serial',     '', '', '', '',
2115         #part_device?  or our own part_dsl_device?
2116         #'devicepart',   'int',     '', '', '', '',
2117         'svcnum',       'int',     '', '', '', '', 
2118         'mac_addr', 'varchar',     '', 12, '', '', 
2119       ],
2120       'primary_key' => 'devicenum',
2121       'unique' => [ [ 'mac_addr' ], ],
2122       'index'  => [ [ 'svcnum' ], ], # [ 'devicepart' ] ],
2123     },
2124     
2125     'dsl_note' => {
2126       'columns' => [
2127         'notenum',           'serial',    '',        '', '', '',
2128         'svcnum',     'int', '',       '', '', '',
2129         'author',     'varchar', 'NULL', $char_d,  '', '',
2130         'priority',   'char', 'NULL',       1,  '', '', 
2131         '_date',     'int', 'NULL',       '', '', '',
2132         'note',     'text', '',       '', '', '',
2133       ],
2134       'primary_key' => 'notenum',
2135       'unique' => [ ],
2136       'index' => [ ['svcnum'] ],
2137     },
2138
2139     'svc_dish' => {
2140       'columns' => [
2141         'svcnum',   'int',     '',     '', '', '',
2142         'acctnum',  'varchar', '',     16, '', '',
2143         'installdate', @date_type,         '', '', 
2144         'note',     'text',    'NULL', '', '', '',
2145       ],
2146       'primary_key' => 'svcnum',
2147       'unique' => [ ],
2148       'index' => [ ],
2149     },
2150
2151     'svc_hardware' => {
2152       'columns' => [
2153         'svcnum',   'int',     '',          '', '', '',
2154         'typenum',  'int',     '',          '', '', '',
2155         'serial',   'varchar', 'NULL', $char_d, '', '',
2156         'ip_addr',  'varchar', 'NULL',      40, '', '',
2157         'hw_addr',  'varchar', 'NULL',      12, '', '',
2158         'smartcard','varchar', 'NULL',      30, '', '',
2159         'statusnum','int',     'NULL',      '', '', '',
2160         'note',     'text',    'NULL',      '', '', '',
2161       ],
2162       'primary_key' => 'svcnum',
2163       'unique' => [ ],
2164       'index' => [ ],
2165     },
2166
2167     'hardware_class' => {
2168       'columns' => [
2169         'classnum',   'serial', '',      '', '', '',
2170         'classname', 'varchar', '', $char_d, '', '',
2171       ],
2172       'primary_key' => 'classnum',
2173       'unique' => [ ],
2174       'index'  => [ ],
2175     },
2176
2177     'hardware_type' => {
2178       'columns' => [
2179         'typenum',  'serial',     '',      '', '', '',
2180         'classnum',    'int',     '',      '', '', '',
2181         'model',   'varchar',     '', $char_d, '', '',
2182         'revision','varchar', 'NULL', $char_d, '', '',
2183       ],
2184       'primary_key' => 'typenum',
2185       'unique' => [ [ 'classnum', 'model', 'revision' ] ],
2186       'index'  => [ ],
2187     },
2188
2189     'hardware_status' => {
2190       'columns' => [
2191         'statusnum', 'serial', '',      '', '', '',
2192         'label'    ,'varchar', '', $char_d, '', '',
2193         'disabled',    'char', 'NULL',   1, '', '', 
2194       ],
2195       'primary_key' => 'statusnum',
2196       'unique' => [ ],
2197       'index'  => [ ],
2198     },
2199
2200     'domain_record' => {
2201       'columns' => [
2202         'recnum',    'serial',     '',  '', '', '', 
2203         'svcnum',    'int',     '',  '', '', '', 
2204         'reczone',   'varchar', '',  255, '', '', 
2205         'recaf',     'char',    '',  2, '', '', 
2206         'rectype',   'varchar',    '',  5, '', '', 
2207         'recdata',   'varchar', '',  255, '', '', 
2208         'ttl',       'int',     'NULL', '', '', '',
2209       ],
2210       'primary_key' => 'recnum',
2211       'unique'      => [],
2212       'index'       => [ ['svcnum'] ],
2213     },
2214
2215     'registrar' => {
2216       'columns' => [
2217         'registrarnum',   'serial', '',      '', '', '',
2218         'registrarname', 'varchar', '', $char_d, '', '',
2219       ],
2220       'primary_key' => 'registrarnum',
2221       'unique'      => [],
2222       'index'       => [],
2223     },
2224
2225     'cgp_rule' => {
2226       'columns' => [
2227         'rulenum',  'serial',     '',      '', '', '',
2228         'name',    'varchar',     '', $char_d, '', '',
2229         'comment', 'varchar', 'NULL', $char_d, '', '',
2230         'svcnum',      'int',     '',      '', '', '',
2231         'priority',    'int',     '',      '', '', '',
2232       ],
2233       'primary_key' => 'rulenum',
2234       'unique'      => [ [ 'svcnum', 'name' ] ],
2235       'index'       => [ [ 'svcnum' ] ],
2236     },
2237
2238     'cgp_rule_condition' => {
2239       'columns' => [
2240         'ruleconditionnum',  'serial',     '',      '', '', '',
2241         'conditionname',    'varchar',     '', $char_d, '', '',
2242         'op',               'varchar', 'NULL', $char_d, '', '',
2243         'params',           'varchar', 'NULL',     255, '', '',
2244         'rulenum',              'int',     '',      '', '', '',
2245       ],
2246       'primary_key' => 'ruleconditionnum',
2247       'unique'      => [],
2248       'index'       => [ [ 'rulenum' ] ],
2249     },
2250
2251     'cgp_rule_action' => {
2252        'columns' => [
2253         'ruleactionnum',  'serial',     '',      '', '', '',
2254         'action',        'varchar',     '', $char_d, '', '',
2255         'params',        'varchar', 'NULL',     255, '', '',
2256         'rulenum',           'int',     '',      '', '', '',
2257       ],
2258       'primary_key' => 'ruleactionnum',
2259       'unique'      => [],
2260       'index'       => [ [ 'rulenum' ] ],
2261    },
2262
2263     'svc_forward' => {
2264       'columns' => [
2265         'svcnum',   'int',            '',   '', '', '', 
2266         'srcsvc',   'int',        'NULL',   '', '', '', 
2267         'src',      'varchar',    'NULL',  255, '', '', 
2268         'dstsvc',   'int',        'NULL',   '', '', '', 
2269         'dst',      'varchar',    'NULL',  255, '', '', 
2270       ],
2271       'primary_key' => 'svcnum',
2272       'unique'      => [],
2273       'index'       => [ ['srcsvc'], ['dstsvc'] ],
2274     },
2275
2276     'svc_www' => {
2277       'columns' => [
2278         'svcnum',   'int',      '',  '', '', '', 
2279         'recnum',   'int',      '',  '', '', '', 
2280         'usersvc',  'int',  'NULL',  '', '', '', 
2281         'config',   'text', 'NULL',  '', '', '', 
2282       ],
2283       'primary_key' => 'svcnum',
2284       'unique'      => [],
2285       'index'       => [],
2286     },
2287
2288     #'svc_wo' => {
2289     #  'columns' => [
2290     #    'svcnum',    'int',    '',   '',
2291     #    'svcnum',    'int',    '',   '',
2292     #    'svcnum',    'int',    '',   '',
2293     #    'worker',    'varchar',   '',   $char_d,
2294     #    '_date',     @date_type,
2295     #  ],
2296     #  'primary_key' => 'svcnum',
2297     #  'unique' => [ [] ],
2298     #  'index' => [ [] ],
2299     #},
2300
2301     'prepay_credit' => {
2302       'columns' => [
2303         'prepaynum',   'serial',     '',   '', '', '', 
2304         'identifier',  'varchar', '', $char_d, '', '', 
2305         'amount',      @money_type, '', '', 
2306         'seconds',     'int',     'NULL', '', '', '', 
2307         'upbytes',     'bigint',     'NULL', '', '', '', 
2308         'downbytes',   'bigint',     'NULL', '', '', '', 
2309         'totalbytes',  'bigint',     'NULL', '', '', '', 
2310         'agentnum',    'int',     'NULL', '', '', '', 
2311       ],
2312       'primary_key' => 'prepaynum',
2313       'unique'      => [ ['identifier'] ],
2314       'index'       => [],
2315     },
2316
2317     'port' => {
2318       'columns' => [
2319         'portnum',  'serial',     '',   '', '', '', 
2320         'ip',       'varchar', 'NULL', 15, '', '', 
2321         'nasport',  'int',     'NULL', '', '', '', 
2322         'nasnum',   'int',     '',   '', '', '', 
2323       ],
2324       'primary_key' => 'portnum',
2325       'unique'      => [],
2326       'index'       => [],
2327     },
2328
2329     'nas' => {
2330       'columns' => [
2331         'nasnum',       'serial',     '',  '',              '', '', 
2332         'nasname',     'varchar',     '', 128,              '', '',
2333         'shortname',   'varchar', 'NULL',  32,              '', '',
2334         'type',        'varchar',     '',  30,         'other', '',
2335         'ports',           'int', 'NULL',  '',              '', '',
2336         'secret',      'varchar',     '',  60,        'secret', '',
2337         'server',      'varchar', 'NULL',  64,              '', '',
2338         'community',   'varchar', 'NULL',  50,              '', '',
2339         'description', 'varchar',     '', 200, 'RADIUS Client', '',
2340         'svcnum',          'int', 'NULL',  '',              '', '',
2341       ],
2342       'primary_key' => 'nasnum',
2343       'unique'      => [ [ 'nasname' ], ],
2344       'index'       => [],
2345     },
2346
2347     'export_nas' => {
2348       'columns' => [
2349         'exportnasnum', 'serial', '', '', '', '', 
2350         'exportnum',       'int', '', '', '', '', 
2351         'nasnum',          'int', '', '', '', '', 
2352       ],
2353       'primary_key' => 'exportnasnum',
2354       'unique'      => [ [ 'exportnum', 'nasnum' ] ],
2355       'index'       => [ [ 'exportnum' ], [ 'nasnum' ] ],
2356     },
2357
2358     'queue' => {
2359       'columns' => [
2360         'jobnum',      'serial',     '',      '', '', '', 
2361         'job',        'varchar',     '',     512, '', '', 
2362         '_date',          'int',     '',      '', '', '', 
2363         'status',     'varchar',     '', $char_d, '', '', 
2364         'statustext',    'text', 'NULL',      '', '', '', 
2365         'svcnum',         'int', 'NULL',      '', '', '', 
2366         'custnum',        'int', 'NULL',      '', '', '',
2367         'secure',        'char', 'NULL',       1, '', '',
2368         'priority',       'int', 'NULL',      '', '', '',
2369       ],
2370       'primary_key' => 'jobnum',
2371       'unique'      => [],
2372       'index'       => [ [ 'secure' ], [ 'priority' ],
2373                          [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
2374                        ],
2375     },
2376
2377     'queue_arg' => {
2378       'columns' => [
2379         'argnum', 'serial', '', '', '', '', 
2380         'jobnum', 'int', '', '', '', '', 
2381         'frozen', 'char', 'NULL',       1, '', '',
2382         'arg', 'text', 'NULL', '', '', '', 
2383       ],
2384       'primary_key' => 'argnum',
2385       'unique'      => [],
2386       'index'       => [ [ 'jobnum' ] ],
2387     },
2388
2389     'queue_depend' => {
2390       'columns' => [
2391         'dependnum', 'serial', '', '', '', '', 
2392         'jobnum', 'int', '', '', '', '', 
2393         'depend_jobnum', 'int', '', '', '', '', 
2394       ],
2395       'primary_key' => 'dependnum',
2396       'unique'      => [],
2397       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
2398     },
2399
2400     'export_svc' => {
2401       'columns' => [
2402         'exportsvcnum' => 'serial', '', '', '', '', 
2403         'exportnum'    => 'int', '', '', '', '', 
2404         'svcpart'      => 'int', '', '', '', '', 
2405       ],
2406       'primary_key' => 'exportsvcnum',
2407       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
2408       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
2409     },
2410
2411     'export_device' => {
2412       'columns' => [
2413         'exportdevicenum' => 'serial', '', '', '', '', 
2414         'exportnum'    => 'int', '', '', '', '', 
2415         'devicepart'      => 'int', '', '', '', '', 
2416       ],
2417       'primary_key' => 'exportdevicenum',
2418       'unique'      => [ [ 'exportnum', 'devicepart' ] ],
2419       'index'       => [ [ 'exportnum' ], [ 'devicepart' ] ],
2420     },
2421
2422     'part_export' => {
2423       'columns' => [
2424         'exportnum', 'serial', '', '', '', '', 
2425         'exportname', 'varchar', 'NULL', $char_d, '', '',
2426         'machine', 'varchar', '', $char_d, '', '', 
2427         'exporttype', 'varchar', '', $char_d, '', '', 
2428         'nodomain',     'char', 'NULL', 1, '', '', 
2429       ],
2430       'primary_key' => 'exportnum',
2431       'unique'      => [],
2432       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
2433     },
2434
2435     'part_export_option' => {
2436       'columns' => [
2437         'optionnum', 'serial', '', '', '', '', 
2438         'exportnum', 'int', '', '', '', '', 
2439         'optionname', 'varchar', '', $char_d, '', '', 
2440         'optionvalue', 'text', 'NULL', '', '', '', 
2441       ],
2442       'primary_key' => 'optionnum',
2443       'unique'      => [],
2444       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
2445     },
2446
2447     'radius_usergroup' => {
2448       'columns' => [
2449         'usergroupnum', 'serial', '', '', '', '', 
2450         'svcnum',       'int', '', '', '', '', 
2451         'groupname',    'varchar', 'NULL', $char_d, '', '', 
2452         'groupnum',     'int', 'NULL', '', '', '', 
2453       ],
2454       'primary_key' => 'usergroupnum',
2455       'unique'      => [],
2456       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
2457     },
2458     
2459     'radius_group' => {
2460       'columns' => [
2461         'groupnum', 'serial', '', '', '', '', 
2462         'groupname',    'varchar', '', $char_d, '', '', 
2463         'description',  'varchar', 'NULL', $char_d, '', '', 
2464         'priority', 'int', '', '', '1', '',
2465       ],
2466       'primary_key' => 'groupnum',
2467       'unique'      => [ ['groupname'] ],
2468       'index'       => [],
2469     },
2470
2471     'radius_attr' => {
2472       'columns' => [
2473         'attrnum',   'serial', '', '', '', '',
2474         'groupnum',     'int', '', '', '', '',
2475         'attrname', 'varchar', '', $char_d, '', '',
2476         'value',    'varchar', '', $char_d, '', '',
2477         'attrtype',    'char', '', 1, '', '',
2478         'op',          'char', '', 2, '', '',
2479       ],
2480       'primary_key' => 'attrnum',
2481       'unique'      => [ ['groupnum','attrname'] ], #?
2482       'index'       => [],
2483     },
2484
2485     'msgcat' => {
2486       'columns' => [
2487         'msgnum', 'serial', '', '', '', '', 
2488         'msgcode', 'varchar', '', 255, '', '', 
2489         'locale', 'varchar', '', 16, '', '', 
2490         'msg', 'text', '', '', '', '', 
2491       ],
2492       'primary_key' => 'msgnum',
2493       'unique'      => [ [ 'msgcode', 'locale' ] ],
2494       'index'       => [],
2495     },
2496
2497     'cust_tax_exempt' => {
2498       'columns' => [
2499         'exemptnum', 'serial', '', '', '', '', 
2500         'custnum',   'int', '', '', '', '', 
2501         'taxnum',    'int', '', '', '', '', 
2502         'year',      'int', '', '', '', '', 
2503         'month',     'int', '', '', '', '', 
2504         'amount',   @money_type, '', '', 
2505       ],
2506       'primary_key' => 'exemptnum',
2507       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
2508       'index'       => [],
2509     },
2510
2511     'cust_tax_exempt_pkg' => {
2512       'columns' => [
2513         'exemptpkgnum',  'serial', '', '', '', '', 
2514         #'custnum',      'int', '', '', '', ''
2515         'billpkgnum',   'int', '', '', '', '', 
2516         'taxnum',       'int', '', '', '', '', 
2517         'year',         'int', '', '', '', '', 
2518         'month',        'int', '', '', '', '', 
2519         'creditbillpkgnum', 'int', 'NULL', '', '', '',
2520         'amount',       @money_type, '', '', 
2521       ],
2522       'primary_key' => 'exemptpkgnum',
2523       'unique' => [],
2524       'index'  => [ [ 'taxnum', 'year', 'month' ],
2525                     [ 'billpkgnum' ],
2526                     [ 'taxnum' ],
2527                     [ 'creditbillpkgnum' ],
2528                   ],
2529     },
2530
2531     'router' => {
2532       'columns' => [
2533         'routernum', 'serial', '', '', '', '', 
2534         'routername', 'varchar', '', $char_d, '', '', 
2535         'svcnum', 'int', 'NULL', '', '', '', 
2536         'agentnum',   'int', 'NULL', '', '', '', 
2537         'manual_addr', 'char', 'NULL', 1, '', '',
2538       ],
2539       'primary_key' => 'routernum',
2540       'unique'      => [],
2541       'index'       => [],
2542     },
2543
2544     'part_svc_router' => {
2545       'columns' => [
2546         'svcrouternum', 'serial', '', '', '', '', 
2547         'svcpart', 'int', '', '', '', '', 
2548         'routernum', 'int', '', '', '', '', 
2549       ],
2550       'primary_key' => 'svcrouternum',
2551       'unique'      => [],
2552       'index'       => [],
2553     },
2554
2555     'addr_block' => {
2556       'columns' => [
2557         'blocknum', 'serial', '', '', '', '', 
2558         'routernum', 'int', '', '', '', '', 
2559         'ip_gateway', 'varchar', '', 15, '', '', 
2560         'ip_netmask', 'int', '', '', '', '', 
2561         'agentnum',   'int', 'NULL', '', '', '', 
2562         'manual_flag', 'char', 'NULL', 1, '', '', 
2563       ],
2564       'primary_key' => 'blocknum',
2565       'unique'      => [ [ 'blocknum', 'routernum' ] ],
2566       'index'       => [],
2567     },
2568
2569     'svc_broadband' => {
2570       'columns' => [
2571         'svcnum',                  'int',     '',      '', '', '', 
2572         'description',         'varchar', 'NULL', $char_d, '', '', 
2573         'routernum',               'int', 'NULL',      '', '', '',
2574         'blocknum',                'int', 'NULL',      '', '', '', 
2575         'sectornum',               'int', 'NULL',      '', '', '',
2576         'speed_up',                'int', 'NULL',      '', '', '', 
2577         'speed_down',              'int', 'NULL',      '', '', '', 
2578         'ip_addr',             'varchar', 'NULL',      15, '', '', 
2579         'mac_addr',            'varchar', 'NULL',      12, '', '', 
2580         'authkey',             'varchar', 'NULL',      32, '', '', 
2581         'latitude',            'decimal', 'NULL',  '10,7', '', '', 
2582         'longitude',           'decimal', 'NULL',  '10,7', '', '', 
2583         'altitude',            'decimal', 'NULL',      '', '', '', 
2584         'vlan_profile',        'varchar', 'NULL', $char_d, '', '', 
2585         'performance_profile', 'varchar', 'NULL', $char_d, '', '',
2586         'plan_id',             'varchar', 'NULL', $char_d, '', '',
2587       ],
2588       'primary_key' => 'svcnum',
2589       'unique'      => [ [ 'ip_addr' ], [ 'mac_addr' ] ],
2590       'index'       => [],
2591     },
2592
2593     'tower' => {
2594       'columns' => [
2595         'towernum',   'serial',     '',      '', '', '',
2596         #'agentnum',      'int', 'NULL',      '', '', '',
2597         'towername', 'varchar',     '', $char_d, '', '',
2598         'disabled',     'char', 'NULL',       1, '', '',
2599         'latitude', 'decimal', 'NULL',   '10,7', '', '', 
2600         'longitude','decimal', 'NULL',   '10,7', '', '', 
2601         'altitude', 'decimal', 'NULL',       '', '', '', 
2602         'coord_auto',  'char', 'NULL',        1, '', '',
2603       ],
2604       'primary_key' => 'towernum',
2605       'unique'      => [ [ 'towername' ] ], # , 'agentnum' ] ],
2606       'index'       => [],
2607     },
2608
2609     'tower_sector' => {
2610       'columns' => [
2611         'sectornum',   'serial',     '',      '', '', '',
2612         'towernum',       'int',     '',      '', '', '',
2613         'sectorname', 'varchar',     '', $char_d, '', '',
2614         'ip_addr',    'varchar', 'NULL',      15, '', '',
2615       ],
2616       'primary_key' => 'sectornum',
2617       'unique'      => [ [ 'towernum', 'sectorname' ], [ 'ip_addr' ], ],
2618       'index'       => [ [ 'towernum' ] ],
2619     },
2620
2621     'part_virtual_field' => {
2622       'columns' => [
2623         'vfieldpart', 'serial', '', '', '', '', 
2624         'dbtable', 'varchar', '', 32, '', '', 
2625         'name', 'varchar', '', 32, '', '', 
2626         'length', 'int', 'NULL', '', '', '', 
2627         'label', 'varchar', 'NULL', 80, '', '', 
2628       ],
2629       'primary_key' => 'vfieldpart',
2630       'unique' => [],
2631       'index' => [],
2632     },
2633
2634     'virtual_field' => {
2635       'columns' => [
2636         'vfieldnum', 'serial', '', '', '', '', 
2637         'recnum', 'int', '', '', '', '', 
2638         'vfieldpart', 'int', '', '', '', '', 
2639         'value', 'varchar', '', 128, '', '', 
2640       ],
2641       'primary_key' => 'vfieldnum',
2642       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
2643       'index' => [],
2644     },
2645
2646     'acct_snarf' => {
2647       'columns' => [
2648         'snarfnum',    'serial',     '',      '', '', '', 
2649         'snarfname',  'varchar', 'NULL', $char_d, '', '', 
2650         'svcnum',         'int',     '',      '', '', '', 
2651         'machine',    'varchar',     '',     255, '', '', 
2652         'protocol',   'varchar',     '', $char_d, '', '', 
2653         'username',   'varchar',     '', $char_d, '', '', 
2654         '_password',  'varchar',     '', $char_d, '', '', 
2655         'check_freq',     'int', 'NULL',      '', '', '', 
2656         'leavemail',     'char', 'NULL',       1, '', '', 
2657         'apop',          'char', 'NULL',       1, '', '', 
2658         'tls',           'char', 'NULL',       1, '', '', 
2659         'mailbox',    'varchar', 'NULL', $char_d, '', '', 
2660       ],
2661       'primary_key' => 'snarfnum',
2662       'unique' => [],
2663       'index'  => [ [ 'svcnum' ] ],
2664     },
2665
2666     'svc_external' => {
2667       'columns' => [
2668         'svcnum',     'int',     '',      '', '', '', 
2669         'id',      'bigint', 'NULL',      '', '', '', 
2670         'title',  'varchar', 'NULL', $char_d, '', '', 
2671       ],
2672       'primary_key' => 'svcnum',
2673       'unique'      => [],
2674       'index'       => [],
2675     },
2676
2677     'cust_pay_refund' => {
2678       'columns' => [
2679         'payrefundnum', 'serial', '', '', '', '', 
2680         'paynum',  'int', '', '', '', '', 
2681         'refundnum',  'int', '', '', '', '', 
2682         '_date',    @date_type, '', '', 
2683         'amount',   @money_type, '', '', 
2684       ],
2685       'primary_key' => 'payrefundnum',
2686       'unique' => [],
2687       'index' => [ ['paynum'], ['refundnum'] ],
2688     },
2689
2690     'part_pkg_option' => {
2691       'columns' => [
2692         'optionnum', 'serial', '', '', '', '', 
2693         'pkgpart', 'int', '', '', '', '', 
2694         'optionname', 'varchar', '', $char_d, '', '', 
2695         'optionvalue', 'text', 'NULL', '', '', '', 
2696       ],
2697       'primary_key' => 'optionnum',
2698       'unique'      => [],
2699       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
2700     },
2701
2702     'part_pkg_vendor' => {
2703       'columns' => [
2704         'num', 'serial', '', '', '', '', 
2705         'pkgpart', 'int', '', '', '', '', 
2706         'exportnum', 'int', '', '', '', '', 
2707         'vendor_pkg_id', 'varchar', '', $char_d, '', '', 
2708       ],
2709       'primary_key' => 'num',
2710       'unique' => [ [ 'pkgpart', 'exportnum' ] ],
2711       'index'       => [ [ 'pkgpart' ] ],
2712     },
2713     
2714     'part_pkg_report_option' => {
2715       'columns' => [
2716         'num',      'serial',   '',      '', '', '', 
2717         'name',     'varchar',  '', $char_d, '', '', 
2718         'disabled', 'char', 'NULL',       1, '', '', 
2719       ],
2720       'primary_key' => 'num',
2721       'unique' => [ [ 'name' ] ],
2722       'index' => [ [ 'disabled' ] ],
2723     },
2724
2725     'rate' => {
2726       'columns' => [
2727         'ratenum',  'serial', '', '', '', '', 
2728         'ratename', 'varchar', '', $char_d, '', '', 
2729       ],
2730       'primary_key' => 'ratenum',
2731       'unique'      => [],
2732       'index'       => [],
2733     },
2734
2735     'rate_detail' => {
2736       'columns' => [
2737         'ratedetailnum',   'serial',  '',     '',      '', '', 
2738         'ratenum',         'int',     '',     '',      '', '', 
2739         'orig_regionnum',  'int', 'NULL',     '',      '', '', 
2740         'dest_regionnum',  'int',     '',     '',      '', '', 
2741         'min_included',    'int',     '',     '',      '', '', 
2742         'conn_charge',     'decimal', '', '10,4', '0.0000', '',
2743         'conn_sec',        'int',     '',     '',      '0', '',
2744         'min_charge',      'decimal', '', '10,5',       '', '',
2745         'sec_granularity', 'int',     '',     '',       '', '', 
2746         'ratetimenum',     'int', 'NULL',     '',       '', '',
2747         'classnum',        'int', 'NULL',     '',       '', '', 
2748         'cdrtypenum',      'int', 'NULL',     '',       '', '',
2749         'region_group', 'char', 'NULL',        1,       '', '', 
2750       ],
2751       'primary_key' => 'ratedetailnum',
2752       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
2753       'index'       => [ [ 'ratenum', 'dest_regionnum' ],
2754                          [ 'ratenum', 'ratetimenum' ]
2755                        ],
2756     },
2757
2758     'rate_region' => {
2759       'columns' => [
2760         'regionnum',   'serial',      '', '', '', '', 
2761         'regionname',  'varchar',     '', $char_d, '', '', 
2762       ],
2763       'primary_key' => 'regionnum',
2764       'unique'      => [],
2765       'index'       => [],
2766     },
2767
2768     'rate_prefix' => {
2769       'columns' => [
2770         'prefixnum',   'serial',      '', '', '', '', 
2771         'regionnum',   'int',         '', '', '', '', 
2772         'countrycode', 'varchar',     '',  3, '', '', 
2773         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
2774         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
2775         'latanum',     'int',     'NULL',      '', '', '',
2776         'state',       'char',    'NULL',       2, '', '', 
2777         'ocn',         'char',    'NULL',       4, '', '', 
2778       ],
2779       'primary_key' => 'prefixnum',
2780       'unique'      => [],
2781       'index'       => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
2782     },
2783
2784     'rate_time' => {
2785       'columns' => [
2786         'ratetimenum', 'serial',      '',      '', '', '',
2787         'ratetimename',   'varchar',      '', $char_d, '', '',
2788       ],
2789       'primary_key' => 'ratetimenum',
2790       'unique'      => [],
2791       'index'       => [],
2792     },
2793
2794     'rate_time_interval' => {
2795       'columns' => [
2796         'intervalnum', 'serial', '', '', '', '',
2797         'stime',          'int', '', '', '', '',
2798         'etime',          'int', '', '', '', '',
2799         'ratetimenum',    'int', '', '', '', '',
2800       ],
2801       'primary_key' => 'intervalnum',
2802       'unique'      => [],
2803       'index'       => [],
2804     },
2805
2806     #not really part of the above rate_ stuff (used with flat rate rather than
2807     # rated billing), but could be eventually, and its a rate
2808     'rate_tier' => {
2809       'columns' => [
2810         'tiernum',   'serial', '',      '', '', '',
2811         'tiername', 'varchar', '', $char_d, '', '',
2812       ],
2813       'primary_key' => 'tiernum',
2814       'unique'      => [ [ 'tiername'], ],
2815       'index'       => [],
2816     },
2817
2818     'rate_tier_detail' => {
2819       'columns' => [
2820         'tierdetailnum', 'serial', '',     '', '', '',
2821         'tiernum',          'int', '',     '', '', '',
2822         'min_quan',         'int', '',     '', '', '',
2823         'min_charge',   'decimal', '', '10,4', '', '',
2824       ],
2825       'primary_key' => 'tierdetailnum',
2826       'unique'      => [],
2827       'index'       => [ ['tiernum'], ],
2828     },
2829
2830     'usage_class' => {
2831       'columns' => [
2832         'classnum',    'serial',      '',      '', '', '', 
2833         'weight',      'int',     'NULL',      '', '', '',
2834         'classname',   'varchar',     '', $char_d, '', '', 
2835         'format',      'varchar', 'NULL', $char_d, '', '', 
2836         'disabled',    'char',    'NULL',       1, '', '', 
2837       ],
2838       'primary_key' => 'classnum',
2839       'unique' => [],
2840       'index' => [ ['disabled'] ],
2841     },
2842
2843     'reg_code' => {
2844       'columns' => [
2845         'codenum',   'serial',    '', '', '', '', 
2846         'code',      'varchar',   '', $char_d, '', '', 
2847         'agentnum',  'int',       '', '', '', '', 
2848       ],
2849       'primary_key' => 'codenum',
2850       'unique'      => [ [ 'agentnum', 'code' ] ],
2851       'index'       => [ [ 'agentnum' ] ],
2852     },
2853
2854     'reg_code_pkg' => {
2855       'columns' => [
2856         'codepkgnum', 'serial', '', '', '', '', 
2857         'codenum',   'int',    '', '', '', '', 
2858         'pkgpart',   'int',    '', '', '', '', 
2859       ],
2860       'primary_key' => 'codepkgnum',
2861       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
2862       'index'       => [ [ 'codenum' ] ],
2863     },
2864
2865     'clientapi_session' => {
2866       'columns' => [
2867         'sessionnum',  'serial',  '', '', '', '', 
2868         'sessionid',  'varchar',  '', $char_d, '', '', 
2869         'namespace',  'varchar',  '', $char_d, '', '', 
2870       ],
2871       'primary_key' => 'sessionnum',
2872       'unique'      => [ [ 'sessionid', 'namespace' ] ],
2873       'index'       => [],
2874     },
2875
2876     'clientapi_session_field' => {
2877       'columns' => [
2878         'fieldnum',    'serial',     '', '', '', '', 
2879         'sessionnum',     'int',     '', '', '', '', 
2880         'fieldname',  'varchar',     '', $char_d, '', '', 
2881         'fieldvalue',    'text', 'NULL', '', '', '', 
2882       ],
2883       'primary_key' => 'fieldnum',
2884       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
2885       'index'       => [],
2886     },
2887
2888     'payment_gateway' => {
2889       'columns' => [
2890         'gatewaynum',       'serial',   '',     '', '', '', 
2891         'gateway_namespace','varchar',  'NULL', $char_d, '', '', 
2892         'gateway_module',   'varchar',  '',     $char_d, '', '', 
2893         'gateway_username', 'varchar',  'NULL', $char_d, '', '', 
2894         'gateway_password', 'varchar',  'NULL', $char_d, '', '', 
2895         'gateway_action',   'varchar',  'NULL', $char_d, '', '', 
2896         'gateway_callback_url', 'varchar',  'NULL', $char_d, '', '', 
2897         'disabled',   'char',  'NULL',   1, '', '', 
2898       ],
2899       'primary_key' => 'gatewaynum',
2900       'unique' => [],
2901       'index'  => [ [ 'disabled' ] ],
2902     },
2903
2904     'payment_gateway_option' => {
2905       'columns' => [
2906         'optionnum',   'serial',  '',     '', '', '', 
2907         'gatewaynum',  'int',     '',     '', '', '', 
2908         'optionname',  'varchar', '',     $char_d, '', '', 
2909         'optionvalue', 'text',    'NULL', '', '', '', 
2910       ],
2911       'primary_key' => 'optionnum',
2912       'unique'      => [],
2913       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
2914     },
2915
2916     'agent_payment_gateway' => {
2917       'columns' => [
2918         'agentgatewaynum', 'serial', '', '', '', '', 
2919         'agentnum',        'int', '', '', '', '', 
2920         'gatewaynum',      'int', '', '', '', '', 
2921         'cardtype',        'varchar', 'NULL', $char_d, '', '', 
2922         'taxclass',        'varchar', 'NULL', $char_d, '', '', 
2923       ],
2924       'primary_key' => 'agentgatewaynum',
2925       'unique'      => [],
2926       'index'       => [ [ 'agentnum', 'cardtype' ], ],
2927     },
2928
2929     'banned_pay' => {
2930       'columns' => [
2931         'bannum',  'serial',   '',     '', '', '', 
2932         'payby',   'char',     '',       4, '', '', 
2933         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
2934         #'paymask', 'varchar',  'NULL', $char_d, '', ''
2935         '_date',            @date_type,         '', '', 
2936         'end_date',         @date_type,         '', '', 
2937         'otaker',  'varchar',  'NULL',      32, '', '', 
2938         'usernum',     'int',  'NULL',      '', '', '',
2939         'bantype', 'varchar',  'NULL', $char_d, '', '',
2940         'reason',  'varchar',  'NULL', $char_d, '', '', 
2941       ],
2942       'primary_key' => 'bannum',
2943       'unique'      => [],
2944       'index'       => [ [ 'payby', 'payinfo' ], [ 'usernum' ], ],
2945     },
2946
2947     'pkg_category' => {
2948       'columns' => [
2949         'categorynum',   'serial',  '', '', '', '', 
2950         'categoryname',  'varchar', '', $char_d, '', '', 
2951         'weight',         'int', 'NULL',  '', '', '',
2952         'condense',      'char', 'NULL',   1, '', '', 
2953         'disabled',      'char', 'NULL',   1, '', '', 
2954       ],
2955       'primary_key' => 'categorynum',
2956       'unique' => [],
2957       'index' => [ ['disabled'] ],
2958     },
2959
2960     'pkg_class' => {
2961       'columns' => [
2962         'classnum',    'serial',   '',      '', '', '', 
2963         'classname',   'varchar',  '', $char_d, '', '', 
2964         'categorynum', 'int',  'NULL',      '', '', '', 
2965         'disabled',    'char', 'NULL',       1, '', '', 
2966         'fcc_ds0s',      'int',     'NULL', '', '', '', 
2967       ],
2968       'primary_key' => 'classnum',
2969       'unique' => [],
2970       'index' => [ ['disabled'] ],
2971     },
2972
2973     'cdr' => {
2974       'columns' => [
2975         # qw( name type null length default local );
2976
2977         ###
2978         #asterisk fields
2979         ###
2980
2981         'acctid',   'bigserial',  '', '', '', '', 
2982         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
2983         'calldate', 'timestamp',   '',      '', \'now()', '',
2984         'clid',        'varchar',  '', $char_d, \"''", '', 
2985         'src',         'varchar',  '', $char_d, \"''", '', 
2986         'dst',         'varchar',  '', $char_d, \"''", '', 
2987         'dcontext',    'varchar',  '', $char_d, \"''", '', 
2988         'channel',     'varchar',  '', $char_d, \"''", '', 
2989         'dstchannel',  'varchar',  '', $char_d, \"''", '', 
2990         'lastapp',     'varchar',  '', $char_d, \"''", '', 
2991         'lastdata',    'varchar',  '', $char_d, \"''", '', 
2992
2993         #currently only opensips
2994         'src_ip_addr', 'varchar',  'NULL',  15,    '', '',
2995         'dst_ip_addr', 'varchar',  'NULL',  15,    '', '',
2996
2997         #these don't seem to be logged by most of the SQL cdr_* modules
2998         #except tds under sql-illegal names, so;
2999         # ... don't rely on them for rating?
3000         # and, what they hey, i went ahead and changed the names and data types
3001         # to freeside-style dates...
3002           #'start',  'timestamp', 'NULL',  '',    '', '',
3003           #'answer', 'timestamp', 'NULL',  '',    '', '',
3004           #'end',    'timestamp', 'NULL',  '',    '', '',
3005         'startdate',  @date_type, '', '', 
3006         'answerdate', @date_type, '', '', 
3007         'enddate',    @date_type, '', '', 
3008         #
3009
3010         'duration',    'int',      '',      '',     0, '',
3011         'billsec',     'int',      '',      '',     0, '', 
3012         'disposition', 'varchar',  '',      45, \"''", '',
3013         'amaflags',    'int',      '',      '',     0, '',
3014         'accountcode', 'varchar',  '',      20, \"''", '',
3015         'uniqueid',    'varchar',  '', $char_d, \"''", '',
3016         'userfield',   'varchar',  '',     512, \"''", '',
3017
3018         'max_callers', 'int',  'NULL',      '',    '', '',
3019
3020         ###
3021         # old fields for unitel/RSLCOM/convergent that don't map to asterisk
3022         # ones we adoped moved to "own fields" section below
3023         # charged_party, upstream_price, rated_price, carrierid, cdrtypenum
3024         ###
3025
3026         'upstream_currency',      'char', 'NULL',       3, '', '',
3027         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
3028
3029         # how it was rated internally...
3030         'ratedetailnum',           'int', 'NULL',      '', '', '',
3031
3032         'distance',            'decimal', 'NULL',      '', '', '',
3033         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
3034
3035         #cdr_calltype: the big list in appendix 2
3036         'calltypenum',             'int', 'NULL',      '', '', '',
3037
3038         'description',         'varchar', 'NULL', $char_d, '', '',
3039         'quantity',                'int', 'NULL',      '', '', '', 
3040
3041         'upstream_rateid',         'int', 'NULL',      '', '', '',
3042         
3043         ###
3044         #and now for our own fields
3045         ###
3046
3047         'cdrtypenum',              'int', 'NULL',      '', '', '',
3048
3049         'charged_party',       'varchar', 'NULL', $char_d, '', '',
3050
3051         'upstream_price',      'decimal', 'NULL',  '10,4', '', '', 
3052         'upstream_src_regionname', 'varchar', 'NULL', $char_d, '', '',
3053         'upstream_dst_regionname', 'varchar', 'NULL', $char_d, '', '',
3054
3055         # how it was rated internally...
3056         'rated_pretty_dst',       'varchar', 'NULL', $char_d, '', '',
3057         'rated_regionname',       'varchar', 'NULL', $char_d, '', '',
3058         'rated_price',            'decimal', 'NULL',  '10,4', '', '',
3059         'rated_seconds',              'int', 'NULL',      '', '', '',
3060         'rated_minutes', 'double precision', 'NULL',      '', '', '',
3061         'rated_granularity',          'int', 'NULL',      '', '', '',
3062         'rated_ratedetailnum',        'int', 'NULL',      '', '', '',
3063         'rated_classnum',             'int', 'NULL',      '', '', '', 
3064         'rated_ratename',         'varchar', 'NULL', $char_d, '', '', 
3065
3066         'carrierid',               'int', 'NULL',      '', '', '',
3067
3068         # service it was matched to
3069         'svcnum',             'int',   'NULL',     '',   '', '', 
3070
3071         #NULL, done (or something)
3072         'freesidestatus', 'varchar',   'NULL',     32,   '', '', 
3073
3074         #NULL, done (or something)
3075         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '', 
3076
3077         #an indexed place to put big numbers
3078         'cdrid',         'bigint',     'NULL',     '',  '', '', 
3079
3080         #for taqua accountcode rewriting, for starters
3081         'sessionnum',       'int',    'NULL',      '', '', '',
3082         'subscriber',   'varchar',    'NULL', $char_d, '', '',
3083
3084         #old
3085         'cdrbatch',     'varchar',    'NULL',     255, '', '',
3086         #new
3087         'cdrbatchnum',      'int',    'NULL',      '', '', '',
3088
3089       ],
3090       'primary_key' => 'acctid',
3091       'unique' => [],
3092       'index' => [ [ 'calldate' ],
3093                    [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
3094                    [ 'lastapp' ],
3095                    ['accountcode'], ['uniqueid'], ['carrierid'], ['cdrid'],
3096                    [ 'sessionnum' ], [ 'subscriber' ],
3097                    [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
3098                    [ 'cdrbatch' ], [ 'cdrbatchnum' ],
3099                    [ 'src_ip_addr' ], [ 'dst_ip_addr' ],
3100                  ],
3101     },
3102
3103     'cdr_batch' => {
3104       'columns' => [
3105         'cdrbatchnum',   'serial',    '',   '', '', '', 
3106         'cdrbatch', 'varchar', 'NULL', 255, '', '',
3107         '_date',     @date_type, '', '', 
3108       ],
3109       'primary_key' => 'cdrbatchnum',
3110       'unique' => [ [ 'cdrbatch' ] ],
3111       'index' => [],
3112     },
3113
3114     'cdr_termination' => {
3115       'columns' => [
3116         'cdrtermnum', 'bigserial',     '',      '', '', '',
3117         'acctid',        'bigint',     '',      '', '', '', 
3118         'termpart',         'int',     '',      '', '', '',#future use see below
3119         'rated_price',  'decimal', 'NULL',  '10,4', '', '',
3120         'rated_seconds',    'int', 'NULL',      '', '', '',
3121         'rated_minutes', 'double precision', 'NULL',   '', '', '',
3122         'status',       'varchar', 'NULL',      32, '', '',
3123         'svcnum',           'int', 'NULL',      '', '', '',
3124       ],
3125       'primary_key' => 'cdrtermnum',
3126       'unique'      => [ [ 'acctid', 'termpart' ] ],
3127       'index'       => [ [ 'acctid' ], [ 'status' ], ],
3128     },
3129
3130     #to handle multiple termination/settlement passes...
3131    # 'part_termination' => {
3132    #   'columns' => [
3133    #     'termpart',       'int', '',      '', '', '',
3134    #     'termname',   'varchar', '', $char_d, '', '',
3135    #     'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
3136    #   ],
3137    #   'primary_key' => 'termpart',
3138    #   'unique' => [],
3139    #   'index'  => [],
3140    # },
3141
3142     #the remaining cdr_ tables are not really used
3143     'cdr_calltype' => {
3144       'columns' => [
3145         'calltypenum',   'serial',  '', '', '', '', 
3146         'calltypename',  'varchar', '', $char_d, '', '', 
3147       ],
3148       'primary_key' => 'calltypenum',
3149       'unique'      => [],
3150       'index'       => [],
3151     },
3152
3153     'cdr_type' => {
3154       'columns' => [
3155         'cdrtypenum'  => 'serial',  '', '', '', '',
3156         'cdrtypename' => 'varchar', '', $char_d, '', '',
3157       ],
3158       'primary_key' => 'cdrtypenum',
3159       'unique'      => [],
3160       'index'       => [],
3161     },
3162
3163     'cdr_carrier' => {
3164       'columns' => [
3165         'carrierid'   => 'serial',  '', '', '', '',
3166         'carriername' => 'varchar', '', $char_d, '', '',
3167       ],
3168       'primary_key' => 'carrierid',
3169       'unique'      => [],
3170       'index'       => [],
3171     },
3172
3173     #'cdr_file' => {
3174     #  'columns' => [
3175     #    'filenum',    'serial',     '', '', '', '',
3176     #    'filename',  'varchar',     '', '', '', '',
3177     #    'status',    'varchar', 'NULL', '', '', '',
3178     #  ],
3179     #  'primary_key' => 'filenum',
3180     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
3181     #                                   # agent-virtualize or have a customer
3182     #                                   # with dup-filename needs or something
3183     #                                   # (only used by cdr.http_and_import for
3184     #                                   #  chrissakes)
3185     #  'index'  => [],
3186     #},
3187
3188     'inventory_item' => {
3189       'columns' => [
3190         'itemnum',   'serial',      '',      '', '', '',
3191         'classnum',  'int',         '',      '', '', '',
3192         'agentnum',  'int',     'NULL',      '', '', '',
3193         'item',      'varchar',     '', $char_d, '', '',
3194         'svcnum',    'int',     'NULL',      '', '', '',
3195         'svc_field', 'varchar', 'NULL', $char_d, '', '',
3196       ],
3197       'primary_key' => 'itemnum',
3198       'unique' => [ [ 'classnum', 'item' ] ],
3199       'index'  => [ [ 'classnum' ], [ 'agentnum' ], [ 'svcnum' ] ],
3200     },
3201
3202     'inventory_class' => {
3203       'columns' => [
3204         'classnum',  'serial',       '',      '', '', '',
3205         'classname', 'varchar',      '', $char_d, '', '',
3206       ],
3207       'primary_key' => 'classnum',
3208       'unique' => [],
3209       'index'  => [],
3210     },
3211
3212     'access_user' => {
3213       'columns' => [
3214         'usernum',   'serial',  '',      '', '', '',
3215         'username',  'varchar', '', $char_d, '', '',
3216         '_password', 'varchar', '', $char_d, '', '',
3217         'last',      'varchar', '', $char_d, '', '', 
3218         'first',     'varchar', '', $char_d, '', '', 
3219         'user_custnum',  'int', 'NULL',  '', '', '',
3220         'disabled',     'char', 'NULL',   1, '', '', 
3221       ],
3222       'primary_key' => 'usernum',
3223       'unique' => [ [ 'username' ] ],
3224       'index'  => [ [ 'user_custnum' ] ],
3225     },
3226
3227     'access_user_pref' => {
3228       'columns' => [
3229         'prefnum',    'serial',       '', '', '', '',
3230         'usernum',     'int',       '', '', '', '',
3231         'prefname', 'varchar', '', $char_d, '', '', 
3232         'prefvalue', 'text', 'NULL', '', '', '', 
3233         'expiration', @date_type, '', '',
3234       ],
3235       'primary_key' => 'prefnum',
3236       'unique' => [],
3237       'index'  => [ [ 'usernum' ] ],
3238     },
3239
3240     'access_group' => {
3241       'columns' => [
3242         'groupnum',   'serial', '',      '', '', '',
3243         'groupname', 'varchar', '', $char_d, '', '',
3244       ],
3245       'primary_key' => 'groupnum',
3246       'unique' => [ [ 'groupname' ] ],
3247       'index'  => [],
3248     },
3249
3250     'access_usergroup' => {
3251       'columns' => [
3252         'usergroupnum', 'serial', '', '', '', '',
3253         'usernum',         'int', '', '', '', '',
3254         'groupnum',        'int', '', '', '', '',
3255       ],
3256       'primary_key' => 'usergroupnum',
3257       'unique' => [ [ 'usernum', 'groupnum' ] ],
3258       'index'  => [ [ 'usernum' ] ],
3259     },
3260
3261     'access_groupagent' => {
3262       'columns' => [
3263         'groupagentnum', 'serial', '', '', '', '',
3264         'groupnum',         'int', '', '', '', '',
3265         'agentnum',         'int', '', '', '', '',
3266       ],
3267       'primary_key' => 'groupagentnum',
3268       'unique' => [ [ 'groupnum', 'agentnum' ] ],
3269       'index'  => [ [ 'groupnum' ] ],
3270     },
3271
3272     'access_groupsales' => {
3273       'columns' => [
3274         'groupsalesnum', 'serial', '', '', '', '',
3275         'groupnum',         'int', '', '', '', '',
3276         'salesnum',         'int', '', '', '', '',
3277       ],
3278       'primary_key' => 'groupsalesnum',
3279       'unique' => [ [ 'groupnum', 'salesnum' ] ],
3280       'index'  => [ [ 'groupnum' ] ],
3281     },
3282
3283     'access_right' => {
3284       'columns' => [
3285         'rightnum',   'serial', '',      '', '', '',
3286         'righttype', 'varchar', '', $char_d, '', '',
3287         'rightobjnum',   'int', '',      '', '', '',
3288         'rightname', 'varchar', '', $char_d, '', '',
3289       ],
3290       'primary_key' => 'rightnum',
3291       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
3292       'index'  => [],
3293     },
3294
3295     'svc_phone' => {
3296       'columns' => [
3297         'svcnum',       'int',         '',      '', '', '', 
3298         'countrycode',  'varchar',     '',       3, '', '', 
3299         'phonenum',     'varchar',     '',      15, '', '',  #12 ?
3300         'pin',          'varchar', 'NULL', $char_d, '', '',
3301         'sip_password', 'varchar', 'NULL', $char_d, '', '',
3302         'phone_name',   'varchar', 'NULL', $char_d, '', '',
3303         'pbxsvc',           'int', 'NULL',      '', '', '',
3304         'domsvc',           'int', 'NULL',      '', '', '', 
3305         'locationnum',      'int', 'NULL', '', '', '',
3306         'forwarddst',     'varchar',     'NULL',      15, '', '', 
3307         'email',           'varchar', 'NULL',  255, '', '', 
3308         'lnp_status',   'varchar', 'NULL', $char_d, '', '',
3309         'portable',     'char', 'NULL',       1,  '', '', 
3310         'lrn',     'char',     'NULL',      10, '', '', 
3311         'lnp_desired_due_date',     'int', 'NULL',       '', '', '',
3312         'lnp_due_date',     'int', 'NULL',       '', '', '',
3313         'lnp_other_provider', 'varchar', 'NULL', $char_d,  '', '',
3314         'lnp_other_provider_account', 'varchar', 'NULL', $char_d,  '', '',
3315         'lnp_reject_reason', 'varchar', 'NULL', $char_d,  '', '',
3316       ],
3317       'primary_key' => 'svcnum',
3318       'unique' => [],
3319       'index'  => [ ['countrycode', 'phonenum'], ['pbxsvc'], ['domsvc'],
3320                     ['locationnum'],
3321                   ],
3322     },
3323
3324     'phone_device' => {
3325       'columns' => [
3326         'devicenum', 'serial',     '', '', '', '',
3327         'devicepart',   'int',     '', '', '', '',
3328         'svcnum',       'int',     '', '', '', '', 
3329         'mac_addr', 'varchar', 'NULL', 12, '', '', 
3330       ],
3331       'primary_key' => 'devicenum',
3332       'unique' => [ [ 'mac_addr' ], ],
3333       'index'  => [ [ 'devicepart' ], [ 'svcnum' ], ],
3334     },
3335
3336     'part_device' => {
3337       'columns' => [
3338         'devicepart', 'serial',  '',      '', '', '',
3339         'devicename', 'varchar', '', $char_d, '', '',
3340         'inventory_classnum', 'int', 'NULL', '', '', '',
3341       ],
3342       'primary_key' => 'devicepart',
3343       'unique' => [ [ 'devicename' ] ], #?
3344       'index'  => [],
3345     },
3346
3347     'phone_avail' => {
3348       'columns' => [
3349         'availnum',    'serial',      '',      '', '', '', 
3350         'exportnum',   'int',         '',      '', '', '', 
3351         'countrycode', 'varchar',     '',       3, '', '', 
3352         'state',       'char',    'NULL',       2, '', '', 
3353         'npa',         'char',        '',       3, '', '', 
3354         'nxx',         'char',    'NULL',       3, '', '', 
3355         'station',     'char',    'NULL',       4, '', '',
3356         'name',        'varchar', 'NULL', $char_d, '', '',
3357         'rate_center_abbrev', 'varchar', 'NULL', $char_d, '', '',
3358         'latanum',      'int',     'NULL',      '', '', '',
3359         'msanum',       'int', 'NULL', '', '', '',
3360         'ordernum',      'int',     'NULL',      '', '', '',
3361         'svcnum',      'int',     'NULL',      '', '', '',
3362         'availbatch', 'varchar',  'NULL', $char_d, '', '',
3363       ],
3364       'primary_key' => 'availnum',
3365       'unique' => [],
3366       'index'  => [ [ 'exportnum', 'countrycode', 'state' ],     #npa search
3367                     [ 'exportnum', 'countrycode', 'npa' ],       #nxx search
3368                     [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
3369                     [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
3370                     [ 'svcnum' ],
3371                     [ 'availbatch' ],
3372                     [ 'latanum' ],
3373                   ],
3374     },
3375     
3376     'lata' => {
3377       'columns' => [
3378         'latanum',    'int',      '',      '', '', '', 
3379         'description',   'varchar',    '',      $char_d, '', '', 
3380         'have_usage',   'int',    'NULL',      '', '', '', 
3381       ],
3382       'primary_key' => 'latanum',
3383       'unique' => [],
3384       'index'  => [],
3385     },
3386     
3387     'msa' => {
3388       'columns' => [
3389         'msanum',    'int',      '',      '', '', '', 
3390         'description',   'varchar',    '',      $char_d, '', '', 
3391       ],
3392       'primary_key' => 'msanum',
3393       'unique' => [],
3394       'index'  => [],
3395     },
3396     
3397     'rate_center' => {
3398       'columns' => [
3399         'ratecenternum',    'serial',      '',      '', '', '', 
3400         'description',   'varchar',    '',      $char_d, '', '', 
3401       ],
3402       'primary_key' => 'ratecenternum',
3403       'unique' => [],
3404       'index'  => [],
3405     },
3406
3407     'did_vendor' => {
3408       'columns' => [
3409         'vendornum',    'serial',      '',      '', '', '', 
3410         'vendorname',   'varchar',        '',     $char_d, '', '', 
3411       ],
3412       'primary_key' => 'vendornum',
3413       'unique' => [],
3414       'index'  => [],
3415     },
3416     
3417     'did_order_item' => {
3418       'columns' => [
3419         'orderitemnum',    'serial',      '',      '', '', '', 
3420         'ordernum',    'int',      '',      '', '', '', 
3421         'msanum',      'int',     'NULL',      '', '', '',
3422         'npa',      'int',     'NULL',      '', '', '',
3423         'latanum',      'int',     'NULL',      '', '', '',
3424         'ratecenternum',      'int',     'NULL',      '', '', '',
3425         'state',       'char',    'NULL',       2, '', '', 
3426         'quantity',      'int',     '',      '', '', '',
3427         'custnum',   'int', 'NULL', '', '', '',
3428       ],
3429       'primary_key' => 'orderitemnum',
3430       'unique' => [],
3431       'index'  => [],
3432     },
3433
3434     'did_order' => {
3435       'columns' => [
3436         'ordernum',    'serial',      '',      '', '', '', 
3437         'vendornum',   'int',       '',      '', '', '', 
3438         'vendor_order_id',   'varchar',  'NULL',   $char_d, '', '', 
3439         'custnum',   'int', 'NULL', '', '', '',
3440         'submitted',      'int',     '',      '', '', '',
3441         'confirmed',      'int',     'NULL',      '', '', '',
3442         'received',      'int',     'NULL',      '', '', '',
3443       ],
3444       'primary_key' => 'ordernum',
3445       'unique' => [ [ 'vendornum', 'vendor_order_id' ] ],
3446       'index'  => [],
3447     },
3448
3449     'reason_type' => {
3450       'columns' => [
3451         'typenum',   'serial',  '', '', '', '', 
3452         'class',     'char', '', 1, '', '', 
3453         'type',     'varchar', '', $char_d, '', '', 
3454       ],
3455       'primary_key' => 'typenum',
3456       'unique' => [],
3457       'index' => [],
3458     },
3459
3460     'reason' => {
3461       'columns' => [
3462         'reasonnum',     'serial',  '', '', '', '', 
3463         'reason_type',   'int',  '', '', '', '', 
3464         'reason',        'text', '', '', '', '', 
3465         'disabled',      'char',    'NULL', 1, '', '', 
3466       ],
3467       'primary_key' => 'reasonnum',
3468       'unique' => [],
3469       'index' => [],
3470     },
3471
3472     'conf' => {
3473       'columns' => [
3474         'confnum',  'serial',     '',      '', '', '', 
3475         'agentnum', 'int',    'NULL',      '', '', '', 
3476         'locale',   'varchar','NULL',      16, '', '',
3477         'name',     'varchar',    '', $char_d, '', '', 
3478         'value',    'text',   'NULL',      '', '', '',
3479       ],
3480       'primary_key' => 'confnum',
3481       'unique' => [ [ 'agentnum', 'locale', 'name' ] ],
3482       'index' => [],
3483     },
3484
3485     'pkg_referral' => {
3486       'columns' => [
3487         'pkgrefnum',     'serial', '', '', '', '',
3488         'pkgnum',        'int',    '', '', '', '',
3489         'refnum',        'int',    '', '', '', '',
3490       ],
3491       'primary_key' => 'pkgrefnum',
3492       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
3493       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
3494     },
3495
3496     'svc_pbx' => {
3497       'columns' => [
3498         'svcnum',           'int',     '',      '', '', '', 
3499         'id',               'int', 'NULL',      '', '', '', 
3500         'title',        'varchar', 'NULL', $char_d, '', '', 
3501         'max_extensions',   'int', 'NULL',      '', '', '',
3502         'max_simultaneous', 'int', 'NULL',      '', '', '',
3503       ],
3504       'primary_key' => 'svcnum',
3505       'unique' => [],
3506       'index'  => [ [ 'id' ] ],
3507     },
3508
3509     'svc_mailinglist' => { #svc_group?
3510       'columns' => [
3511         'svcnum',            'int',     '',            '', '', '', 
3512         'username',      'varchar',     '', $username_len, '', '',
3513         'domsvc',            'int',     '',            '', '', '', 
3514         'listnum',           'int',     '',            '', '', '',
3515         'reply_to',         'char', 'NULL',             1, '', '',#SetReplyTo
3516         'remove_from',      'char', 'NULL',             1, '', '',#RemoveAuthor
3517         'reject_auto',      'char', 'NULL',             1, '', '',#RejectAuto
3518         'remove_to_and_cc', 'char', 'NULL',             1, '', '',#RemoveToAndCc
3519       ],
3520       'primary_key' => 'svcnum',
3521       'unique' => [],
3522       'index'  => [ ['username'], ['domsvc'], ['listnum'] ],
3523     },
3524
3525     'mailinglist' => {
3526       'columns' => [
3527         'listnum',   'serial', '',      '', '', '',
3528         'listname', 'varchar', '', $char_d, '', '',
3529       ],
3530       'primary_key' => 'listnum',
3531       'unique' => [],
3532       'index'  => [],
3533     },
3534
3535     'mailinglistmember' => {
3536       'columns' => [
3537         'membernum',        'serial',     '',   '', '', '',
3538         'listnum',             'int',     '',   '', '', '',
3539         'svcnum',              'int', 'NULL',   '', '', '', 
3540         'contactemailnum',     'int', 'NULL',   '', '', '', 
3541         'email',           'varchar', 'NULL',  255, '', '', 
3542       ],
3543       'primary_key' => 'membernum',
3544       'unique'      => [],
3545       'index'       => [['listnum'],['svcnum'],['contactemailnum'],['email']],
3546     },
3547
3548     'bill_batch' => {
3549       'columns' => [
3550         'batchnum',         'serial',     '',  '', '', '',
3551         'agentnum',            'int', 'NULL',  '', '', '',
3552         'status',             'char', 'NULL', '1', '', '',
3553         'pdf',                'blob', 'NULL',  '', '', '',
3554       ],
3555       'primary_key' => 'batchnum',
3556       'unique'      => [],
3557       'index'       => [ ['agentnum'] ],
3558     },
3559
3560     'cust_bill_batch' => {
3561       'columns' => [
3562         'billbatchnum',     'serial',     '', '', '', '',
3563         'batchnum',            'int',     '', '', '', '',
3564         'invnum',              'int',     '', '', '', '',
3565       ],
3566       'primary_key' => 'billbatchnum',
3567       'unique'      => [],
3568       'index'       => [ [ 'batchnum' ], [ 'invnum' ] ],
3569     },
3570
3571     'cust_bill_batch_option' => {
3572       'columns' => [
3573         'optionnum', 'serial', '', '', '', '', 
3574         'billbatchnum', 'int', '', '', '', '', 
3575         'optionname', 'varchar', '', $char_d, '', '', 
3576         'optionvalue', 'text', 'NULL', '', '', '', 
3577       ],
3578       'primary_key' => 'optionnum',
3579       'unique'      => [],
3580       'index'       => [ [ 'billbatchnum' ], [ 'optionname' ] ],
3581     },
3582
3583     'msg_template' => {
3584       'columns' => [
3585         'msgnum',     'serial',     '',      '', '', '',
3586         'msgname',   'varchar',     '', $char_d, '', '',
3587         'agentnum',      'int', 'NULL',      '', '', '',
3588         'subject',   'varchar', 'NULL',     512, '', '',
3589         'mime_type', 'varchar',     '', $char_d, '', '',
3590         'body',         'blob', 'NULL',      '', '', '',
3591         'disabled',     'char', 'NULL',       1, '', '', 
3592         'from_addr', 'varchar', 'NULL',     255, '', '',
3593         'bcc_addr',  'varchar', 'NULL',     255, '', '',
3594       ],
3595       'primary_key' => 'msgnum',
3596       'unique'      => [ ],
3597       'index'       => [ ['agentnum'], ],
3598     },
3599
3600     'template_content' => {
3601       'columns' => [
3602         'contentnum', 'serial',     '',      '', '', '',
3603         'msgnum',        'int',     '',      '', '', '',
3604         'locale',    'varchar', 'NULL',      16, '', '',
3605         'subject',   'varchar', 'NULL',     512, '', '',
3606         'body',         'text', 'NULL',      '', '', '',
3607       ],
3608       'primary_key' => 'contentnum',
3609       'unique'      => [ ['msgnum', 'locale'] ],
3610       'index'       => [ ],
3611     },
3612
3613     'cust_msg' => {
3614       'columns' => [
3615         'custmsgnum', 'serial',     '',     '', '', '',
3616         'custnum',       'int',     '',     '', '', '',
3617         'msgnum',        'int', 'NULL',     '', '', '',
3618         '_date',    @date_type,                 '', '',
3619         'env_from',  'varchar', 'NULL',    255, '', '',
3620         'env_to',    'varchar', 'NULL',    255, '', '',
3621         'header',       'blob', 'NULL',     '', '', '',
3622         'body',         'blob', 'NULL',     '', '', '',
3623         'error',     'varchar', 'NULL',    255, '', '',
3624         'status',    'varchar',     '',$char_d, '', '',
3625       ],
3626       'primary_key' => 'custmsgnum',
3627       'unique'      => [ ],
3628       'index'       => [ ['custnum'], ],
3629     },
3630
3631     'svc_cert' => {
3632       'columns' => [
3633         'svcnum',                'int',     '',      '', '', '', 
3634         'recnum',                'int', 'NULL',      '', '', '',
3635         'privatekey',           'text', 'NULL',      '', '', '',
3636         'csr',                  'text', 'NULL',      '', '', '',
3637         'certificate',          'text', 'NULL',      '', '', '',
3638         'cacert',               'text', 'NULL',      '', '', '',
3639         'common_name',       'varchar', 'NULL', $char_d, '', '',
3640         'organization',      'varchar', 'NULL', $char_d, '', '',
3641         'organization_unit', 'varchar', 'NULL', $char_d, '', '',
3642         'city',              'varchar', 'NULL', $char_d, '', '',
3643         'state',             'varchar', 'NULL', $char_d, '', '',
3644         'country',              'char', 'NULL',       2, '', '',
3645         'cert_contact',      'varchar', 'NULL', $char_d, '', '',
3646       ],
3647       'primary_key' => 'svcnum',
3648       'unique' => [],
3649       'index'  => [], #recnum
3650     },
3651
3652     'svc_port' => {
3653       'columns' => [
3654         'svcnum',                'int',     '',      '', '', '', 
3655         'serviceid', 'varchar', '', 64, '', '', #srvexport / reportfields
3656       ],
3657       'primary_key' => 'svcnum',
3658       'unique' => [],
3659       'index'  => [], #recnum
3660     },
3661
3662     'areacode'  => {
3663       'columns' => [
3664         'areanum',   'serial',        '',      '', '', '',
3665         'code',        'char',        '',       3, '', '', 
3666         'country',     'char',    'NULL',       2, '', '',
3667         'state',       'char',    'NULL',       2, '', '', 
3668         'description','varchar',  'NULL',     255, '', '',
3669       ], 
3670       'primary_key' => 'areanum',
3671       'unique' => [ [ 'areanum' ] ],
3672       'index'  => [],
3673     },
3674
3675     'upgrade_journal' => {
3676       'columns' => [
3677         'upgradenum', 'serial', '', '', '', '',
3678         '_date', 'int', '', '', '', '',
3679         'upgrade', 'varchar', '', $char_d, '', '',
3680         'status', 'varchar', '', $char_d, '', '',
3681         'statustext', 'varchar', 'NULL', $char_d, '', '',
3682       ],
3683       'primary_key' => 'upgradenum',
3684       'unique' => [ [ 'upgradenum' ] ],
3685       'index' => [ [ 'upgrade' ] ],
3686     },
3687
3688     %{ tables_hashref_torrus() },
3689
3690     # tables of ours for doing torrus virtual port combining
3691     'torrus_srvderive' => {
3692       'columns' => [
3693         'derivenum',     'serial',     '', '', '', '',
3694         'serviceid',    'varchar',     '', 64, '', '', #srvexport / reportfields
3695         'last_srv_date',   'date', 'NULL', '', '', '',
3696       ],
3697       'primary_key' => 'derivenum',
3698       'unique' => [ ['serviceid'] ],
3699       'index'  => [],
3700     },
3701
3702     'torrus_srvderive_component' => {
3703       'columns' => [
3704         'componentnum', 'serial', '', '', '', '',
3705         'derivenum',       'int', '', '', '', '',
3706         'serviceid',   'varchar', '', 64, '', '', #srvexport / reportfields
3707       ],
3708       'primary_key' => 'componentnum',
3709       'unique'      => [ [ 'derivenum', 'serviceid' ], ],
3710       'index'       => [ [ 'derivenum', ], ],
3711     },
3712
3713
3714     # name type nullability length default local
3715
3716     #'new_table' => {
3717     #  'columns' => [
3718     #    'num', 'serial',       '', '', '', '',
3719     #  ],
3720     #  'primary_key' => 'num',
3721     #  'unique' => [],
3722     #  'index'  => [],
3723     #},
3724
3725   };
3726
3727 }
3728
3729 =back
3730
3731 =head1 BUGS
3732
3733 =head1 SEE ALSO
3734
3735 L<DBIx::DBSchema>
3736
3737 =cut
3738
3739 1;
3740