add cust_main.archived field, skip billing if Y, RT#4412
[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.33;
7 use DBIx::DBSchema::Table;
8 use DBIx::DBSchema::Column 0.06;
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 "TYPE=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 = 'TYPE=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       unless ( defined $hash{'default'} ) {
106         warn "$tablename:\n".
107              join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
108       }
109
110       push @columns, new DBIx::DBSchema::Column ( \%hash );
111     }
112
113     #false laziness w/sub indices in DBIx::DBSchema::DBD (well, sorta)
114     #and sub sql_create_table in DBIx::DBSchema::Table (slighty more?)
115     my $unique = $tables_hashref->{$tablename}{'unique'};
116     my $index  = $tables_hashref->{$tablename}{'index'};
117     my @indices = ();
118     push @indices, map {
119                          DBIx::DBSchema::Index->new({
120                            'name'    => $tablename. $indexnum++,
121                            'unique'  => 1,
122                            'columns' => $_,
123                          });
124                        }
125                        @$unique;
126     push @indices, map {
127                          DBIx::DBSchema::Index->new({
128                            'name'    => $tablename. $indexnum++,
129                            'unique'  => 0,
130                            'columns' => $_,
131                          });
132                        }
133                        @$index;
134
135     DBIx::DBSchema::Table->new({
136       'name'          => $tablename,
137       'primary_key'   => $tables_hashref->{$tablename}{'primary_key'},
138       'columns'       => \@columns,
139       'indices'       => \@indices,
140       'local_options' => $local_options,
141     });
142
143   } keys %$tables_hashref;
144
145   if ( $DEBUG ) {
146     warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
147     warn "[debug]$me   $_\n" foreach $dbdef->tables;
148   }
149   
150   #add radius attributes to svc_acct
151   #
152   #my($svc_acct)=$dbdef->table('svc_acct');
153   # 
154   #my($attribute);
155   #foreach $attribute (@attributes) {
156   #  $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
157   #    'radius_'. $attribute,
158   #    'varchar',
159   #    'NULL',
160   #    $char_d,
161   #  ));
162   #}
163   # 
164   #foreach $attribute (@check_attributes) {
165   #  $svc_acct->addcolumn( new DBIx::DBSchema::Column (
166   #    'rc_'. $attribute,
167   #    'varchar',
168   #    'NULL',
169   #    $char_d,
170   #  ));
171   #}
172
173   #create history tables (false laziness w/create-history-tables)
174   foreach my $table (
175     grep { ! /^clientapi_session/ }
176     grep { ! /^h_/ }
177     $dbdef->tables
178   ) {
179     my $tableobj = $dbdef->table($table)
180       or die "unknown table $table";
181
182     my %indices = $tableobj->indices;
183     
184     my %h_indices = map { 
185                           ( "h_$_" =>
186                               DBIx::DBSchema::Index->new({
187                                 'name'    => 'h_'. $indices{$_}->name,
188                                 'unique'  => 0,
189                                 'columns' => [ @{$indices{$_}->columns} ],
190                               })
191                           );
192                         }
193                         keys %indices;
194
195     $h_indices{"h_${table}_srckey"} = DBIx::DBSchema::Index->new({
196                                         'name'    => "h_${table}_srckey",
197                                         'unique'  => 0,
198                                         'columns' => [ 'history_action', #right?
199                                                        $tableobj->primary_key,
200                                                      ],
201                                       });
202
203     $h_indices{"h_${table}_srckey2"} = DBIx::DBSchema::Index->new({
204                                          'name'    => "h_${table}_srckey2",
205                                          'unique'  => 0,
206                                          'columns' => [ 'history_date',
207                                                         $tableobj->primary_key,
208                                                       ],
209                                        });
210
211     my $h_tableobj = DBIx::DBSchema::Table->new( {
212       'name'          => "h_$table",
213       'primary_key'   => 'historynum',
214       'indices'       => \%h_indices,
215       'local_options' => $local_options,
216       'columns'       => [
217           DBIx::DBSchema::Column->new( {
218             'name'    => 'historynum',
219             'type'    => 'serial',
220             'null'    => 'NOT NULL',
221             'length'  => '',
222             'default' => '',
223             'local'   => '',
224           } ),
225           DBIx::DBSchema::Column->new( {
226             'name'    => 'history_date',
227             'type'    => 'int',
228             'null'    => 'NULL',
229             'length'  => '',
230             'default' => '',
231             'local'   => '',
232           } ),
233           DBIx::DBSchema::Column->new( {
234             'name'    => 'history_user',
235             'type'    => 'varchar',
236             'null'    => 'NOT NULL',
237             'length'  => '80',
238             'default' => '',
239             'local'   => '',
240           } ),
241           DBIx::DBSchema::Column->new( {
242             'name'    => 'history_action',
243             'type'    => 'varchar',
244             'null'    => 'NOT NULL',
245             'length'  => '80',
246             'default' => '',
247             'local'   => '',
248           } ),
249           map {
250             my $column = $tableobj->column($_);
251     
252             #clone so as to not disturb the original
253             $column = DBIx::DBSchema::Column->new( {
254               map { $_ => $column->$_() }
255                 qw( name type null length default local )
256             } );
257     
258             if ( $column->type =~ /^(\w*)SERIAL$/i ) {
259               $column->type('int');
260               $column->null('NULL');
261             }
262             #$column->default('')
263             #  if $column->default =~ /^nextval\(/i;
264             #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
265             #$column->local($local);
266             $column;
267           } $tableobj->columns
268       ],
269     } );
270     $dbdef->addtable($h_tableobj);
271   }
272
273   if ( $datasrc =~ /^dbi:mysql/i ) {
274
275     my $dup_lock_table = DBIx::DBSchema::Table->new( {
276       'name'          => 'duplicate_lock',
277       'primary_key'   => 'duplocknum',
278       'local_options' => $local_options,
279       'columns'       => [
280         DBIx::DBSchema::Column->new( {
281           'name'    => 'duplocknum',
282           'type'    => 'serial',
283           'null'    => 'NOT NULL',
284           'length'  => '',
285           'default' => '',
286           'local'   => '',
287         } ),
288         DBIx::DBSchema::Column->new( {
289           'name'    => 'lockname',
290           'type'    => 'varchar',
291           'null'    => 'NOT NULL',
292           'length'  => '80',
293           'default' => '',
294           'local'   => '',
295         } ),
296       ],
297       'indices' => { 'duplicate_lock1' =>
298                        DBIx::DBSchema::Index->new({
299                          'name'    => 'duplicate_lock1',
300                          'unique'  => 1,
301                          'columns' => [ 'lockname' ],
302                        })
303                    },
304     } );
305
306     $dbdef->addtable($dup_lock_table);
307
308   }
309
310   $dbdef;
311
312 }
313
314 sub tables_hashref {
315
316   my $char_d = 80; #default maxlength for text fields
317
318   #my(@date_type)  = ( 'timestamp', '', ''     );
319   my @date_type  = ( 'int', 'NULL', ''     );
320   my @perl_type = ( 'text', 'NULL', ''  ); 
321   my @money_type = ( 'decimal',   '', '10,2' );
322   my @money_typen = ( 'decimal',   'NULL', '10,2' );
323   my @taxrate_type  = ( 'decimal',   '',     '14,8' ); # requires pg 8 for 
324   my @taxrate_typen = ( 'decimal',   'NULL', '14,8' ); # fs-upgrade to work
325
326   my $username_len = 32; #usernamemax config file
327
328     # name type nullability length default local
329
330   return {
331
332     'agent' => {
333       'columns' => [
334         'agentnum',          'serial',    '',       '', '', '', 
335         'agent',            'varchar',    '',  $char_d, '', '', 
336         'typenum',              'int',    '',       '', '', '', 
337         'ticketing_queueid',    'int', 'NULL',      '', '', '', 
338         'invoice_template', 'varchar', 'NULL', $char_d, '', '',
339         'agent_custnum',        'int', 'NULL',      '', '', '',
340         'disabled',            'char', 'NULL',       1, '', '', 
341         'username',         'varchar', 'NULL', $char_d, '', '', #deprecated
342         '_password',        'varchar', 'NULL', $char_d, '', '', #deprecated
343         'freq',              'int', 'NULL', '', '', '', #deprecated (never used)
344         'prog',                     @perl_type, '', '', #deprecated (never used)
345       ],
346       'primary_key' => 'agentnum',
347       #'unique' => [ [ 'agent_custnum' ] ], #one agent per customer?
348                                             #insert is giving it a value, tho..
349       #'index' => [ ['typenum'], ['disabled'] ],
350       'unique' => [],
351       'index' => [ ['typenum'], ['disabled'], ['agent_custnum'] ],
352     },
353
354     'agent_type' => {
355       'columns' => [
356         'typenum',   'serial',  '', '', '', '', 
357         'atype',     'varchar', '', $char_d, '', '', 
358       ],
359       'primary_key' => 'typenum',
360       'unique' => [],
361       'index' => [],
362     },
363
364     'type_pkgs' => {
365       'columns' => [
366         'typepkgnum', 'serial', '', '', '', '', 
367         'typenum',   'int',  '', '', '', '', 
368         'pkgpart',   'int',  '', '', '', '', 
369       ],
370       'primary_key' => 'typepkgnum',
371       'unique' => [ ['typenum', 'pkgpart'] ],
372       'index' => [ ['typenum'] ],
373     },
374
375     'cust_bill' => {
376       'columns' => [
377         'invnum',    'serial',  '', '', '', '', 
378         'custnum',   'int',  '', '', '', '', 
379         '_date',     @date_type, '', '', 
380         'charged',   @money_type, '', '', 
381         'printed',   'int',  '', '', '', '', 
382         'closed',    'char', 'NULL', 1, '', '', 
383       ],
384       'primary_key' => 'invnum',
385       'unique' => [],
386       'index' => [ ['custnum'], ['_date'] ],
387     },
388
389     'cust_bill_event' => {
390       'columns' => [
391         'eventnum',    'serial',  '', '', '', '', 
392         'invnum',   'int',  '', '', '', '', 
393         'eventpart',   'int',  '', '', '', '', 
394         '_date',     @date_type, '', '', 
395         'status', 'varchar', '', $char_d, '', '', 
396         'statustext', 'text', 'NULL', '', '', '', 
397       ],
398       'primary_key' => 'eventnum',
399       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
400       'unique' => [],
401       'index' => [ ['invnum'], ['status'], ['eventpart'],
402                    ['statustext'], ['_date'],
403                  ],
404     },
405
406     'part_bill_event' => {
407       'columns' => [
408         'eventpart',    'serial',  '', '', '', '', 
409         'freq',        'varchar',       'NULL',     $char_d, '', '', 
410         'payby',       'char',  '', 4, '', '', 
411         'event',       'varchar',           '',     $char_d, '', '', 
412         'eventcode',    @perl_type, '', '', 
413         'seconds',     'int', 'NULL', '', '', '', 
414         'weight',      'int', '', '', '', '', 
415         'plan',       'varchar', 'NULL', $char_d, '', '', 
416         'plandata',   'text', 'NULL', '', '', '', 
417         'reason',     'int', 'NULL', '', '', '', 
418         'disabled',     'char', 'NULL', 1, '', '', 
419       ],
420       'primary_key' => 'eventpart',
421       'unique' => [],
422       'index' => [ ['payby'], ['disabled'], ],
423     },
424
425     'part_event' => {
426       'columns' => [
427         'eventpart',   'serial',      '',      '', '', '', 
428         'agentnum',    'int',     'NULL',      '', '', '', 
429         'event',       'varchar',     '', $char_d, '', '', 
430         'eventtable',  'varchar',     '', $char_d, '', '',
431         'check_freq',  'varchar', 'NULL', $char_d, '', '', 
432         'weight',      'int',         '',      '', '', '', 
433         'action',      'varchar',     '', $char_d, '', '',
434         'disabled',     'char',   'NULL',       1, '', '', 
435       ],
436       'primary_key' => 'eventpart',
437       'unique' => [],
438       'index' => [ ['agentnum'], ['eventtable'], ['check_freq'], ['disabled'], ],
439     },
440
441     'part_event_option' => {
442       'columns' => [
443         'optionnum', 'serial', '', '', '', '', 
444         'eventpart', 'int', '', '', '', '', 
445         'optionname', 'varchar', '', $char_d, '', '', 
446         'optionvalue', 'text', 'NULL', '', '', '', 
447       ],
448       'primary_key' => 'optionnum',
449       'unique'      => [],
450       'index'       => [ [ 'eventpart' ], [ 'optionname' ] ],
451     },
452
453     'part_event_condition' => {
454       'columns' => [
455         'eventconditionnum', 'serial', '', '', '', '', 
456         'eventpart', 'int', '', '', '', '', 
457         'conditionname', 'varchar', '', $char_d, '', '', 
458       ],
459       'primary_key' => 'eventconditionnum',
460       'unique'      => [],
461       'index'       => [ [ 'eventpart' ], [ 'conditionname' ] ],
462     },
463
464     'part_event_condition_option' => {
465       'columns' => [
466         'optionnum', 'serial', '', '', '', '', 
467         'eventconditionnum', 'int', '', '', '', '', 
468         'optionname', 'varchar', '', $char_d, '', '', 
469         'optionvalue', 'text', 'NULL', '', '', '', 
470       ],
471       'primary_key' => 'optionnum',
472       'unique'      => [],
473       'index'       => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
474     },
475
476     'part_event_condition_option_option' => {
477       'columns' => [
478         'optionoptionnum', 'serial', '', '', '', '', 
479         'optionnum', 'int', '', '', '', '', 
480         'optionname', 'varchar', '', $char_d, '', '', 
481         'optionvalue', 'text', 'NULL', '', '', '', 
482       ],
483       'primary_key' => 'optionoptionnum',
484       'unique'      => [],
485       'index'       => [ [ 'optionnum' ], [ 'optionname' ] ],
486     },
487
488     'cust_event' => {
489       'columns' => [
490         'eventnum',    'serial',  '', '', '', '', 
491         'eventpart',   'int',  '', '', '', '', 
492         'tablenum',   'int',  '', '', '', '', 
493         '_date',     @date_type, '', '', 
494         'status', 'varchar', '', $char_d, '', '', 
495         'statustext', 'text', 'NULL', '', '', '', 
496       ],
497       'primary_key' => 'eventnum',
498       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
499       'unique' => [],
500       'index' => [ ['eventpart'], ['tablenum'], ['status'],
501                    ['statustext'], ['_date'],
502                  ],
503     },
504
505     'cust_bill_pkg' => {
506       'columns' => [
507         'billpkgnum',        'serial',     '',      '', '', '', 
508         'invnum',               'int',     '',      '', '', '', 
509         'pkgnum',               'int',     '',      '', '', '', 
510         'pkgpart_override',     'int', 'NULL',      '', '', '', 
511         'setup',               @money_type,             '', '', 
512         'recur',               @money_type,             '', '', 
513         'sdate',               @date_type,              '', '', 
514         'edate',               @date_type,              '', '', 
515         'itemdesc',         'varchar', 'NULL', $char_d, '', '', 
516         'section',          'varchar', 'NULL', $char_d, '', '', 
517         'quantity',             'int', 'NULL',      '', '', '',
518         'unitsetup',           @money_typen,            '', '', 
519         'unitrecur',           @money_typen,            '', '', 
520       ],
521       'primary_key' => 'billpkgnum',
522       'unique' => [],
523       'index' => [ ['invnum'], [ 'pkgnum' ] ],
524     },
525
526     'cust_bill_pkg_detail' => {
527       'columns' => [
528         'detailnum', 'serial', '', '', '', '', 
529         'billpkgnum', 'int', 'NULL', '', '', '',        # should not be nullable
530         'pkgnum',  'int', 'NULL', '', '', '',           # deprecated
531         'invnum',  'int', 'NULL', '', '', '',           # deprecated
532         'amount',  @money_typen, '', '', 
533         'format',  'char', 'NULL', 1, '', '',
534         'classnum', 'int', 'NULL', '', '', '',
535         'detail',  'varchar', '', 255, '', '', 
536       ],
537       'primary_key' => 'detailnum',
538       'unique' => [],
539       'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
540     },
541
542     'cust_bill_pkg_display' => {
543       'columns' => [
544         'billpkgdisplaynum', 'serial', '', '', '', '', 
545         'billpkgnum', 'int', '', '', '', '', 
546         'section',  'varchar', 'NULL', $char_d, '', '', 
547         #'unitsetup', @money_typen, '', '',     #override the linked real one?
548         #'unitrecur', @money_typen, '', '',     #this too?
549         'post_total', 'char', 'NULL', 1, '', '',
550         'type',       'char', 'NULL', 1, '', '',
551         'summary',    'char', 'NULL', 1, '', '',
552       ],
553       'primary_key' => 'billpkgdisplaynum',
554       'unique' => [],
555       'index' => [ ['billpkgnum'], ],
556     },
557
558     'cust_bill_pkg_tax_location' => {
559       'columns' => [
560         'billpkgtaxlocationnum', 'serial',      '', '', '', '',
561         'billpkgnum',               'int',      '', '', '', '',
562         'taxnum',                   'int',      '', '', '', '',
563         'taxtype',              'varchar', $char_d, '', '', '',
564         'pkgnum',                   'int',      '', '', '', '',
565         'locationnum',              'int',      '', '', '', '', #redundant?
566         'amount',                   @money_type,        '', '',
567       ],
568       'primary_key' => 'billpkgtaxlocationnum',
569       'unique' => [],
570       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'pkgnum' ], [ 'locationnum' ] ],
571     },
572
573     'cust_credit' => {
574       'columns' => [
575         'crednum',  'serial', '', '', '', '', 
576         'custnum',  'int', '', '', '', '', 
577         '_date',    @date_type, '', '', 
578         'amount',   @money_type, '', '', 
579         'otaker',   'varchar', '', 32, '', '', 
580         'reason',   'text', 'NULL', '', '', '', 
581         'reasonnum', 'int', 'NULL', '', '', '', 
582         'addlinfo', 'text', 'NULL', '', '', '',
583         'closed',    'char', 'NULL', 1, '', '', 
584       ],
585       'primary_key' => 'crednum',
586       'unique' => [],
587       'index' => [ ['custnum'], ['_date'] ],
588     },
589
590     'cust_credit_bill' => {
591       'columns' => [
592         'creditbillnum', 'serial', '', '', '', '', 
593         'crednum',  'int', '', '', '', '', 
594         'invnum',  'int', '', '', '', '', 
595         '_date',    @date_type, '', '', 
596         'amount',   @money_type, '', '', 
597       ],
598       'primary_key' => 'creditbillnum',
599       'unique' => [],
600       'index' => [ ['crednum'], ['invnum'] ],
601     },
602
603     'cust_credit_bill_pkg' => {
604       'columns' => [
605         'creditbillpkgnum', 'serial', '',      '', '', '',
606         'creditbillnum',       'int', '',      '', '', '',
607         'billpkgnum',          'int', '',      '', '', '',
608         'amount',            @money_type,          '', '',
609         'setuprecur',      'varchar', '', $char_d, '', '',
610         'sdate',   @date_type, '', '', 
611         'edate',   @date_type, '', '', 
612       ],
613       'primary_key' => 'creditbillpkgnum',
614       'unique'      => [],
615       'index'       => [ [ 'creditbillnum' ], [ 'billpkgnum' ], ],
616     },
617
618     'cust_main' => {
619       'columns' => [
620         'custnum',  'serial',  '',     '', '', '', 
621         'agentnum', 'int',  '',     '', '', '', 
622         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
623         'custbatch', 'varchar', 'NULL', $char_d, '', '',
624 #        'titlenum', 'int',  'NULL',   '', '', '', 
625         'last',     'varchar', '',     $char_d, '', '', 
626 #        'middle',   'varchar', 'NULL', $char_d, '', '', 
627         'first',    'varchar', '',     $char_d, '', '', 
628         'ss',       'varchar', 'NULL', 11, '', '', 
629         'stateid', 'varchar', 'NULL', $char_d, '', '', 
630         'stateid_state', 'varchar', 'NULL', $char_d, '', '', 
631         'birthdate' ,@date_type, '', '', 
632         'signupdate',@date_type, '', '', 
633         'dundate',   @date_type, '', '', 
634         'company',  'varchar', 'NULL', $char_d, '', '', 
635         'address1', 'varchar', '',     $char_d, '', '', 
636         'address2', 'varchar', 'NULL', $char_d, '', '', 
637         'city',     'varchar', '',     $char_d, '', '', 
638         'county',   'varchar', 'NULL', $char_d, '', '', 
639         'state',    'varchar', 'NULL', $char_d, '', '', 
640         'zip',      'varchar', 'NULL', 10, '', '', 
641         'country',  'char', '',     2, '', '', 
642         'daytime',  'varchar', 'NULL', 20, '', '', 
643         'night',    'varchar', 'NULL', 20, '', '', 
644         'fax',      'varchar', 'NULL', 12, '', '', 
645         'ship_last',     'varchar', 'NULL', $char_d, '', '', 
646 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '', 
647         'ship_first',    'varchar', 'NULL', $char_d, '', '', 
648         'ship_company',  'varchar', 'NULL', $char_d, '', '', 
649         'ship_address1', 'varchar', 'NULL', $char_d, '', '', 
650         'ship_address2', 'varchar', 'NULL', $char_d, '', '', 
651         'ship_city',     'varchar', 'NULL', $char_d, '', '', 
652         'ship_county',   'varchar', 'NULL', $char_d, '', '', 
653         'ship_state',    'varchar', 'NULL', $char_d, '', '', 
654         'ship_zip',      'varchar', 'NULL', 10, '', '', 
655         'ship_country',  'char', 'NULL', 2, '', '', 
656         'ship_daytime',  'varchar', 'NULL', 20, '', '', 
657         'ship_night',    'varchar', 'NULL', 20, '', '', 
658         'ship_fax',      'varchar', 'NULL', 12, '', '', 
659         'payby',    'char', '',     4, '', '', 
660         'payinfo',  'varchar', 'NULL', 512, '', '', 
661         'paycvv',   'varchar', 'NULL', 512, '', '', 
662         'paymask', 'varchar', 'NULL', $char_d, '', '', 
663         #'paydate',  @date_type, '', '', 
664         'paydate',  'varchar', 'NULL', 10, '', '', 
665         'paystart_month', 'int', 'NULL', '', '', '', 
666         'paystart_year',  'int', 'NULL', '', '', '', 
667         'payissue', 'varchar', 'NULL', 2, '', '', 
668         'payname',  'varchar', 'NULL', $char_d, '', '', 
669         'paystate', 'varchar', 'NULL', $char_d, '', '', 
670         'paytype',  'varchar', 'NULL', $char_d, '', '', 
671         'payip',    'varchar', 'NULL', 15, '', '', 
672         'geocode',  'varchar', 'NULL', 20,  '', '',
673         'tax',      'char', 'NULL', 1, '', '', 
674         'otaker',   'varchar', '',    32, '', '', 
675         'refnum',   'int',  '',     '', '', '', 
676         'referral_custnum', 'int',  'NULL', '', '', '', 
677         'comments', 'text', 'NULL', '', '', '', 
678         'spool_cdr','char', 'NULL', 1, '', '', 
679         'squelch_cdr','char', 'NULL', 1, '', '', 
680         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
681         'archived', 'char', 'NULL', 1, '', '',
682       ],
683       'primary_key' => 'custnum',
684       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
685       #'index' => [ ['last'], ['company'] ],
686       'index' => [
687                    [ 'agentnum' ], [ 'refnum' ], [ 'custbatch' ],
688                    [ 'referral_custnum' ],
689                    [ 'payby' ], [ 'paydate' ],
690                    #billing
691                    [ 'last' ], [ 'company' ],
692                    [ 'county' ], [ 'state' ], [ 'country' ],
693                    [ 'zip' ],
694                    [ 'daytime' ], [ 'night' ], [ 'fax' ],
695                    #shipping
696                    [ 'ship_last' ], [ 'ship_company' ],
697                    [ 'ship_county' ], [ 'ship_state' ], [ 'ship_country' ],
698                    [ 'ship_zip' ],
699                    [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
700                    [ 'archived' ],
701                  ],
702     },
703
704     #eventually use for billing & ship from cust_main too
705     #for now, just cust_pkg locations
706     'cust_location' => {
707       'columns' => [
708         'locationnum',  'serial',     '',      '', '', '',
709         'custnum',         'int',     '',      '', '', '',
710         'address1',    'varchar',     '', $char_d, '', '', 
711         'address2',    'varchar', 'NULL', $char_d, '', '', 
712         'city',        'varchar',     '', $char_d, '', '', 
713         'county',      'varchar', 'NULL', $char_d, '', '', 
714         'state',       'varchar', 'NULL', $char_d, '', '', 
715         'zip',         'varchar', 'NULL',      10, '', '', 
716         'country',        'char',     '',       2, '', '', 
717         'geocode',     'varchar', 'NULL',      20, '', '',
718       ],
719       'primary_key' => 'locationnum',
720       'unique'      => [],
721       'index'       => [ [ 'custnum' ],
722                          [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
723                        ],
724     },
725
726     'cust_main_invoice' => {
727       'columns' => [
728         'destnum',  'serial',  '',     '', '', '', 
729         'custnum',  'int',  '',     '', '', '', 
730         'dest',     'varchar', '',  $char_d, '', '', 
731       ],
732       'primary_key' => 'destnum',
733       'unique' => [],
734       'index' => [ ['custnum'], ],
735     },
736
737     'cust_main_note' => {
738       'columns' => [
739         'notenum',  'serial',  '',     '', '', '', 
740         'custnum',  'int',  '',     '', '', '', 
741         '_date',    @date_type, '', '', 
742         'otaker',   'varchar', '',    32, '', '', 
743         'comments', 'text', 'NULL', '', '', '', 
744       ],
745       'primary_key' => 'notenum',
746       'unique' => [],
747       'index' => [ [ 'custnum' ], [ '_date' ], ],
748     },
749
750     'cust_main_county' => { #county+state+country are checked off the
751                             #cust_main_county for validation and to provide
752                             # a tax rate.
753       'columns' => [
754         'taxnum',   'serial',   '',    '', '', '', 
755         'state',    'varchar',  'NULL',    $char_d, '', '', 
756         'county',   'varchar',  'NULL',    $char_d, '', '', 
757         'country',  'char',  '', 2, '', '', 
758         'taxclass',   'varchar', 'NULL', $char_d, '', '', 
759         'exempt_amount', @money_type, '', '', 
760         'tax',      'real',  '',    '', '', '', #tax %
761         'taxname',  'varchar',  'NULL',    $char_d, '', '', 
762         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
763         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
764       ],
765       'primary_key' => 'taxnum',
766       'unique' => [],
767   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
768       'index' => [ [ 'county' ], [ 'state' ], [ 'country' ],
769                    [ 'taxclass' ],
770                  ],
771     },
772
773     'tax_rate'    => {
774       'columns' => [
775         'taxnum',       'serial',     '',      '', '', '', 
776         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
777         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
778         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
779         'taxclassnum', 'int',      '',      '', '', '', 
780         'effective_date', @date_type, '', '', 
781         'tax',        @taxrate_type,      '', '',        # tax %
782         'excessrate', @taxrate_typen,     '', '',        # second tax %
783         'taxbase',    @money_typen, '', '',              # amount at first tax rate
784         'taxmax',     @money_typen, '', '',              # maximum about at both rates
785         'usetax',        @taxrate_typen,     '', '',     # tax % when non-local
786         'useexcessrate', @taxrate_typen,     '', '',     # second tax % when non-local
787         'unittype',    'int',  'NULL', '', '', '',      # for fee
788         'fee',         @taxrate_typen,     '', '',      # amount tax per unit
789         'excessfee',   @taxrate_typen,     '', '',      # second amount tax per unit
790         'feebase',     @taxrate_typen,     '', '',      # units taxed at first rate
791         'feemax',      @taxrate_typen,     '', '',      # maximum number of unit taxed
792         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
793         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
794         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
795         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
796         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
797         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
798         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
799         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
800         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
801         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
802       ],
803       'primary_key' => 'taxnum',
804       'unique' => [],
805       'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
806     },
807
808     'cust_tax_location' => { 
809       'columns' => [
810         'custlocationnum', 'serial',  '',     '', '', '', 
811         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
812         'city',            'varchar', 'NULL', $char_d, '', '',
813         'postalcity',      'varchar', 'NULL', $char_d, '', '',
814         'county',          'varchar', 'NULL', $char_d, '', '',
815         'zip',             'char',    '',     5,  '', '', 
816         'state',           'char',    '',     2,  '', '', 
817         'plus4hi',         'char',    'NULL', 4,  '', '', 
818         'plus4lo',         'char',    'NULL', 4,  '', '', 
819         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
820         'cityflag',        'char',    'NULL', 1,  '', '', # I(n)/O(out)/B(oth)/NULL
821         'geocode',         'varchar', '',    20,  '', '', 
822       ],
823       'primary_key' => 'custlocationnum',
824       'unique' => [],
825       'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
826     },
827
828     'tax_class' => { 
829       'columns' => [
830         'taxclassnum',  'serial',  '',            '', '', '',
831         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
832         'taxclass',     'varchar', '',       $char_d, '', '',          
833         'description',  'varchar', '',     2*$char_d, '', '',          
834       ],
835       'primary_key' => 'taxclassnum',
836       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
837       'index' => [],
838     },
839
840     'cust_pay_pending' => {
841       'columns' => [
842         'paypendingnum','serial',      '',  '', '', '',
843         'custnum',      'int',         '',  '', '', '', 
844         'paid',         @money_type,            '', '', 
845         '_date',        @date_type,             '', '', 
846         'payby',        'char',        '',   4, '', '', #CARD/BILL/COMP, should
847                                                         # be index into payby
848                                                         # table eventually
849         'payinfo',      'varchar', 'NULL', 512, '', '', #see cust_main above
850         'paymask',      'varchar', 'NULL', $char_d, '', '', 
851         'paydate',      'varchar', 'NULL', 10, '', '', 
852         'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
853         #'paybatch',     'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
854         'payunique',    'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
855
856         'status',       'varchar',     '', $char_d, '', '', 
857         'session_id',   'varchar', 'NULL', $char_d, '', '', #only need 32
858         'statustext',   'text',    'NULL',  '', '', '', 
859         'gatewaynum',   'int',     'NULL',  '', '', '',
860         #'cust_balance', @money_type,            '', '',
861         'paynum',       'int',     'NULL',  '', '', '',
862         'jobnum',       'int',     'NULL',  '', '', '', 
863       ],
864       'primary_key' => 'paypendingnum',
865       'unique'      => [ [ 'payunique' ] ],
866       'index'       => [ [ 'custnum' ], [ 'status' ], ],
867     },
868
869     'cust_pay' => {
870       'columns' => [
871         'paynum',   'serial',    '',   '', '', '',
872         'custnum',  'int',    '',   '', '', '', 
873         '_date',    @date_type, '', '', 
874         'paid',     @money_type, '', '', 
875         'otaker',   'varchar', 'NULL', 32, '', '',  #NULL for the upgrade so we can create & populate the field
876         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
877                                                  # index into payby table
878                                                  # eventually
879         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
880         'paymask', 'varchar', 'NULL', $char_d, '', '', 
881         'paydate',  'varchar', 'NULL', 10, '', '', 
882         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
883         'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
884         'closed',    'char', 'NULL', 1, '', '', 
885       ],
886       'primary_key' => 'paynum',
887       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
888       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
889     },
890
891     'cust_pay_void' => {
892       'columns' => [
893         'paynum',    'int',    '',   '', '', '', 
894         'custnum',   'int',    '',   '', '', '', 
895         'paid',      @money_type, '', '', 
896         '_date',     @date_type, '', '', 
897         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
898                                                   # index into payby table
899                                                   # eventually
900         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
901         'paymask', 'varchar', 'NULL', $char_d, '', '', 
902         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
903         'closed',    'char', 'NULL', 1, '', '', 
904         'void_date', @date_type, '', '', 
905         'reason',    'varchar',   'NULL', $char_d, '', '', 
906         'otaker',   'varchar', '', 32, '', '', 
907       ],
908       'primary_key' => 'paynum',
909       'unique' => [],
910       'index' => [ [ 'custnum' ] ],
911     },
912
913     'cust_bill_pay' => {
914       'columns' => [
915         'billpaynum', 'serial',     '',   '', '', '', 
916         'invnum',  'int',     '',   '', '', '', 
917         'paynum',  'int',     '',   '', '', '', 
918         'amount',  @money_type, '', '', 
919         '_date',   @date_type, '', '', 
920       ],
921       'primary_key' => 'billpaynum',
922       'unique' => [],
923       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
924     },
925
926     'cust_bill_pay_batch' => {
927       'columns' => [
928         'billpaynum', 'serial',     '',   '', '', '', 
929         'invnum',  'int',     '',   '', '', '', 
930         'paybatchnum',  'int',     '',   '', '', '', 
931         'amount',  @money_type, '', '', 
932         '_date',   @date_type, '', '', 
933       ],
934       'primary_key' => 'billpaynum',
935       'unique' => [],
936       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
937     },
938
939     'cust_bill_pay_pkg' => {
940       'columns' => [
941         'billpaypkgnum', 'serial', '', '', '', '',
942         'billpaynum',       'int', '', '', '', '',
943         'billpkgnum',       'int', '', '', '', '',
944         'amount',         @money_type,     '', '',
945         'setuprecur',      'varchar', '', $char_d, '', '',
946         'sdate',   @date_type, '', '', 
947         'edate',   @date_type, '', '', 
948       ],
949       'primary_key' => 'billpaypkgnum',
950       'unique'      => [],
951       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
952     },
953
954     'pay_batch' => { #batches of payments to an external processor
955       'columns' => [
956         'batchnum',   'serial',    '',   '', '', '', 
957         'payby',      'char',      '',    4, '', '', # CARD/CHEK
958         'status',     'char', 'NULL',     1, '', '', 
959         'download',   @date_type, '', '', 
960         'upload',     @date_type, '', '', 
961       ],
962       'primary_key' => 'batchnum',
963       'unique' => [],
964       'index' => [],
965     },
966
967     'cust_pay_batch' => { #what's this used for again?  list of customers
968                           #in current CARD batch? (necessarily CARD?)
969       'columns' => [
970         'paybatchnum',   'serial',    '',   '', '', '', 
971         'batchnum',   'int',    '',   '', '', '', 
972         'invnum',   'int',    '',   '', '', '', 
973         'custnum',   'int',    '',   '', '', '', 
974         'last',     'varchar', '',     $char_d, '', '', 
975         'first',    'varchar', '',     $char_d, '', '', 
976         'address1', 'varchar', '',     $char_d, '', '', 
977         'address2', 'varchar', 'NULL', $char_d, '', '', 
978         'city',     'varchar', '',     $char_d, '', '', 
979         'state',    'varchar', 'NULL', $char_d, '', '', 
980         'zip',      'varchar', 'NULL', 10, '', '', 
981         'country',  'char', '',     2, '', '', 
982         #        'trancode', 'int', '', '', '', ''
983         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
984         'payinfo',  'varchar', '',     512, '', '', 
985         #'exp',      @date_type, '', ''
986         'exp',      'varchar', 'NULL',     11, '', '', 
987         'payname',  'varchar', 'NULL', $char_d, '', '', 
988         'amount',   @money_type, '', '', 
989         'status',   'varchar', 'NULL',     $char_d, '', '', 
990       ],
991       'primary_key' => 'paybatchnum',
992       'unique' => [],
993       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
994     },
995
996     'cust_pkg' => {
997       'columns' => [
998         'pkgnum',           'serial',     '', '', '', '', 
999         'custnum',             'int',     '', '', '', '', 
1000         'pkgpart',             'int',     '', '', '', '', 
1001         'locationnum',         'int', 'NULL', '', '', '',
1002         'otaker',          'varchar',     '', 32, '', '', 
1003         'setup',          @date_type,             '', '', 
1004         'bill',           @date_type,             '', '', 
1005         'last_bill',      @date_type,             '', '', 
1006         'susp',           @date_type,             '', '', 
1007         'adjourn',        @date_type,             '', '', 
1008         'cancel',         @date_type,             '', '', 
1009         'expire',         @date_type,             '', '', 
1010         'change_date',    @date_type,             '', '',
1011         'change_pkgnum',       'int', 'NULL', '', '', '',
1012         'change_pkgpart',      'int', 'NULL', '', '', '',
1013         'change_locationnum',  'int', 'NULL', '', '', '',
1014         'manual_flag',        'char', 'NULL',  1, '', '', 
1015         'quantity',            'int', 'NULL', '', '', '',
1016       ],
1017       'primary_key' => 'pkgnum',
1018       'unique' => [],
1019       'index' => [ ['custnum'], ['pkgpart'], [ 'locationnum' ],
1020                    ['setup'], ['last_bill'], ['bill'], ['susp'], ['adjourn'],
1021                    ['expire'], ['cancel'],
1022                    ['change_date'],
1023                  ],
1024     },
1025
1026     'cust_pkg_option' => {
1027       'columns' => [
1028         'optionnum', 'serial', '', '', '', '', 
1029         'pkgnum', 'int', '', '', '', '', 
1030         'optionname', 'varchar', '', $char_d, '', '', 
1031         'optionvalue', 'text', 'NULL', '', '', '', 
1032       ],
1033       'primary_key' => 'optionnum',
1034       'unique'      => [],
1035       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
1036     },
1037
1038     'cust_pkg_detail' => {
1039       'columns' => [
1040         'pkgdetailnum', 'serial', '',      '', '', '',
1041         'pkgnum',          'int', '',      '', '', '',
1042         'detail',      'varchar', '', $char_d, '', '', 
1043         'detailtype',     'char', '',       1, '', '', # "I"nvoice or "C"omment
1044         'weight',          'int', '',      '', '', '',
1045       ],
1046       'primary_key' => 'pkgdetailnum',
1047       'unique' => [],
1048       'index'  => [ [ 'pkgnum', 'detailtype' ] ],
1049     },
1050
1051     'cust_pkg_reason' => {
1052       'columns' => [
1053         'num',      'serial',    '',   '', '', '', 
1054         'pkgnum',   'int',    '',   '', '', '', 
1055         'reasonnum','int',    '',   '', '', '', 
1056         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
1057         'otaker',   'varchar', '', 32, '', '', 
1058         'date',     @date_type, '', '', 
1059       ],
1060       'primary_key' => 'num',
1061       'unique' => [],
1062       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], ],
1063     },
1064
1065     'cust_refund' => {
1066       'columns' => [
1067         'refundnum',    'serial',    '',   '', '', '', 
1068         'custnum',  'int',    '',   '', '', '', 
1069         '_date',        @date_type, '', '', 
1070         'refund',       @money_type, '', '', 
1071         'otaker',       'varchar',   '',   32, '', '', 
1072         'reason',       'varchar',   '',   $char_d, '', '', 
1073         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
1074                                                      # be index into payby
1075                                                      # table eventually
1076         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
1077         'paymask', 'varchar', 'NULL', $char_d, '', '', 
1078         'paybatch',     'varchar',   'NULL', $char_d, '', '', 
1079         'closed',    'char', 'NULL', 1, '', '', 
1080       ],
1081       'primary_key' => 'refundnum',
1082       'unique' => [],
1083       'index' => [ ['custnum'], ['_date'] ],
1084     },
1085
1086     'cust_credit_refund' => {
1087       'columns' => [
1088         'creditrefundnum', 'serial',     '',   '', '', '', 
1089         'crednum',  'int',     '',   '', '', '', 
1090         'refundnum',  'int',     '',   '', '', '', 
1091         'amount',  @money_type, '', '', 
1092         '_date',   @date_type, '', '', 
1093       ],
1094       'primary_key' => 'creditrefundnum',
1095       'unique' => [],
1096       'index' => [ ['crednum'], ['refundnum'] ],
1097     },
1098
1099
1100     'cust_svc' => {
1101       'columns' => [
1102         'svcnum',    'serial',    '',   '', '', '', 
1103         'pkgnum',    'int',    'NULL',   '', '', '', 
1104         'svcpart',   'int',    '',   '', '', '', 
1105         'overlimit', @date_type, '', '', 
1106       ],
1107       'primary_key' => 'svcnum',
1108       'unique' => [],
1109       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1110     },
1111
1112     'cust_svc_option' => {
1113       'columns' => [
1114         'optionnum',   'serial', '', '', '', '', 
1115         'svcnum',      'int', '', '', '', '', 
1116         'optionname',  'varchar', '', $char_d, '', '', 
1117         'optionvalue', 'text', 'NULL', '', '', '', 
1118       ],
1119       'primary_key' => 'optionnum',
1120       'unique'      => [],
1121       'index'       => [ [ 'svcnum' ], [ 'optionname' ] ],
1122     },
1123
1124     'part_pkg' => {
1125       'columns' => [
1126         'pkgpart',       'serial',    '',   '', '', '', 
1127         'pkg',           'varchar',   '',   $char_d, '', '', 
1128         'comment',       'varchar',   '',   $char_d, '', '', 
1129         'promo_code',    'varchar', 'NULL', $char_d, '', '', 
1130         'setup',         @perl_type, '', '', 
1131         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
1132         'recur',         @perl_type, '', '', 
1133         'setuptax',      'char', 'NULL', 1, '', '', 
1134         'recurtax',      'char', 'NULL', 1, '', '', 
1135         'plan',          'varchar', 'NULL', $char_d, '', '', 
1136         'plandata',      'text', 'NULL', '', '', '', 
1137         'disabled',      'char', 'NULL', 1, '', '', 
1138         'taxclass',      'varchar', 'NULL', $char_d, '', '', 
1139         'classnum',      'int',     'NULL', '', '', '', 
1140         'taxproductnum', 'int',     'NULL', '', '', '', 
1141         'pay_weight',    'real',    'NULL', '', '', '',
1142         'credit_weight', 'real',    'NULL', '', '', '',
1143         'agentnum',      'int',     'NULL', '', '', '', 
1144
1145       ],
1146       'primary_key' => 'pkgpart',
1147       'unique' => [],
1148       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
1149     },
1150
1151     'part_pkg_link' => {
1152       'columns' => [
1153         'pkglinknum',  'serial',  '',      '', '', '',
1154         'src_pkgpart', 'int',     '',      '', '', '',
1155         'dst_pkgpart', 'int',     '',      '', '', '', 
1156         'link_type',   'varchar', '', $char_d, '', '',
1157       ],
1158       'primary_key' => 'pkglinknum',
1159       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type' ] ],
1160       'index'  => [ [ 'src_pkgpart' ] ],
1161     },
1162
1163     'part_pkg_taxclass' => {
1164       'columns' => [
1165         'taxclassnum',  'serial', '',       '', '', '',
1166         'taxclass',     'varchar', '', $char_d, '', '', 
1167       ],
1168       'primary_key' => 'taxclassnum',
1169       'unique'      => [ [ 'taxclass' ] ],
1170       'index'       => [],
1171     },
1172
1173     'part_pkg_taxproduct' => {
1174       'columns' => [
1175         'taxproductnum', 'serial',      '',        '', '', '',
1176         'data_vendor',   'varchar', 'NULL',   $char_d, '', '', 
1177         'taxproduct',    'varchar',     '',   $char_d, '', '', 
1178         'description',   'varchar',     '', 3*$char_d, '', '', 
1179       ],
1180       'primary_key' => 'taxproductnum',
1181       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
1182       'index'       => [],
1183     },
1184
1185     'part_pkg_taxrate' => { 
1186       'columns' => [
1187         'pkgtaxratenum', 'serial',  '',     '',      '', '',
1188         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
1189         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
1190         'taxproductnum', 'int',  '',     '',       '', '',          
1191         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
1192         'county',           'varchar', 'NULL', $char_d, '', '', 
1193         'state',            'varchar', 'NULL', $char_d, '', '', 
1194         'local',            'varchar', 'NULL', $char_d, '', '', 
1195         'country',          'char',    'NULL', 2,       '', '',
1196         'taxclassnumtaxed', 'int',     'NULL', '',      '', '', 
1197         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '', 
1198         'taxclassnum',      'int',     'NULL', '',      '', '', 
1199         'effdate',          @date_type, '', '', 
1200         'taxable',          'char',    'NULL', 1,       '', '', 
1201       ],
1202       'primary_key' => 'pkgtaxratenum',
1203       'unique' => [],
1204       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1205     },
1206
1207     'part_pkg_taxoverride' => { 
1208       'columns' => [
1209         'taxoverridenum', 'serial', '', '', '', '',
1210         'pkgpart',        'serial', '', '', '', '',
1211         'taxclassnum',    'serial', '', '', '', '',
1212         'usage_class',    'varchar', 'NULL', $char_d, '', '', 
1213       ],
1214       'primary_key' => 'taxoverridenum',
1215       'unique' => [],
1216       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1217     },
1218
1219 #    'part_title' => {
1220 #      'columns' => [
1221 #        'titlenum',   'int',    '',   '',
1222 #        'title',      'varchar',   '',   $char_d,
1223 #      ],
1224 #      'primary_key' => 'titlenum',
1225 #      'unique' => [ [] ],
1226 #      'index' => [ [] ],
1227 #    },
1228
1229     'pkg_svc' => {
1230       'columns' => [
1231         'pkgsvcnum',  'serial', '',  '', '', '', 
1232         'pkgpart',    'int',    '',   '', '', '', 
1233         'svcpart',    'int',    '',   '', '', '', 
1234         'quantity',   'int',    '',   '', '', '', 
1235         'primary_svc','char', 'NULL',  1, '', '', 
1236       ],
1237       'primary_key' => 'pkgsvcnum',
1238       'unique' => [ ['pkgpart', 'svcpart'] ],
1239       'index' => [ ['pkgpart'], ['quantity'] ],
1240     },
1241
1242     'part_referral' => {
1243       'columns' => [
1244         'refnum',   'serial',     '',        '', '', '', 
1245         'referral', 'varchar',    '',   $char_d, '', '', 
1246         'disabled', 'char',   'NULL',         1, '', '', 
1247         'agentnum', 'int',    'NULL',        '', '', '', 
1248       ],
1249       'primary_key' => 'refnum',
1250       'unique' => [],
1251       'index' => [ ['disabled'], ['agentnum'], ],
1252     },
1253
1254     'part_svc' => {
1255       'columns' => [
1256         'svcpart',    'serial',    '',   '', '', '', 
1257         'svc',        'varchar',   '',   $char_d, '', '', 
1258         'svcdb',      'varchar',   '',   $char_d, '', '', 
1259         'disabled',   'char',  'NULL',   1, '', '', 
1260       ],
1261       'primary_key' => 'svcpart',
1262       'unique' => [],
1263       'index' => [ [ 'disabled' ] ],
1264     },
1265
1266     'part_svc_column' => {
1267       'columns' => [
1268         'columnnum',   'serial',         '', '', '', '', 
1269         'svcpart',     'int',         '', '', '', '', 
1270         'columnname',  'varchar',     '', 64, '', '', 
1271         'columnvalue', 'varchar', 'NULL', $char_d, '', '', 
1272         'columnflag',  'char',    'NULL', 1, '', '', 
1273       ],
1274       'primary_key' => 'columnnum',
1275       'unique' => [ [ 'svcpart', 'columnname' ] ],
1276       'index' => [ [ 'svcpart' ] ],
1277     },
1278
1279     #(this should be renamed to part_pop)
1280     'svc_acct_pop' => {
1281       'columns' => [
1282         'popnum',    'serial',    '',   '', '', '', 
1283         'city',      'varchar',   '',   $char_d, '', '', 
1284         'state',     'varchar',   '',   $char_d, '', '', 
1285         'ac',        'char',   '',   3, '', '', 
1286         'exch',      'char',   '',   3, '', '', 
1287         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
1288       ],
1289       'primary_key' => 'popnum',
1290       'unique' => [],
1291       'index' => [ [ 'state' ] ],
1292     },
1293
1294     'part_pop_local' => {
1295       'columns' => [
1296         'localnum',  'serial',     '',     '', '', '', 
1297         'popnum',    'int',     '',     '', '', '', 
1298         'city',      'varchar', 'NULL', $char_d, '', '', 
1299         'state',     'char',    'NULL', 2, '', '', 
1300         'npa',       'char',    '',     3, '', '', 
1301         'nxx',       'char',    '',     3, '', '', 
1302       ],
1303       'primary_key' => 'localnum',
1304       'unique' => [],
1305       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1306     },
1307
1308     'svc_acct' => {
1309       'columns' => [
1310         'svcnum',    'int',    '',   '', '', '', 
1311         'username',  'varchar',   '',   $username_len, '', '',
1312         '_password', 'varchar',   '',  512, '', '',
1313         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1314         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '', 
1315         'popnum',    'int',    'NULL',   '', '', '', 
1316         'uid',       'int', 'NULL',   '', '', '', 
1317         'gid',       'int', 'NULL',   '', '', '', 
1318         'finger',    'varchar',   'NULL',   $char_d, '', '', 
1319         'dir',       'varchar',   'NULL',   $char_d, '', '', 
1320         'shell',     'varchar',   'NULL',   $char_d, '', '', 
1321         'quota',     'varchar',   'NULL',   $char_d, '', '', 
1322         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
1323         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
1324         'seconds_threshold',   'int', 'NULL',   '', '', '',
1325         'upbytes',   'bigint', 'NULL',   '', '', '', 
1326         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
1327         'downbytes', 'bigint', 'NULL',   '', '', '',
1328         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
1329         'totalbytes','bigint', 'NULL',   '', '', '',
1330         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
1331         'domsvc',    'int', '',   '', '', '', 
1332         'last_login',  @date_type, '', '', 
1333         'last_logout', @date_type, '', '', 
1334       ],
1335       'primary_key' => 'svcnum',
1336       #'unique' => [ [ 'username', 'domsvc' ] ],
1337       'unique' => [],
1338       'index' => [ ['username'], ['domsvc'] ],
1339     },
1340
1341     'acct_rt_transaction' => {
1342       'columns' => [
1343         'svcrtid',   'int',    '',   '', '', '', 
1344         'svcnum',    'int',    '',   '', '', '', 
1345         'transaction_id',       'int', '',   '', '', '', 
1346         '_date',   @date_type, '', '',
1347         'seconds',   'int', '',   '', '', '', #uhhhh
1348         'support',   'int', '',   '', '', '',
1349       ],
1350       'primary_key' => 'svcrtid',
1351       'unique' => [],
1352       'index' => [ ['svcnum', 'transaction_id'] ],
1353     },
1354
1355     #'svc_charge' => {
1356     #  'columns' => [
1357     #    'svcnum',    'int',    '',   '',
1358     #    'amount',    @money_type,
1359     #  ],
1360     #  'primary_key' => 'svcnum',
1361     #  'unique' => [ [] ],
1362     #  'index' => [ [] ],
1363     #},
1364
1365     'svc_domain' => {
1366       'columns' => [
1367         'svcnum',           'int',    '',        '', '', '',
1368         'domain',       'varchar',    '',   $char_d, '', '',
1369         'suffix',       'varchar', 'NULL',  $char_d, '', '',
1370         'catchall',         'int', 'NULL',       '', '', '',
1371         'parent_svcnum',    'int', 'NULL',       '', '', '',
1372         'registrarnum',     'int', 'NULL',       '', '', '',
1373         'registrarkey', 'varchar', 'NULL',      512, '', '',
1374         'setup_date',  @date_type, '', '',
1375         'renewal_interval', 'int', 'NULL',       '', '', '',
1376         'expiration_date', @date_type, '', '',
1377       ],
1378       'primary_key' => 'svcnum',
1379       'unique' => [ ],
1380       'index' => [ ['domain'] ],
1381     },
1382
1383     'domain_record' => {
1384       'columns' => [
1385         'recnum',    'serial',     '',  '', '', '', 
1386         'svcnum',    'int',     '',  '', '', '', 
1387         'reczone',   'varchar', '',  255, '', '', 
1388         'recaf',     'char',    '',  2, '', '', 
1389         'rectype',   'varchar',    '',  5, '', '', 
1390         'recdata',   'varchar', '',  255, '', '', 
1391       ],
1392       'primary_key' => 'recnum',
1393       'unique'      => [],
1394       'index'       => [ ['svcnum'] ],
1395     },
1396
1397     'registrar' => {
1398       'columns' => [
1399         'registrarnum',   'serial', '',      '', '', '',
1400         'registrarname', 'varchar', '', $char_d, '', '',
1401       ],
1402       'primary_key' => 'registrarnum',
1403       'unique'      => [],
1404       'index'       => [],
1405     },
1406
1407     'svc_forward' => {
1408       'columns' => [
1409         'svcnum',   'int',            '',   '', '', '', 
1410         'srcsvc',   'int',        'NULL',   '', '', '', 
1411         'src',      'varchar',    'NULL',  255, '', '', 
1412         'dstsvc',   'int',        'NULL',   '', '', '', 
1413         'dst',      'varchar',    'NULL',  255, '', '', 
1414       ],
1415       'primary_key' => 'svcnum',
1416       'unique'      => [],
1417       'index'       => [ ['srcsvc'], ['dstsvc'] ],
1418     },
1419
1420     'svc_www' => {
1421       'columns' => [
1422         'svcnum',   'int',      '',  '', '', '', 
1423         'recnum',   'int',      '',  '', '', '', 
1424         'usersvc',  'int',  'NULL',  '', '', '', 
1425         'config',   'text', 'NULL',  '', '', '', 
1426       ],
1427       'primary_key' => 'svcnum',
1428       'unique'      => [],
1429       'index'       => [],
1430     },
1431
1432     #'svc_wo' => {
1433     #  'columns' => [
1434     #    'svcnum',    'int',    '',   '',
1435     #    'svcnum',    'int',    '',   '',
1436     #    'svcnum',    'int',    '',   '',
1437     #    'worker',    'varchar',   '',   $char_d,
1438     #    '_date',     @date_type,
1439     #  ],
1440     #  'primary_key' => 'svcnum',
1441     #  'unique' => [ [] ],
1442     #  'index' => [ [] ],
1443     #},
1444
1445     'prepay_credit' => {
1446       'columns' => [
1447         'prepaynum',   'serial',     '',   '', '', '', 
1448         'identifier',  'varchar', '', $char_d, '', '', 
1449         'amount',      @money_type, '', '', 
1450         'seconds',     'int',     'NULL', '', '', '', 
1451         'upbytes',     'bigint',     'NULL', '', '', '', 
1452         'downbytes',   'bigint',     'NULL', '', '', '', 
1453         'totalbytes',  'bigint',     'NULL', '', '', '', 
1454         'agentnum',    'int',     'NULL', '', '', '', 
1455       ],
1456       'primary_key' => 'prepaynum',
1457       'unique'      => [ ['identifier'] ],
1458       'index'       => [],
1459     },
1460
1461     'port' => {
1462       'columns' => [
1463         'portnum',  'serial',     '',   '', '', '', 
1464         'ip',       'varchar', 'NULL', 15, '', '', 
1465         'nasport',  'int',     'NULL', '', '', '', 
1466         'nasnum',   'int',     '',   '', '', '', 
1467       ],
1468       'primary_key' => 'portnum',
1469       'unique'      => [],
1470       'index'       => [],
1471     },
1472
1473     'nas' => {
1474       'columns' => [
1475         'nasnum',   'serial',     '',    '', '', '', 
1476         'nas',      'varchar', '',    $char_d, '', '', 
1477         'nasip',    'varchar', '',    15, '', '', 
1478         'nasfqdn',  'varchar', '',    $char_d, '', '', 
1479         'last',     'int',     '',    '', '', '', 
1480       ],
1481       'primary_key' => 'nasnum',
1482       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
1483       'index'       => [ [ 'last' ] ],
1484     },
1485
1486 #    'session' => {
1487 #      'columns' => [
1488 #        'sessionnum', 'serial',       '',   '', '', '', 
1489 #        'portnum',    'int',       '',   '', '', '', 
1490 #        'svcnum',     'int',       '',   '', '', '', 
1491 #        'login',      @date_type, '', '', 
1492 #        'logout',     @date_type, '', '', 
1493 #      ],
1494 #      'primary_key' => 'sessionnum',
1495 #      'unique'      => [],
1496 #      'index'       => [ [ 'portnum' ] ],
1497 #    },
1498
1499     'queue' => {
1500       'columns' => [
1501         'jobnum',      'serial',     '',      '', '', '', 
1502         'job',           'text',     '',      '', '', '', 
1503         '_date',          'int',     '',      '', '', '', 
1504         'status',     'varchar',     '', $char_d, '', '', 
1505         'statustext',    'text', 'NULL',      '', '', '', 
1506         'svcnum',         'int', 'NULL',      '', '', '', 
1507         'custnum',        'int', 'NULL',      '', '', '',
1508         'secure',        'char', 'NULL',       1, '', '',
1509         'priority',       'int', 'NULL',      '', '', '',
1510       ],
1511       'primary_key' => 'jobnum',
1512       'unique'      => [],
1513       'index'       => [ [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ] ],
1514     },
1515
1516     'queue_arg' => {
1517       'columns' => [
1518         'argnum', 'serial', '', '', '', '', 
1519         'jobnum', 'int', '', '', '', '', 
1520         'arg', 'text', 'NULL', '', '', '', 
1521       ],
1522       'primary_key' => 'argnum',
1523       'unique'      => [],
1524       'index'       => [ [ 'jobnum' ] ],
1525     },
1526
1527     'queue_depend' => {
1528       'columns' => [
1529         'dependnum', 'serial', '', '', '', '', 
1530         'jobnum', 'int', '', '', '', '', 
1531         'depend_jobnum', 'int', '', '', '', '', 
1532       ],
1533       'primary_key' => 'dependnum',
1534       'unique'      => [],
1535       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1536     },
1537
1538     'export_svc' => {
1539       'columns' => [
1540         'exportsvcnum' => 'serial', '', '', '', '', 
1541         'exportnum'    => 'int', '', '', '', '', 
1542         'svcpart'      => 'int', '', '', '', '', 
1543       ],
1544       'primary_key' => 'exportsvcnum',
1545       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
1546       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
1547     },
1548
1549     'part_export' => {
1550       'columns' => [
1551         'exportnum', 'serial', '', '', '', '', 
1552         'machine', 'varchar', '', $char_d, '', '', 
1553         'exporttype', 'varchar', '', $char_d, '', '', 
1554         'nodomain',     'char', 'NULL', 1, '', '', 
1555       ],
1556       'primary_key' => 'exportnum',
1557       'unique'      => [],
1558       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
1559     },
1560
1561     'part_export_option' => {
1562       'columns' => [
1563         'optionnum', 'serial', '', '', '', '', 
1564         'exportnum', 'int', '', '', '', '', 
1565         'optionname', 'varchar', '', $char_d, '', '', 
1566         'optionvalue', 'text', 'NULL', '', '', '', 
1567       ],
1568       'primary_key' => 'optionnum',
1569       'unique'      => [],
1570       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
1571     },
1572
1573     'radius_usergroup' => {
1574       'columns' => [
1575         'usergroupnum', 'serial', '', '', '', '', 
1576         'svcnum',       'int', '', '', '', '', 
1577         'groupname',    'varchar', '', $char_d, '', '', 
1578       ],
1579       'primary_key' => 'usergroupnum',
1580       'unique'      => [],
1581       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
1582     },
1583
1584     'msgcat' => {
1585       'columns' => [
1586         'msgnum', 'serial', '', '', '', '', 
1587         'msgcode', 'varchar', '', $char_d, '', '', 
1588         'locale', 'varchar', '', 16, '', '', 
1589         'msg', 'text', '', '', '', '', 
1590       ],
1591       'primary_key' => 'msgnum',
1592       'unique'      => [ [ 'msgcode', 'locale' ] ],
1593       'index'       => [],
1594     },
1595
1596     'cust_tax_exempt' => {
1597       'columns' => [
1598         'exemptnum', 'serial', '', '', '', '', 
1599         'custnum',   'int', '', '', '', '', 
1600         'taxnum',    'int', '', '', '', '', 
1601         'year',      'int', '', '', '', '', 
1602         'month',     'int', '', '', '', '', 
1603         'amount',   @money_type, '', '', 
1604       ],
1605       'primary_key' => 'exemptnum',
1606       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1607       'index'       => [],
1608     },
1609
1610     'cust_tax_exempt_pkg' => {
1611       'columns' => [
1612         'exemptpkgnum',  'serial', '', '', '', '', 
1613         #'custnum',      'int', '', '', '', ''
1614         'billpkgnum',   'int', '', '', '', '', 
1615         'taxnum',       'int', '', '', '', '', 
1616         'year',         'int', '', '', '', '', 
1617         'month',        'int', '', '', '', '', 
1618         'amount',       @money_type, '', '', 
1619       ],
1620       'primary_key' => 'exemptpkgnum',
1621       'unique' => [],
1622       'index'  => [ [ 'taxnum', 'year', 'month' ],
1623                     [ 'billpkgnum' ],
1624                     [ 'taxnum' ]
1625                   ],
1626     },
1627
1628     'router' => {
1629       'columns' => [
1630         'routernum', 'serial', '', '', '', '', 
1631         'routername', 'varchar', '', $char_d, '', '', 
1632         'svcnum', 'int', 'NULL', '', '', '', 
1633         'agentnum',   'int', 'NULL', '', '', '', 
1634       ],
1635       'primary_key' => 'routernum',
1636       'unique'      => [],
1637       'index'       => [],
1638     },
1639
1640     'part_svc_router' => {
1641       'columns' => [
1642         'svcrouternum', 'serial', '', '', '', '', 
1643         'svcpart', 'int', '', '', '', '', 
1644         'routernum', 'int', '', '', '', '', 
1645       ],
1646       'primary_key' => 'svcrouternum',
1647       'unique'      => [],
1648       'index'       => [],
1649     },
1650
1651     'addr_block' => {
1652       'columns' => [
1653         'blocknum', 'serial', '', '', '', '', 
1654         'routernum', 'int', '', '', '', '', 
1655         'ip_gateway', 'varchar', '', 15, '', '', 
1656         'ip_netmask', 'int', '', '', '', '', 
1657         'agentnum',   'int', 'NULL', '', '', '', 
1658         'manual_flag', 'char', 'NULL', 1, '', '', 
1659       ],
1660       'primary_key' => 'blocknum',
1661       'unique'      => [ [ 'blocknum', 'routernum' ] ],
1662       'index'       => [],
1663     },
1664
1665     'svc_broadband' => {
1666       'columns' => [
1667         'svcnum', 'int', '', '', '', '', 
1668         'description', 'varchar', 'NULL', $char_d, '', '', 
1669         'blocknum', 'int', '', '', '', '', 
1670         'speed_up', 'int', '', '', '', '', 
1671         'speed_down', 'int', '', '', '', '', 
1672         'ip_addr', 'varchar', '', 15, '', '', 
1673         'mac_addr', 'varchar', 'NULL', 12, '', '', 
1674         'authkey',  'varchar', 'NULL', 32, '', '', 
1675         'latitude', 'decimal', 'NULL', '', '', '', 
1676         'longitude', 'decimal', 'NULL', '', '', '', 
1677         'altitude', 'decimal', 'NULL', '', '', '', 
1678         'vlan_profile', 'varchar', 'NULL', $char_d, '', '', 
1679         'performance_profile', 'varchar', 'NULL', $char_d, '', '',
1680       ],
1681       'primary_key' => 'svcnum',
1682       'unique'      => [ [ 'mac_addr' ] ],
1683       'index'       => [],
1684     },
1685
1686     'part_virtual_field' => {
1687       'columns' => [
1688         'vfieldpart', 'serial', '', '', '', '', 
1689         'dbtable', 'varchar', '', 32, '', '', 
1690         'name', 'varchar', '', 32, '', '', 
1691         'check_block', 'text', 'NULL', '', '', '', 
1692         'length', 'int', 'NULL', '', '', '', 
1693         'list_source', 'text', 'NULL', '', '', '', 
1694         'label', 'varchar', 'NULL', 80, '', '', 
1695       ],
1696       'primary_key' => 'vfieldpart',
1697       'unique' => [],
1698       'index' => [],
1699     },
1700
1701     'virtual_field' => {
1702       'columns' => [
1703         'vfieldnum', 'serial', '', '', '', '', 
1704         'recnum', 'int', '', '', '', '', 
1705         'vfieldpart', 'int', '', '', '', '', 
1706         'value', 'varchar', '', 128, '', '', 
1707       ],
1708       'primary_key' => 'vfieldnum',
1709       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1710       'index' => [],
1711     },
1712
1713     'acct_snarf' => {
1714       'columns' => [
1715         'snarfnum',  'int', '', '', '', '', 
1716         'svcnum',    'int', '', '', '', '', 
1717         'machine',   'varchar', '', 255, '', '', 
1718         'protocol',  'varchar', '', $char_d, '', '', 
1719         'username',  'varchar', '', $char_d, '', '', 
1720         '_password', 'varchar', '', $char_d, '', '', 
1721       ],
1722       'primary_key' => 'snarfnum',
1723       'unique' => [],
1724       'index'  => [ [ 'svcnum' ] ],
1725     },
1726
1727     'svc_external' => {
1728       'columns' => [
1729         'svcnum', 'int', '', '', '', '', 
1730         'id',     'int', 'NULL', '', '', '', 
1731         'title',  'varchar', 'NULL', $char_d, '', '', 
1732       ],
1733       'primary_key' => 'svcnum',
1734       'unique'      => [],
1735       'index'       => [],
1736     },
1737
1738     'cust_pay_refund' => {
1739       'columns' => [
1740         'payrefundnum', 'serial', '', '', '', '', 
1741         'paynum',  'int', '', '', '', '', 
1742         'refundnum',  'int', '', '', '', '', 
1743         '_date',    @date_type, '', '', 
1744         'amount',   @money_type, '', '', 
1745       ],
1746       'primary_key' => 'payrefundnum',
1747       'unique' => [],
1748       'index' => [ ['paynum'], ['refundnum'] ],
1749     },
1750
1751     'part_pkg_option' => {
1752       'columns' => [
1753         'optionnum', 'serial', '', '', '', '', 
1754         'pkgpart', 'int', '', '', '', '', 
1755         'optionname', 'varchar', '', $char_d, '', '', 
1756         'optionvalue', 'text', 'NULL', '', '', '', 
1757       ],
1758       'primary_key' => 'optionnum',
1759       'unique'      => [],
1760       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
1761     },
1762
1763     'rate' => {
1764       'columns' => [
1765         'ratenum',  'serial', '', '', '', '', 
1766         'ratename', 'varchar', '', $char_d, '', '', 
1767       ],
1768       'primary_key' => 'ratenum',
1769       'unique'      => [],
1770       'index'       => [],
1771     },
1772
1773     'rate_detail' => {
1774       'columns' => [
1775         'ratedetailnum',   'serial', '', '', '', '', 
1776         'ratenum',         'int',     '', '', '', '', 
1777         'orig_regionnum',  'int', 'NULL', '', '', '', 
1778         'dest_regionnum',  'int',     '', '', '', '', 
1779         'min_included',    'int',     '', '', '', '', 
1780         #'min_charge',      @money_type, '', '', 
1781         'min_charge',      'decimal', '', '10,5', '', '', 
1782         'sec_granularity', 'int',     '', '', '', '', 
1783         #time period (link to table of periods)?
1784         'classnum',        'int',     'NULL', '', '', '', 
1785       ],
1786       'primary_key' => 'ratedetailnum',
1787       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1788       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
1789     },
1790
1791     'rate_region' => {
1792       'columns' => [
1793         'regionnum',   'serial',      '', '', '', '', 
1794         'regionname',  'varchar',     '', $char_d, '', '', 
1795       ],
1796       'primary_key' => 'regionnum',
1797       'unique'      => [],
1798       'index'       => [],
1799     },
1800
1801     'rate_prefix' => {
1802       'columns' => [
1803         'prefixnum',   'serial',      '', '', '', '', 
1804         'regionnum',   'int',         '', '', '', '', 
1805         'countrycode', 'varchar',     '',  3, '', '', 
1806         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
1807         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
1808       ],
1809       'primary_key' => 'prefixnum',
1810       'unique'      => [],
1811       'index'       => [ [ 'countrycode' ], [ 'regionnum' ] ],
1812     },
1813
1814     'usage_class' => {
1815       'columns' => [
1816         'classnum',    'serial',   '',      '', '', '', 
1817         'classname',   'varchar',  '', $char_d, '', '', 
1818         'disabled',    'char', 'NULL',       1, '', '', 
1819       ],
1820       'primary_key' => 'classnum',
1821       'unique' => [],
1822       'index' => [ ['disabled'] ],
1823     },
1824
1825     'reg_code' => {
1826       'columns' => [
1827         'codenum',   'serial',    '', '', '', '', 
1828         'code',      'varchar',   '', $char_d, '', '', 
1829         'agentnum',  'int',       '', '', '', '', 
1830       ],
1831       'primary_key' => 'codenum',
1832       'unique'      => [ [ 'agentnum', 'code' ] ],
1833       'index'       => [ [ 'agentnum' ] ],
1834     },
1835
1836     'reg_code_pkg' => {
1837       'columns' => [
1838         'codepkgnum', 'serial', '', '', '', '', 
1839         'codenum',   'int',    '', '', '', '', 
1840         'pkgpart',   'int',    '', '', '', '', 
1841       ],
1842       'primary_key' => 'codepkgnum',
1843       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
1844       'index'       => [ [ 'codenum' ] ],
1845     },
1846
1847     'clientapi_session' => {
1848       'columns' => [
1849         'sessionnum',  'serial',  '', '', '', '', 
1850         'sessionid',  'varchar',  '', $char_d, '', '', 
1851         'namespace',  'varchar',  '', $char_d, '', '', 
1852       ],
1853       'primary_key' => 'sessionnum',
1854       'unique'      => [ [ 'sessionid', 'namespace' ] ],
1855       'index'       => [],
1856     },
1857
1858     'clientapi_session_field' => {
1859       'columns' => [
1860         'fieldnum',    'serial',     '', '', '', '', 
1861         'sessionnum',     'int',     '', '', '', '', 
1862         'fieldname',  'varchar',     '', $char_d, '', '', 
1863         'fieldvalue',    'text', 'NULL', '', '', '', 
1864       ],
1865       'primary_key' => 'fieldnum',
1866       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
1867       'index'       => [],
1868     },
1869
1870     'payment_gateway' => {
1871       'columns' => [
1872         'gatewaynum',       'serial',   '',     '', '', '', 
1873         'gateway_namespace','varchar',  'NULL', $char_d, '', '', 
1874         'gateway_module',   'varchar',  '',     $char_d, '', '', 
1875         'gateway_username', 'varchar',  'NULL', $char_d, '', '', 
1876         'gateway_password', 'varchar',  'NULL', $char_d, '', '', 
1877         'gateway_action',   'varchar',  'NULL', $char_d, '', '', 
1878         'gateway_callback_url', 'varchar',  'NULL', $char_d, '', '', 
1879         'disabled',   'char',  'NULL',   1, '', '', 
1880       ],
1881       'primary_key' => 'gatewaynum',
1882       'unique' => [],
1883       'index'  => [ [ 'disabled' ] ],
1884     },
1885
1886     'payment_gateway_option' => {
1887       'columns' => [
1888         'optionnum',   'serial',  '',     '', '', '', 
1889         'gatewaynum',  'int',     '',     '', '', '', 
1890         'optionname',  'varchar', '',     $char_d, '', '', 
1891         'optionvalue', 'text',    'NULL', '', '', '', 
1892       ],
1893       'primary_key' => 'optionnum',
1894       'unique'      => [],
1895       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1896     },
1897
1898     'agent_payment_gateway' => {
1899       'columns' => [
1900         'agentgatewaynum', 'serial', '', '', '', '', 
1901         'agentnum',        'int', '', '', '', '', 
1902         'gatewaynum',      'int', '', '', '', '', 
1903         'cardtype',        'varchar', 'NULL', $char_d, '', '', 
1904         'taxclass',        'varchar', 'NULL', $char_d, '', '', 
1905       ],
1906       'primary_key' => 'agentgatewaynum',
1907       'unique'      => [],
1908       'index'       => [ [ 'agentnum', 'cardtype' ], ],
1909     },
1910
1911     'banned_pay' => {
1912       'columns' => [
1913         'bannum',  'serial',   '',     '', '', '', 
1914         'payby',   'char',     '',       4, '', '', 
1915         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
1916         #'paymask', 'varchar',  'NULL', $char_d, '', ''
1917         '_date',   @date_type, '', '', 
1918         'otaker',  'varchar',  '',     32, '', '', 
1919         'reason',  'varchar',  'NULL', $char_d, '', '', 
1920       ],
1921       'primary_key' => 'bannum',
1922       'unique'      => [ [ 'payby', 'payinfo' ] ],
1923       'index'       => [],
1924     },
1925
1926     'pkg_category' => {
1927       'columns' => [
1928         'categorynum',   'serial',  '', '', '', '', 
1929         'categoryname',  'varchar', '', $char_d, '', '', 
1930         'disabled',      'char', 'NULL',   1, '', '', 
1931       ],
1932       'primary_key' => 'categorynum',
1933       'unique' => [],
1934       'index' => [ ['disabled'] ],
1935     },
1936
1937     'pkg_class' => {
1938       'columns' => [
1939         'classnum',    'serial',   '',      '', '', '', 
1940         'classname',   'varchar',  '', $char_d, '', '', 
1941         'categorynum', 'int',  'NULL',      '', '', '', 
1942         'disabled',    'char', 'NULL',       1, '', '', 
1943       ],
1944       'primary_key' => 'classnum',
1945       'unique' => [],
1946       'index' => [ ['disabled'] ],
1947     },
1948
1949     'cdr' => {
1950       'columns' => [
1951         # qw( name type null length default local );
1952
1953         ###
1954         #asterisk fields
1955         ###
1956
1957         'acctid',   'bigserial',  '', '', '', '', 
1958         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1959         'calldate', 'timestamp',   '',      '', \'now()', '',
1960         'clid',        'varchar',  '', $char_d, \"''", '', 
1961         'src',         'varchar',  '', $char_d, \"''", '', 
1962         'dst',         'varchar',  '', $char_d, \"''", '', 
1963         'dcontext',    'varchar',  '', $char_d, \"''", '', 
1964         'channel',     'varchar',  '', $char_d, \"''", '', 
1965         'dstchannel',  'varchar',  '', $char_d, \"''", '', 
1966         'lastapp',     'varchar',  '', $char_d, \"''", '', 
1967         'lastdata',    'varchar',  '', $char_d, \"''", '', 
1968
1969         #these don't seem to be logged by most of the SQL cdr_* modules
1970         #except tds under sql-illegal names, so;
1971         # ... don't rely on them for rating?
1972         # and, what they hey, i went ahead and changed the names and data types
1973         # to freeside-style dates...
1974           #'start',  'timestamp', 'NULL',  '',    '', '',
1975           #'answer', 'timestamp', 'NULL',  '',    '', '',
1976           #'end',    'timestamp', 'NULL',  '',    '', '',
1977         'startdate',  @date_type, '', '', 
1978         'answerdate', @date_type, '', '', 
1979         'enddate',    @date_type, '', '', 
1980         #
1981
1982         'duration',    'int',      '',      '',     0, '',
1983         'billsec',     'int',      '',      '',     0, '', 
1984         'disposition', 'varchar',  '',      45, \"''", '',
1985         'amaflags',    'int',      '',      '',     0, '',
1986         'accountcode', 'varchar',  '',      20, \"''", '',
1987         'uniqueid',    'varchar',  '',      32, \"''", '',
1988         'userfield',   'varchar',  '',     255, \"''", '',
1989
1990         ###
1991         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1992         # defaults
1993         ###
1994
1995         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1996         'cdrtypenum',              'int', 'NULL',      '', '', '',
1997
1998         'charged_party',       'varchar', 'NULL', $char_d, '', '',
1999
2000         'upstream_currency',      'char', 'NULL',       3, '', '',
2001         'upstream_price',      'decimal', 'NULL',  '10,2', '', '', 
2002         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
2003
2004         # how it was rated internally...
2005         'ratedetailnum',           'int', 'NULL',      '', '', '',
2006         'rated_price',         'decimal', 'NULL',  '10,2', '', '',
2007
2008         'distance',            'decimal', 'NULL',      '', '', '',
2009         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
2010
2011         #cdr_calltype: the big list in appendix 2
2012         'calltypenum',             'int', 'NULL',      '', '', '',
2013
2014         'description',         'varchar', 'NULL', $char_d, '', '',
2015         'quantity',                'int', 'NULL',      '', '', '', 
2016
2017         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
2018         'carrierid',               'int', 'NULL',      '', '', '',
2019
2020         'upstream_rateid',         'int', 'NULL',      '', '', '',
2021         
2022         ###
2023         #and now for our own fields
2024         ###
2025
2026         # a svcnum... right..?
2027         'svcnum',             'int',   'NULL',     '',   '', '', 
2028
2029         #NULL, done (or something)
2030         'freesidestatus', 'varchar',   'NULL',     32,   '', '', 
2031
2032         #NULL, done (or something)
2033         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '', 
2034
2035         'cdrbatch', 'varchar', 'NULL', $char_d, '', '',
2036
2037       ],
2038       'primary_key' => 'acctid',
2039       'unique' => [],
2040       'index' => [ [ 'calldate' ], [ 'src' ], [ 'dst' ], [ 'charged_party' ], [ 'accountcode' ], [ 'freesidestatus' ], [ 'freesiderewritestatus' ], [ 'cdrbatch' ], ],
2041     },
2042
2043     'cdr_calltype' => {
2044       'columns' => [
2045         'calltypenum',   'serial',  '', '', '', '', 
2046         'calltypename',  'varchar', '', $char_d, '', '', 
2047       ],
2048       'primary_key' => 'calltypenum',
2049       'unique'      => [],
2050       'index'       => [],
2051     },
2052
2053     'cdr_type' => {
2054       'columns' => [
2055         'cdrtypenum'  => 'serial',  '', '', '', '',
2056         'cdrtypename' => 'varchar', '', $char_d, '', '',
2057       ],
2058       'primary_key' => 'cdrtypenum',
2059       'unique'      => [],
2060       'index'       => [],
2061     },
2062
2063     'cdr_carrier' => {
2064       'columns' => [
2065         'carrierid'   => 'serial',  '', '', '', '',
2066         'carriername' => 'varchar', '', $char_d, '', '',
2067       ],
2068       'primary_key' => 'carrierid',
2069       'unique'      => [],
2070       'index'       => [],
2071     },
2072
2073     #map upstream rateid to ours...
2074     'cdr_upstream_rate' => {
2075       'columns' => [
2076         'upstreamratenum', 'serial',  '', '', '', '',
2077         'upstream_rateid', 'varchar', '', $char_d, '', '', 
2078         'ratedetailnum',   'int', 'NULL', '', '', '',
2079       ],
2080       'primary_key' => 'upstreamratenum', #XXX need a primary key
2081       'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
2082       'index'  => [],
2083     },
2084
2085     #'cdr_file' => {
2086     #  'columns' => [
2087     #    'filenum',    'serial',     '', '', '', '',
2088     #    'filename',  'varchar',     '', '', '', '',
2089     #    'status',    'varchar', 'NULL', '', '', '',
2090     #  ],
2091     #  'primary_key' => 'filenum',
2092     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
2093     #                                   # agent-virtualize or have a customer
2094     #                                   # with dup-filename needs or something
2095     #                                   # (only used by cdr.http_and_import for
2096     #                                   #  chrissakes)
2097     #  'index'  => [],
2098     #},
2099
2100     'inventory_item' => {
2101       'columns' => [
2102         'itemnum',  'serial',      '',      '', '', '',
2103         'classnum', 'int',         '',      '', '', '',
2104         'item',     'varchar',     '', $char_d, '', '',
2105         'svcnum',   'int',     'NULL',      '', '', '',
2106       ],
2107       'primary_key' => 'itemnum',
2108       'unique' => [ [ 'classnum', 'item' ] ],
2109       'index'  => [ [ 'classnum' ], [ 'svcnum' ] ],
2110     },
2111
2112     'inventory_class' => {
2113       'columns' => [
2114         'classnum',  'serial',       '',      '', '', '',
2115         'classname', 'varchar',      '', $char_d, '', '',
2116       ],
2117       'primary_key' => 'classnum',
2118       'unique' => [],
2119       'index'  => [],
2120     },
2121
2122     'access_user' => {
2123       'columns' => [
2124         'usernum',   'serial',  '',      '', '', '',
2125         'username',  'varchar', '', $char_d, '', '',
2126         '_password', 'varchar', '', $char_d, '', '',
2127         'last',      'varchar', '', $char_d, '', '', 
2128         'first',     'varchar', '', $char_d, '', '', 
2129         'disabled',     'char', 'NULL',   1, '', '', 
2130       ],
2131       'primary_key' => 'usernum',
2132       'unique' => [ [ 'username' ] ],
2133       'index'  => [],
2134     },
2135
2136     'access_user_pref' => {
2137       'columns' => [
2138         'prefnum',    'serial',       '', '', '', '',
2139         'usernum',     'int',       '', '', '', '',
2140         'prefname', 'varchar', '', $char_d, '', '', 
2141         'prefvalue', 'text', 'NULL', '', '', '', 
2142         'expiration', @date_type, '', '',
2143       ],
2144       'primary_key' => 'prefnum',
2145       'unique' => [],
2146       'index'  => [ [ 'usernum' ] ],
2147     },
2148
2149     'access_group' => {
2150       'columns' => [
2151         'groupnum',   'serial', '',      '', '', '',
2152         'groupname', 'varchar', '', $char_d, '', '',
2153       ],
2154       'primary_key' => 'groupnum',
2155       'unique' => [ [ 'groupname' ] ],
2156       'index'  => [],
2157     },
2158
2159     'access_usergroup' => {
2160       'columns' => [
2161         'usergroupnum', 'serial', '', '', '', '',
2162         'usernum',         'int', '', '', '', '',
2163         'groupnum',        'int', '', '', '', '',
2164       ],
2165       'primary_key' => 'usergroupnum',
2166       'unique' => [ [ 'usernum', 'groupnum' ] ],
2167       'index'  => [ [ 'usernum' ] ],
2168     },
2169
2170     'access_groupagent' => {
2171       'columns' => [
2172         'groupagentnum', 'serial', '', '', '', '',
2173         'groupnum',         'int', '', '', '', '',
2174         'agentnum',         'int', '', '', '', '',
2175       ],
2176       'primary_key' => 'groupagentnum',
2177       'unique' => [ [ 'groupnum', 'agentnum' ] ],
2178       'index'  => [ [ 'groupnum' ] ],
2179     },
2180
2181     'access_right' => {
2182       'columns' => [
2183         'rightnum',   'serial', '',      '', '', '',
2184         'righttype', 'varchar', '', $char_d, '', '',
2185         'rightobjnum',   'int', '',      '', '', '',
2186         'rightname', 'varchar', '', $char_d, '', '',
2187       ],
2188       'primary_key' => 'rightnum',
2189       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2190       'index'  => [],
2191     },
2192
2193     'svc_phone' => {
2194       'columns' => [
2195         'svcnum',       'int',         '',      '', '', '', 
2196         'countrycode',  'varchar',     '',       3, '', '', 
2197         'phonenum',     'varchar',     '',      15, '', '',  #12 ?
2198         'pin',          'varchar', 'NULL', $char_d, '', '',
2199         'sip_password', 'varchar', 'NULL', $char_d, '', '',
2200         'phone_name',   'varchar', 'NULL', $char_d, '', '',
2201       ],
2202       'primary_key' => 'svcnum',
2203       'unique' => [],
2204       'index'  => [ [ 'countrycode', 'phonenum' ] ],
2205     },
2206
2207     'phone_avail' => {
2208       'columns' => [
2209         'availnum',    'serial',      '',      '', '', '', 
2210         'exportnum',   'int',         '',      '', '', '', 
2211         'countrycode', 'varchar',     '',       3, '', '', 
2212         'state',       'char',    'NULL',       2, '', '', 
2213         'npa',         'char',        '',       3, '', '', 
2214         'nxx',         'char',    'NULL',       3, '', '', 
2215         'station',     'char',    'NULL',       4, '', '',
2216         'name',        'varchar', 'NULL', $char_d, '', '',
2217         'svcnum',      'int',     'NULL',      '', '', '',
2218         'availbatch', 'varchar',  'NULL', $char_d, '', '',
2219       ],
2220       'primary_key' => 'availnum',
2221       'unique' => [],
2222       'index'  => [ [ 'exportnum', 'countrycode', 'state' ],     #npa search
2223                     [ 'exportnum', 'countrycode', 'npa' ],       #nxx search
2224                     [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
2225                     [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
2226                     [ 'svcnum' ],
2227                     [ 'availbatch' ],
2228                   ],
2229     },
2230
2231     'reason_type' => {
2232       'columns' => [
2233         'typenum',   'serial',  '', '', '', '', 
2234         'class',     'char', '', 1, '', '', 
2235         'type',     'varchar', '', $char_d, '', '', 
2236       ],
2237       'primary_key' => 'typenum',
2238       'unique' => [],
2239       'index' => [],
2240     },
2241
2242     'reason' => {
2243       'columns' => [
2244         'reasonnum',     'serial',  '', '', '', '', 
2245         'reason_type',   'int',  '', '', '', '', 
2246         'reason',        'text', '', '', '', '', 
2247         'disabled',      'char',    'NULL', 1, '', '', 
2248       ],
2249       'primary_key' => 'reasonnum',
2250       'unique' => [],
2251       'index' => [],
2252     },
2253
2254     'conf' => {
2255       'columns' => [
2256         'confnum',  'serial',  '', '', '', '', 
2257         'agentnum', 'int',  'NULL', '', '', '', 
2258         'name',     'varchar', '', $char_d, '', '', 
2259         'value',    'text', 'NULL', '', '', '',
2260       ],
2261       'primary_key' => 'confnum',
2262       'unique' => [ [ 'agentnum', 'name' ]],
2263       'index' => [],
2264     },
2265
2266     'pkg_referral' => {
2267       'columns' => [
2268         'pkgrefnum',     'serial', '', '', '', '',
2269         'pkgnum',        'int',    '', '', '', '',
2270         'refnum',        'int',    '', '', '', '',
2271       ],
2272       'primary_key' => 'pkgrefnum',
2273       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
2274       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
2275     },
2276     # name type nullability length default local
2277
2278     #'new_table' => {
2279     #  'columns' => [
2280     #    'num', 'serial',       '', '', '', '',
2281     #  ],
2282     #  'primary_key' => 'num',
2283     #  'unique' => [],
2284     #  'index'  => [],
2285     #},
2286
2287   };
2288
2289 }
2290
2291 =back
2292
2293 =head1 BUGS
2294
2295 =head1 SEE ALSO
2296
2297 L<DBIx::DBSchema>
2298
2299 =cut
2300
2301 1;
2302