add configuration option to control recurring_flag behavior, RT#3843
[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       ],
682       'primary_key' => 'custnum',
683       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
684       #'index' => [ ['last'], ['company'] ],
685       'index' => [
686                    [ 'agentnum' ], [ 'refnum' ], [ 'custbatch' ],
687                    [ 'referral_custnum' ],
688                    [ 'payby' ], [ 'paydate' ],
689                    #billing
690                    [ 'last' ], [ 'company' ],
691                    [ 'county' ], [ 'state' ], [ 'country' ],
692                    [ 'zip' ],
693                    [ 'daytime' ], [ 'night' ], [ 'fax' ],
694                    #shipping
695                    [ 'ship_last' ], [ 'ship_company' ],
696                    [ 'ship_county' ], [ 'ship_state' ], [ 'ship_country' ],
697                    [ 'ship_zip' ],
698                    [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
699                  ],
700     },
701
702     #eventually use for billing & ship from cust_main too
703     #for now, just cust_pkg locations
704     'cust_location' => {
705       'columns' => [
706         'locationnum',  'serial',     '',      '', '', '',
707         'custnum',         'int',     '',      '', '', '',
708         'address1',    'varchar',     '', $char_d, '', '', 
709         'address2',    'varchar', 'NULL', $char_d, '', '', 
710         'city',        'varchar',     '', $char_d, '', '', 
711         'county',      'varchar', 'NULL', $char_d, '', '', 
712         'state',       'varchar', 'NULL', $char_d, '', '', 
713         'zip',         'varchar', 'NULL',      10, '', '', 
714         'country',        'char',     '',       2, '', '', 
715         'geocode',     'varchar', 'NULL',      20, '', '',
716       ],
717       'primary_key' => 'locationnum',
718       'unique'      => [],
719       'index'       => [ [ 'custnum' ],
720                          [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
721                        ],
722     },
723
724     'cust_main_invoice' => {
725       'columns' => [
726         'destnum',  'serial',  '',     '', '', '', 
727         'custnum',  'int',  '',     '', '', '', 
728         'dest',     'varchar', '',  $char_d, '', '', 
729       ],
730       'primary_key' => 'destnum',
731       'unique' => [],
732       'index' => [ ['custnum'], ],
733     },
734
735     'cust_main_note' => {
736       'columns' => [
737         'notenum',  'serial',  '',     '', '', '', 
738         'custnum',  'int',  '',     '', '', '', 
739         '_date',    @date_type, '', '', 
740         'otaker',   'varchar', '',    32, '', '', 
741         'comments', 'text', 'NULL', '', '', '', 
742       ],
743       'primary_key' => 'notenum',
744       'unique' => [],
745       'index' => [ [ 'custnum' ], [ '_date' ], ],
746     },
747
748     'cust_main_county' => { #county+state+country are checked off the
749                             #cust_main_county for validation and to provide
750                             # a tax rate.
751       'columns' => [
752         'taxnum',   'serial',   '',    '', '', '', 
753         'state',    'varchar',  'NULL',    $char_d, '', '', 
754         'county',   'varchar',  'NULL',    $char_d, '', '', 
755         'country',  'char',  '', 2, '', '', 
756         'taxclass',   'varchar', 'NULL', $char_d, '', '', 
757         'exempt_amount', @money_type, '', '', 
758         'tax',      'real',  '',    '', '', '', #tax %
759         'taxname',  'varchar',  'NULL',    $char_d, '', '', 
760         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
761         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
762       ],
763       'primary_key' => 'taxnum',
764       'unique' => [],
765   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
766       'index' => [ [ 'county' ], [ 'state' ], [ 'country' ],
767                    [ 'taxclass' ],
768                  ],
769     },
770
771     'tax_rate'    => {
772       'columns' => [
773         'taxnum',       'serial',     '',      '', '', '', 
774         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
775         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
776         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
777         'taxclassnum', 'int',      '',      '', '', '', 
778         'effective_date', @date_type, '', '', 
779         'tax',        @taxrate_type,      '', '',        # tax %
780         'excessrate', @taxrate_typen,     '', '',        # second tax %
781         'taxbase',    @money_typen, '', '',              # amount at first tax rate
782         'taxmax',     @money_typen, '', '',              # maximum about at both rates
783         'usetax',        @taxrate_typen,     '', '',     # tax % when non-local
784         'useexcessrate', @taxrate_typen,     '', '',     # second tax % when non-local
785         'unittype',    'int',  'NULL', '', '', '',      # for fee
786         'fee',         @taxrate_typen,     '', '',      # amount tax per unit
787         'excessfee',   @taxrate_typen,     '', '',      # second amount tax per unit
788         'feebase',     @taxrate_typen,     '', '',      # units taxed at first rate
789         'feemax',      @taxrate_typen,     '', '',      # maximum number of unit taxed
790         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
791         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
792         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
793         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
794         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
795         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
796         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
797         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
798         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
799         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
800       ],
801       'primary_key' => 'taxnum',
802       'unique' => [],
803       'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
804     },
805
806     'cust_tax_location' => { 
807       'columns' => [
808         'custlocationnum', 'serial',  '',     '', '', '', 
809         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
810         'city',            'varchar', 'NULL', $char_d, '', '',
811         'postalcity',      'varchar', 'NULL', $char_d, '', '',
812         'county',          'varchar', 'NULL', $char_d, '', '',
813         'zip',             'char',    '',     5,  '', '', 
814         'state',           'char',    '',     2,  '', '', 
815         'plus4hi',         'char',    'NULL', 4,  '', '', 
816         'plus4lo',         'char',    'NULL', 4,  '', '', 
817         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
818         'cityflag',        'char',    'NULL', 1,  '', '', # I(n)/O(out)/B(oth)/NULL
819         'geocode',         'varchar', '',    20,  '', '', 
820       ],
821       'primary_key' => 'custlocationnum',
822       'unique' => [],
823       'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
824     },
825
826     'tax_class' => { 
827       'columns' => [
828         'taxclassnum',  'serial',  '',            '', '', '',
829         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
830         'taxclass',     'varchar', '',       $char_d, '', '',          
831         'description',  'varchar', '',     2*$char_d, '', '',          
832       ],
833       'primary_key' => 'taxclassnum',
834       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
835       'index' => [],
836     },
837
838     'cust_pay_pending' => {
839       'columns' => [
840         'paypendingnum','serial',      '',  '', '', '',
841         'custnum',      'int',         '',  '', '', '', 
842         'paid',         @money_type,            '', '', 
843         '_date',        @date_type,             '', '', 
844         'payby',        'char',        '',   4, '', '', #CARD/BILL/COMP, should
845                                                         # be index into payby
846                                                         # table eventually
847         'payinfo',      'varchar', 'NULL', 512, '', '', #see cust_main above
848         'paymask',      'varchar', 'NULL', $char_d, '', '', 
849         'paydate',      'varchar', 'NULL', 10, '', '', 
850         'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
851         #'paybatch',     'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
852         'payunique',    'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
853
854         'status',       'varchar',     '', $char_d, '', '', 
855         'session_id',   'varchar', 'NULL', $char_d, '', '', #only need 32
856         'statustext',   'text',    'NULL',  '', '', '', 
857         'gatewaynum',   'int',     'NULL',  '', '', '',
858         #'cust_balance', @money_type,            '', '',
859         'paynum',       'int',     'NULL',  '', '', '',
860         'jobnum',       'int',     'NULL',  '', '', '', 
861       ],
862       'primary_key' => 'paypendingnum',
863       'unique'      => [ [ 'payunique' ] ],
864       'index'       => [ [ 'custnum' ], [ 'status' ], ],
865     },
866
867     'cust_pay' => {
868       'columns' => [
869         'paynum',   'serial',    '',   '', '', '',
870         'custnum',  'int',    '',   '', '', '', 
871         '_date',    @date_type, '', '', 
872         'paid',     @money_type, '', '', 
873         'otaker',   'varchar', 'NULL', 32, '', '',  #NULL for the upgrade so we can create & populate the field
874         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
875                                                  # index into payby table
876                                                  # eventually
877         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
878         'paymask', 'varchar', 'NULL', $char_d, '', '', 
879         'paydate',  'varchar', 'NULL', 10, '', '', 
880         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
881         'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
882         'closed',    'char', 'NULL', 1, '', '', 
883       ],
884       'primary_key' => 'paynum',
885       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
886       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
887     },
888
889     'cust_pay_void' => {
890       'columns' => [
891         'paynum',    'int',    '',   '', '', '', 
892         'custnum',   'int',    '',   '', '', '', 
893         'paid',      @money_type, '', '', 
894         '_date',     @date_type, '', '', 
895         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
896                                                   # index into payby table
897                                                   # eventually
898         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
899         'paymask', 'varchar', 'NULL', $char_d, '', '', 
900         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
901         'closed',    'char', 'NULL', 1, '', '', 
902         'void_date', @date_type, '', '', 
903         'reason',    'varchar',   'NULL', $char_d, '', '', 
904         'otaker',   'varchar', '', 32, '', '', 
905       ],
906       'primary_key' => 'paynum',
907       'unique' => [],
908       'index' => [ [ 'custnum' ] ],
909     },
910
911     'cust_bill_pay' => {
912       'columns' => [
913         'billpaynum', 'serial',     '',   '', '', '', 
914         'invnum',  'int',     '',   '', '', '', 
915         'paynum',  'int',     '',   '', '', '', 
916         'amount',  @money_type, '', '', 
917         '_date',   @date_type, '', '', 
918       ],
919       'primary_key' => 'billpaynum',
920       'unique' => [],
921       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
922     },
923
924     'cust_bill_pay_batch' => {
925       'columns' => [
926         'billpaynum', 'serial',     '',   '', '', '', 
927         'invnum',  'int',     '',   '', '', '', 
928         'paybatchnum',  'int',     '',   '', '', '', 
929         'amount',  @money_type, '', '', 
930         '_date',   @date_type, '', '', 
931       ],
932       'primary_key' => 'billpaynum',
933       'unique' => [],
934       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
935     },
936
937     'cust_bill_pay_pkg' => {
938       'columns' => [
939         'billpaypkgnum', 'serial', '', '', '', '',
940         'billpaynum',       'int', '', '', '', '',
941         'billpkgnum',       'int', '', '', '', '',
942         'amount',         @money_type,     '', '',
943         'setuprecur',      'varchar', '', $char_d, '', '',
944         'sdate',   @date_type, '', '', 
945         'edate',   @date_type, '', '', 
946       ],
947       'primary_key' => 'billpaypkgnum',
948       'unique'      => [],
949       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
950     },
951
952     'pay_batch' => { #batches of payments to an external processor
953       'columns' => [
954         'batchnum',   'serial',    '',   '', '', '', 
955         'payby',      'char',      '',    4, '', '', # CARD/CHEK
956         'status',     'char', 'NULL',     1, '', '', 
957         'download',   @date_type, '', '', 
958         'upload',     @date_type, '', '', 
959       ],
960       'primary_key' => 'batchnum',
961       'unique' => [],
962       'index' => [],
963     },
964
965     'cust_pay_batch' => { #what's this used for again?  list of customers
966                           #in current CARD batch? (necessarily CARD?)
967       'columns' => [
968         'paybatchnum',   'serial',    '',   '', '', '', 
969         'batchnum',   'int',    '',   '', '', '', 
970         'invnum',   'int',    '',   '', '', '', 
971         'custnum',   'int',    '',   '', '', '', 
972         'last',     'varchar', '',     $char_d, '', '', 
973         'first',    'varchar', '',     $char_d, '', '', 
974         'address1', 'varchar', '',     $char_d, '', '', 
975         'address2', 'varchar', 'NULL', $char_d, '', '', 
976         'city',     'varchar', '',     $char_d, '', '', 
977         'state',    'varchar', 'NULL', $char_d, '', '', 
978         'zip',      'varchar', 'NULL', 10, '', '', 
979         'country',  'char', '',     2, '', '', 
980         #        'trancode', 'int', '', '', '', ''
981         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
982         'payinfo',  'varchar', '',     512, '', '', 
983         #'exp',      @date_type, '', ''
984         'exp',      'varchar', 'NULL',     11, '', '', 
985         'payname',  'varchar', 'NULL', $char_d, '', '', 
986         'amount',   @money_type, '', '', 
987         'status',   'varchar', 'NULL',     $char_d, '', '', 
988       ],
989       'primary_key' => 'paybatchnum',
990       'unique' => [],
991       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
992     },
993
994     'cust_pkg' => {
995       'columns' => [
996         'pkgnum',           'serial',     '', '', '', '', 
997         'custnum',             'int',     '', '', '', '', 
998         'pkgpart',             'int',     '', '', '', '', 
999         'locationnum',         'int', 'NULL', '', '', '',
1000         'otaker',          'varchar',     '', 32, '', '', 
1001         'setup',          @date_type,             '', '', 
1002         'bill',           @date_type,             '', '', 
1003         'last_bill',      @date_type,             '', '', 
1004         'susp',           @date_type,             '', '', 
1005         'adjourn',        @date_type,             '', '', 
1006         'cancel',         @date_type,             '', '', 
1007         'expire',         @date_type,             '', '', 
1008         'change_date',    @date_type,             '', '',
1009         'change_pkgnum',       'int', 'NULL', '', '', '',
1010         'change_pkgpart',      'int', 'NULL', '', '', '',
1011         'change_locationnum',  'int', 'NULL', '', '', '',
1012         'manual_flag',        'char', 'NULL',  1, '', '', 
1013         'quantity',            'int', 'NULL', '', '', '',
1014       ],
1015       'primary_key' => 'pkgnum',
1016       'unique' => [],
1017       'index' => [ ['custnum'], ['pkgpart'], [ 'locationnum' ],
1018                    ['setup'], ['last_bill'], ['bill'], ['susp'], ['adjourn'],
1019                    ['expire'], ['cancel'],
1020                    ['change_date'],
1021                  ],
1022     },
1023
1024     'cust_pkg_option' => {
1025       'columns' => [
1026         'optionnum', 'serial', '', '', '', '', 
1027         'pkgnum', 'int', '', '', '', '', 
1028         'optionname', 'varchar', '', $char_d, '', '', 
1029         'optionvalue', 'text', 'NULL', '', '', '', 
1030       ],
1031       'primary_key' => 'optionnum',
1032       'unique'      => [],
1033       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
1034     },
1035
1036     'cust_pkg_detail' => {
1037       'columns' => [
1038         'pkgdetailnum', 'serial', '',      '', '', '',
1039         'pkgnum',          'int', '',      '', '', '',
1040         'detail',      'varchar', '', $char_d, '', '', 
1041         'detailtype',     'char', '',       1, '', '', # "I"nvoice or "C"omment
1042         'weight',          'int', '',      '', '', '',
1043       ],
1044       'primary_key' => 'pkgdetailnum',
1045       'unique' => [],
1046       'index'  => [ [ 'pkgnum', 'detailtype' ] ],
1047     },
1048
1049     'cust_pkg_reason' => {
1050       'columns' => [
1051         'num',      'serial',    '',   '', '', '', 
1052         'pkgnum',   'int',    '',   '', '', '', 
1053         'reasonnum','int',    '',   '', '', '', 
1054         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
1055         'otaker',   'varchar', '', 32, '', '', 
1056         'date',     @date_type, '', '', 
1057       ],
1058       'primary_key' => 'num',
1059       'unique' => [],
1060       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], ],
1061     },
1062
1063     'cust_refund' => {
1064       'columns' => [
1065         'refundnum',    'serial',    '',   '', '', '', 
1066         'custnum',  'int',    '',   '', '', '', 
1067         '_date',        @date_type, '', '', 
1068         'refund',       @money_type, '', '', 
1069         'otaker',       'varchar',   '',   32, '', '', 
1070         'reason',       'varchar',   '',   $char_d, '', '', 
1071         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
1072                                                      # be index into payby
1073                                                      # table eventually
1074         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
1075         'paymask', 'varchar', 'NULL', $char_d, '', '', 
1076         'paybatch',     'varchar',   'NULL', $char_d, '', '', 
1077         'closed',    'char', 'NULL', 1, '', '', 
1078       ],
1079       'primary_key' => 'refundnum',
1080       'unique' => [],
1081       'index' => [ ['custnum'], ['_date'] ],
1082     },
1083
1084     'cust_credit_refund' => {
1085       'columns' => [
1086         'creditrefundnum', 'serial',     '',   '', '', '', 
1087         'crednum',  'int',     '',   '', '', '', 
1088         'refundnum',  'int',     '',   '', '', '', 
1089         'amount',  @money_type, '', '', 
1090         '_date',   @date_type, '', '', 
1091       ],
1092       'primary_key' => 'creditrefundnum',
1093       'unique' => [],
1094       'index' => [ ['crednum'], ['refundnum'] ],
1095     },
1096
1097
1098     'cust_svc' => {
1099       'columns' => [
1100         'svcnum',    'serial',    '',   '', '', '', 
1101         'pkgnum',    'int',    'NULL',   '', '', '', 
1102         'svcpart',   'int',    '',   '', '', '', 
1103         'overlimit', @date_type, '', '', 
1104       ],
1105       'primary_key' => 'svcnum',
1106       'unique' => [],
1107       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1108     },
1109
1110     'cust_svc_option' => {
1111       'columns' => [
1112         'optionnum',   'serial', '', '', '', '', 
1113         'svcnum',      'int', '', '', '', '', 
1114         'optionname',  'varchar', '', $char_d, '', '', 
1115         'optionvalue', 'text', 'NULL', '', '', '', 
1116       ],
1117       'primary_key' => 'optionnum',
1118       'unique'      => [],
1119       'index'       => [ [ 'svcnum' ], [ 'optionname' ] ],
1120     },
1121
1122     'part_pkg' => {
1123       'columns' => [
1124         'pkgpart',       'serial',    '',   '', '', '', 
1125         'pkg',           'varchar',   '',   $char_d, '', '', 
1126         'comment',       'varchar',   '',   $char_d, '', '', 
1127         'promo_code',    'varchar', 'NULL', $char_d, '', '', 
1128         'setup',         @perl_type, '', '', 
1129         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
1130         'recur',         @perl_type, '', '', 
1131         'setuptax',      'char', 'NULL', 1, '', '', 
1132         'recurtax',      'char', 'NULL', 1, '', '', 
1133         'plan',          'varchar', 'NULL', $char_d, '', '', 
1134         'plandata',      'text', 'NULL', '', '', '', 
1135         'disabled',      'char', 'NULL', 1, '', '', 
1136         'taxclass',      'varchar', 'NULL', $char_d, '', '', 
1137         'classnum',      'int',     'NULL', '', '', '', 
1138         'taxproductnum', 'int',     'NULL', '', '', '', 
1139         'pay_weight',    'real',    'NULL', '', '', '',
1140         'credit_weight', 'real',    'NULL', '', '', '',
1141         'agentnum',      'int',     'NULL', '', '', '', 
1142
1143       ],
1144       'primary_key' => 'pkgpart',
1145       'unique' => [],
1146       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
1147     },
1148
1149     'part_pkg_link' => {
1150       'columns' => [
1151         'pkglinknum',  'serial',  '',      '', '', '',
1152         'src_pkgpart', 'int',     '',      '', '', '',
1153         'dst_pkgpart', 'int',     '',      '', '', '', 
1154         'link_type',   'varchar', '', $char_d, '', '',
1155       ],
1156       'primary_key' => 'pkglinknum',
1157       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type' ] ],
1158       'index'  => [ [ 'src_pkgpart' ] ],
1159     },
1160
1161     'part_pkg_taxclass' => {
1162       'columns' => [
1163         'taxclassnum',  'serial', '',       '', '', '',
1164         'taxclass',     'varchar', '', $char_d, '', '', 
1165       ],
1166       'primary_key' => 'taxclassnum',
1167       'unique'      => [ [ 'taxclass' ] ],
1168       'index'       => [],
1169     },
1170
1171     'part_pkg_taxproduct' => {
1172       'columns' => [
1173         'taxproductnum', 'serial',      '',        '', '', '',
1174         'data_vendor',   'varchar', 'NULL',   $char_d, '', '', 
1175         'taxproduct',    'varchar',     '',   $char_d, '', '', 
1176         'description',   'varchar',     '', 3*$char_d, '', '', 
1177       ],
1178       'primary_key' => 'taxproductnum',
1179       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
1180       'index'       => [],
1181     },
1182
1183     'part_pkg_taxrate' => { 
1184       'columns' => [
1185         'pkgtaxratenum', 'serial',  '',     '',      '', '',
1186         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
1187         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
1188         'taxproductnum', 'int',  '',     '',       '', '',          
1189         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
1190         'county',           'varchar', 'NULL', $char_d, '', '', 
1191         'state',            'varchar', 'NULL', $char_d, '', '', 
1192         'local',            'varchar', 'NULL', $char_d, '', '', 
1193         'country',          'char',    'NULL', 2,       '', '',
1194         'taxclassnumtaxed', 'int',     'NULL', '',      '', '', 
1195         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '', 
1196         'taxclassnum',      'int',     'NULL', '',      '', '', 
1197         'effdate',          @date_type, '', '', 
1198         'taxable',          'char',    'NULL', 1,       '', '', 
1199       ],
1200       'primary_key' => 'pkgtaxratenum',
1201       'unique' => [],
1202       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1203     },
1204
1205     'part_pkg_taxoverride' => { 
1206       'columns' => [
1207         'taxoverridenum', 'serial', '', '', '', '',
1208         'pkgpart',        'serial', '', '', '', '',
1209         'taxclassnum',    'serial', '', '', '', '',
1210         'usage_class',    'varchar', 'NULL', $char_d, '', '', 
1211       ],
1212       'primary_key' => 'taxoverridenum',
1213       'unique' => [],
1214       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1215     },
1216
1217 #    'part_title' => {
1218 #      'columns' => [
1219 #        'titlenum',   'int',    '',   '',
1220 #        'title',      'varchar',   '',   $char_d,
1221 #      ],
1222 #      'primary_key' => 'titlenum',
1223 #      'unique' => [ [] ],
1224 #      'index' => [ [] ],
1225 #    },
1226
1227     'pkg_svc' => {
1228       'columns' => [
1229         'pkgsvcnum',  'serial', '',  '', '', '', 
1230         'pkgpart',    'int',    '',   '', '', '', 
1231         'svcpart',    'int',    '',   '', '', '', 
1232         'quantity',   'int',    '',   '', '', '', 
1233         'primary_svc','char', 'NULL',  1, '', '', 
1234       ],
1235       'primary_key' => 'pkgsvcnum',
1236       'unique' => [ ['pkgpart', 'svcpart'] ],
1237       'index' => [ ['pkgpart'], ['quantity'] ],
1238     },
1239
1240     'part_referral' => {
1241       'columns' => [
1242         'refnum',   'serial',     '',        '', '', '', 
1243         'referral', 'varchar',    '',   $char_d, '', '', 
1244         'disabled', 'char',   'NULL',         1, '', '', 
1245         'agentnum', 'int',    'NULL',        '', '', '', 
1246       ],
1247       'primary_key' => 'refnum',
1248       'unique' => [],
1249       'index' => [ ['disabled'], ['agentnum'], ],
1250     },
1251
1252     'part_svc' => {
1253       'columns' => [
1254         'svcpart',    'serial',    '',   '', '', '', 
1255         'svc',        'varchar',   '',   $char_d, '', '', 
1256         'svcdb',      'varchar',   '',   $char_d, '', '', 
1257         'disabled',   'char',  'NULL',   1, '', '', 
1258       ],
1259       'primary_key' => 'svcpart',
1260       'unique' => [],
1261       'index' => [ [ 'disabled' ] ],
1262     },
1263
1264     'part_svc_column' => {
1265       'columns' => [
1266         'columnnum',   'serial',         '', '', '', '', 
1267         'svcpart',     'int',         '', '', '', '', 
1268         'columnname',  'varchar',     '', 64, '', '', 
1269         'columnvalue', 'varchar', 'NULL', $char_d, '', '', 
1270         'columnflag',  'char',    'NULL', 1, '', '', 
1271       ],
1272       'primary_key' => 'columnnum',
1273       'unique' => [ [ 'svcpart', 'columnname' ] ],
1274       'index' => [ [ 'svcpart' ] ],
1275     },
1276
1277     #(this should be renamed to part_pop)
1278     'svc_acct_pop' => {
1279       'columns' => [
1280         'popnum',    'serial',    '',   '', '', '', 
1281         'city',      'varchar',   '',   $char_d, '', '', 
1282         'state',     'varchar',   '',   $char_d, '', '', 
1283         'ac',        'char',   '',   3, '', '', 
1284         'exch',      'char',   '',   3, '', '', 
1285         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
1286       ],
1287       'primary_key' => 'popnum',
1288       'unique' => [],
1289       'index' => [ [ 'state' ] ],
1290     },
1291
1292     'part_pop_local' => {
1293       'columns' => [
1294         'localnum',  'serial',     '',     '', '', '', 
1295         'popnum',    'int',     '',     '', '', '', 
1296         'city',      'varchar', 'NULL', $char_d, '', '', 
1297         'state',     'char',    'NULL', 2, '', '', 
1298         'npa',       'char',    '',     3, '', '', 
1299         'nxx',       'char',    '',     3, '', '', 
1300       ],
1301       'primary_key' => 'localnum',
1302       'unique' => [],
1303       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1304     },
1305
1306     'svc_acct' => {
1307       'columns' => [
1308         'svcnum',    'int',    '',   '', '', '', 
1309         'username',  'varchar',   '',   $username_len, '', '',
1310         '_password', 'varchar',   '',  512, '', '',
1311         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1312         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '', 
1313         'popnum',    'int',    'NULL',   '', '', '', 
1314         'uid',       'int', 'NULL',   '', '', '', 
1315         'gid',       'int', 'NULL',   '', '', '', 
1316         'finger',    'varchar',   'NULL',   $char_d, '', '', 
1317         'dir',       'varchar',   'NULL',   $char_d, '', '', 
1318         'shell',     'varchar',   'NULL',   $char_d, '', '', 
1319         'quota',     'varchar',   'NULL',   $char_d, '', '', 
1320         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
1321         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
1322         'seconds_threshold',   'int', 'NULL',   '', '', '',
1323         'upbytes',   'bigint', 'NULL',   '', '', '', 
1324         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
1325         'downbytes', 'bigint', 'NULL',   '', '', '',
1326         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
1327         'totalbytes','bigint', 'NULL',   '', '', '',
1328         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
1329         'domsvc',    'int', '',   '', '', '', 
1330         'last_login',  @date_type, '', '', 
1331         'last_logout', @date_type, '', '', 
1332       ],
1333       'primary_key' => 'svcnum',
1334       #'unique' => [ [ 'username', 'domsvc' ] ],
1335       'unique' => [],
1336       'index' => [ ['username'], ['domsvc'] ],
1337     },
1338
1339     'acct_rt_transaction' => {
1340       'columns' => [
1341         'svcrtid',   'int',    '',   '', '', '', 
1342         'svcnum',    'int',    '',   '', '', '', 
1343         'transaction_id',       'int', '',   '', '', '', 
1344         '_date',   @date_type, '', '',
1345         'seconds',   'int', '',   '', '', '', #uhhhh
1346         'support',   'int', '',   '', '', '',
1347       ],
1348       'primary_key' => 'svcrtid',
1349       'unique' => [],
1350       'index' => [ ['svcnum', 'transaction_id'] ],
1351     },
1352
1353     #'svc_charge' => {
1354     #  'columns' => [
1355     #    'svcnum',    'int',    '',   '',
1356     #    'amount',    @money_type,
1357     #  ],
1358     #  'primary_key' => 'svcnum',
1359     #  'unique' => [ [] ],
1360     #  'index' => [ [] ],
1361     #},
1362
1363     'svc_domain' => {
1364       'columns' => [
1365         'svcnum',           'int',    '',        '', '', '',
1366         'domain',       'varchar',    '',   $char_d, '', '',
1367         'suffix',       'varchar', 'NULL',  $char_d, '', '',
1368         'catchall',         'int', 'NULL',       '', '', '',
1369         'parent_svcnum',    'int', 'NULL',       '', '', '',
1370         'registrarnum',     'int', 'NULL',       '', '', '',
1371         'registrarkey', 'varchar', 'NULL',      512, '', '',
1372         'setup_date',  @date_type, '', '',
1373         'renewal_interval', 'int', 'NULL',       '', '', '',
1374         'expiration_date', @date_type, '', '',
1375       ],
1376       'primary_key' => 'svcnum',
1377       'unique' => [ ],
1378       'index' => [ ['domain'] ],
1379     },
1380
1381     'domain_record' => {
1382       'columns' => [
1383         'recnum',    'serial',     '',  '', '', '', 
1384         'svcnum',    'int',     '',  '', '', '', 
1385         'reczone',   'varchar', '',  255, '', '', 
1386         'recaf',     'char',    '',  2, '', '', 
1387         'rectype',   'varchar',    '',  5, '', '', 
1388         'recdata',   'varchar', '',  255, '', '', 
1389       ],
1390       'primary_key' => 'recnum',
1391       'unique'      => [],
1392       'index'       => [ ['svcnum'] ],
1393     },
1394
1395     'registrar' => {
1396       'columns' => [
1397         'registrarnum',   'serial', '',      '', '', '',
1398         'registrarname', 'varchar', '', $char_d, '', '',
1399       ],
1400       'primary_key' => 'registrarnum',
1401       'unique'      => [],
1402       'index'       => [],
1403     },
1404
1405     'svc_forward' => {
1406       'columns' => [
1407         'svcnum',   'int',            '',   '', '', '', 
1408         'srcsvc',   'int',        'NULL',   '', '', '', 
1409         'src',      'varchar',    'NULL',  255, '', '', 
1410         'dstsvc',   'int',        'NULL',   '', '', '', 
1411         'dst',      'varchar',    'NULL',  255, '', '', 
1412       ],
1413       'primary_key' => 'svcnum',
1414       'unique'      => [],
1415       'index'       => [ ['srcsvc'], ['dstsvc'] ],
1416     },
1417
1418     'svc_www' => {
1419       'columns' => [
1420         'svcnum',   'int',      '',  '', '', '', 
1421         'recnum',   'int',      '',  '', '', '', 
1422         'usersvc',  'int',  'NULL',  '', '', '', 
1423         'config',   'text', 'NULL',  '', '', '', 
1424       ],
1425       'primary_key' => 'svcnum',
1426       'unique'      => [],
1427       'index'       => [],
1428     },
1429
1430     #'svc_wo' => {
1431     #  'columns' => [
1432     #    'svcnum',    'int',    '',   '',
1433     #    'svcnum',    'int',    '',   '',
1434     #    'svcnum',    'int',    '',   '',
1435     #    'worker',    'varchar',   '',   $char_d,
1436     #    '_date',     @date_type,
1437     #  ],
1438     #  'primary_key' => 'svcnum',
1439     #  'unique' => [ [] ],
1440     #  'index' => [ [] ],
1441     #},
1442
1443     'prepay_credit' => {
1444       'columns' => [
1445         'prepaynum',   'serial',     '',   '', '', '', 
1446         'identifier',  'varchar', '', $char_d, '', '', 
1447         'amount',      @money_type, '', '', 
1448         'seconds',     'int',     'NULL', '', '', '', 
1449         'upbytes',     'bigint',     'NULL', '', '', '', 
1450         'downbytes',   'bigint',     'NULL', '', '', '', 
1451         'totalbytes',  'bigint',     'NULL', '', '', '', 
1452         'agentnum',    'int',     'NULL', '', '', '', 
1453       ],
1454       'primary_key' => 'prepaynum',
1455       'unique'      => [ ['identifier'] ],
1456       'index'       => [],
1457     },
1458
1459     'port' => {
1460       'columns' => [
1461         'portnum',  'serial',     '',   '', '', '', 
1462         'ip',       'varchar', 'NULL', 15, '', '', 
1463         'nasport',  'int',     'NULL', '', '', '', 
1464         'nasnum',   'int',     '',   '', '', '', 
1465       ],
1466       'primary_key' => 'portnum',
1467       'unique'      => [],
1468       'index'       => [],
1469     },
1470
1471     'nas' => {
1472       'columns' => [
1473         'nasnum',   'serial',     '',    '', '', '', 
1474         'nas',      'varchar', '',    $char_d, '', '', 
1475         'nasip',    'varchar', '',    15, '', '', 
1476         'nasfqdn',  'varchar', '',    $char_d, '', '', 
1477         'last',     'int',     '',    '', '', '', 
1478       ],
1479       'primary_key' => 'nasnum',
1480       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
1481       'index'       => [ [ 'last' ] ],
1482     },
1483
1484 #    'session' => {
1485 #      'columns' => [
1486 #        'sessionnum', 'serial',       '',   '', '', '', 
1487 #        'portnum',    'int',       '',   '', '', '', 
1488 #        'svcnum',     'int',       '',   '', '', '', 
1489 #        'login',      @date_type, '', '', 
1490 #        'logout',     @date_type, '', '', 
1491 #      ],
1492 #      'primary_key' => 'sessionnum',
1493 #      'unique'      => [],
1494 #      'index'       => [ [ 'portnum' ] ],
1495 #    },
1496
1497     'queue' => {
1498       'columns' => [
1499         'jobnum',      'serial',     '',      '', '', '', 
1500         'job',           'text',     '',      '', '', '', 
1501         '_date',          'int',     '',      '', '', '', 
1502         'status',     'varchar',     '', $char_d, '', '', 
1503         'statustext',    'text', 'NULL',      '', '', '', 
1504         'svcnum',         'int', 'NULL',      '', '', '', 
1505         'custnum',        'int', 'NULL',      '', '', '',
1506         'secure',        'char', 'NULL',       1, '', '',
1507       ],
1508       'primary_key' => 'jobnum',
1509       'unique'      => [],
1510       'index'       => [ [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ] ],
1511     },
1512
1513     'queue_arg' => {
1514       'columns' => [
1515         'argnum', 'serial', '', '', '', '', 
1516         'jobnum', 'int', '', '', '', '', 
1517         'arg', 'text', 'NULL', '', '', '', 
1518       ],
1519       'primary_key' => 'argnum',
1520       'unique'      => [],
1521       'index'       => [ [ 'jobnum' ] ],
1522     },
1523
1524     'queue_depend' => {
1525       'columns' => [
1526         'dependnum', 'serial', '', '', '', '', 
1527         'jobnum', 'int', '', '', '', '', 
1528         'depend_jobnum', 'int', '', '', '', '', 
1529       ],
1530       'primary_key' => 'dependnum',
1531       'unique'      => [],
1532       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1533     },
1534
1535     'export_svc' => {
1536       'columns' => [
1537         'exportsvcnum' => 'serial', '', '', '', '', 
1538         'exportnum'    => 'int', '', '', '', '', 
1539         'svcpart'      => 'int', '', '', '', '', 
1540       ],
1541       'primary_key' => 'exportsvcnum',
1542       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
1543       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
1544     },
1545
1546     'part_export' => {
1547       'columns' => [
1548         'exportnum', 'serial', '', '', '', '', 
1549         'machine', 'varchar', '', $char_d, '', '', 
1550         'exporttype', 'varchar', '', $char_d, '', '', 
1551         'nodomain',     'char', 'NULL', 1, '', '', 
1552       ],
1553       'primary_key' => 'exportnum',
1554       'unique'      => [],
1555       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
1556     },
1557
1558     'part_export_option' => {
1559       'columns' => [
1560         'optionnum', 'serial', '', '', '', '', 
1561         'exportnum', 'int', '', '', '', '', 
1562         'optionname', 'varchar', '', $char_d, '', '', 
1563         'optionvalue', 'text', 'NULL', '', '', '', 
1564       ],
1565       'primary_key' => 'optionnum',
1566       'unique'      => [],
1567       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
1568     },
1569
1570     'radius_usergroup' => {
1571       'columns' => [
1572         'usergroupnum', 'serial', '', '', '', '', 
1573         'svcnum',       'int', '', '', '', '', 
1574         'groupname',    'varchar', '', $char_d, '', '', 
1575       ],
1576       'primary_key' => 'usergroupnum',
1577       'unique'      => [],
1578       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
1579     },
1580
1581     'msgcat' => {
1582       'columns' => [
1583         'msgnum', 'serial', '', '', '', '', 
1584         'msgcode', 'varchar', '', $char_d, '', '', 
1585         'locale', 'varchar', '', 16, '', '', 
1586         'msg', 'text', '', '', '', '', 
1587       ],
1588       'primary_key' => 'msgnum',
1589       'unique'      => [ [ 'msgcode', 'locale' ] ],
1590       'index'       => [],
1591     },
1592
1593     'cust_tax_exempt' => {
1594       'columns' => [
1595         'exemptnum', 'serial', '', '', '', '', 
1596         'custnum',   'int', '', '', '', '', 
1597         'taxnum',    'int', '', '', '', '', 
1598         'year',      'int', '', '', '', '', 
1599         'month',     'int', '', '', '', '', 
1600         'amount',   @money_type, '', '', 
1601       ],
1602       'primary_key' => 'exemptnum',
1603       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1604       'index'       => [],
1605     },
1606
1607     'cust_tax_exempt_pkg' => {
1608       'columns' => [
1609         'exemptpkgnum',  'serial', '', '', '', '', 
1610         #'custnum',      'int', '', '', '', ''
1611         'billpkgnum',   'int', '', '', '', '', 
1612         'taxnum',       'int', '', '', '', '', 
1613         'year',         'int', '', '', '', '', 
1614         'month',        'int', '', '', '', '', 
1615         'amount',       @money_type, '', '', 
1616       ],
1617       'primary_key' => 'exemptpkgnum',
1618       'unique' => [],
1619       'index'  => [ [ 'taxnum', 'year', 'month' ],
1620                     [ 'billpkgnum' ],
1621                     [ 'taxnum' ]
1622                   ],
1623     },
1624
1625     'router' => {
1626       'columns' => [
1627         'routernum', 'serial', '', '', '', '', 
1628         'routername', 'varchar', '', $char_d, '', '', 
1629         'svcnum', 'int', 'NULL', '', '', '', 
1630         'agentnum',   'int', 'NULL', '', '', '', 
1631       ],
1632       'primary_key' => 'routernum',
1633       'unique'      => [],
1634       'index'       => [],
1635     },
1636
1637     'part_svc_router' => {
1638       'columns' => [
1639         'svcrouternum', 'serial', '', '', '', '', 
1640         'svcpart', 'int', '', '', '', '', 
1641         'routernum', 'int', '', '', '', '', 
1642       ],
1643       'primary_key' => 'svcrouternum',
1644       'unique'      => [],
1645       'index'       => [],
1646     },
1647
1648     'addr_block' => {
1649       'columns' => [
1650         'blocknum', 'serial', '', '', '', '', 
1651         'routernum', 'int', '', '', '', '', 
1652         'ip_gateway', 'varchar', '', 15, '', '', 
1653         'ip_netmask', 'int', '', '', '', '', 
1654         'agentnum',   'int', 'NULL', '', '', '', 
1655         'manual_flag', 'char', 'NULL', 1, '', '', 
1656       ],
1657       'primary_key' => 'blocknum',
1658       'unique'      => [ [ 'blocknum', 'routernum' ] ],
1659       'index'       => [],
1660     },
1661
1662     'svc_broadband' => {
1663       'columns' => [
1664         'svcnum', 'int', '', '', '', '', 
1665         'description', 'varchar', 'NULL', $char_d, '', '', 
1666         'blocknum', 'int', '', '', '', '', 
1667         'speed_up', 'int', '', '', '', '', 
1668         'speed_down', 'int', '', '', '', '', 
1669         'ip_addr', 'varchar', '', 15, '', '', 
1670         'mac_addr', 'varchar', 'NULL', 12, '', '', 
1671         'authkey',  'varchar', 'NULL', 32, '', '', 
1672         'latitude', 'decimal', 'NULL', '', '', '', 
1673         'longitude', 'decimal', 'NULL', '', '', '', 
1674         'altitude', 'decimal', 'NULL', '', '', '', 
1675         'vlan_profile', 'varchar', 'NULL', $char_d, '', '', 
1676         'performance_profile', 'varchar', 'NULL', $char_d, '', '',
1677       ],
1678       'primary_key' => 'svcnum',
1679       'unique'      => [ [ 'mac_addr' ] ],
1680       'index'       => [],
1681     },
1682
1683     'part_virtual_field' => {
1684       'columns' => [
1685         'vfieldpart', 'serial', '', '', '', '', 
1686         'dbtable', 'varchar', '', 32, '', '', 
1687         'name', 'varchar', '', 32, '', '', 
1688         'check_block', 'text', 'NULL', '', '', '', 
1689         'length', 'int', 'NULL', '', '', '', 
1690         'list_source', 'text', 'NULL', '', '', '', 
1691         'label', 'varchar', 'NULL', 80, '', '', 
1692       ],
1693       'primary_key' => 'vfieldpart',
1694       'unique' => [],
1695       'index' => [],
1696     },
1697
1698     'virtual_field' => {
1699       'columns' => [
1700         'vfieldnum', 'serial', '', '', '', '', 
1701         'recnum', 'int', '', '', '', '', 
1702         'vfieldpart', 'int', '', '', '', '', 
1703         'value', 'varchar', '', 128, '', '', 
1704       ],
1705       'primary_key' => 'vfieldnum',
1706       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1707       'index' => [],
1708     },
1709
1710     'acct_snarf' => {
1711       'columns' => [
1712         'snarfnum',  'int', '', '', '', '', 
1713         'svcnum',    'int', '', '', '', '', 
1714         'machine',   'varchar', '', 255, '', '', 
1715         'protocol',  'varchar', '', $char_d, '', '', 
1716         'username',  'varchar', '', $char_d, '', '', 
1717         '_password', 'varchar', '', $char_d, '', '', 
1718       ],
1719       'primary_key' => 'snarfnum',
1720       'unique' => [],
1721       'index'  => [ [ 'svcnum' ] ],
1722     },
1723
1724     'svc_external' => {
1725       'columns' => [
1726         'svcnum', 'int', '', '', '', '', 
1727         'id',     'int', 'NULL', '', '', '', 
1728         'title',  'varchar', 'NULL', $char_d, '', '', 
1729       ],
1730       'primary_key' => 'svcnum',
1731       'unique'      => [],
1732       'index'       => [],
1733     },
1734
1735     'cust_pay_refund' => {
1736       'columns' => [
1737         'payrefundnum', 'serial', '', '', '', '', 
1738         'paynum',  'int', '', '', '', '', 
1739         'refundnum',  'int', '', '', '', '', 
1740         '_date',    @date_type, '', '', 
1741         'amount',   @money_type, '', '', 
1742       ],
1743       'primary_key' => 'payrefundnum',
1744       'unique' => [],
1745       'index' => [ ['paynum'], ['refundnum'] ],
1746     },
1747
1748     'part_pkg_option' => {
1749       'columns' => [
1750         'optionnum', 'serial', '', '', '', '', 
1751         'pkgpart', 'int', '', '', '', '', 
1752         'optionname', 'varchar', '', $char_d, '', '', 
1753         'optionvalue', 'text', 'NULL', '', '', '', 
1754       ],
1755       'primary_key' => 'optionnum',
1756       'unique'      => [],
1757       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
1758     },
1759
1760     'rate' => {
1761       'columns' => [
1762         'ratenum',  'serial', '', '', '', '', 
1763         'ratename', 'varchar', '', $char_d, '', '', 
1764       ],
1765       'primary_key' => 'ratenum',
1766       'unique'      => [],
1767       'index'       => [],
1768     },
1769
1770     'rate_detail' => {
1771       'columns' => [
1772         'ratedetailnum',   'serial', '', '', '', '', 
1773         'ratenum',         'int',     '', '', '', '', 
1774         'orig_regionnum',  'int', 'NULL', '', '', '', 
1775         'dest_regionnum',  'int',     '', '', '', '', 
1776         'min_included',    'int',     '', '', '', '', 
1777         #'min_charge',      @money_type, '', '', 
1778         'min_charge',      'decimal', '', '10,5', '', '', 
1779         'sec_granularity', 'int',     '', '', '', '', 
1780         #time period (link to table of periods)?
1781         'classnum',        'int',     'NULL', '', '', '', 
1782       ],
1783       'primary_key' => 'ratedetailnum',
1784       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1785       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
1786     },
1787
1788     'rate_region' => {
1789       'columns' => [
1790         'regionnum',   'serial',      '', '', '', '', 
1791         'regionname',  'varchar',     '', $char_d, '', '', 
1792       ],
1793       'primary_key' => 'regionnum',
1794       'unique'      => [],
1795       'index'       => [],
1796     },
1797
1798     'rate_prefix' => {
1799       'columns' => [
1800         'prefixnum',   'serial',      '', '', '', '', 
1801         'regionnum',   'int',         '', '', '', '', 
1802         'countrycode', 'varchar',     '',  3, '', '', 
1803         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
1804         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
1805       ],
1806       'primary_key' => 'prefixnum',
1807       'unique'      => [],
1808       'index'       => [ [ 'countrycode' ], [ 'regionnum' ] ],
1809     },
1810
1811     'usage_class' => {
1812       'columns' => [
1813         'classnum',    'serial',   '',      '', '', '', 
1814         'classname',   'varchar',  '', $char_d, '', '', 
1815         'disabled',    'char', 'NULL',       1, '', '', 
1816       ],
1817       'primary_key' => 'classnum',
1818       'unique' => [],
1819       'index' => [ ['disabled'] ],
1820     },
1821
1822     'reg_code' => {
1823       'columns' => [
1824         'codenum',   'serial',    '', '', '', '', 
1825         'code',      'varchar',   '', $char_d, '', '', 
1826         'agentnum',  'int',       '', '', '', '', 
1827       ],
1828       'primary_key' => 'codenum',
1829       'unique'      => [ [ 'agentnum', 'code' ] ],
1830       'index'       => [ [ 'agentnum' ] ],
1831     },
1832
1833     'reg_code_pkg' => {
1834       'columns' => [
1835         'codepkgnum', 'serial', '', '', '', '', 
1836         'codenum',   'int',    '', '', '', '', 
1837         'pkgpart',   'int',    '', '', '', '', 
1838       ],
1839       'primary_key' => 'codepkgnum',
1840       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
1841       'index'       => [ [ 'codenum' ] ],
1842     },
1843
1844     'clientapi_session' => {
1845       'columns' => [
1846         'sessionnum',  'serial',  '', '', '', '', 
1847         'sessionid',  'varchar',  '', $char_d, '', '', 
1848         'namespace',  'varchar',  '', $char_d, '', '', 
1849       ],
1850       'primary_key' => 'sessionnum',
1851       'unique'      => [ [ 'sessionid', 'namespace' ] ],
1852       'index'       => [],
1853     },
1854
1855     'clientapi_session_field' => {
1856       'columns' => [
1857         'fieldnum',    'serial',     '', '', '', '', 
1858         'sessionnum',     'int',     '', '', '', '', 
1859         'fieldname',  'varchar',     '', $char_d, '', '', 
1860         'fieldvalue',    'text', 'NULL', '', '', '', 
1861       ],
1862       'primary_key' => 'fieldnum',
1863       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
1864       'index'       => [],
1865     },
1866
1867     'payment_gateway' => {
1868       'columns' => [
1869         'gatewaynum',       'serial',   '',     '', '', '', 
1870         'gateway_namespace','varchar',  'NULL', $char_d, '', '', 
1871         'gateway_module',   'varchar',  '',     $char_d, '', '', 
1872         'gateway_username', 'varchar',  'NULL', $char_d, '', '', 
1873         'gateway_password', 'varchar',  'NULL', $char_d, '', '', 
1874         'gateway_action',   'varchar',  'NULL', $char_d, '', '', 
1875         'gateway_callback_url', 'varchar',  'NULL', $char_d, '', '', 
1876         'disabled',   'char',  'NULL',   1, '', '', 
1877       ],
1878       'primary_key' => 'gatewaynum',
1879       'unique' => [],
1880       'index'  => [ [ 'disabled' ] ],
1881     },
1882
1883     'payment_gateway_option' => {
1884       'columns' => [
1885         'optionnum',   'serial',  '',     '', '', '', 
1886         'gatewaynum',  'int',     '',     '', '', '', 
1887         'optionname',  'varchar', '',     $char_d, '', '', 
1888         'optionvalue', 'text',    'NULL', '', '', '', 
1889       ],
1890       'primary_key' => 'optionnum',
1891       'unique'      => [],
1892       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1893     },
1894
1895     'agent_payment_gateway' => {
1896       'columns' => [
1897         'agentgatewaynum', 'serial', '', '', '', '', 
1898         'agentnum',        'int', '', '', '', '', 
1899         'gatewaynum',      'int', '', '', '', '', 
1900         'cardtype',        'varchar', 'NULL', $char_d, '', '', 
1901         'taxclass',        'varchar', 'NULL', $char_d, '', '', 
1902       ],
1903       'primary_key' => 'agentgatewaynum',
1904       'unique'      => [],
1905       'index'       => [ [ 'agentnum', 'cardtype' ], ],
1906     },
1907
1908     'banned_pay' => {
1909       'columns' => [
1910         'bannum',  'serial',   '',     '', '', '', 
1911         'payby',   'char',     '',       4, '', '', 
1912         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
1913         #'paymask', 'varchar',  'NULL', $char_d, '', ''
1914         '_date',   @date_type, '', '', 
1915         'otaker',  'varchar',  '',     32, '', '', 
1916         'reason',  'varchar',  'NULL', $char_d, '', '', 
1917       ],
1918       'primary_key' => 'bannum',
1919       'unique'      => [ [ 'payby', 'payinfo' ] ],
1920       'index'       => [],
1921     },
1922
1923     'pkg_category' => {
1924       'columns' => [
1925         'categorynum',   'serial',  '', '', '', '', 
1926         'categoryname',  'varchar', '', $char_d, '', '', 
1927         'disabled',      'char', 'NULL',   1, '', '', 
1928       ],
1929       'primary_key' => 'categorynum',
1930       'unique' => [],
1931       'index' => [ ['disabled'] ],
1932     },
1933
1934     'pkg_class' => {
1935       'columns' => [
1936         'classnum',    'serial',   '',      '', '', '', 
1937         'classname',   'varchar',  '', $char_d, '', '', 
1938         'categorynum', 'int',  'NULL',      '', '', '', 
1939         'disabled',    'char', 'NULL',       1, '', '', 
1940       ],
1941       'primary_key' => 'classnum',
1942       'unique' => [],
1943       'index' => [ ['disabled'] ],
1944     },
1945
1946     'cdr' => {
1947       'columns' => [
1948         # qw( name type null length default local );
1949
1950         ###
1951         #asterisk fields
1952         ###
1953
1954         'acctid',   'bigserial',  '', '', '', '', 
1955         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1956         'calldate', 'timestamp',   '',      '', \'now()', '',
1957         'clid',        'varchar',  '', $char_d, \"''", '', 
1958         'src',         'varchar',  '', $char_d, \"''", '', 
1959         'dst',         'varchar',  '', $char_d, \"''", '', 
1960         'dcontext',    'varchar',  '', $char_d, \"''", '', 
1961         'channel',     'varchar',  '', $char_d, \"''", '', 
1962         'dstchannel',  'varchar',  '', $char_d, \"''", '', 
1963         'lastapp',     'varchar',  '', $char_d, \"''", '', 
1964         'lastdata',    'varchar',  '', $char_d, \"''", '', 
1965
1966         #these don't seem to be logged by most of the SQL cdr_* modules
1967         #except tds under sql-illegal names, so;
1968         # ... don't rely on them for rating?
1969         # and, what they hey, i went ahead and changed the names and data types
1970         # to freeside-style dates...
1971           #'start',  'timestamp', 'NULL',  '',    '', '',
1972           #'answer', 'timestamp', 'NULL',  '',    '', '',
1973           #'end',    'timestamp', 'NULL',  '',    '', '',
1974         'startdate',  @date_type, '', '', 
1975         'answerdate', @date_type, '', '', 
1976         'enddate',    @date_type, '', '', 
1977         #
1978
1979         'duration',    'int',      '',      '',     0, '',
1980         'billsec',     'int',      '',      '',     0, '', 
1981         'disposition', 'varchar',  '',      45, \"''", '',
1982         'amaflags',    'int',      '',      '',     0, '',
1983         'accountcode', 'varchar',  '',      20, \"''", '',
1984         'uniqueid',    'varchar',  '',      32, \"''", '',
1985         'userfield',   'varchar',  '',     255, \"''", '',
1986
1987         ###
1988         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1989         # defaults
1990         ###
1991
1992         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1993         'cdrtypenum',              'int', 'NULL',      '', '', '',
1994
1995         'charged_party',       'varchar', 'NULL', $char_d, '', '',
1996
1997         'upstream_currency',      'char', 'NULL',       3, '', '',
1998         'upstream_price',      'decimal', 'NULL',  '10,2', '', '', 
1999         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
2000
2001         # how it was rated internally...
2002         'ratedetailnum',           'int', 'NULL',      '', '', '',
2003         'rated_price',         'decimal', 'NULL',  '10,2', '', '',
2004
2005         'distance',            'decimal', 'NULL',      '', '', '',
2006         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
2007
2008         #cdr_calltype: the big list in appendix 2
2009         'calltypenum',             'int', 'NULL',      '', '', '',
2010
2011         'description',         'varchar', 'NULL', $char_d, '', '',
2012         'quantity',                'int', 'NULL',      '', '', '', 
2013
2014         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
2015         'carrierid',               'int', 'NULL',      '', '', '',
2016
2017         'upstream_rateid',         'int', 'NULL',      '', '', '',
2018         
2019         ###
2020         #and now for our own fields
2021         ###
2022
2023         # a svcnum... right..?
2024         'svcnum',             'int',   'NULL',     '',   '', '', 
2025
2026         #NULL, done (or something)
2027         'freesidestatus', 'varchar',   'NULL',     32,   '', '', 
2028
2029         #NULL, done (or something)
2030         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '', 
2031
2032         'cdrbatch', 'varchar', 'NULL', $char_d, '', '',
2033
2034       ],
2035       'primary_key' => 'acctid',
2036       'unique' => [],
2037       'index' => [ [ 'calldate' ], [ 'src' ], [ 'dst' ], [ 'charged_party' ], [ 'accountcode' ], [ 'freesidestatus' ], [ 'freesiderewritestatus' ], [ 'cdrbatch' ], ],
2038     },
2039
2040     'cdr_calltype' => {
2041       'columns' => [
2042         'calltypenum',   'serial',  '', '', '', '', 
2043         'calltypename',  'varchar', '', $char_d, '', '', 
2044       ],
2045       'primary_key' => 'calltypenum',
2046       'unique'      => [],
2047       'index'       => [],
2048     },
2049
2050     'cdr_type' => {
2051       'columns' => [
2052         'cdrtypenum'  => 'serial',  '', '', '', '',
2053         'cdrtypename' => 'varchar', '', $char_d, '', '',
2054       ],
2055       'primary_key' => 'cdrtypenum',
2056       'unique'      => [],
2057       'index'       => [],
2058     },
2059
2060     'cdr_carrier' => {
2061       'columns' => [
2062         'carrierid'   => 'serial',  '', '', '', '',
2063         'carriername' => 'varchar', '', $char_d, '', '',
2064       ],
2065       'primary_key' => 'carrierid',
2066       'unique'      => [],
2067       'index'       => [],
2068     },
2069
2070     #map upstream rateid to ours...
2071     'cdr_upstream_rate' => {
2072       'columns' => [
2073         'upstreamratenum', 'serial',  '', '', '', '',
2074         'upstream_rateid', 'varchar', '', $char_d, '', '', 
2075         'ratedetailnum',   'int', 'NULL', '', '', '',
2076       ],
2077       'primary_key' => 'upstreamratenum', #XXX need a primary key
2078       'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
2079       'index'  => [],
2080     },
2081
2082     #'cdr_file' => {
2083     #  'columns' => [
2084     #    'filenum',    'serial',     '', '', '', '',
2085     #    'filename',  'varchar',     '', '', '', '',
2086     #    'status',    'varchar', 'NULL', '', '', '',
2087     #  ],
2088     #  'primary_key' => 'filenum',
2089     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
2090     #                                   # agent-virtualize or have a customer
2091     #                                   # with dup-filename needs or something
2092     #                                   # (only used by cdr.http_and_import for
2093     #                                   #  chrissakes)
2094     #  'index'  => [],
2095     #},
2096
2097     'inventory_item' => {
2098       'columns' => [
2099         'itemnum',  'serial',      '',      '', '', '',
2100         'classnum', 'int',         '',      '', '', '',
2101         'item',     'varchar',     '', $char_d, '', '',
2102         'svcnum',   'int',     'NULL',      '', '', '',
2103       ],
2104       'primary_key' => 'itemnum',
2105       'unique' => [ [ 'classnum', 'item' ] ],
2106       'index'  => [ [ 'classnum' ], [ 'svcnum' ] ],
2107     },
2108
2109     'inventory_class' => {
2110       'columns' => [
2111         'classnum',  'serial',       '',      '', '', '',
2112         'classname', 'varchar',      '', $char_d, '', '',
2113       ],
2114       'primary_key' => 'classnum',
2115       'unique' => [],
2116       'index'  => [],
2117     },
2118
2119     'access_user' => {
2120       'columns' => [
2121         'usernum',   'serial',  '',      '', '', '',
2122         'username',  'varchar', '', $char_d, '', '',
2123         '_password', 'varchar', '', $char_d, '', '',
2124         'last',      'varchar', '', $char_d, '', '', 
2125         'first',     'varchar', '', $char_d, '', '', 
2126         'disabled',     'char', 'NULL',   1, '', '', 
2127       ],
2128       'primary_key' => 'usernum',
2129       'unique' => [ [ 'username' ] ],
2130       'index'  => [],
2131     },
2132
2133     'access_user_pref' => {
2134       'columns' => [
2135         'prefnum',    'serial',       '', '', '', '',
2136         'usernum',     'int',       '', '', '', '',
2137         'prefname', 'varchar', '', $char_d, '', '', 
2138         'prefvalue', 'text', 'NULL', '', '', '', 
2139         'expiration', @date_type, '', '',
2140       ],
2141       'primary_key' => 'prefnum',
2142       'unique' => [],
2143       'index'  => [ [ 'usernum' ] ],
2144     },
2145
2146     'access_group' => {
2147       'columns' => [
2148         'groupnum',   'serial', '',      '', '', '',
2149         'groupname', 'varchar', '', $char_d, '', '',
2150       ],
2151       'primary_key' => 'groupnum',
2152       'unique' => [ [ 'groupname' ] ],
2153       'index'  => [],
2154     },
2155
2156     'access_usergroup' => {
2157       'columns' => [
2158         'usergroupnum', 'serial', '', '', '', '',
2159         'usernum',         'int', '', '', '', '',
2160         'groupnum',        'int', '', '', '', '',
2161       ],
2162       'primary_key' => 'usergroupnum',
2163       'unique' => [ [ 'usernum', 'groupnum' ] ],
2164       'index'  => [ [ 'usernum' ] ],
2165     },
2166
2167     'access_groupagent' => {
2168       'columns' => [
2169         'groupagentnum', 'serial', '', '', '', '',
2170         'groupnum',         'int', '', '', '', '',
2171         'agentnum',         'int', '', '', '', '',
2172       ],
2173       'primary_key' => 'groupagentnum',
2174       'unique' => [ [ 'groupnum', 'agentnum' ] ],
2175       'index'  => [ [ 'groupnum' ] ],
2176     },
2177
2178     'access_right' => {
2179       'columns' => [
2180         'rightnum',   'serial', '',      '', '', '',
2181         'righttype', 'varchar', '', $char_d, '', '',
2182         'rightobjnum',   'int', '',      '', '', '',
2183         'rightname', 'varchar', '', $char_d, '', '',
2184       ],
2185       'primary_key' => 'rightnum',
2186       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2187       'index'  => [],
2188     },
2189
2190     'svc_phone' => {
2191       'columns' => [
2192         'svcnum',       'int',         '',      '', '', '', 
2193         'countrycode',  'varchar',     '',       3, '', '', 
2194         'phonenum',     'varchar',     '',      15, '', '',  #12 ?
2195         'pin',          'varchar', 'NULL', $char_d, '', '',
2196         'sip_password', 'varchar', 'NULL', $char_d, '', '',
2197         'phone_name',   'varchar', 'NULL', $char_d, '', '',
2198       ],
2199       'primary_key' => 'svcnum',
2200       'unique' => [],
2201       'index'  => [ [ 'countrycode', 'phonenum' ] ],
2202     },
2203
2204     'phone_avail' => {
2205       'columns' => [
2206         'availnum',    'serial',      '',      '', '', '', 
2207         'exportnum',   'int',         '',      '', '', '', 
2208         'countrycode', 'varchar',     '',       3, '', '', 
2209         'state',       'char',    'NULL',       2, '', '', 
2210         'npa',         'char',        '',       3, '', '', 
2211         'nxx',         'char',    'NULL',       3, '', '', 
2212         'station',     'char',    'NULL',       4, '', '',
2213         'name',        'varchar', 'NULL', $char_d, '', '',
2214         'svcnum',      'int',     'NULL',      '', '', '',
2215         'availbatch', 'varchar',  'NULL', $char_d, '', '',
2216       ],
2217       'primary_key' => 'availnum',
2218       'unique' => [],
2219       'index'  => [ [ 'exportnum', 'countrycode', 'state' ],     #npa search
2220                     [ 'exportnum', 'countrycode', 'npa' ],       #nxx search
2221                     [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
2222                     [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
2223                     [ 'svcnum' ],
2224                     [ 'availbatch' ],
2225                   ],
2226     },
2227
2228     'reason_type' => {
2229       'columns' => [
2230         'typenum',   'serial',  '', '', '', '', 
2231         'class',     'char', '', 1, '', '', 
2232         'type',     'varchar', '', $char_d, '', '', 
2233       ],
2234       'primary_key' => 'typenum',
2235       'unique' => [],
2236       'index' => [],
2237     },
2238
2239     'reason' => {
2240       'columns' => [
2241         'reasonnum',     'serial',  '', '', '', '', 
2242         'reason_type',   'int',  '', '', '', '', 
2243         'reason',        'text', '', '', '', '', 
2244         'disabled',      'char',    'NULL', 1, '', '', 
2245       ],
2246       'primary_key' => 'reasonnum',
2247       'unique' => [],
2248       'index' => [],
2249     },
2250
2251     'conf' => {
2252       'columns' => [
2253         'confnum',  'serial',  '', '', '', '', 
2254         'agentnum', 'int',  'NULL', '', '', '', 
2255         'name',     'varchar', '', $char_d, '', '', 
2256         'value',    'text', 'NULL', '', '', '',
2257       ],
2258       'primary_key' => 'confnum',
2259       'unique' => [ [ 'agentnum', 'name' ]],
2260       'index' => [],
2261     },
2262
2263     'pkg_referral' => {
2264       'columns' => [
2265         'pkgrefnum',     'serial', '', '', '', '',
2266         'pkgnum',        'int',    '', '', '', '',
2267         'refnum',        'int',    '', '', '', '',
2268       ],
2269       'primary_key' => 'pkgrefnum',
2270       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
2271       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
2272     },
2273     # name type nullability length default local
2274
2275     #'new_table' => {
2276     #  'columns' => [
2277     #    'num', 'serial',       '', '', '', '',
2278     #  ],
2279     #  'primary_key' => 'num',
2280     #  'unique' => [],
2281     #  'index'  => [],
2282     #},
2283
2284   };
2285
2286 }
2287
2288 =back
2289
2290 =head1 BUGS
2291
2292 =head1 SEE ALSO
2293
2294 L<DBIx::DBSchema>
2295
2296 =cut
2297
2298 1;
2299