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