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 use FS::UID qw(datasrc);
  11
  12 @ISA = qw(Exporter);
  13 @EXPORT_OK = qw( dbdef dbdef_dist reload_dbdef );
  14
  15 $DEBUG = 0;
  16 $me = '[FS::Schema]';
  17
  18 =head1 NAME
  19
  20 FS::Schema - Freeside database schema
  21
  22 =head1 SYNOPSYS
  23
  24     use FS::Schema qw(dbdef dbdef_dist reload_dbdef);
  25
  26     $dbdef = reload_dbdef;
  27     $dbdef = reload_dbdef "/non/standard/filename";
  28     $dbdef = dbdef;
  29     $dbdef_dist = dbdef_dist;
  30
  31 =head1 DESCRIPTION
  32
  33 This class represents the database schema.
  34
  35 =head1 METHODS
  36
  37 =over 4
  38
  39 =item reload_dbdef([FILENAME])
  40
  41 Load a database definition (see L<DBIx::DBSchema>), optionally from a
  42 non-default filename.  This command is executed at startup unless
  43 I<$FS::Schema::setup_hack> is true.  Returns a DBIx::DBSchema object.
  44
  45 =cut
  46
  47 sub reload_dbdef {
  48   my $file = shift;
  49
  50   unless ( exists $dbdef_cache{$file} ) {
  51     warn "[debug]$me loading dbdef for $file\n" if $DEBUG;
  52     $dbdef_cache{$file} = DBIx::DBSchema->load( $file )
  53       or die "can't load database schema from $file: $DBIx::DBSchema::errstr\n";
  54   } else {
  55     warn "[debug]$me re-using cached dbdef for $file\n" if $DEBUG;
  56   }
  57   $dbdef = $dbdef_cache{$file};
  58 }
  59
  60 =item dbdef
  61
  62 Returns the current database definition (represents the current database,
  63 assuming it is up-to-date).  See L<DBIx::DBSchema>.
  64
  65 =cut
  66
  67 sub dbdef { $dbdef; }
  68
  69 =item dbdef_dist [ OPTION => VALUE ... ]
  70
  71 Returns the current canoical database definition as defined in this file.
  72
  73 =cut
  74
  75 sub dbdef_dist {
  76
  77   ###
  78   # create a dbdef object from the old data structure
  79   ###
  80
  81   my $tables_hashref = tables_hashref();
  82
  83
  84   #turn it into objects
  85   my $dbdef = new DBIx::DBSchema map {
  86
  87     my $tablename = $_;
  88     my $indexnum = 1;
  89
  90     my @columns;
  91     while (@{$tables_hashref->{$tablename}{'columns'}}) {
  92       #my($name, $type, $null, $length, $default, $local) =
  93       my @coldef =
  94         splice @{$tables_hashref->{$tablename}{'columns'}}, 0, 6;
  95       my %hash = map { $_ => shift @coldef }
  96                      qw( name type null length default local );
  97
  98       unless ( defined $hash{'default'} ) {
  99         warn "$tablename:\n".
 100              join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
 101       }
 102
 103       push @columns, new DBIx::DBSchema::Column ( \%hash );
 104     }
 105
 106     #false laziness w/sub indices in DBIx::DBSchema::DBD (well, sorta)
 107     #and sub sql_create_table in DBIx::DBSchema::Table (slighty more?)
 108     my $unique = $tables_hashref->{$tablename}{'unique'};
 109     my $index  = $tables_hashref->{$tablename}{'index'};
 110     my @indices = ();
 111     push @indices, map {
 112                          DBIx::DBSchema::Index->new({
 113                            'name'    => $tablename. $indexnum++,
 114                            'unique'  => 1,
 115                            'columns' => $_,
 116                          });
 117                        }
 118                        @$unique;
 119     push @indices, map {
 120                          DBIx::DBSchema::Index->new({
 121                            'name'    => $tablename. $indexnum++,
 122                            'unique'  => 0,
 123                            'columns' => $_,
 124                          });
 125                        }
 126                        @$index;
 127
 128     DBIx::DBSchema::Table->new({
 129       'name'        => $tablename,
 130       'primary_key' => $tables_hashref->{$tablename}{'primary_key'},
 131       'columns'     => \@columns,
 132       'indices'     => \@indices,
 133     });
 134
 135   } keys %$tables_hashref;
 136
 137   if ( $DEBUG ) {
 138     warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
 139     warn "[debug]$me   $_\n" foreach $dbdef->tables;
 140   }
 141
 142   #add radius attributes to svc_acct
 143   #
 144   #my($svc_acct)=$dbdef->table('svc_acct');
 145   #
 146   #my($attribute);
 147   #foreach $attribute (@attributes) {
 148   #  $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
 149   #    'radius_'. $attribute,
 150   #    'varchar',
 151   #    'NULL',
 152   #    $char_d,
 153   #  ));
 154   #}
 155   #
 156   #foreach $attribute (@check_attributes) {
 157   #  $svc_acct->addcolumn( new DBIx::DBSchema::Column (
 158   #    'rc_'. $attribute,
 159   #    'varchar',
 160   #    'NULL',
 161   #    $char_d,
 162   #  ));
 163   #}
 164
 165   #create history tables (false laziness w/create-history-tables)
 166   foreach my $table (
 167     grep { ! /^clientapi_session/ }
 168     grep { ! /^h_/ }
 169     $dbdef->tables
 170   ) {
 171     my $tableobj = $dbdef->table($table)
 172       or die "unknown table $table";
 173
 174     my %indices = $tableobj->indices;
 175
 176     my %h_indices = map {
 177                           ( "h_$_" =>
 178                               DBIx::DBSchema::Index->new({
 179                                 'name'    => 'h_'. $indices{$_}->name,
 180                                 'unique'  => 0,
 181                                 'columns' => [ @{$indices{$_}->columns} ],
 182                               })
 183                           );
 184                         }
 185                         keys %indices;
 186
 187     my $h_tableobj = DBIx::DBSchema::Table->new( {
 188       'name'        => "h_$table",
 189       'primary_key' => 'historynum',
 190       'indices'     => \%h_indices,
 191       'columns'     => [
 192                          DBIx::DBSchema::Column->new( {
 193                            'name'    => 'historynum',
 194                            'type'    => 'serial',
 195                            'null'    => 'NOT NULL',
 196                            'length'  => '',
 197                            'default' => '',
 198                            'local'   => '',
 199                          } ),
 200                          DBIx::DBSchema::Column->new( {
 201                            'name'    => 'history_date',
 202                            'type'    => 'int',
 203                            'null'    => 'NULL',
 204                            'length'  => '',
 205                            'default' => '',
 206                            'local'   => '',
 207                          } ),
 208                          DBIx::DBSchema::Column->new( {
 209                            'name'    => 'history_user',
 210                            'type'    => 'varchar',
 211                            'null'    => 'NOT NULL',
 212                            'length'  => '80',
 213                            'default' => '',
 214                            'local'   => '',
 215                          } ),
 216                          DBIx::DBSchema::Column->new( {
 217                            'name'    => 'history_action',
 218                            'type'    => 'varchar',
 219                            'null'    => 'NOT NULL',
 220                            'length'  => '80',
 221                            'default' => '',
 222                            'local'   => '',
 223                          } ),
 224                          map {
 225                            my $column = $tableobj->column($_);
 226
 227                            #clone so as to not disturb the original
 228                            $column = DBIx::DBSchema::Column->new( {
 229                              map { $_ => $column->$_() }
 230                                qw( name type null length default local )
 231                            } );
 232
 233                            if ( $column->type eq 'serial' ) {
 234                              $column->type('int');
 235                              $column->null('NULL');
 236                            }
 237                            #$column->default('')
 238                            #  if $column->default =~ /^nextval\(/i;
 239                            #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
 240                            #$column->local($local);
 241                            $column;
 242                          } $tableobj->columns
 243                      ],
 244     } );
 245     $dbdef->addtable($h_tableobj);
 246   }
 247
 248   $dbdef;
 249
 250 }
 251
 252 sub tables_hashref {
 253
 254   my $char_d = 80; #default maxlength for text fields
 255
 256   #my(@date_type)  = ( 'timestamp', '', ''     );
 257   my @date_type  = ( 'int', 'NULL', ''     );
 258   my @perl_type = ( 'text', 'NULL', ''  );
 259   my @money_type = ( 'decimal',   '', '10,2' );
 260
 261   my $username_len = 32; #usernamemax config file
 262
 263     # name type nullability length default local
 264
 265   return {
 266
 267     'agent' => {
 268       'columns' => [
 269         'agentnum', 'serial',            '',     '', '', '',
 270         'agent',    'varchar',           '',     $char_d, '', '',
 271         'typenum',  'int',            '',     '', '', '',
 272         'freq',     'int',       'NULL', '', '', '',
 273         'prog',     @perl_type, '', '',
 274         'disabled',     'char', 'NULL', 1, '', '',
 275         'username', 'varchar',       'NULL',     $char_d, '', '',
 276         '_password','varchar',       'NULL',     $char_d, '', '',
 277         'ticketing_queueid', 'int', 'NULL', '', '', '',
 278       ],
 279       'primary_key' => 'agentnum',
 280       'unique' => [],
 281       'index' => [ ['typenum'], ['disabled'] ],
 282     },
 283
 284     'agent_type' => {
 285       'columns' => [
 286         'typenum',   'serial',  '', '', '', '',
 287         'atype',     'varchar', '', $char_d, '', '',
 288       ],
 289       'primary_key' => 'typenum',
 290       'unique' => [],
 291       'index' => [],
 292     },
 293
 294     'type_pkgs' => {
 295       'columns' => [
 296         'typepkgnum', 'serial', '', '', '', '',
 297         'typenum',   'int',  '', '', '', '',
 298         'pkgpart',   'int',  '', '', '', '',
 299       ],
 300       'primary_key' => 'typepkgnum',
 301       'unique' => [ ['typenum', 'pkgpart'] ],
 302       'index' => [ ['typenum'] ],
 303     },
 304
 305     'cust_bill' => {
 306       'columns' => [
 307         'invnum',    'serial',  '', '', '', '',
 308         'custnum',   'int',  '', '', '', '',
 309         '_date',     @date_type, '', '',
 310         'charged',   @money_type, '', '',
 311         'printed',   'int',  '', '', '', '',
 312         'closed',    'char', 'NULL', 1, '', '',
 313       ],
 314       'primary_key' => 'invnum',
 315       'unique' => [],
 316       'index' => [ ['custnum'], ['_date'] ],
 317     },
 318
 319     'cust_bill_event' => {
 320       'columns' => [
 321         'eventnum',    'serial',  '', '', '', '',
 322         'invnum',   'int',  '', '', '', '',
 323         'eventpart',   'int',  '', '', '', '',
 324         '_date',     @date_type, '', '',
 325         'status', 'varchar', '', $char_d, '', '',
 326         'statustext', 'text', 'NULL', '', '', '',
 327       ],
 328       'primary_key' => 'eventnum',
 329       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 330       'unique' => [],
 331       'index' => [ ['invnum'], ['status'] ],
 332     },
 333
 334     'part_bill_event' => {
 335       'columns' => [
 336         'eventpart',    'serial',  '', '', '', '',
 337         'freq',        'varchar',       'NULL',     $char_d, '', '',
 338         'payby',       'char',  '', 4, '', '',
 339         'event',       'varchar',           '',     $char_d, '', '',
 340         'eventcode',    @perl_type, '', '',
 341         'seconds',     'int', 'NULL', '', '', '',
 342         'weight',      'int', '', '', '', '',
 343         'plan',       'varchar', 'NULL', $char_d, '', '',
 344         'plandata',   'text', 'NULL', '', '', '',
 345         'reason',     'int', 'NULL', '', '', '',
 346         'disabled',     'char', 'NULL', 1, '', '',
 347       ],
 348       'primary_key' => 'eventpart',
 349       'unique' => [],
 350       'index' => [ ['payby'], ['disabled'], ],
 351     },
 352
 353     'cust_bill_pkg' => {
 354       'columns' => [
 355         'billpkgnum', 'serial', '', '', '', '',
 356         'pkgnum',  'int', '', '', '', '',
 357         'invnum',  'int', '', '', '', '',
 358         'setup',   @money_type, '', '',
 359         'recur',   @money_type, '', '',
 360         'sdate',   @date_type, '', '',
 361         'edate',   @date_type, '', '',
 362         'itemdesc', 'varchar', 'NULL', $char_d, '', '',
 363       ],
 364       'primary_key' => 'billpkgnum',
 365       'unique' => [],
 366       'index' => [ ['invnum'], [ 'pkgnum' ] ],
 367     },
 368
 369     'cust_bill_pkg_detail' => {
 370       'columns' => [
 371         'detailnum', 'serial', '', '', '', '',
 372         'pkgnum',  'int', '', '', '', '',
 373         'invnum',  'int', '', '', '', '',
 374         'detail',  'varchar', '', $char_d, '', '',
 375       ],
 376       'primary_key' => 'detailnum',
 377       'unique' => [],
 378       'index' => [ [ 'pkgnum', 'invnum' ] ],
 379     },
 380
 381     'cust_credit' => {
 382       'columns' => [
 383         'crednum',  'serial', '', '', '', '',
 384         'custnum',  'int', '', '', '', '',
 385         '_date',    @date_type, '', '',
 386         'amount',   @money_type, '', '',
 387         'otaker',   'varchar', '', 32, '', '',
 388         'reason',   'text', 'NULL', '', '', '',
 389         'closed',    'char', 'NULL', 1, '', '',
 390       ],
 391       'primary_key' => 'crednum',
 392       'unique' => [],
 393       'index' => [ ['custnum'] ],
 394     },
 395
 396     'cust_credit_bill' => {
 397       'columns' => [
 398         'creditbillnum', 'serial', '', '', '', '',
 399         'crednum',  'int', '', '', '', '',
 400         'invnum',  'int', '', '', '', '',
 401         '_date',    @date_type, '', '',
 402         'amount',   @money_type, '', '',
 403       ],
 404       'primary_key' => 'creditbillnum',
 405       'unique' => [],
 406       'index' => [ ['crednum'], ['invnum'] ],
 407     },
 408
 409     'cust_credit_bill_pkg' => {
 410       'columns' => [
 411         'creditbillpkgnum', 'serial', '',      '', '', '',
 412         'creditbillnum',       'int', '',      '', '', '',
 413         'billpkgnum',          'int', '',      '', '', '',
 414         'amount',            @money_type,          '', '',
 415         'setuprecur',      'varchar', '', $char_d, '', '',
 416         'sdate',   @date_type, '', '',
 417         'edate',   @date_type, '', '',
 418       ],
 419       'primary_key' => 'creditbillpkgnum',
 420       'unique'      => [],
 421       'index'       => [ [ 'creditbillnum' ], [ 'billpkgnum' ], ],
 422     },
 423
 424     'cust_main' => {
 425       'columns' => [
 426         'custnum',  'serial',  '',     '', '', '',
 427         'agentnum', 'int',  '',     '', '', '',
 428         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
 429 #        'titlenum', 'int',  'NULL',   '', '', '',
 430         'last',     'varchar', '',     $char_d, '', '',
 431 #        'middle',   'varchar', 'NULL', $char_d, '', '',
 432         'first',    'varchar', '',     $char_d, '', '',
 433         'ss',       'varchar', 'NULL', 11, '', '',
 434         'stateid', 'varchar', 'NULL', $char_d, '', '',
 435         'stateid_state', 'varchar', 'NULL', $char_d, '', '',
 436         'birthdate' ,@date_type, '', '',
 437         'signupdate',@date_type, '', '',
 438         'company',  'varchar', 'NULL', $char_d, '', '',
 439         'address1', 'varchar', '',     $char_d, '', '',
 440         'address2', 'varchar', 'NULL', $char_d, '', '',
 441         'city',     'varchar', '',     $char_d, '', '',
 442         'county',   'varchar', 'NULL', $char_d, '', '',
 443         'state',    'varchar', 'NULL', $char_d, '', '',
 444         'zip',      'varchar', 'NULL', 10, '', '',
 445         'country',  'char', '',     2, '', '',
 446         'daytime',  'varchar', 'NULL', 20, '', '',
 447         'night',    'varchar', 'NULL', 20, '', '',
 448         'fax',      'varchar', 'NULL', 12, '', '',
 449         'ship_last',     'varchar', 'NULL', $char_d, '', '',
 450 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '',
 451         'ship_first',    'varchar', 'NULL', $char_d, '', '',
 452         'ship_company',  'varchar', 'NULL', $char_d, '', '',
 453         'ship_address1', 'varchar', 'NULL', $char_d, '', '',
 454         'ship_address2', 'varchar', 'NULL', $char_d, '', '',
 455         'ship_city',     'varchar', 'NULL', $char_d, '', '',
 456         'ship_county',   'varchar', 'NULL', $char_d, '', '',
 457         'ship_state',    'varchar', 'NULL', $char_d, '', '',
 458         'ship_zip',      'varchar', 'NULL', 10, '', '',
 459         'ship_country',  'char', 'NULL', 2, '', '',
 460         'ship_daytime',  'varchar', 'NULL', 20, '', '',
 461         'ship_night',    'varchar', 'NULL', 20, '', '',
 462         'ship_fax',      'varchar', 'NULL', 12, '', '',
 463         'payby',    'char', '',     4, '', '',
 464         'payinfo',  'varchar', 'NULL', 512, '', '',
 465         'paycvv',   'varchar', 'NULL', 512, '', '',
 466         'paymask', 'varchar', 'NULL', $char_d, '', '',
 467         #'paydate',  @date_type, '', '',
 468         'paydate',  'varchar', 'NULL', 10, '', '',
 469         'paystart_month', 'int', 'NULL', '', '', '',
 470         'paystart_year',  'int', 'NULL', '', '', '',
 471         'payissue', 'varchar', 'NULL', 2, '', '',
 472         'payname',  'varchar', 'NULL', $char_d, '', '',
 473         'paystate', 'varchar', 'NULL', $char_d, '', '',
 474         'paytype',  'varchar', 'NULL', $char_d, '', '',
 475         'payip',    'varchar', 'NULL', 15, '', '',
 476         'tax',      'char', 'NULL', 1, '', '',
 477         'otaker',   'varchar', '',    32, '', '',
 478         'refnum',   'int',  '',     '', '', '',
 479         'referral_custnum', 'int',  'NULL', '', '', '',
 480         'comments', 'text', 'NULL', '', '', '',
 481         'spool_cdr','char', 'NULL', 1, '', '',
 482         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 483       ],
 484       'primary_key' => 'custnum',
 485       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
 486       #'index' => [ ['last'], ['company'] ],
 487       'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ],
 488                    [ 'daytime' ], [ 'night' ], [ 'fax' ], [ 'refnum' ],
 489                    [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
 490                    [ 'ship_last' ], [ 'ship_company' ],
 491                    [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
 492                    [ 'payby' ], [ 'paydate' ],
 493                  ],
 494     },
 495
 496     'cust_main_invoice' => {
 497       'columns' => [
 498         'destnum',  'serial',  '',     '', '', '',
 499         'custnum',  'int',  '',     '', '', '',
 500         'dest',     'varchar', '',  $char_d, '', '',
 501       ],
 502       'primary_key' => 'destnum',
 503       'unique' => [],
 504       'index' => [ ['custnum'], ],
 505     },
 506
 507     'cust_main_note' => {
 508       'columns' => [
 509         'notenum',  'serial',  '',     '', '', '',
 510         'custnum',  'int',  '',     '', '', '',
 511         '_date',    @date_type, '', '',
 512         'otaker',   'varchar', '',    32, '', '',
 513         'comments', 'text', 'NULL', '', '', '',
 514       ],
 515       'primary_key' => 'notenum',
 516       'unique' => [],
 517       'index' => [ [ 'custnum' ], [ '_date' ], ],
 518     },
 519
 520     'cust_main_county' => { #county+state+country are checked off the
 521                             #cust_main_county for validation and to provide
 522                             # a tax rate.
 523       'columns' => [
 524         'taxnum',   'serial',   '',    '', '', '',
 525         'state',    'varchar',  'NULL',    $char_d, '', '',
 526         'county',   'varchar',  'NULL',    $char_d, '', '',
 527         'country',  'char',  '', 2, '', '',
 528         'taxclass',   'varchar', 'NULL', $char_d, '', '',
 529         'exempt_amount', @money_type, '', '',
 530         'tax',      'real',  '',    '', '', '', #tax %
 531         'taxname',  'varchar',  'NULL',    $char_d, '', '',
 532         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
 533         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
 534       ],
 535       'primary_key' => 'taxnum',
 536       'unique' => [],
 537   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
 538       'index' => [ [ 'county' ], [ 'state' ], [ 'country' ] ],
 539     },
 540
 541     'cust_pay' => {
 542       'columns' => [
 543         'paynum',   'serial',    '',   '', '', '',
 544         #now cust_bill_pay #'invnum',   'int',    '',   '', '', '',
 545         'custnum',  'int',    '',   '', '', '',
 546         'paid',     @money_type, '', '',
 547         '_date',    @date_type, '', '',
 548         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 549                                                  # index into payby table
 550                                                  # eventually
 551         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
 552         'paymask', 'varchar', 'NULL', $char_d, '', '',
 553         'paydate',  'varchar', 'NULL', 10, '', '',
 554         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 555         'closed',    'char', 'NULL', 1, '', '',
 556       ],
 557       'primary_key' => 'paynum',
 558       'unique' => [],
 559       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
 560     },
 561
 562     'cust_pay_void' => {
 563       'columns' => [
 564         'paynum',    'int',    '',   '', '', '',
 565         'custnum',   'int',    '',   '', '', '',
 566         'paid',      @money_type, '', '',
 567         '_date',     @date_type, '', '',
 568         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 569                                                   # index into payby table
 570                                                   # eventually
 571         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
 572         'paymask', 'varchar', 'NULL', $char_d, '', '',
 573         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 574         'closed',    'char', 'NULL', 1, '', '',
 575         'void_date', @date_type, '', '',
 576         'reason',    'varchar',   'NULL', $char_d, '', '',
 577         'otaker',   'varchar', '', 32, '', '',
 578       ],
 579       'primary_key' => 'paynum',
 580       'unique' => [],
 581       'index' => [ [ 'custnum' ] ],
 582     },
 583
 584     'cust_bill_pay' => {
 585       'columns' => [
 586         'billpaynum', 'serial',     '',   '', '', '',
 587         'invnum',  'int',     '',   '', '', '',
 588         'paynum',  'int',     '',   '', '', '',
 589         'amount',  @money_type, '', '',
 590         '_date',   @date_type, '', '',
 591       ],
 592       'primary_key' => 'billpaynum',
 593       'unique' => [],
 594       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
 595     },
 596
 597     'cust_bill_pay_batch' => {
 598       'columns' => [
 599         'billpaynum', 'serial',     '',   '', '', '',
 600         'invnum',  'int',     '',   '', '', '',
 601         'paybatchnum',  'int',     '',   '', '', '',
 602         'amount',  @money_type, '', '',
 603         '_date',   @date_type, '', '',
 604       ],
 605       'primary_key' => 'billpaynum',
 606       'unique' => [],
 607       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
 608     },
 609
 610     'cust_bill_pay_pkg' => {
 611       'columns' => [
 612         'billpaypkgnum', 'serial', '', '', '', '',
 613         'billpaynum',       'int', '', '', '', '',
 614         'billpkgnum',       'int', '', '', '', '',
 615         'amount',         @money_type,     '', '',
 616         'setuprecur',      'varchar', '', $char_d, '', '',
 617         'sdate',   @date_type, '', '',
 618         'edate',   @date_type, '', '',
 619       ],
 620       'primary_key' => 'billpaypkgnum',
 621       'unique'      => [],
 622       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
 623     },
 624
 625     'pay_batch' => { #batches of payments to an external processor
 626       'columns' => [
 627         'batchnum',   'serial',    '',   '', '', '',
 628         'payby',      'char',      '',    4, '', '', # CARD/CHEK
 629         'status',     'char', 'NULL',     1, '', '',
 630         'download',   @date_type, '', '',
 631         'upload',     @date_type, '', '',
 632       ],
 633       'primary_key' => 'batchnum',
 634       'unique' => [],
 635       'index' => [],
 636     },
 637
 638     'cust_pay_batch' => { #what's this used for again?  list of customers
 639                           #in current CARD batch? (necessarily CARD?)
 640       'columns' => [
 641         'paybatchnum',   'serial',    '',   '', '', '',
 642         'batchnum',   'int',    '',   '', '', '',
 643         'invnum',   'int',    '',   '', '', '',
 644         'custnum',   'int',    '',   '', '', '',
 645         'last',     'varchar', '',     $char_d, '', '',
 646         'first',    'varchar', '',     $char_d, '', '',
 647         'address1', 'varchar', '',     $char_d, '', '',
 648         'address2', 'varchar', 'NULL', $char_d, '', '',
 649         'city',     'varchar', '',     $char_d, '', '',
 650         'state',    'varchar', 'NULL', $char_d, '', '',
 651         'zip',      'varchar', 'NULL', 10, '', '',
 652         'country',  'char', '',     2, '', '',
 653         #        'trancode', 'int', '', '', '', ''
 654         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 655         'payinfo',  'varchar', '',     512, '', '',
 656         #'exp',      @date_type, '', ''
 657         'exp',      'varchar', 'NULL',     11, '', '',
 658         'payname',  'varchar', 'NULL', $char_d, '', '',
 659         'amount',   @money_type, '', '',
 660         'status',   'varchar', 'NULL',     $char_d, '', '',
 661       ],
 662       'primary_key' => 'paybatchnum',
 663       'unique' => [],
 664       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
 665     },
 666
 667     'cust_pkg' => {
 668       'columns' => [
 669         'pkgnum',    'serial',    '',   '', '', '',
 670         'custnum',   'int',    '',   '', '', '',
 671         'pkgpart',   'int',    '',   '', '', '',
 672         'otaker',    'varchar', '', 32, '', '',
 673         'setup',     @date_type, '', '',
 674         'bill',      @date_type, '', '',
 675         'last_bill', @date_type, '', '',
 676         'susp',      @date_type, '', '',
 677         'adjourn',   @date_type, '', '',
 678         'cancel',    @date_type, '', '',
 679         'expire',    @date_type, '', '',
 680         'manual_flag', 'char', 'NULL', 1, '', '',
 681       ],
 682       'primary_key' => 'pkgnum',
 683       'unique' => [],
 684       'index' => [ ['custnum'], ['pkgpart'] ],
 685     },
 686
 687     'cust_pkg_option' => {
 688       'columns' => [
 689         'optionnum', 'serial', '', '', '', '',
 690         'pkgnum', 'int', '', '', '', '',
 691         'optionname', 'varchar', '', $char_d, '', '',
 692         'optionvalue', 'text', 'NULL', '', '', '',
 693       ],
 694       'primary_key' => 'optionnum',
 695       'unique'      => [],
 696       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
 697     },
 698
 699     'cust_pkg_reason' => {
 700       'columns' => [
 701         'num',      'serial',    '',   '', '', '',
 702         'pkgnum',   'int',    '',   '', '', '',
 703         'reasonnum','int',    '',   '', '', '',
 704         'otaker',   'varchar', '', 32, '', '',
 705         'date',     @date_type, '', '',
 706       ],
 707       'primary_key' => 'num',
 708       'unique' => [],
 709       'index' => [],
 710     },
 711
 712     'cust_refund' => {
 713       'columns' => [
 714         'refundnum',    'serial',    '',   '', '', '',
 715         #now cust_credit_refund #'crednum',      'int',    '',   '', '', '',
 716         'custnum',  'int',    '',   '', '', '',
 717         '_date',        @date_type, '', '',
 718         'refund',       @money_type, '', '',
 719         'otaker',       'varchar',   '',   32, '', '',
 720         'reason',       'varchar',   '',   $char_d, '', '',
 721         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
 722                                                      # be index into payby
 723                                                      # table eventually
 724         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
 725         'paymask', 'varchar', 'NULL', $char_d, '', '',
 726         'paybatch',     'varchar',   'NULL', $char_d, '', '',
 727         'closed',    'char', 'NULL', 1, '', '',
 728       ],
 729       'primary_key' => 'refundnum',
 730       'unique' => [],
 731       'index' => [],
 732     },
 733
 734     'cust_credit_refund' => {
 735       'columns' => [
 736         'creditrefundnum', 'serial',     '',   '', '', '',
 737         'crednum',  'int',     '',   '', '', '',
 738         'refundnum',  'int',     '',   '', '', '',
 739         'amount',  @money_type, '', '',
 740         '_date',   @date_type, '', '',
 741       ],
 742       'primary_key' => 'creditrefundnum',
 743       'unique' => [],
 744       'index' => [ [ 'crednum', 'refundnum' ] ],
 745     },
 746
 747
 748     'cust_svc' => {
 749       'columns' => [
 750         'svcnum',    'serial',    '',   '', '', '',
 751         'pkgnum',    'int',    'NULL',   '', '', '',
 752         'svcpart',   'int',    '',   '', '', '',
 753         'overlimit', @date_type, '', '',
 754       ],
 755       'primary_key' => 'svcnum',
 756       'unique' => [],
 757       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
 758     },
 759
 760     'part_pkg' => {
 761       'columns' => [
 762         'pkgpart',       'serial',    '',   '', '', '',
 763         'pkg',           'varchar',   '',   $char_d, '', '',
 764         'comment',       'varchar',   '',   $char_d, '', '',
 765         'promo_code',    'varchar', 'NULL', $char_d, '', '',
 766         'setup',         @perl_type, '', '',
 767         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
 768         'recur',         @perl_type, '', '',
 769         'setuptax',      'char', 'NULL', 1, '', '',
 770         'recurtax',      'char', 'NULL', 1, '', '',
 771         'plan',          'varchar', 'NULL', $char_d, '', '',
 772         'plandata',      'text', 'NULL', '', '', '',
 773         'disabled',      'char', 'NULL', 1, '', '',
 774         'taxclass',      'varchar', 'NULL', $char_d, '', '',
 775         'classnum',      'int',     'NULL', '', '', '',
 776         'pay_weight',    'real',    'NULL', '', '', '',
 777         'credit_weight', 'real',    'NULL', '', '', '',
 778       ],
 779       'primary_key' => 'pkgpart',
 780       'unique' => [],
 781       'index' => [ [ 'promo_code' ], [ 'disabled' ] ],
 782     },
 783
 784 #    'part_title' => {
 785 #      'columns' => [
 786 #        'titlenum',   'int',    '',   '',
 787 #        'title',      'varchar',   '',   $char_d,
 788 #      ],
 789 #      'primary_key' => 'titlenum',
 790 #      'unique' => [ [] ],
 791 #      'index' => [ [] ],
 792 #    },
 793
 794     'pkg_svc' => {
 795       'columns' => [
 796         'pkgsvcnum',  'serial', '',  '', '', '',
 797         'pkgpart',    'int',    '',   '', '', '',
 798         'svcpart',    'int',    '',   '', '', '',
 799         'quantity',   'int',    '',   '', '', '',
 800         'primary_svc','char', 'NULL',  1, '', '',
 801       ],
 802       'primary_key' => 'pkgsvcnum',
 803       'unique' => [ ['pkgpart', 'svcpart'] ],
 804       'index' => [ ['pkgpart'] ],
 805     },
 806
 807     'part_referral' => {
 808       'columns' => [
 809         'refnum',   'serial',     '',        '', '', '',
 810         'referral', 'varchar',    '',   $char_d, '', '',
 811         'disabled', 'char',   'NULL',         1, '', '',
 812         'agentnum', 'int',    'NULL',        '', '', '',
 813       ],
 814       'primary_key' => 'refnum',
 815       'unique' => [],
 816       'index' => [ ['disabled'] ],
 817     },
 818
 819     'part_svc' => {
 820       'columns' => [
 821         'svcpart',    'serial',    '',   '', '', '',
 822         'svc',        'varchar',   '',   $char_d, '', '',
 823         'svcdb',      'varchar',   '',   $char_d, '', '',
 824         'disabled',   'char',  'NULL',   1, '', '',
 825       ],
 826       'primary_key' => 'svcpart',
 827       'unique' => [],
 828       'index' => [ [ 'disabled' ] ],
 829     },
 830
 831     'part_svc_column' => {
 832       'columns' => [
 833         'columnnum',   'serial',         '', '', '', '',
 834         'svcpart',     'int',         '', '', '', '',
 835         'columnname',  'varchar',     '', 64, '', '',
 836         'columnvalue', 'varchar', 'NULL', $char_d, '', '',
 837         'columnflag',  'char',    'NULL', 1, '', '',
 838       ],
 839       'primary_key' => 'columnnum',
 840       'unique' => [ [ 'svcpart', 'columnname' ] ],
 841       'index' => [ [ 'svcpart' ] ],
 842     },
 843
 844     #(this should be renamed to part_pop)
 845     'svc_acct_pop' => {
 846       'columns' => [
 847         'popnum',    'serial',    '',   '', '', '',
 848         'city',      'varchar',   '',   $char_d, '', '',
 849         'state',     'varchar',   '',   $char_d, '', '',
 850         'ac',        'char',   '',   3, '', '',
 851         'exch',      'char',   '',   3, '', '',
 852         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
 853       ],
 854       'primary_key' => 'popnum',
 855       'unique' => [],
 856       'index' => [ [ 'state' ] ],
 857     },
 858
 859     'part_pop_local' => {
 860       'columns' => [
 861         'localnum',  'serial',     '',     '', '', '',
 862         'popnum',    'int',     '',     '', '', '',
 863         'city',      'varchar', 'NULL', $char_d, '', '',
 864         'state',     'char',    'NULL', 2, '', '',
 865         'npa',       'char',    '',     3, '', '',
 866         'nxx',       'char',    '',     3, '', '',
 867       ],
 868       'primary_key' => 'localnum',
 869       'unique' => [],
 870       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
 871     },
 872
 873     'svc_acct' => {
 874       'columns' => [
 875         'svcnum',    'int',    '',   '', '', '',
 876         'username',  'varchar',   '',   $username_len, '', '',
 877         '_password', 'varchar',   '',  512, '', '',
 878         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
 879         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
 880         'popnum',    'int',    'NULL',   '', '', '',
 881         'uid',       'int', 'NULL',   '', '', '',
 882         'gid',       'int', 'NULL',   '', '', '',
 883         'finger',    'varchar',   'NULL',   $char_d, '', '',
 884         'dir',       'varchar',   'NULL',   $char_d, '', '',
 885         'shell',     'varchar',   'NULL',   $char_d, '', '',
 886         'quota',     'varchar',   'NULL',   $char_d, '', '',
 887         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
 888         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
 889         'seconds_threshold',   'int', 'NULL',   '', '', '',
 890         'upbytes',   'bigint', 'NULL',   '', '', '',
 891         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
 892         'downbytes', 'bigint', 'NULL',   '', '', '',
 893         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
 894         'totalbytes','bigint', 'NULL',   '', '', '',
 895         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
 896         'domsvc',    'int', '',   '', '', '',
 897       ],
 898       'primary_key' => 'svcnum',
 899       #'unique' => [ [ 'username', 'domsvc' ] ],
 900       'unique' => [],
 901       'index' => [ ['username'], ['domsvc'] ],
 902     },
 903
 904     #'svc_charge' => {
 905     #  'columns' => [
 906     #    'svcnum',    'int',    '',   '',
 907     #    'amount',    @money_type,
 908     #  ],
 909     #  'primary_key' => 'svcnum',
 910     #  'unique' => [ [] ],
 911     #  'index' => [ [] ],
 912     #},
 913
 914     'svc_domain' => {
 915       'columns' => [
 916         'svcnum',           'int',    '',        '', '', '',
 917         'domain',       'varchar',    '',   $char_d, '', '',
 918         'suffix',       'varchar', 'NULL',  $char_d, '', '',
 919         'catchall',         'int', 'NULL',       '', '', '',
 920         'parent_svcnum',    'int', 'NULL',       '', '', '',
 921         'registrarnum',     'int', 'NULL',       '', '', '',
 922         'registrarkey', 'varchar', 'NULL',       '', '', '',
 923         'setup_date',  @date_type, '', '',
 924         'renewal_interval', 'int', 'NULL',       '', '', '',
 925         'expiration_date', @date_type, '', '',
 926       ],
 927       'primary_key' => 'svcnum',
 928       'unique' => [ ],
 929       'index' => [ ['domain'] ],
 930     },
 931
 932     'domain_record' => {
 933       'columns' => [
 934         'recnum',    'serial',     '',  '', '', '',
 935         'svcnum',    'int',     '',  '', '', '',
 936         'reczone',   'varchar', '',  255, '', '',
 937         'recaf',     'char',    '',  2, '', '',
 938         'rectype',   'varchar',    '',  5, '', '',
 939         'recdata',   'varchar', '',  255, '', '',
 940       ],
 941       'primary_key' => 'recnum',
 942       'unique'      => [],
 943       'index'       => [ ['svcnum'] ],
 944     },
 945
 946     'registrar' => {
 947       'columns' => [
 948         'registrarnum',   'serial', '',      '', '', '',
 949         'registrarname', 'varchar', '', $char_d, '', '',
 950       ],
 951       'primary_key' => 'registrarnum',
 952       'unique'      => [],
 953       'index'       => [],
 954     },
 955
 956     'svc_forward' => {
 957       'columns' => [
 958         'svcnum',   'int',            '',   '', '', '',
 959         'srcsvc',   'int',        'NULL',   '', '', '',
 960         'src',      'varchar',    'NULL',  255, '', '',
 961         'dstsvc',   'int',        'NULL',   '', '', '',
 962         'dst',      'varchar',    'NULL',  255, '', '',
 963       ],
 964       'primary_key' => 'svcnum',
 965       'unique'      => [],
 966       'index'       => [ ['srcsvc'], ['dstsvc'] ],
 967     },
 968
 969     'svc_www' => {
 970       'columns' => [
 971         'svcnum',   'int',    '',  '', '', '',
 972         'recnum',   'int',    '',  '', '', '',
 973         'usersvc',  'int',    '',  '', '', '',
 974         'config',   'text',   'NULL',  '', '', '',
 975       ],
 976       'primary_key' => 'svcnum',
 977       'unique'      => [],
 978       'index'       => [],
 979     },
 980
 981     #'svc_wo' => {
 982     #  'columns' => [
 983     #    'svcnum',    'int',    '',   '',
 984     #    'svcnum',    'int',    '',   '',
 985     #    'svcnum',    'int',    '',   '',
 986     #    'worker',    'varchar',   '',   $char_d,
 987     #    '_date',     @date_type,
 988     #  ],
 989     #  'primary_key' => 'svcnum',
 990     #  'unique' => [ [] ],
 991     #  'index' => [ [] ],
 992     #},
 993
 994     'prepay_credit' => {
 995       'columns' => [
 996         'prepaynum',   'serial',     '',   '', '', '',
 997         'identifier',  'varchar', '', $char_d, '', '',
 998         'amount',      @money_type, '', '',
 999         'seconds',     'int',     'NULL', '', '', '',
1000         'upbytes',     'bigint',     'NULL', '', '', '',
1001         'downbytes',   'bigint',     'NULL', '', '', '',
1002         'totalbytes',  'bigint',     'NULL', '', '', '',
1003         'agentnum',    'int',     'NULL', '', '', '',
1004       ],
1005       'primary_key' => 'prepaynum',
1006       'unique'      => [ ['identifier'] ],
1007       'index'       => [],
1008     },
1009
1010     'port' => {
1011       'columns' => [
1012         'portnum',  'serial',     '',   '', '', '',
1013         'ip',       'varchar', 'NULL', 15, '', '',
1014         'nasport',  'int',     'NULL', '', '', '',
1015         'nasnum',   'int',     '',   '', '', '',
1016       ],
1017       'primary_key' => 'portnum',
1018       'unique'      => [],
1019       'index'       => [],
1020     },
1021
1022     'nas' => {
1023       'columns' => [
1024         'nasnum',   'serial',     '',    '', '', '',
1025         'nas',      'varchar', '',    $char_d, '', '',
1026         'nasip',    'varchar', '',    15, '', '',
1027         'nasfqdn',  'varchar', '',    $char_d, '', '',
1028         'last',     'int',     '',    '', '', '',
1029       ],
1030       'primary_key' => 'nasnum',
1031       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
1032       'index'       => [ [ 'last' ] ],
1033     },
1034
1035 #    'session' => {
1036 #      'columns' => [
1037 #        'sessionnum', 'serial',       '',   '', '', '',
1038 #        'portnum',    'int',       '',   '', '', '',
1039 #        'svcnum',     'int',       '',   '', '', '',
1040 #        'login',      @date_type, '', '',
1041 #        'logout',     @date_type, '', '',
1042 #      ],
1043 #      'primary_key' => 'sessionnum',
1044 #      'unique'      => [],
1045 #      'index'       => [ [ 'portnum' ] ],
1046 #    },
1047
1048     'queue' => {
1049       'columns' => [
1050         'jobnum', 'serial', '', '', '', '',
1051         'job', 'text', '', '', '', '',
1052         '_date', 'int', '', '', '', '',
1053         'status', 'varchar', '', $char_d, '', '',
1054         'statustext', 'text', 'NULL', '', '', '',
1055         'svcnum', 'int', 'NULL', '', '', '',
1056       ],
1057       'primary_key' => 'jobnum',
1058       'unique'      => [],
1059       'index'       => [ [ 'svcnum' ], [ 'status' ] ],
1060     },
1061
1062     'queue_arg' => {
1063       'columns' => [
1064         'argnum', 'serial', '', '', '', '',
1065         'jobnum', 'int', '', '', '', '',
1066         'arg', 'text', 'NULL', '', '', '',
1067       ],
1068       'primary_key' => 'argnum',
1069       'unique'      => [],
1070       'index'       => [ [ 'jobnum' ] ],
1071     },
1072
1073     'queue_depend' => {
1074       'columns' => [
1075         'dependnum', 'serial', '', '', '', '',
1076         'jobnum', 'int', '', '', '', '',
1077         'depend_jobnum', 'int', '', '', '', '',
1078       ],
1079       'primary_key' => 'dependnum',
1080       'unique'      => [],
1081       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1082     },
1083
1084     'export_svc' => {
1085       'columns' => [
1086         'exportsvcnum' => 'serial', '', '', '', '',
1087         'exportnum'    => 'int', '', '', '', '',
1088         'svcpart'      => 'int', '', '', '', '',
1089       ],
1090       'primary_key' => 'exportsvcnum',
1091       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
1092       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
1093     },
1094
1095     'part_export' => {
1096       'columns' => [
1097         'exportnum', 'serial', '', '', '', '',
1098         'machine', 'varchar', '', $char_d, '', '',
1099         'exporttype', 'varchar', '', $char_d, '', '',
1100         'nodomain',     'char', 'NULL', 1, '', '',
1101       ],
1102       'primary_key' => 'exportnum',
1103       'unique'      => [],
1104       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
1105     },
1106
1107     'part_export_option' => {
1108       'columns' => [
1109         'optionnum', 'serial', '', '', '', '',
1110         'exportnum', 'int', '', '', '', '',
1111         'optionname', 'varchar', '', $char_d, '', '',
1112         'optionvalue', 'text', 'NULL', '', '', '',
1113       ],
1114       'primary_key' => 'optionnum',
1115       'unique'      => [],
1116       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
1117     },
1118
1119     'radius_usergroup' => {
1120       'columns' => [
1121         'usergroupnum', 'serial', '', '', '', '',
1122         'svcnum',       'int', '', '', '', '',
1123         'groupname',    'varchar', '', $char_d, '', '',
1124       ],
1125       'primary_key' => 'usergroupnum',
1126       'unique'      => [],
1127       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
1128     },
1129
1130     'msgcat' => {
1131       'columns' => [
1132         'msgnum', 'serial', '', '', '', '',
1133         'msgcode', 'varchar', '', $char_d, '', '',
1134         'locale', 'varchar', '', 16, '', '',
1135         'msg', 'text', '', '', '', '',
1136       ],
1137       'primary_key' => 'msgnum',
1138       'unique'      => [ [ 'msgcode', 'locale' ] ],
1139       'index'       => [],
1140     },
1141
1142     'cust_tax_exempt' => {
1143       'columns' => [
1144         'exemptnum', 'serial', '', '', '', '',
1145         'custnum',   'int', '', '', '', '',
1146         'taxnum',    'int', '', '', '', '',
1147         'year',      'int', '', '', '', '',
1148         'month',     'int', '', '', '', '',
1149         'amount',   @money_type, '', '',
1150       ],
1151       'primary_key' => 'exemptnum',
1152       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1153       'index'       => [],
1154     },
1155
1156     'cust_tax_exempt_pkg' => {
1157       'columns' => [
1158         'exemptpkgnum',  'serial', '', '', '', '',
1159         #'custnum',      'int', '', '', '', ''
1160         'billpkgnum',   'int', '', '', '', '',
1161         'taxnum',       'int', '', '', '', '',
1162         'year',         'int', '', '', '', '',
1163         'month',        'int', '', '', '', '',
1164         'amount',       @money_type, '', '',
1165       ],
1166       'primary_key' => 'exemptpkgnum',
1167       'unique' => [],
1168       'index'  => [ [ 'taxnum', 'year', 'month' ],
1169                     [ 'billpkgnum' ],
1170                     [ 'taxnum' ]
1171                   ],
1172     },
1173
1174     'router' => {
1175       'columns' => [
1176         'routernum', 'serial', '', '', '', '',
1177         'routername', 'varchar', '', $char_d, '', '',
1178         'svcnum', 'int', 'NULL', '', '', '',
1179       ],
1180       'primary_key' => 'routernum',
1181       'unique'      => [],
1182       'index'       => [],
1183     },
1184
1185     'part_svc_router' => {
1186       'columns' => [
1187         'svcrouternum', 'serial', '', '', '', '',
1188         'svcpart', 'int', '', '', '', '',
1189         'routernum', 'int', '', '', '', '',
1190       ],
1191       'primary_key' => 'svcrouternum',
1192       'unique'      => [],
1193       'index'       => [],
1194     },
1195
1196     'addr_block' => {
1197       'columns' => [
1198         'blocknum', 'serial', '', '', '', '',
1199         'routernum', 'int', '', '', '', '',
1200         'ip_gateway', 'varchar', '', 15, '', '',
1201         'ip_netmask', 'int', '', '', '', '',
1202       ],
1203       'primary_key' => 'blocknum',
1204       'unique'      => [ [ 'blocknum', 'routernum' ] ],
1205       'index'       => [],
1206     },
1207
1208     'svc_broadband' => {
1209       'columns' => [
1210         'svcnum', 'int', '', '', '', '',
1211         'description', 'varchar', 'NULL', $char_d, '', '',
1212         'blocknum', 'int', '', '', '', '',
1213         'speed_up', 'int', '', '', '', '',
1214         'speed_down', 'int', '', '', '', '',
1215         'ip_addr', 'varchar', '', 15, '', '',
1216         'mac_addr', 'varchar', 'NULL', 12, '', '',
1217         'authkey',  'varchar', 'NULL', 32, '', '',
1218         'latitude', 'decimal', 'NULL', '', '', '',
1219         'longitude', 'decimal', 'NULL', '', '', '',
1220         'altitude', 'decimal', 'NULL', '', '', '',
1221         'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1222       ],
1223       'primary_key' => 'svcnum',
1224       'unique'      => [],
1225       'index'       => [],
1226     },
1227
1228     'part_virtual_field' => {
1229       'columns' => [
1230         'vfieldpart', 'serial', '', '', '', '',
1231         'dbtable', 'varchar', '', 32, '', '',
1232         'name', 'varchar', '', 32, '', '',
1233         'check_block', 'text', 'NULL', '', '', '',
1234         'length', 'int', 'NULL', '', '', '',
1235         'list_source', 'text', 'NULL', '', '', '',
1236         'label', 'varchar', 'NULL', 80, '', '',
1237       ],
1238       'primary_key' => 'vfieldpart',
1239       'unique' => [],
1240       'index' => [],
1241     },
1242
1243     'virtual_field' => {
1244       'columns' => [
1245         'vfieldnum', 'serial', '', '', '', '',
1246         'recnum', 'int', '', '', '', '',
1247         'vfieldpart', 'int', '', '', '', '',
1248         'value', 'varchar', '', 128, '', '',
1249       ],
1250       'primary_key' => 'vfieldnum',
1251       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1252       'index' => [],
1253     },
1254
1255     'acct_snarf' => {
1256       'columns' => [
1257         'snarfnum',  'int', '', '', '', '',
1258         'svcnum',    'int', '', '', '', '',
1259         'machine',   'varchar', '', 255, '', '',
1260         'protocol',  'varchar', '', $char_d, '', '',
1261         'username',  'varchar', '', $char_d, '', '',
1262         '_password', 'varchar', '', $char_d, '', '',
1263       ],
1264       'primary_key' => 'snarfnum',
1265       'unique' => [],
1266       'index'  => [ [ 'svcnum' ] ],
1267     },
1268
1269     'svc_external' => {
1270       'columns' => [
1271         'svcnum', 'int', '', '', '', '',
1272         'id',     'int', 'NULL', '', '', '',
1273         'title',  'varchar', 'NULL', $char_d, '', '',
1274       ],
1275       'primary_key' => 'svcnum',
1276       'unique'      => [],
1277       'index'       => [],
1278     },
1279
1280     'cust_pay_refund' => {
1281       'columns' => [
1282         'payrefundnum', 'serial', '', '', '', '',
1283         'paynum',  'int', '', '', '', '',
1284         'refundnum',  'int', '', '', '', '',
1285         '_date',    @date_type, '', '',
1286         'amount',   @money_type, '', '',
1287       ],
1288       'primary_key' => 'payrefundnum',
1289       'unique' => [],
1290       'index' => [ ['paynum'], ['refundnum'] ],
1291     },
1292
1293     'part_pkg_option' => {
1294       'columns' => [
1295         'optionnum', 'serial', '', '', '', '',
1296         'pkgpart', 'int', '', '', '', '',
1297         'optionname', 'varchar', '', $char_d, '', '',
1298         'optionvalue', 'text', 'NULL', '', '', '',
1299       ],
1300       'primary_key' => 'optionnum',
1301       'unique'      => [],
1302       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
1303     },
1304
1305     'rate' => {
1306       'columns' => [
1307         'ratenum',  'serial', '', '', '', '',
1308         'ratename', 'varchar', '', $char_d, '', '',
1309       ],
1310       'primary_key' => 'ratenum',
1311       'unique'      => [],
1312       'index'       => [],
1313     },
1314
1315     'rate_detail' => {
1316       'columns' => [
1317         'ratedetailnum',   'serial', '', '', '', '',
1318         'ratenum',         'int',     '', '', '', '',
1319         'orig_regionnum',  'int', 'NULL', '', '', '',
1320         'dest_regionnum',  'int',     '', '', '', '',
1321         'min_included',    'int',     '', '', '', '',
1322         #'min_charge',      @money_type, '', '',
1323         'min_charge',      'decimal', '', '10,5', '', '',
1324         'sec_granularity', 'int',     '', '', '', '',
1325         #time period (link to table of periods)?
1326       ],
1327       'primary_key' => 'ratedetailnum',
1328       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1329       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
1330     },
1331
1332     'rate_region' => {
1333       'columns' => [
1334         'regionnum',   'serial',      '', '', '', '',
1335         'regionname',  'varchar',     '', $char_d, '', '',
1336       ],
1337       'primary_key' => 'regionnum',
1338       'unique'      => [],
1339       'index'       => [],
1340     },
1341
1342     'rate_prefix' => {
1343       'columns' => [
1344         'prefixnum',   'serial',    '', '', '', '',
1345         'regionnum',   'int',       '', '',, '', '',
1346         'countrycode', 'varchar',     '', 3, '', '',
1347         'npa',         'varchar', 'NULL', 6, '', '',
1348         'nxx',         'varchar', 'NULL', 3, '', '',
1349       ],
1350       'primary_key' => 'prefixnum',
1351       'unique'      => [],
1352       'index'       => [ [ 'countrycode' ], [ 'regionnum' ] ],
1353     },
1354
1355     'reg_code' => {
1356       'columns' => [
1357         'codenum',   'serial',    '', '', '', '',
1358         'code',      'varchar',   '', $char_d, '', '',
1359         'agentnum',  'int',       '', '', '', '',
1360       ],
1361       'primary_key' => 'codenum',
1362       'unique'      => [ [ 'agentnum', 'code' ] ],
1363       'index'       => [ [ 'agentnum' ] ],
1364     },
1365
1366     'reg_code_pkg' => {
1367       'columns' => [
1368         'codepkgnum', 'serial', '', '', '', '',
1369         'codenum',   'int',    '', '', '', '',
1370         'pkgpart',   'int',    '', '', '', '',
1371       ],
1372       'primary_key' => 'codepkgnum',
1373       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
1374       'index'       => [ [ 'codenum' ] ],
1375     },
1376
1377     'clientapi_session' => {
1378       'columns' => [
1379         'sessionnum',  'serial',  '', '', '', '',
1380         'sessionid',  'varchar',  '', $char_d, '', '',
1381         'namespace',  'varchar',  '', $char_d, '', '',
1382       ],
1383       'primary_key' => 'sessionnum',
1384       'unique'      => [ [ 'sessionid', 'namespace' ] ],
1385       'index'       => [],
1386     },
1387
1388     'clientapi_session_field' => {
1389       'columns' => [
1390         'fieldnum',    'serial',     '', '', '', '',
1391         'sessionnum',     'int',     '', '', '', '',
1392         'fieldname',  'varchar',     '', $char_d, '', '',
1393         'fieldvalue',    'text', 'NULL', '', '', '',
1394       ],
1395       'primary_key' => 'fieldnum',
1396       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
1397       'index'       => [],
1398     },
1399
1400     'payment_gateway' => {
1401       'columns' => [
1402         'gatewaynum',       'serial',   '',     '', '', '',
1403         'gateway_module',   'varchar',  '',     $char_d, '', '',
1404         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
1405         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
1406         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
1407         'disabled',   'char',  'NULL',   1, '', '',
1408       ],
1409       'primary_key' => 'gatewaynum',
1410       'unique' => [],
1411       'index'  => [ [ 'disabled' ] ],
1412     },
1413
1414     'payment_gateway_option' => {
1415       'columns' => [
1416         'optionnum',   'serial',  '',     '', '', '',
1417         'gatewaynum',  'int',     '',     '', '', '',
1418         'optionname',  'varchar', '',     $char_d, '', '',
1419         'optionvalue', 'text',    'NULL', '', '', '',
1420       ],
1421       'primary_key' => 'optionnum',
1422       'unique'      => [],
1423       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1424     },
1425
1426     'agent_payment_gateway' => {
1427       'columns' => [
1428         'agentgatewaynum', 'serial', '', '', '', '',
1429         'agentnum',        'int', '', '', '', '',
1430         'gatewaynum',      'int', '', '', '', '',
1431         'cardtype',        'varchar', 'NULL', $char_d, '', '',
1432         'taxclass',        'varchar', 'NULL', $char_d, '', '',
1433       ],
1434       'primary_key' => 'agentgatewaynum',
1435       'unique'      => [],
1436       'index'       => [ [ 'agentnum', 'cardtype' ], ],
1437     },
1438
1439     'banned_pay' => {
1440       'columns' => [
1441         'bannum',  'serial',   '',     '', '', '',
1442         'payby',   'char',     '',       4, '', '',
1443         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
1444         #'paymask', 'varchar',  'NULL', $char_d, '', ''
1445         '_date',   @date_type, '', '',
1446         'otaker',  'varchar',  '',     32, '', '',
1447         'reason',  'varchar',  'NULL', $char_d, '', '',
1448       ],
1449       'primary_key' => 'bannum',
1450       'unique'      => [ [ 'payby', 'payinfo' ] ],
1451       'index'       => [],
1452     },
1453
1454     'pkg_class' => {
1455       'columns' => [
1456         'classnum',   'serial',  '', '', '', '',
1457         'classname',  'varchar', '', $char_d, '', '',
1458         'disabled',     'char', 'NULL',   1, '', '',
1459       ],
1460       'primary_key' => 'classnum',
1461       'unique' => [],
1462       'index' => [ ['disabled'] ],
1463     },
1464
1465     'cdr' => {
1466       'columns' => [
1467         # qw( name type null length default local );
1468
1469         ###
1470         #asterisk fields
1471         ###
1472
1473         'acctid',   'bigserial',  '', '', '', '',
1474         'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1475         'clid',        'varchar',  '', $char_d, \"''", '',
1476         'src',         'varchar',  '', $char_d, \"''", '',
1477         'dst',         'varchar',  '', $char_d, \"''", '',
1478         'dcontext',    'varchar',  '', $char_d, \"''", '',
1479         'channel',     'varchar',  '', $char_d, \"''", '',
1480         'dstchannel',  'varchar',  '', $char_d, \"''", '',
1481         'lastapp',     'varchar',  '', $char_d, \"''", '',
1482         'lastdata',    'varchar',  '', $char_d, \"''", '',
1483
1484         #these don't seem to be logged by most of the SQL cdr_* modules
1485         #except tds under sql-illegal names, so;
1486         # ... don't rely on them for rating?
1487         # and, what they hey, i went ahead and changed the names and data types
1488         # to freeside-style dates...
1489           #'start',  'timestamp', 'NULL',  '',    '', '',
1490           #'answer', 'timestamp', 'NULL',  '',    '', '',
1491           #'end',    'timestamp', 'NULL',  '',    '', '',
1492         'startdate',  @date_type, '', '',
1493         'answerdate', @date_type, '', '',
1494         'enddate',    @date_type, '', '',
1495         #
1496
1497         'duration',    'int',      '',      '',     0, '',
1498         'billsec',     'int',      '',      '',     0, '',
1499         'disposition', 'varchar',  '',      45, \"''", '',
1500         'amaflags',    'int',      '',      '',     0, '',
1501         'accountcode', 'varchar',  '',      20, \"''", '',
1502         'uniqueid',    'varchar',  '',      32, \"''", '',
1503         'userfield',   'varchar',  '',     255, \"''", '',
1504
1505         ###
1506         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1507         # defaults
1508         ###
1509
1510         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1511         'cdrtypenum',              'int', 'NULL',      '', '', '',
1512
1513         'charged_party',       'varchar', 'NULL', $char_d, '', '',
1514
1515         'upstream_currency',      'char', 'NULL',       3, '', '',
1516         'upstream_price',      'decimal', 'NULL',  '10,2', '', '',
1517         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
1518
1519         # how it was rated internally...
1520         'ratedetailnum',           'int', 'NULL',      '', '', '',
1521         'rated_price',         'decimal', 'NULL',  '10,2', '', '',
1522
1523         'distance',            'decimal', 'NULL',      '', '', '',
1524         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
1525
1526         #cdr_calltype: the big list in appendix 2
1527         'calltypenum',             'int', 'NULL',      '', '', '',
1528
1529         'description',         'varchar', 'NULL', $char_d, '', '',
1530         'quantity',                'int', 'NULL',      '', '', '',
1531
1532         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
1533         'carrierid',               'int', 'NULL',      '', '', '',
1534
1535         'upstream_rateid',         'int', 'NULL',      '', '', '',
1536
1537         ###
1538         #and now for our own fields
1539         ###
1540
1541         # a svcnum... right..?
1542         'svcnum',             'int',   'NULL',     '',   '', '',
1543
1544         #NULL, done (or something)
1545         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
1546
1547       ],
1548       'primary_key' => 'acctid',
1549       'unique' => [],
1550       'index' => [ [ 'calldate' ], [ 'dst' ], [ 'accountcode' ], [ 'freesidestatus' ] ],
1551     },
1552
1553     'cdr_calltype' => {
1554       'columns' => [
1555         'calltypenum',   'serial',  '', '', '', '',
1556         'calltypename',  'varchar', '', $char_d, '', '',
1557       ],
1558       'primary_key' => 'calltypenum',
1559       'unique'      => [],
1560       'index'       => [],
1561     },
1562
1563     'cdr_type' => {
1564       'columns' => [
1565         'cdrtypenum'  => 'serial',  '', '', '', '',
1566         'cdrtypename' => 'varchar', '', '', '', '',
1567       ],
1568       'primary_key' => 'cdrtypenum',
1569       'unique'      => [],
1570       'index'       => [],
1571     },
1572
1573     'cdr_carrier' => {
1574       'columns' => [
1575         'carrierid'   => 'serial',  '', '', '', '',
1576         'carriername' => 'varchar', '', '', '', '',
1577       ],
1578       'primary_key' => 'carrierid',
1579       'unique'      => [],
1580       'index'       => [],
1581     },
1582
1583     #map upstream rateid to ours...
1584     'cdr_upstream_rate' => {
1585       'columns' => [
1586         'upstreamratenum', 'serial',  '', '', '', '',
1587         'upstream_rateid', 'varchar', '', $char_d, '', '',
1588         'ratedetailnum',   'int', 'NULL', '', '', '',
1589       ],
1590       'primary_key' => 'upstreamratenum', #XXX need a primary key
1591       'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
1592       'index'  => [],
1593     },
1594
1595     'inventory_item' => {
1596       'columns' => [
1597         'itemnum',  'serial',      '',      '', '', '',
1598         'classnum', 'int',         '',      '', '', '',
1599         'item',     'varchar',     '', $char_d, '', '',
1600         'svcnum',   'int',     'NULL',      '', '', '',
1601       ],
1602       'primary_key' => 'itemnum',
1603       'unique' => [ [ 'classnum', 'item' ] ],
1604       'index'  => [ [ 'classnum' ], [ 'svcnum' ] ],
1605     },
1606
1607     'inventory_class' => {
1608       'columns' => [
1609         'classnum',  'serial',       '',      '', '', '',
1610         'classname', 'varchar',      '', $char_d, '', '',
1611       ],
1612       'primary_key' => 'classnum',
1613       'unique' => [],
1614       'index'  => [],
1615     },
1616
1617     'access_user' => {
1618       'columns' => [
1619         'usernum',   'serial',  '',      '', '', '',
1620         'username',  'varchar', '', $char_d, '', '',
1621         '_password', 'varchar', '', $char_d, '', '',
1622         'last',      'varchar', '', $char_d, '', '',
1623         'first',     'varchar', '', $char_d, '', '',
1624         'disabled',     'char', 'NULL',   1, '', '',
1625       ],
1626       'primary_key' => 'usernum',
1627       'unique' => [ [ 'username' ] ],
1628       'index'  => [],
1629     },
1630
1631     'access_user_pref' => {
1632       'columns' => [
1633         'prefnum',    'serial',       '', '', '', '',
1634         'usernum',     'int',       '', '', '', '',
1635         'prefname', 'varchar', '', $char_d, '', '',
1636         'prefvalue', 'text', 'NULL', '', '', '',
1637       ],
1638       'primary_key' => 'prefnum',
1639       'unique' => [],
1640       'index'  => [ [ 'usernum' ] ],
1641     },
1642
1643     'access_group' => {
1644       'columns' => [
1645         'groupnum',   'serial', '',      '', '', '',
1646         'groupname', 'varchar', '', $char_d, '', '',
1647       ],
1648       'primary_key' => 'groupnum',
1649       'unique' => [ [ 'groupname' ] ],
1650       'index'  => [],
1651     },
1652
1653     'access_usergroup' => {
1654       'columns' => [
1655         'usergroupnum', 'serial', '', '', '', '',
1656         'usernum',         'int', '', '', '', '',
1657         'groupnum',        'int', '', '', '', '',
1658       ],
1659       'primary_key' => 'usergroupnum',
1660       'unique' => [ [ 'usernum', 'groupnum' ] ],
1661       'index'  => [ [ 'usernum' ] ],
1662     },
1663
1664     'access_groupagent' => {
1665       'columns' => [
1666         'groupagentnum', 'serial', '', '', '', '',
1667         'groupnum',         'int', '', '', '', '',
1668         'agentnum',         'int', '', '', '', '',
1669       ],
1670       'primary_key' => 'groupagentnum',
1671       'unique' => [ [ 'groupnum', 'agentnum' ] ],
1672       'index'  => [ [ 'groupnum' ] ],
1673     },
1674
1675     'access_right' => {
1676       'columns' => [
1677         'rightnum',   'serial', '',      '', '', '',
1678         'righttype', 'varchar', '', $char_d, '', '',
1679         'rightobjnum',   'int', '',      '', '', '',
1680         'rightname', 'varchar', '',      '', '', '',
1681       ],
1682       'primary_key' => 'rightnum',
1683       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
1684       'index'  => [],
1685     },
1686
1687     'svc_phone' => {
1688       'columns' => [
1689         'svcnum',      'int',         '',      '', '', '',
1690         'countrycode', 'varchar',     '',       3, '', '',
1691         'phonenum',    'varchar',     '',      15, '', '',  #12 ?
1692         'pin',         'varchar', 'NULL', $char_d, '', '',
1693       ],
1694       'primary_key' => 'svcnum',
1695       'unique' => [],
1696       'index'  => [ [ 'countrycode', 'phonenum' ] ],
1697     },
1698
1699     'reason_type' => {
1700       'columns' => [
1701         'typenum',   'serial',  '', '', '', '',
1702         'class',     'char', '', 1, '', '',
1703         'type',     'varchar', '', $char_d, '', '',
1704       ],
1705       'primary_key' => 'typenum',
1706       'unique' => [],
1707       'index' => [],
1708     },
1709
1710     'reason' => {
1711       'columns' => [
1712         'reasonnum',     'serial',  '', '', '', '',
1713         'reason_type',   'int',  '', '', '', '',
1714         'reason',        'varchar', '', $char_d, '', '',
1715         'disabled',      'char',    'NULL', 1, '', '',
1716       ],
1717       'primary_key' => 'reasonnum',
1718       'unique' => [],
1719       'index' => [],
1720     },
1721
1722     'conf' => {
1723       'columns' => [
1724         'confnum',  'serial',  '', '', '', '',
1725         'agentnum', 'int',  'NULL', '', '', '',
1726         'name',     'varchar', '', $char_d, '', '',
1727         'value',    'varchar', 'NULL', '', '', '',       # Pg specific
1728       ],
1729       'primary_key' => 'confnum',
1730       'unique' => [ [ 'agentnum', 'name' ]],
1731       'index' => [],
1732     },
1733
1734     # name type nullability length default local
1735
1736     #'new_table' => {
1737     #  'columns' => [
1738     #    'num', 'serial',       '', '', '', '',
1739     #  ],
1740     #  'primary_key' => 'num',
1741     #  'unique' => [],
1742     #  'index'  => [],
1743     #},
1744
1745   };
1746
1747 }
1748
1749 =back
1750
1751 =head1 BUGS
1752
1753 =head1 SEE ALSO
1754
1755 L<DBIx::DBSchema>
1756
1757 =cut
1758
1759 1;
1760