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         'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
 556         'closed',    'char', 'NULL', 1, '', '',
 557       ],
 558       'primary_key' => 'paynum',
 559       'unique' => [ [ 'payunique' ] ],
 560       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
 561     },
 562
 563     'cust_pay_void' => {
 564       'columns' => [
 565         'paynum',    'int',    '',   '', '', '',
 566         'custnum',   'int',    '',   '', '', '',
 567         'paid',      @money_type, '', '',
 568         '_date',     @date_type, '', '',
 569         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 570                                                   # index into payby table
 571                                                   # eventually
 572         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
 573         'paymask', 'varchar', 'NULL', $char_d, '', '',
 574         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 575         'closed',    'char', 'NULL', 1, '', '',
 576         'void_date', @date_type, '', '',
 577         'reason',    'varchar',   'NULL', $char_d, '', '',
 578         'otaker',   'varchar', '', 32, '', '',
 579       ],
 580       'primary_key' => 'paynum',
 581       'unique' => [],
 582       'index' => [ [ 'custnum' ] ],
 583     },
 584
 585     'cust_bill_pay' => {
 586       'columns' => [
 587         'billpaynum', 'serial',     '',   '', '', '',
 588         'invnum',  'int',     '',   '', '', '',
 589         'paynum',  'int',     '',   '', '', '',
 590         'amount',  @money_type, '', '',
 591         '_date',   @date_type, '', '',
 592       ],
 593       'primary_key' => 'billpaynum',
 594       'unique' => [],
 595       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
 596     },
 597
 598     'cust_bill_pay_batch' => {
 599       'columns' => [
 600         'billpaynum', 'serial',     '',   '', '', '',
 601         'invnum',  'int',     '',   '', '', '',
 602         'paybatchnum',  'int',     '',   '', '', '',
 603         'amount',  @money_type, '', '',
 604         '_date',   @date_type, '', '',
 605       ],
 606       'primary_key' => 'billpaynum',
 607       'unique' => [],
 608       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
 609     },
 610
 611     'cust_bill_pay_pkg' => {
 612       'columns' => [
 613         'billpaypkgnum', 'serial', '', '', '', '',
 614         'billpaynum',       'int', '', '', '', '',
 615         'billpkgnum',       'int', '', '', '', '',
 616         'amount',         @money_type,     '', '',
 617         'setuprecur',      'varchar', '', $char_d, '', '',
 618         'sdate',   @date_type, '', '',
 619         'edate',   @date_type, '', '',
 620       ],
 621       'primary_key' => 'billpaypkgnum',
 622       'unique'      => [],
 623       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
 624     },
 625
 626     'pay_batch' => { #batches of payments to an external processor
 627       'columns' => [
 628         'batchnum',   'serial',    '',   '', '', '',
 629         'payby',      'char',      '',    4, '', '', # CARD/CHEK
 630         'status',     'char', 'NULL',     1, '', '',
 631         'download',   @date_type, '', '',
 632         'upload',     @date_type, '', '',
 633       ],
 634       'primary_key' => 'batchnum',
 635       'unique' => [],
 636       'index' => [],
 637     },
 638
 639     'cust_pay_batch' => { #what's this used for again?  list of customers
 640                           #in current CARD batch? (necessarily CARD?)
 641       'columns' => [
 642         'paybatchnum',   'serial',    '',   '', '', '',
 643         'batchnum',   'int',    '',   '', '', '',
 644         'invnum',   'int',    '',   '', '', '',
 645         'custnum',   'int',    '',   '', '', '',
 646         'last',     'varchar', '',     $char_d, '', '',
 647         'first',    'varchar', '',     $char_d, '', '',
 648         'address1', 'varchar', '',     $char_d, '', '',
 649         'address2', 'varchar', 'NULL', $char_d, '', '',
 650         'city',     'varchar', '',     $char_d, '', '',
 651         'state',    'varchar', 'NULL', $char_d, '', '',
 652         'zip',      'varchar', 'NULL', 10, '', '',
 653         'country',  'char', '',     2, '', '',
 654         #        'trancode', 'int', '', '', '', ''
 655         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 656         'payinfo',  'varchar', '',     512, '', '',
 657         #'exp',      @date_type, '', ''
 658         'exp',      'varchar', 'NULL',     11, '', '',
 659         'payname',  'varchar', 'NULL', $char_d, '', '',
 660         'amount',   @money_type, '', '',
 661         'status',   'varchar', 'NULL',     $char_d, '', '',
 662       ],
 663       'primary_key' => 'paybatchnum',
 664       'unique' => [],
 665       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
 666     },
 667
 668     'cust_pkg' => {
 669       'columns' => [
 670         'pkgnum',    'serial',    '',   '', '', '',
 671         'custnum',   'int',    '',   '', '', '',
 672         'pkgpart',   'int',    '',   '', '', '',
 673         'otaker',    'varchar', '', 32, '', '',
 674         'setup',     @date_type, '', '',
 675         'bill',      @date_type, '', '',
 676         'last_bill', @date_type, '', '',
 677         'susp',      @date_type, '', '',
 678         'adjourn',   @date_type, '', '',
 679         'cancel',    @date_type, '', '',
 680         'expire',    @date_type, '', '',
 681         'manual_flag', 'char', 'NULL', 1, '', '',
 682       ],
 683       'primary_key' => 'pkgnum',
 684       'unique' => [],
 685       'index' => [ ['custnum'], ['pkgpart'] ],
 686     },
 687
 688     'cust_pkg_option' => {
 689       'columns' => [
 690         'optionnum', 'serial', '', '', '', '',
 691         'pkgnum', 'int', '', '', '', '',
 692         'optionname', 'varchar', '', $char_d, '', '',
 693         'optionvalue', 'text', 'NULL', '', '', '',
 694       ],
 695       'primary_key' => 'optionnum',
 696       'unique'      => [],
 697       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
 698     },
 699
 700     'cust_pkg_reason' => {
 701       'columns' => [
 702         'num',      'serial',    '',   '', '', '',
 703         'pkgnum',   'int',    '',   '', '', '',
 704         'reasonnum','int',    '',   '', '', '',
 705         'otaker',   'varchar', '', 32, '', '',
 706         'date',     @date_type, '', '',
 707       ],
 708       'primary_key' => 'num',
 709       'unique' => [],
 710       'index' => [],
 711     },
 712
 713     'cust_refund' => {
 714       'columns' => [
 715         'refundnum',    'serial',    '',   '', '', '',
 716         #now cust_credit_refund #'crednum',      'int',    '',   '', '', '',
 717         'custnum',  'int',    '',   '', '', '',
 718         '_date',        @date_type, '', '',
 719         'refund',       @money_type, '', '',
 720         'otaker',       'varchar',   '',   32, '', '',
 721         'reason',       'varchar',   '',   $char_d, '', '',
 722         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
 723                                                      # be index into payby
 724                                                      # table eventually
 725         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
 726         'paymask', 'varchar', 'NULL', $char_d, '', '',
 727         'paybatch',     'varchar',   'NULL', $char_d, '', '',
 728         'closed',    'char', 'NULL', 1, '', '',
 729       ],
 730       'primary_key' => 'refundnum',
 731       'unique' => [],
 732       'index' => [],
 733     },
 734
 735     'cust_credit_refund' => {
 736       'columns' => [
 737         'creditrefundnum', 'serial',     '',   '', '', '',
 738         'crednum',  'int',     '',   '', '', '',
 739         'refundnum',  'int',     '',   '', '', '',
 740         'amount',  @money_type, '', '',
 741         '_date',   @date_type, '', '',
 742       ],
 743       'primary_key' => 'creditrefundnum',
 744       'unique' => [],
 745       'index' => [ [ 'crednum', 'refundnum' ] ],
 746     },
 747
 748
 749     'cust_svc' => {
 750       'columns' => [
 751         'svcnum',    'serial',    '',   '', '', '',
 752         'pkgnum',    'int',    'NULL',   '', '', '',
 753         'svcpart',   'int',    '',   '', '', '',
 754         'overlimit', @date_type, '', '',
 755       ],
 756       'primary_key' => 'svcnum',
 757       'unique' => [],
 758       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
 759     },
 760
 761     'part_pkg' => {
 762       'columns' => [
 763         'pkgpart',       'serial',    '',   '', '', '',
 764         'pkg',           'varchar',   '',   $char_d, '', '',
 765         'comment',       'varchar',   '',   $char_d, '', '',
 766         'promo_code',    'varchar', 'NULL', $char_d, '', '',
 767         'setup',         @perl_type, '', '',
 768         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
 769         'recur',         @perl_type, '', '',
 770         'setuptax',      'char', 'NULL', 1, '', '',
 771         'recurtax',      'char', 'NULL', 1, '', '',
 772         'plan',          'varchar', 'NULL', $char_d, '', '',
 773         'plandata',      'text', 'NULL', '', '', '',
 774         'disabled',      'char', 'NULL', 1, '', '',
 775         'taxclass',      'varchar', 'NULL', $char_d, '', '',
 776         'classnum',      'int',     'NULL', '', '', '',
 777         'pay_weight',    'real',    'NULL', '', '', '',
 778         'credit_weight', 'real',    'NULL', '', '', '',
 779       ],
 780       'primary_key' => 'pkgpart',
 781       'unique' => [],
 782       'index' => [ [ 'promo_code' ], [ 'disabled' ] ],
 783     },
 784
 785 #    'part_title' => {
 786 #      'columns' => [
 787 #        'titlenum',   'int',    '',   '',
 788 #        'title',      'varchar',   '',   $char_d,
 789 #      ],
 790 #      'primary_key' => 'titlenum',
 791 #      'unique' => [ [] ],
 792 #      'index' => [ [] ],
 793 #    },
 794
 795     'pkg_svc' => {
 796       'columns' => [
 797         'pkgsvcnum',  'serial', '',  '', '', '',
 798         'pkgpart',    'int',    '',   '', '', '',
 799         'svcpart',    'int',    '',   '', '', '',
 800         'quantity',   'int',    '',   '', '', '',
 801         'primary_svc','char', 'NULL',  1, '', '',
 802       ],
 803       'primary_key' => 'pkgsvcnum',
 804       'unique' => [ ['pkgpart', 'svcpart'] ],
 805       'index' => [ ['pkgpart'] ],
 806     },
 807
 808     'part_referral' => {
 809       'columns' => [
 810         'refnum',   'serial',     '',        '', '', '',
 811         'referral', 'varchar',    '',   $char_d, '', '',
 812         'disabled', 'char',   'NULL',         1, '', '',
 813         'agentnum', 'int',    'NULL',        '', '', '',
 814       ],
 815       'primary_key' => 'refnum',
 816       'unique' => [],
 817       'index' => [ ['disabled'] ],
 818     },
 819
 820     'part_svc' => {
 821       'columns' => [
 822         'svcpart',    'serial',    '',   '', '', '',
 823         'svc',        'varchar',   '',   $char_d, '', '',
 824         'svcdb',      'varchar',   '',   $char_d, '', '',
 825         'disabled',   'char',  'NULL',   1, '', '',
 826       ],
 827       'primary_key' => 'svcpart',
 828       'unique' => [],
 829       'index' => [ [ 'disabled' ] ],
 830     },
 831
 832     'part_svc_column' => {
 833       'columns' => [
 834         'columnnum',   'serial',         '', '', '', '',
 835         'svcpart',     'int',         '', '', '', '',
 836         'columnname',  'varchar',     '', 64, '', '',
 837         'columnvalue', 'varchar', 'NULL', $char_d, '', '',
 838         'columnflag',  'char',    'NULL', 1, '', '',
 839       ],
 840       'primary_key' => 'columnnum',
 841       'unique' => [ [ 'svcpart', 'columnname' ] ],
 842       'index' => [ [ 'svcpart' ] ],
 843     },
 844
 845     #(this should be renamed to part_pop)
 846     'svc_acct_pop' => {
 847       'columns' => [
 848         'popnum',    'serial',    '',   '', '', '',
 849         'city',      'varchar',   '',   $char_d, '', '',
 850         'state',     'varchar',   '',   $char_d, '', '',
 851         'ac',        'char',   '',   3, '', '',
 852         'exch',      'char',   '',   3, '', '',
 853         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
 854       ],
 855       'primary_key' => 'popnum',
 856       'unique' => [],
 857       'index' => [ [ 'state' ] ],
 858     },
 859
 860     'part_pop_local' => {
 861       'columns' => [
 862         'localnum',  'serial',     '',     '', '', '',
 863         'popnum',    'int',     '',     '', '', '',
 864         'city',      'varchar', 'NULL', $char_d, '', '',
 865         'state',     'char',    'NULL', 2, '', '',
 866         'npa',       'char',    '',     3, '', '',
 867         'nxx',       'char',    '',     3, '', '',
 868       ],
 869       'primary_key' => 'localnum',
 870       'unique' => [],
 871       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
 872     },
 873
 874     'svc_acct' => {
 875       'columns' => [
 876         'svcnum',    'int',    '',   '', '', '',
 877         'username',  'varchar',   '',   $username_len, '', '',
 878         '_password', 'varchar',   '',  512, '', '',
 879         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
 880         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
 881         'popnum',    'int',    'NULL',   '', '', '',
 882         'uid',       'int', 'NULL',   '', '', '',
 883         'gid',       'int', 'NULL',   '', '', '',
 884         'finger',    'varchar',   'NULL',   $char_d, '', '',
 885         'dir',       'varchar',   'NULL',   $char_d, '', '',
 886         'shell',     'varchar',   'NULL',   $char_d, '', '',
 887         'quota',     'varchar',   'NULL',   $char_d, '', '',
 888         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
 889         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
 890         'seconds_threshold',   'int', 'NULL',   '', '', '',
 891         'upbytes',   'bigint', 'NULL',   '', '', '',
 892         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
 893         'downbytes', 'bigint', 'NULL',   '', '', '',
 894         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
 895         'totalbytes','bigint', 'NULL',   '', '', '',
 896         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
 897         'domsvc',    'int', '',   '', '', '',
 898       ],
 899       'primary_key' => 'svcnum',
 900       #'unique' => [ [ 'username', 'domsvc' ] ],
 901       'unique' => [],
 902       'index' => [ ['username'], ['domsvc'] ],
 903     },
 904
 905     #'svc_charge' => {
 906     #  'columns' => [
 907     #    'svcnum',    'int',    '',   '',
 908     #    'amount',    @money_type,
 909     #  ],
 910     #  'primary_key' => 'svcnum',
 911     #  'unique' => [ [] ],
 912     #  'index' => [ [] ],
 913     #},
 914
 915     'svc_domain' => {
 916       'columns' => [
 917         'svcnum',           'int',    '',        '', '', '',
 918         'domain',       'varchar',    '',   $char_d, '', '',
 919         'suffix',       'varchar', 'NULL',  $char_d, '', '',
 920         'catchall',         'int', 'NULL',       '', '', '',
 921         'parent_svcnum',    'int', 'NULL',       '', '', '',
 922         'registrarnum',     'int', 'NULL',       '', '', '',
 923         'registrarkey', 'varchar', 'NULL',       '', '', '',
 924         'setup_date',  @date_type, '', '',
 925         'renewal_interval', 'int', 'NULL',       '', '', '',
 926         'expiration_date', @date_type, '', '',
 927       ],
 928       'primary_key' => 'svcnum',
 929       'unique' => [ ],
 930       'index' => [ ['domain'] ],
 931     },
 932
 933     'domain_record' => {
 934       'columns' => [
 935         'recnum',    'serial',     '',  '', '', '',
 936         'svcnum',    'int',     '',  '', '', '',
 937         'reczone',   'varchar', '',  255, '', '',
 938         'recaf',     'char',    '',  2, '', '',
 939         'rectype',   'varchar',    '',  5, '', '',
 940         'recdata',   'varchar', '',  255, '', '',
 941       ],
 942       'primary_key' => 'recnum',
 943       'unique'      => [],
 944       'index'       => [ ['svcnum'] ],
 945     },
 946
 947     'registrar' => {
 948       'columns' => [
 949         'registrarnum',   'serial', '',      '', '', '',
 950         'registrarname', 'varchar', '', $char_d, '', '',
 951       ],
 952       'primary_key' => 'registrarnum',
 953       'unique'      => [],
 954       'index'       => [],
 955     },
 956
 957     'svc_forward' => {
 958       'columns' => [
 959         'svcnum',   'int',            '',   '', '', '',
 960         'srcsvc',   'int',        'NULL',   '', '', '',
 961         'src',      'varchar',    'NULL',  255, '', '',
 962         'dstsvc',   'int',        'NULL',   '', '', '',
 963         'dst',      'varchar',    'NULL',  255, '', '',
 964       ],
 965       'primary_key' => 'svcnum',
 966       'unique'      => [],
 967       'index'       => [ ['srcsvc'], ['dstsvc'] ],
 968     },
 969
 970     'svc_www' => {
 971       'columns' => [
 972         'svcnum',   'int',    '',  '', '', '',
 973         'recnum',   'int',    '',  '', '', '',
 974         'usersvc',  'int',    '',  '', '', '',
 975         'config',   'text',   'NULL',  '', '', '',
 976       ],
 977       'primary_key' => 'svcnum',
 978       'unique'      => [],
 979       'index'       => [],
 980     },
 981
 982     #'svc_wo' => {
 983     #  'columns' => [
 984     #    'svcnum',    'int',    '',   '',
 985     #    'svcnum',    'int',    '',   '',
 986     #    'svcnum',    'int',    '',   '',
 987     #    'worker',    'varchar',   '',   $char_d,
 988     #    '_date',     @date_type,
 989     #  ],
 990     #  'primary_key' => 'svcnum',
 991     #  'unique' => [ [] ],
 992     #  'index' => [ [] ],
 993     #},
 994
 995     'prepay_credit' => {
 996       'columns' => [
 997         'prepaynum',   'serial',     '',   '', '', '',
 998         'identifier',  'varchar', '', $char_d, '', '',
 999         'amount',      @money_type, '', '',
1000         'seconds',     'int',     'NULL', '', '', '',
1001         'upbytes',     'bigint',     'NULL', '', '', '',
1002         'downbytes',   'bigint',     'NULL', '', '', '',
1003         'totalbytes',  'bigint',     'NULL', '', '', '',
1004         'agentnum',    'int',     'NULL', '', '', '',
1005       ],
1006       'primary_key' => 'prepaynum',
1007       'unique'      => [ ['identifier'] ],
1008       'index'       => [],
1009     },
1010
1011     'port' => {
1012       'columns' => [
1013         'portnum',  'serial',     '',   '', '', '',
1014         'ip',       'varchar', 'NULL', 15, '', '',
1015         'nasport',  'int',     'NULL', '', '', '',
1016         'nasnum',   'int',     '',   '', '', '',
1017       ],
1018       'primary_key' => 'portnum',
1019       'unique'      => [],
1020       'index'       => [],
1021     },
1022
1023     'nas' => {
1024       'columns' => [
1025         'nasnum',   'serial',     '',    '', '', '',
1026         'nas',      'varchar', '',    $char_d, '', '',
1027         'nasip',    'varchar', '',    15, '', '',
1028         'nasfqdn',  'varchar', '',    $char_d, '', '',
1029         'last',     'int',     '',    '', '', '',
1030       ],
1031       'primary_key' => 'nasnum',
1032       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
1033       'index'       => [ [ 'last' ] ],
1034     },
1035
1036 #    'session' => {
1037 #      'columns' => [
1038 #        'sessionnum', 'serial',       '',   '', '', '',
1039 #        'portnum',    'int',       '',   '', '', '',
1040 #        'svcnum',     'int',       '',   '', '', '',
1041 #        'login',      @date_type, '', '',
1042 #        'logout',     @date_type, '', '',
1043 #      ],
1044 #      'primary_key' => 'sessionnum',
1045 #      'unique'      => [],
1046 #      'index'       => [ [ 'portnum' ] ],
1047 #    },
1048
1049     'queue' => {
1050       'columns' => [
1051         'jobnum', 'serial', '', '', '', '',
1052         'job', 'text', '', '', '', '',
1053         '_date', 'int', '', '', '', '',
1054         'status', 'varchar', '', $char_d, '', '',
1055         'statustext', 'text', 'NULL', '', '', '',
1056         'svcnum', 'int', 'NULL', '', '', '',
1057       ],
1058       'primary_key' => 'jobnum',
1059       'unique'      => [],
1060       'index'       => [ [ 'svcnum' ], [ 'status' ] ],
1061     },
1062
1063     'queue_arg' => {
1064       'columns' => [
1065         'argnum', 'serial', '', '', '', '',
1066         'jobnum', 'int', '', '', '', '',
1067         'arg', 'text', 'NULL', '', '', '',
1068       ],
1069       'primary_key' => 'argnum',
1070       'unique'      => [],
1071       'index'       => [ [ 'jobnum' ] ],
1072     },
1073
1074     'queue_depend' => {
1075       'columns' => [
1076         'dependnum', 'serial', '', '', '', '',
1077         'jobnum', 'int', '', '', '', '',
1078         'depend_jobnum', 'int', '', '', '', '',
1079       ],
1080       'primary_key' => 'dependnum',
1081       'unique'      => [],
1082       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1083     },
1084
1085     'export_svc' => {
1086       'columns' => [
1087         'exportsvcnum' => 'serial', '', '', '', '',
1088         'exportnum'    => 'int', '', '', '', '',
1089         'svcpart'      => 'int', '', '', '', '',
1090       ],
1091       'primary_key' => 'exportsvcnum',
1092       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
1093       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
1094     },
1095
1096     'part_export' => {
1097       'columns' => [
1098         'exportnum', 'serial', '', '', '', '',
1099         'machine', 'varchar', '', $char_d, '', '',
1100         'exporttype', 'varchar', '', $char_d, '', '',
1101         'nodomain',     'char', 'NULL', 1, '', '',
1102       ],
1103       'primary_key' => 'exportnum',
1104       'unique'      => [],
1105       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
1106     },
1107
1108     'part_export_option' => {
1109       'columns' => [
1110         'optionnum', 'serial', '', '', '', '',
1111         'exportnum', 'int', '', '', '', '',
1112         'optionname', 'varchar', '', $char_d, '', '',
1113         'optionvalue', 'text', 'NULL', '', '', '',
1114       ],
1115       'primary_key' => 'optionnum',
1116       'unique'      => [],
1117       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
1118     },
1119
1120     'radius_usergroup' => {
1121       'columns' => [
1122         'usergroupnum', 'serial', '', '', '', '',
1123         'svcnum',       'int', '', '', '', '',
1124         'groupname',    'varchar', '', $char_d, '', '',
1125       ],
1126       'primary_key' => 'usergroupnum',
1127       'unique'      => [],
1128       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
1129     },
1130
1131     'msgcat' => {
1132       'columns' => [
1133         'msgnum', 'serial', '', '', '', '',
1134         'msgcode', 'varchar', '', $char_d, '', '',
1135         'locale', 'varchar', '', 16, '', '',
1136         'msg', 'text', '', '', '', '',
1137       ],
1138       'primary_key' => 'msgnum',
1139       'unique'      => [ [ 'msgcode', 'locale' ] ],
1140       'index'       => [],
1141     },
1142
1143     'cust_tax_exempt' => {
1144       'columns' => [
1145         'exemptnum', 'serial', '', '', '', '',
1146         'custnum',   'int', '', '', '', '',
1147         'taxnum',    'int', '', '', '', '',
1148         'year',      'int', '', '', '', '',
1149         'month',     'int', '', '', '', '',
1150         'amount',   @money_type, '', '',
1151       ],
1152       'primary_key' => 'exemptnum',
1153       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1154       'index'       => [],
1155     },
1156
1157     'cust_tax_exempt_pkg' => {
1158       'columns' => [
1159         'exemptpkgnum',  'serial', '', '', '', '',
1160         #'custnum',      'int', '', '', '', ''
1161         'billpkgnum',   'int', '', '', '', '',
1162         'taxnum',       'int', '', '', '', '',
1163         'year',         'int', '', '', '', '',
1164         'month',        'int', '', '', '', '',
1165         'amount',       @money_type, '', '',
1166       ],
1167       'primary_key' => 'exemptpkgnum',
1168       'unique' => [],
1169       'index'  => [ [ 'taxnum', 'year', 'month' ],
1170                     [ 'billpkgnum' ],
1171                     [ 'taxnum' ]
1172                   ],
1173     },
1174
1175     'router' => {
1176       'columns' => [
1177         'routernum', 'serial', '', '', '', '',
1178         'routername', 'varchar', '', $char_d, '', '',
1179         'svcnum', 'int', 'NULL', '', '', '',
1180       ],
1181       'primary_key' => 'routernum',
1182       'unique'      => [],
1183       'index'       => [],
1184     },
1185
1186     'part_svc_router' => {
1187       'columns' => [
1188         'svcrouternum', 'serial', '', '', '', '',
1189         'svcpart', 'int', '', '', '', '',
1190         'routernum', 'int', '', '', '', '',
1191       ],
1192       'primary_key' => 'svcrouternum',
1193       'unique'      => [],
1194       'index'       => [],
1195     },
1196
1197     'addr_block' => {
1198       'columns' => [
1199         'blocknum', 'serial', '', '', '', '',
1200         'routernum', 'int', '', '', '', '',
1201         'ip_gateway', 'varchar', '', 15, '', '',
1202         'ip_netmask', 'int', '', '', '', '',
1203       ],
1204       'primary_key' => 'blocknum',
1205       'unique'      => [ [ 'blocknum', 'routernum' ] ],
1206       'index'       => [],
1207     },
1208
1209     'svc_broadband' => {
1210       'columns' => [
1211         'svcnum', 'int', '', '', '', '',
1212         'description', 'varchar', 'NULL', $char_d, '', '',
1213         'blocknum', 'int', '', '', '', '',
1214         'speed_up', 'int', '', '', '', '',
1215         'speed_down', 'int', '', '', '', '',
1216         'ip_addr', 'varchar', '', 15, '', '',
1217         'mac_addr', 'varchar', 'NULL', 12, '', '',
1218         'authkey',  'varchar', 'NULL', 32, '', '',
1219         'latitude', 'decimal', 'NULL', '', '', '',
1220         'longitude', 'decimal', 'NULL', '', '', '',
1221         'altitude', 'decimal', 'NULL', '', '', '',
1222         'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1223       ],
1224       'primary_key' => 'svcnum',
1225       'unique'      => [],
1226       'index'       => [],
1227     },
1228
1229     'part_virtual_field' => {
1230       'columns' => [
1231         'vfieldpart', 'serial', '', '', '', '',
1232         'dbtable', 'varchar', '', 32, '', '',
1233         'name', 'varchar', '', 32, '', '',
1234         'check_block', 'text', 'NULL', '', '', '',
1235         'length', 'int', 'NULL', '', '', '',
1236         'list_source', 'text', 'NULL', '', '', '',
1237         'label', 'varchar', 'NULL', 80, '', '',
1238       ],
1239       'primary_key' => 'vfieldpart',
1240       'unique' => [],
1241       'index' => [],
1242     },
1243
1244     'virtual_field' => {
1245       'columns' => [
1246         'vfieldnum', 'serial', '', '', '', '',
1247         'recnum', 'int', '', '', '', '',
1248         'vfieldpart', 'int', '', '', '', '',
1249         'value', 'varchar', '', 128, '', '',
1250       ],
1251       'primary_key' => 'vfieldnum',
1252       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1253       'index' => [],
1254     },
1255
1256     'acct_snarf' => {
1257       'columns' => [
1258         'snarfnum',  'int', '', '', '', '',
1259         'svcnum',    'int', '', '', '', '',
1260         'machine',   'varchar', '', 255, '', '',
1261         'protocol',  'varchar', '', $char_d, '', '',
1262         'username',  'varchar', '', $char_d, '', '',
1263         '_password', 'varchar', '', $char_d, '', '',
1264       ],
1265       'primary_key' => 'snarfnum',
1266       'unique' => [],
1267       'index'  => [ [ 'svcnum' ] ],
1268     },
1269
1270     'svc_external' => {
1271       'columns' => [
1272         'svcnum', 'int', '', '', '', '',
1273         'id',     'int', 'NULL', '', '', '',
1274         'title',  'varchar', 'NULL', $char_d, '', '',
1275       ],
1276       'primary_key' => 'svcnum',
1277       'unique'      => [],
1278       'index'       => [],
1279     },
1280
1281     'cust_pay_refund' => {
1282       'columns' => [
1283         'payrefundnum', 'serial', '', '', '', '',
1284         'paynum',  'int', '', '', '', '',
1285         'refundnum',  'int', '', '', '', '',
1286         '_date',    @date_type, '', '',
1287         'amount',   @money_type, '', '',
1288       ],
1289       'primary_key' => 'payrefundnum',
1290       'unique' => [],
1291       'index' => [ ['paynum'], ['refundnum'] ],
1292     },
1293
1294     'part_pkg_option' => {
1295       'columns' => [
1296         'optionnum', 'serial', '', '', '', '',
1297         'pkgpart', 'int', '', '', '', '',
1298         'optionname', 'varchar', '', $char_d, '', '',
1299         'optionvalue', 'text', 'NULL', '', '', '',
1300       ],
1301       'primary_key' => 'optionnum',
1302       'unique'      => [],
1303       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
1304     },
1305
1306     'rate' => {
1307       'columns' => [
1308         'ratenum',  'serial', '', '', '', '',
1309         'ratename', 'varchar', '', $char_d, '', '',
1310       ],
1311       'primary_key' => 'ratenum',
1312       'unique'      => [],
1313       'index'       => [],
1314     },
1315
1316     'rate_detail' => {
1317       'columns' => [
1318         'ratedetailnum',   'serial', '', '', '', '',
1319         'ratenum',         'int',     '', '', '', '',
1320         'orig_regionnum',  'int', 'NULL', '', '', '',
1321         'dest_regionnum',  'int',     '', '', '', '',
1322         'min_included',    'int',     '', '', '', '',
1323         #'min_charge',      @money_type, '', '',
1324         'min_charge',      'decimal', '', '10,5', '', '',
1325         'sec_granularity', 'int',     '', '', '', '',
1326         #time period (link to table of periods)?
1327       ],
1328       'primary_key' => 'ratedetailnum',
1329       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1330       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
1331     },
1332
1333     'rate_region' => {
1334       'columns' => [
1335         'regionnum',   'serial',      '', '', '', '',
1336         'regionname',  'varchar',     '', $char_d, '', '',
1337       ],
1338       'primary_key' => 'regionnum',
1339       'unique'      => [],
1340       'index'       => [],
1341     },
1342
1343     'rate_prefix' => {
1344       'columns' => [
1345         'prefixnum',   'serial',    '', '', '', '',
1346         'regionnum',   'int',       '', '',, '', '',
1347         'countrycode', 'varchar',     '', 3, '', '',
1348         'npa',         'varchar', 'NULL', 6, '', '',
1349         'nxx',         'varchar', 'NULL', 3, '', '',
1350       ],
1351       'primary_key' => 'prefixnum',
1352       'unique'      => [],
1353       'index'       => [ [ 'countrycode' ], [ 'regionnum' ] ],
1354     },
1355
1356     'reg_code' => {
1357       'columns' => [
1358         'codenum',   'serial',    '', '', '', '',
1359         'code',      'varchar',   '', $char_d, '', '',
1360         'agentnum',  'int',       '', '', '', '',
1361       ],
1362       'primary_key' => 'codenum',
1363       'unique'      => [ [ 'agentnum', 'code' ] ],
1364       'index'       => [ [ 'agentnum' ] ],
1365     },
1366
1367     'reg_code_pkg' => {
1368       'columns' => [
1369         'codepkgnum', 'serial', '', '', '', '',
1370         'codenum',   'int',    '', '', '', '',
1371         'pkgpart',   'int',    '', '', '', '',
1372       ],
1373       'primary_key' => 'codepkgnum',
1374       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
1375       'index'       => [ [ 'codenum' ] ],
1376     },
1377
1378     'clientapi_session' => {
1379       'columns' => [
1380         'sessionnum',  'serial',  '', '', '', '',
1381         'sessionid',  'varchar',  '', $char_d, '', '',
1382         'namespace',  'varchar',  '', $char_d, '', '',
1383       ],
1384       'primary_key' => 'sessionnum',
1385       'unique'      => [ [ 'sessionid', 'namespace' ] ],
1386       'index'       => [],
1387     },
1388
1389     'clientapi_session_field' => {
1390       'columns' => [
1391         'fieldnum',    'serial',     '', '', '', '',
1392         'sessionnum',     'int',     '', '', '', '',
1393         'fieldname',  'varchar',     '', $char_d, '', '',
1394         'fieldvalue',    'text', 'NULL', '', '', '',
1395       ],
1396       'primary_key' => 'fieldnum',
1397       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
1398       'index'       => [],
1399     },
1400
1401     'payment_gateway' => {
1402       'columns' => [
1403         'gatewaynum',       'serial',   '',     '', '', '',
1404         'gateway_module',   'varchar',  '',     $char_d, '', '',
1405         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
1406         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
1407         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
1408         'disabled',   'char',  'NULL',   1, '', '',
1409       ],
1410       'primary_key' => 'gatewaynum',
1411       'unique' => [],
1412       'index'  => [ [ 'disabled' ] ],
1413     },
1414
1415     'payment_gateway_option' => {
1416       'columns' => [
1417         'optionnum',   'serial',  '',     '', '', '',
1418         'gatewaynum',  'int',     '',     '', '', '',
1419         'optionname',  'varchar', '',     $char_d, '', '',
1420         'optionvalue', 'text',    'NULL', '', '', '',
1421       ],
1422       'primary_key' => 'optionnum',
1423       'unique'      => [],
1424       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1425     },
1426
1427     'agent_payment_gateway' => {
1428       'columns' => [
1429         'agentgatewaynum', 'serial', '', '', '', '',
1430         'agentnum',        'int', '', '', '', '',
1431         'gatewaynum',      'int', '', '', '', '',
1432         'cardtype',        'varchar', 'NULL', $char_d, '', '',
1433         'taxclass',        'varchar', 'NULL', $char_d, '', '',
1434       ],
1435       'primary_key' => 'agentgatewaynum',
1436       'unique'      => [],
1437       'index'       => [ [ 'agentnum', 'cardtype' ], ],
1438     },
1439
1440     'banned_pay' => {
1441       'columns' => [
1442         'bannum',  'serial',   '',     '', '', '',
1443         'payby',   'char',     '',       4, '', '',
1444         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
1445         #'paymask', 'varchar',  'NULL', $char_d, '', ''
1446         '_date',   @date_type, '', '',
1447         'otaker',  'varchar',  '',     32, '', '',
1448         'reason',  'varchar',  'NULL', $char_d, '', '',
1449       ],
1450       'primary_key' => 'bannum',
1451       'unique'      => [ [ 'payby', 'payinfo' ] ],
1452       'index'       => [],
1453     },
1454
1455     'pkg_class' => {
1456       'columns' => [
1457         'classnum',   'serial',  '', '', '', '',
1458         'classname',  'varchar', '', $char_d, '', '',
1459         'disabled',     'char', 'NULL',   1, '', '',
1460       ],
1461       'primary_key' => 'classnum',
1462       'unique' => [],
1463       'index' => [ ['disabled'] ],
1464     },
1465
1466     'cdr' => {
1467       'columns' => [
1468         # qw( name type null length default local );
1469
1470         ###
1471         #asterisk fields
1472         ###
1473
1474         'acctid',   'bigserial',  '', '', '', '',
1475         'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1476         'clid',        'varchar',  '', $char_d, \"''", '',
1477         'src',         'varchar',  '', $char_d, \"''", '',
1478         'dst',         'varchar',  '', $char_d, \"''", '',
1479         'dcontext',    'varchar',  '', $char_d, \"''", '',
1480         'channel',     'varchar',  '', $char_d, \"''", '',
1481         'dstchannel',  'varchar',  '', $char_d, \"''", '',
1482         'lastapp',     'varchar',  '', $char_d, \"''", '',
1483         'lastdata',    'varchar',  '', $char_d, \"''", '',
1484
1485         #these don't seem to be logged by most of the SQL cdr_* modules
1486         #except tds under sql-illegal names, so;
1487         # ... don't rely on them for rating?
1488         # and, what they hey, i went ahead and changed the names and data types
1489         # to freeside-style dates...
1490           #'start',  'timestamp', 'NULL',  '',    '', '',
1491           #'answer', 'timestamp', 'NULL',  '',    '', '',
1492           #'end',    'timestamp', 'NULL',  '',    '', '',
1493         'startdate',  @date_type, '', '',
1494         'answerdate', @date_type, '', '',
1495         'enddate',    @date_type, '', '',
1496         #
1497
1498         'duration',    'int',      '',      '',     0, '',
1499         'billsec',     'int',      '',      '',     0, '',
1500         'disposition', 'varchar',  '',      45, \"''", '',
1501         'amaflags',    'int',      '',      '',     0, '',
1502         'accountcode', 'varchar',  '',      20, \"''", '',
1503         'uniqueid',    'varchar',  '',      32, \"''", '',
1504         'userfield',   'varchar',  '',     255, \"''", '',
1505
1506         ###
1507         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1508         # defaults
1509         ###
1510
1511         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1512         'cdrtypenum',              'int', 'NULL',      '', '', '',
1513
1514         'charged_party',       'varchar', 'NULL', $char_d, '', '',
1515
1516         'upstream_currency',      'char', 'NULL',       3, '', '',
1517         'upstream_price',      'decimal', 'NULL',  '10,2', '', '',
1518         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
1519
1520         # how it was rated internally...
1521         'ratedetailnum',           'int', 'NULL',      '', '', '',
1522         'rated_price',         'decimal', 'NULL',  '10,2', '', '',
1523
1524         'distance',            'decimal', 'NULL',      '', '', '',
1525         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
1526
1527         #cdr_calltype: the big list in appendix 2
1528         'calltypenum',             'int', 'NULL',      '', '', '',
1529
1530         'description',         'varchar', 'NULL', $char_d, '', '',
1531         'quantity',                'int', 'NULL',      '', '', '',
1532
1533         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
1534         'carrierid',               'int', 'NULL',      '', '', '',
1535
1536         'upstream_rateid',         'int', 'NULL',      '', '', '',
1537
1538         ###
1539         #and now for our own fields
1540         ###
1541
1542         # a svcnum... right..?
1543         'svcnum',             'int',   'NULL',     '',   '', '',
1544
1545         #NULL, done (or something)
1546         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
1547
1548       ],
1549       'primary_key' => 'acctid',
1550       'unique' => [],
1551       'index' => [ [ 'calldate' ], [ 'dst' ], [ 'accountcode' ], [ 'freesidestatus' ] ],
1552     },
1553
1554     'cdr_calltype' => {
1555       'columns' => [
1556         'calltypenum',   'serial',  '', '', '', '',
1557         'calltypename',  'varchar', '', $char_d, '', '',
1558       ],
1559       'primary_key' => 'calltypenum',
1560       'unique'      => [],
1561       'index'       => [],
1562     },
1563
1564     'cdr_type' => {
1565       'columns' => [
1566         'cdrtypenum'  => 'serial',  '', '', '', '',
1567         'cdrtypename' => 'varchar', '', '', '', '',
1568       ],
1569       'primary_key' => 'cdrtypenum',
1570       'unique'      => [],
1571       'index'       => [],
1572     },
1573
1574     'cdr_carrier' => {
1575       'columns' => [
1576         'carrierid'   => 'serial',  '', '', '', '',
1577         'carriername' => 'varchar', '', '', '', '',
1578       ],
1579       'primary_key' => 'carrierid',
1580       'unique'      => [],
1581       'index'       => [],
1582     },
1583
1584     #map upstream rateid to ours...
1585     'cdr_upstream_rate' => {
1586       'columns' => [
1587         'upstreamratenum', 'serial',  '', '', '', '',
1588         'upstream_rateid', 'varchar', '', $char_d, '', '',
1589         'ratedetailnum',   'int', 'NULL', '', '', '',
1590       ],
1591       'primary_key' => 'upstreamratenum', #XXX need a primary key
1592       'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
1593       'index'  => [],
1594     },
1595
1596     'inventory_item' => {
1597       'columns' => [
1598         'itemnum',  'serial',      '',      '', '', '',
1599         'classnum', 'int',         '',      '', '', '',
1600         'item',     'varchar',     '', $char_d, '', '',
1601         'svcnum',   'int',     'NULL',      '', '', '',
1602       ],
1603       'primary_key' => 'itemnum',
1604       'unique' => [ [ 'classnum', 'item' ] ],
1605       'index'  => [ [ 'classnum' ], [ 'svcnum' ] ],
1606     },
1607
1608     'inventory_class' => {
1609       'columns' => [
1610         'classnum',  'serial',       '',      '', '', '',
1611         'classname', 'varchar',      '', $char_d, '', '',
1612       ],
1613       'primary_key' => 'classnum',
1614       'unique' => [],
1615       'index'  => [],
1616     },
1617
1618     'access_user' => {
1619       'columns' => [
1620         'usernum',   'serial',  '',      '', '', '',
1621         'username',  'varchar', '', $char_d, '', '',
1622         '_password', 'varchar', '', $char_d, '', '',
1623         'last',      'varchar', '', $char_d, '', '',
1624         'first',     'varchar', '', $char_d, '', '',
1625         'disabled',     'char', 'NULL',   1, '', '',
1626       ],
1627       'primary_key' => 'usernum',
1628       'unique' => [ [ 'username' ] ],
1629       'index'  => [],
1630     },
1631
1632     'access_user_pref' => {
1633       'columns' => [
1634         'prefnum',    'serial',       '', '', '', '',
1635         'usernum',     'int',       '', '', '', '',
1636         'prefname', 'varchar', '', $char_d, '', '',
1637         'prefvalue', 'text', 'NULL', '', '', '',
1638       ],
1639       'primary_key' => 'prefnum',
1640       'unique' => [],
1641       'index'  => [ [ 'usernum' ] ],
1642     },
1643
1644     'access_group' => {
1645       'columns' => [
1646         'groupnum',   'serial', '',      '', '', '',
1647         'groupname', 'varchar', '', $char_d, '', '',
1648       ],
1649       'primary_key' => 'groupnum',
1650       'unique' => [ [ 'groupname' ] ],
1651       'index'  => [],
1652     },
1653
1654     'access_usergroup' => {
1655       'columns' => [
1656         'usergroupnum', 'serial', '', '', '', '',
1657         'usernum',         'int', '', '', '', '',
1658         'groupnum',        'int', '', '', '', '',
1659       ],
1660       'primary_key' => 'usergroupnum',
1661       'unique' => [ [ 'usernum', 'groupnum' ] ],
1662       'index'  => [ [ 'usernum' ] ],
1663     },
1664
1665     'access_groupagent' => {
1666       'columns' => [
1667         'groupagentnum', 'serial', '', '', '', '',
1668         'groupnum',         'int', '', '', '', '',
1669         'agentnum',         'int', '', '', '', '',
1670       ],
1671       'primary_key' => 'groupagentnum',
1672       'unique' => [ [ 'groupnum', 'agentnum' ] ],
1673       'index'  => [ [ 'groupnum' ] ],
1674     },
1675
1676     'access_right' => {
1677       'columns' => [
1678         'rightnum',   'serial', '',      '', '', '',
1679         'righttype', 'varchar', '', $char_d, '', '',
1680         'rightobjnum',   'int', '',      '', '', '',
1681         'rightname', 'varchar', '',      '', '', '',
1682       ],
1683       'primary_key' => 'rightnum',
1684       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
1685       'index'  => [],
1686     },
1687
1688     'svc_phone' => {
1689       'columns' => [
1690         'svcnum',      'int',         '',      '', '', '',
1691         'countrycode', 'varchar',     '',       3, '', '',
1692         'phonenum',    'varchar',     '',      15, '', '',  #12 ?
1693         'pin',         'varchar', 'NULL', $char_d, '', '',
1694       ],
1695       'primary_key' => 'svcnum',
1696       'unique' => [],
1697       'index'  => [ [ 'countrycode', 'phonenum' ] ],
1698     },
1699
1700     'reason_type' => {
1701       'columns' => [
1702         'typenum',   'serial',  '', '', '', '',
1703         'class',     'char', '', 1, '', '',
1704         'type',     'varchar', '', $char_d, '', '',
1705       ],
1706       'primary_key' => 'typenum',
1707       'unique' => [],
1708       'index' => [],
1709     },
1710
1711     'reason' => {
1712       'columns' => [
1713         'reasonnum',     'serial',  '', '', '', '',
1714         'reason_type',   'int',  '', '', '', '',
1715         'reason',        'varchar', '', $char_d, '', '',
1716         'disabled',      'char',    'NULL', 1, '', '',
1717       ],
1718       'primary_key' => 'reasonnum',
1719       'unique' => [],
1720       'index' => [],
1721     },
1722
1723     'conf' => {
1724       'columns' => [
1725         'confnum',  'serial',  '', '', '', '',
1726         'agentnum', 'int',  'NULL', '', '', '',
1727         'name',     'varchar', '', $char_d, '', '',
1728         'value',    'varchar', 'NULL', '', '', '',       # Pg specific
1729       ],
1730       'primary_key' => 'confnum',
1731       'unique' => [ [ 'agentnum', 'name' ]],
1732       'index' => [],
1733     },
1734
1735     # name type nullability length default local
1736
1737     #'new_table' => {
1738     #  'columns' => [
1739     #    'num', 'serial',       '', '', '', '',
1740     #  ],
1741     #  'primary_key' => 'num',
1742     #  'unique' => [],
1743     #  'index'  => [],
1744     #},
1745
1746   };
1747
1748 }
1749
1750 =back
1751
1752 =head1 BUGS
1753
1754 =head1 SEE ALSO
1755
1756 L<DBIx::DBSchema>
1757
1758 =cut
1759
1760 1;
1761