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