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_main' => {
 394       'columns' => [
 395         'custnum',  'serial',  '',     '', '', '',
 396         'agentnum', 'int',  '',     '', '', '',
 397         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
 398 #        'titlenum', 'int',  'NULL',   '', '', '',
 399         'last',     'varchar', '',     $char_d, '', '',
 400 #        'middle',   'varchar', 'NULL', $char_d, '', '',
 401         'first',    'varchar', '',     $char_d, '', '',
 402         'ss',       'varchar', 'NULL', 11, '', '',
 403         'company',  'varchar', 'NULL', $char_d, '', '',
 404         'address1', 'varchar', '',     $char_d, '', '',
 405         'address2', 'varchar', 'NULL', $char_d, '', '',
 406         'city',     'varchar', '',     $char_d, '', '',
 407         'county',   'varchar', 'NULL', $char_d, '', '',
 408         'state',    'varchar', 'NULL', $char_d, '', '',
 409         'zip',      'varchar', 'NULL', 10, '', '',
 410         'country',  'char', '',     2, '', '',
 411         'daytime',  'varchar', 'NULL', 20, '', '',
 412         'night',    'varchar', 'NULL', 20, '', '',
 413         'fax',      'varchar', 'NULL', 12, '', '',
 414         'ship_last',     'varchar', 'NULL', $char_d, '', '',
 415 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '',
 416         'ship_first',    'varchar', 'NULL', $char_d, '', '',
 417         'ship_company',  'varchar', 'NULL', $char_d, '', '',
 418         'ship_address1', 'varchar', 'NULL', $char_d, '', '',
 419         'ship_address2', 'varchar', 'NULL', $char_d, '', '',
 420         'ship_city',     'varchar', 'NULL', $char_d, '', '',
 421         'ship_county',   'varchar', 'NULL', $char_d, '', '',
 422         'ship_state',    'varchar', 'NULL', $char_d, '', '',
 423         'ship_zip',      'varchar', 'NULL', 10, '', '',
 424         'ship_country',  'char', 'NULL', 2, '', '',
 425         'ship_daytime',  'varchar', 'NULL', 20, '', '',
 426         'ship_night',    'varchar', 'NULL', 20, '', '',
 427         'ship_fax',      'varchar', 'NULL', 12, '', '',
 428         'payby',    'char', '',     4, '', '',
 429         'payinfo',  'varchar', 'NULL', 512, '', '',
 430         'paycvv',   'varchar', 'NULL', 512, '', '',
 431         'paymask', 'varchar', 'NULL', $char_d, '', '',
 432         #'paydate',  @date_type, '', '',
 433         'paydate',  'varchar', 'NULL', 10, '', '',
 434         'paystart_month', 'int', 'NULL', '', '', '',
 435         'paystart_year',  'int', 'NULL', '', '', '',
 436         'payissue', 'varchar', 'NULL', 2, '', '',
 437         'payname',  'varchar', 'NULL', $char_d, '', '',
 438         'payip',    'varchar', 'NULL', 15, '', '',
 439         'tax',      'char', 'NULL', 1, '', '',
 440         'otaker',   'varchar', '',    32, '', '',
 441         'refnum',   'int',  '',     '', '', '',
 442         'referral_custnum', 'int',  'NULL', '', '', '',
 443         'comments', 'text', 'NULL', '', '', '',
 444         'spool_cdr','char', 'NULL', 1, '', '',
 445       ],
 446       'primary_key' => 'custnum',
 447       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
 448       #'index' => [ ['last'], ['company'] ],
 449       'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ],
 450                    [ 'daytime' ], [ 'night' ], [ 'fax' ], [ 'refnum' ],
 451                    [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
 452                    [ 'ship_last' ], [ 'ship_company' ],
 453                    [ 'payby' ], [ 'paydate' ],
 454
 455                  ],
 456     },
 457
 458     'cust_main_invoice' => {
 459       'columns' => [
 460         'destnum',  'serial',  '',     '', '', '',
 461         'custnum',  'int',  '',     '', '', '',
 462         'dest',     'varchar', '',  $char_d, '', '',
 463       ],
 464       'primary_key' => 'destnum',
 465       'unique' => [],
 466       'index' => [ ['custnum'], ],
 467     },
 468
 469     'cust_main_county' => { #county+state+country are checked off the
 470                             #cust_main_county for validation and to provide
 471                             # a tax rate.
 472       'columns' => [
 473         'taxnum',   'serial',   '',    '', '', '',
 474         'state',    'varchar',  'NULL',    $char_d, '', '',
 475         'county',   'varchar',  'NULL',    $char_d, '', '',
 476         'country',  'char',  '', 2, '', '',
 477         'taxclass',   'varchar', 'NULL', $char_d, '', '',
 478         'exempt_amount', @money_type, '', '',
 479         'tax',      'real',  '',    '', '', '', #tax %
 480         'taxname',  'varchar',  'NULL',    $char_d, '', '',
 481         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
 482         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
 483       ],
 484       'primary_key' => 'taxnum',
 485       'unique' => [],
 486   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
 487       'index' => [ [ 'county' ], [ 'state' ], [ 'country' ] ],
 488     },
 489
 490     'cust_pay' => {
 491       'columns' => [
 492         'paynum',   'serial',    '',   '', '', '',
 493         #now cust_bill_pay #'invnum',   'int',    '',   '', '', '',
 494         'custnum',  'int',    '',   '', '', '',
 495         'paid',     @money_type, '', '',
 496         '_date',    @date_type, '', '',
 497         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 498                                                  # index into payby table
 499                                                  # eventually
 500         'payinfo',  'varchar',   'NULL', $char_d, '', '', #see cust_main above
 501         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 502         'closed',    'char', 'NULL', 1, '', '',
 503       ],
 504       'primary_key' => 'paynum',
 505       'unique' => [],
 506       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
 507     },
 508
 509     'cust_pay_void' => {
 510       'columns' => [
 511         'paynum',    'int',    '',   '', '', '',
 512         'custnum',   'int',    '',   '', '', '',
 513         'paid',      @money_type, '', '',
 514         '_date',     @date_type, '', '',
 515         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 516                                                   # index into payby table
 517                                                   # eventually
 518         'payinfo',   'varchar',   'NULL', $char_d, '', '', #see cust_main above
 519         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 520         'closed',    'char', 'NULL', 1, '', '',
 521         'void_date', @date_type, '', '',
 522         'reason',    'varchar',   'NULL', $char_d, '', '',
 523         'otaker',   'varchar', '', 32, '', '',
 524       ],
 525       'primary_key' => 'paynum',
 526       'unique' => [],
 527       'index' => [ [ 'custnum' ] ],
 528     },
 529
 530     'cust_bill_pay' => {
 531       'columns' => [
 532         'billpaynum', 'serial',     '',   '', '', '',
 533         'invnum',  'int',     '',   '', '', '',
 534         'paynum',  'int',     '',   '', '', '',
 535         'amount',  @money_type, '', '',
 536         '_date',   @date_type, '', '',
 537       ],
 538       'primary_key' => 'billpaynum',
 539       'unique' => [],
 540       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
 541     },
 542
 543     'pay_batch' => { #batches of payments to an external processor
 544       'columns' => [
 545         'batchnum',   'serial',    '',   '', '', '',
 546         'status',     'char', 'NULL',     1, '', '',
 547         'download',   @date_type, '', '',
 548         'upload',     @date_type, '', '',
 549       ],
 550       'primary_key' => 'batchnum',
 551       'unique' => [],
 552       'index' => [],
 553     },
 554
 555     'cust_pay_batch' => { #what's this used for again?  list of customers
 556                           #in current CARD batch? (necessarily CARD?)
 557       'columns' => [
 558         'paybatchnum',   'serial',    '',   '', '', '',
 559         'batchnum',   'int',    '',   '', '', '',
 560         'invnum',   'int',    '',   '', '', '',
 561         'custnum',   'int',    '',   '', '', '',
 562         'last',     'varchar', '',     $char_d, '', '',
 563         'first',    'varchar', '',     $char_d, '', '',
 564         'address1', 'varchar', '',     $char_d, '', '',
 565         'address2', 'varchar', 'NULL', $char_d, '', '',
 566         'city',     'varchar', '',     $char_d, '', '',
 567         'state',    'varchar', 'NULL', $char_d, '', '',
 568         'zip',      'varchar', 'NULL', 10, '', '',
 569         'country',  'char', '',     2, '', '',
 570         #        'trancode', 'int', '', '', '', ''
 571         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 572         'payinfo',  'varchar', '',     512, '', '',
 573         #'exp',      @date_type, '', ''
 574         'exp',      'varchar', 'NULL',     11, '', '',
 575         'payname',  'varchar', 'NULL', $char_d, '', '',
 576         'amount',   @money_type, '', '',
 577         'status',   'varchar', 'NULL',     $char_d, '', '',
 578       ],
 579       'primary_key' => 'paybatchnum',
 580       'unique' => [],
 581       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
 582     },
 583
 584     'cust_pkg' => {
 585       'columns' => [
 586         'pkgnum',    'serial',    '',   '', '', '',
 587         'custnum',   'int',    '',   '', '', '',
 588         'pkgpart',   'int',    '',   '', '', '',
 589         'otaker',    'varchar', '', 32, '', '',
 590         'setup',     @date_type, '', '',
 591         'bill',      @date_type, '', '',
 592         'last_bill', @date_type, '', '',
 593         'susp',      @date_type, '', '',
 594         'cancel',    @date_type, '', '',
 595         'expire',    @date_type, '', '',
 596         'manual_flag', 'char', 'NULL', 1, '', '',
 597       ],
 598       'primary_key' => 'pkgnum',
 599       'unique' => [],
 600       'index' => [ ['custnum'], ['pkgpart'] ],
 601     },
 602
 603     'cust_refund' => {
 604       'columns' => [
 605         'refundnum',    'serial',    '',   '', '', '',
 606         #now cust_credit_refund #'crednum',      'int',    '',   '', '', '',
 607         'custnum',  'int',    '',   '', '', '',
 608         '_date',        @date_type, '', '',
 609         'refund',       @money_type, '', '',
 610         'otaker',       'varchar',   '',   32, '', '',
 611         'reason',       'varchar',   '',   $char_d, '', '',
 612         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
 613                                                      # be index into payby
 614                                                      # table eventually
 615         'payinfo',      'varchar',   'NULL', $char_d, '', '', #see cust_main above
 616         'paybatch',     'varchar',   'NULL', $char_d, '', '',
 617         'closed',    'char', 'NULL', 1, '', '',
 618       ],
 619       'primary_key' => 'refundnum',
 620       'unique' => [],
 621       'index' => [],
 622     },
 623
 624     'cust_credit_refund' => {
 625       'columns' => [
 626         'creditrefundnum', 'serial',     '',   '', '', '',
 627         'crednum',  'int',     '',   '', '', '',
 628         'refundnum',  'int',     '',   '', '', '',
 629         'amount',  @money_type, '', '',
 630         '_date',   @date_type, '', '',
 631       ],
 632       'primary_key' => 'creditrefundnum',
 633       'unique' => [],
 634       'index' => [ [ 'crednum', 'refundnum' ] ],
 635     },
 636
 637
 638     'cust_svc' => {
 639       'columns' => [
 640         'svcnum',    'serial',    '',   '', '', '',
 641         'pkgnum',    'int',    'NULL',   '', '', '',
 642         'svcpart',   'int',    '',   '', '', '',
 643       ],
 644       'primary_key' => 'svcnum',
 645       'unique' => [],
 646       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
 647     },
 648
 649     'part_pkg' => {
 650       'columns' => [
 651         'pkgpart',    'serial',    '',   '', '', '',
 652         'pkg',        'varchar',   '',   $char_d, '', '',
 653         'comment',    'varchar',   '',   $char_d, '', '',
 654         'promo_code', 'varchar', 'NULL', $char_d, '', '',
 655         'setup',      @perl_type, '', '',
 656         'freq',       'varchar',   '',   $char_d, '', '', #billing frequency
 657         'recur',      @perl_type, '', '',
 658         'setuptax',  'char', 'NULL', 1, '', '',
 659         'recurtax',  'char', 'NULL', 1, '', '',
 660         'plan',       'varchar', 'NULL', $char_d, '', '',
 661         'plandata',   'text', 'NULL', '', '', '',
 662         'disabled',   'char', 'NULL', 1, '', '',
 663         'taxclass',   'varchar', 'NULL', $char_d, '', '',
 664         'classnum',   'int',     'NULL', '', '', '',
 665       ],
 666       'primary_key' => 'pkgpart',
 667       'unique' => [],
 668       'index' => [ [ 'promo_code' ], [ 'disabled' ] ],
 669     },
 670
 671 #    'part_title' => {
 672 #      'columns' => [
 673 #        'titlenum',   'int',    '',   '',
 674 #        'title',      'varchar',   '',   $char_d,
 675 #      ],
 676 #      'primary_key' => 'titlenum',
 677 #      'unique' => [ [] ],
 678 #      'index' => [ [] ],
 679 #    },
 680
 681     'pkg_svc' => {
 682       'columns' => [
 683         'pkgsvcnum',  'serial', '',  '', '', '',
 684         'pkgpart',    'int',    '',   '', '', '',
 685         'svcpart',    'int',    '',   '', '', '',
 686         'quantity',   'int',    '',   '', '', '',
 687         'primary_svc','char', 'NULL',  1, '', '',
 688       ],
 689       'primary_key' => 'pkgsvcnum',
 690       'unique' => [ ['pkgpart', 'svcpart'] ],
 691       'index' => [ ['pkgpart'] ],
 692     },
 693
 694     'part_referral' => {
 695       'columns' => [
 696         'refnum',   'serial',     '',        '', '', '',
 697         'referral', 'varchar',    '',   $char_d, '', '',
 698         'disabled', 'char',   'NULL',         1, '', '',
 699         'agentnum', 'int',    'NULL',        '', '', '',
 700       ],
 701       'primary_key' => 'refnum',
 702       'unique' => [],
 703       'index' => [ ['disabled'] ],
 704     },
 705
 706     'part_svc' => {
 707       'columns' => [
 708         'svcpart',    'serial',    '',   '', '', '',
 709         'svc',        'varchar',   '',   $char_d, '', '',
 710         'svcdb',      'varchar',   '',   $char_d, '', '',
 711         'disabled',   'char',  'NULL',   1, '', '',
 712       ],
 713       'primary_key' => 'svcpart',
 714       'unique' => [],
 715       'index' => [ [ 'disabled' ] ],
 716     },
 717
 718     'part_svc_column' => {
 719       'columns' => [
 720         'columnnum',   'serial',         '', '', '', '',
 721         'svcpart',     'int',         '', '', '', '',
 722         'columnname',  'varchar',     '', 64, '', '',
 723         'columnvalue', 'varchar', 'NULL', $char_d, '', '',
 724         'columnflag',  'char',    'NULL', 1, '', '',
 725       ],
 726       'primary_key' => 'columnnum',
 727       'unique' => [ [ 'svcpart', 'columnname' ] ],
 728       'index' => [ [ 'svcpart' ] ],
 729     },
 730
 731     #(this should be renamed to part_pop)
 732     'svc_acct_pop' => {
 733       'columns' => [
 734         'popnum',    'serial',    '',   '', '', '',
 735         'city',      'varchar',   '',   $char_d, '', '',
 736         'state',     'varchar',   '',   $char_d, '', '',
 737         'ac',        'char',   '',   3, '', '',
 738         'exch',      'char',   '',   3, '', '',
 739         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
 740       ],
 741       'primary_key' => 'popnum',
 742       'unique' => [],
 743       'index' => [ [ 'state' ] ],
 744     },
 745
 746     'part_pop_local' => {
 747       'columns' => [
 748         'localnum',  'serial',     '',     '', '', '',
 749         'popnum',    'int',     '',     '', '', '',
 750         'city',      'varchar', 'NULL', $char_d, '', '',
 751         'state',     'char',    'NULL', 2, '', '',
 752         'npa',       'char',    '',     3, '', '',
 753         'nxx',       'char',    '',     3, '', '',
 754       ],
 755       'primary_key' => 'localnum',
 756       'unique' => [],
 757       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
 758     },
 759
 760     'svc_acct' => {
 761       'columns' => [
 762         'svcnum',    'int',    '',   '', '', '',
 763         'username',  'varchar',   '',   $username_len, '', '', #unique (& remove dup code)
 764         '_password', 'varchar',   '',   72, '', '', #13 for encryped pw's plus ' *SUSPENDED* (md5 passwords can be 34, blowfish 60)
 765         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
 766         'popnum',    'int',    'NULL',   '', '', '',
 767         'uid',       'int', 'NULL',   '', '', '',
 768         'gid',       'int', 'NULL',   '', '', '',
 769         'finger',    'varchar',   'NULL',   $char_d, '', '',
 770         'dir',       'varchar',   'NULL',   $char_d, '', '',
 771         'shell',     'varchar',   'NULL',   $char_d, '', '',
 772         'quota',     'varchar',   'NULL',   $char_d, '', '',
 773         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
 774         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
 775         'domsvc',    'int', '',   '', '', '',
 776       ],
 777       'primary_key' => 'svcnum',
 778       #'unique' => [ [ 'username', 'domsvc' ] ],
 779       'unique' => [],
 780       'index' => [ ['username'], ['domsvc'] ],
 781     },
 782
 783     #'svc_charge' => {
 784     #  'columns' => [
 785     #    'svcnum',    'int',    '',   '',
 786     #    'amount',    @money_type,
 787     #  ],
 788     #  'primary_key' => 'svcnum',
 789     #  'unique' => [ [] ],
 790     #  'index' => [ [] ],
 791     #},
 792
 793     'svc_domain' => {
 794       'columns' => [
 795         'svcnum',    'int',    '',   '', '', '',
 796         'domain',    'varchar',    '',   $char_d, '', '',
 797         'catchall',  'int', 'NULL',    '', '', '',
 798       ],
 799       'primary_key' => 'svcnum',
 800       'unique' => [ ['domain'] ],
 801       'index' => [],
 802     },
 803
 804     'domain_record' => {
 805       'columns' => [
 806         'recnum',    'serial',     '',  '', '', '',
 807         'svcnum',    'int',     '',  '', '', '',
 808         'reczone',   'varchar', '',  255, '', '',
 809         'recaf',     'char',    '',  2, '', '',
 810         'rectype',   'varchar',    '',  5, '', '',
 811         'recdata',   'varchar', '',  255, '', '',
 812       ],
 813       'primary_key' => 'recnum',
 814       'unique'      => [],
 815       'index'       => [ ['svcnum'] ],
 816     },
 817
 818     'svc_forward' => {
 819       'columns' => [
 820         'svcnum',   'int',            '',   '', '', '',
 821         'srcsvc',   'int',        'NULL',   '', '', '',
 822         'src',      'varchar',    'NULL',  255, '', '',
 823         'dstsvc',   'int',        'NULL',   '', '', '',
 824         'dst',      'varchar',    'NULL',  255, '', '',
 825       ],
 826       'primary_key' => 'svcnum',
 827       'unique'      => [],
 828       'index'       => [ ['srcsvc'], ['dstsvc'] ],
 829     },
 830
 831     'svc_www' => {
 832       'columns' => [
 833         'svcnum',   'int',    '',  '', '', '',
 834         'recnum',   'int',    '',  '', '', '',
 835         'usersvc',  'int',    '',  '', '', '',
 836       ],
 837       'primary_key' => 'svcnum',
 838       'unique'      => [],
 839       'index'       => [],
 840     },
 841
 842     #'svc_wo' => {
 843     #  'columns' => [
 844     #    'svcnum',    'int',    '',   '',
 845     #    'svcnum',    'int',    '',   '',
 846     #    'svcnum',    'int',    '',   '',
 847     #    'worker',    'varchar',   '',   $char_d,
 848     #    '_date',     @date_type,
 849     #  ],
 850     #  'primary_key' => 'svcnum',
 851     #  'unique' => [ [] ],
 852     #  'index' => [ [] ],
 853     #},
 854
 855     'prepay_credit' => {
 856       'columns' => [
 857         'prepaynum',   'serial',     '',   '', '', '',
 858         'identifier',  'varchar', '', $char_d, '', '',
 859         'amount',      @money_type, '', '',
 860         'seconds',     'int',     'NULL', '', '', '',
 861         'agentnum',    'int',     'NULL', '', '', '',
 862       ],
 863       'primary_key' => 'prepaynum',
 864       'unique'      => [ ['identifier'] ],
 865       'index'       => [],
 866     },
 867
 868     'port' => {
 869       'columns' => [
 870         'portnum',  'serial',     '',   '', '', '',
 871         'ip',       'varchar', 'NULL', 15, '', '',
 872         'nasport',  'int',     'NULL', '', '', '',
 873         'nasnum',   'int',     '',   '', '', '',
 874       ],
 875       'primary_key' => 'portnum',
 876       'unique'      => [],
 877       'index'       => [],
 878     },
 879
 880     'nas' => {
 881       'columns' => [
 882         'nasnum',   'serial',     '',    '', '', '',
 883         'nas',      'varchar', '',    $char_d, '', '',
 884         'nasip',    'varchar', '',    15, '', '',
 885         'nasfqdn',  'varchar', '',    $char_d, '', '',
 886         'last',     'int',     '',    '', '', '',
 887       ],
 888       'primary_key' => 'nasnum',
 889       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
 890       'index'       => [ [ 'last' ] ],
 891     },
 892
 893     'session' => {
 894       'columns' => [
 895         'sessionnum', 'serial',       '',   '', '', '',
 896         'portnum',    'int',       '',   '', '', '',
 897         'svcnum',     'int',       '',   '', '', '',
 898         'login',      @date_type, '', '',
 899         'logout',     @date_type, '', '',
 900       ],
 901       'primary_key' => 'sessionnum',
 902       'unique'      => [],
 903       'index'       => [ [ 'portnum' ] ],
 904     },
 905
 906     'queue' => {
 907       'columns' => [
 908         'jobnum', 'serial', '', '', '', '',
 909         'job', 'text', '', '', '', '',
 910         '_date', 'int', '', '', '', '',
 911         'status', 'varchar', '', $char_d, '', '',
 912         'statustext', 'text', 'NULL', '', '', '',
 913         'svcnum', 'int', 'NULL', '', '', '',
 914       ],
 915       'primary_key' => 'jobnum',
 916       'unique'      => [],
 917       'index'       => [ [ 'svcnum' ], [ 'status' ] ],
 918     },
 919
 920     'queue_arg' => {
 921       'columns' => [
 922         'argnum', 'serial', '', '', '', '',
 923         'jobnum', 'int', '', '', '', '',
 924         'arg', 'text', 'NULL', '', '', '',
 925       ],
 926       'primary_key' => 'argnum',
 927       'unique'      => [],
 928       'index'       => [ [ 'jobnum' ] ],
 929     },
 930
 931     'queue_depend' => {
 932       'columns' => [
 933         'dependnum', 'serial', '', '', '', '',
 934         'jobnum', 'int', '', '', '', '',
 935         'depend_jobnum', 'int', '', '', '', '',
 936       ],
 937       'primary_key' => 'dependnum',
 938       'unique'      => [],
 939       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
 940     },
 941
 942     'export_svc' => {
 943       'columns' => [
 944         'exportsvcnum' => 'serial', '', '', '', '',
 945         'exportnum'    => 'int', '', '', '', '',
 946         'svcpart'      => 'int', '', '', '', '',
 947       ],
 948       'primary_key' => 'exportsvcnum',
 949       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
 950       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
 951     },
 952
 953     'part_export' => {
 954       'columns' => [
 955         'exportnum', 'serial', '', '', '', '',
 956         'machine', 'varchar', '', $char_d, '', '',
 957         'exporttype', 'varchar', '', $char_d, '', '',
 958         'nodomain',     'char', 'NULL', 1, '', '',
 959       ],
 960       'primary_key' => 'exportnum',
 961       'unique'      => [],
 962       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
 963     },
 964
 965     'part_export_option' => {
 966       'columns' => [
 967         'optionnum', 'serial', '', '', '', '',
 968         'exportnum', 'int', '', '', '', '',
 969         'optionname', 'varchar', '', $char_d, '', '',
 970         'optionvalue', 'text', 'NULL', '', '', '',
 971       ],
 972       'primary_key' => 'optionnum',
 973       'unique'      => [],
 974       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
 975     },
 976
 977     'radius_usergroup' => {
 978       'columns' => [
 979         'usergroupnum', 'serial', '', '', '', '',
 980         'svcnum',       'int', '', '', '', '',
 981         'groupname',    'varchar', '', $char_d, '', '',
 982       ],
 983       'primary_key' => 'usergroupnum',
 984       'unique'      => [],
 985       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
 986     },
 987
 988     'msgcat' => {
 989       'columns' => [
 990         'msgnum', 'serial', '', '', '', '',
 991         'msgcode', 'varchar', '', $char_d, '', '',
 992         'locale', 'varchar', '', 16, '', '',
 993         'msg', 'text', '', '', '', '',
 994       ],
 995       'primary_key' => 'msgnum',
 996       'unique'      => [ [ 'msgcode', 'locale' ] ],
 997       'index'       => [],
 998     },
 999
1000     'cust_tax_exempt' => {
1001       'columns' => [
1002         'exemptnum', 'serial', '', '', '', '',
1003         'custnum',   'int', '', '', '', '',
1004         'taxnum',    'int', '', '', '', '',
1005         'year',      'int', '', '', '', '',
1006         'month',     'int', '', '', '', '',
1007         'amount',   @money_type, '', '',
1008       ],
1009       'primary_key' => 'exemptnum',
1010       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1011       'index'       => [],
1012     },
1013
1014     'cust_tax_exempt_pkg' => {
1015       'columns' => [
1016         'exemptpkgnum',  'serial', '', '', '', '',
1017         #'custnum',      'int', '', '', '', ''
1018         'billpkgnum',   'int', '', '', '', '',
1019         'taxnum',       'int', '', '', '', '',
1020         'year',         'int', '', '', '', '',
1021         'month',        'int', '', '', '', '',
1022         'amount',       @money_type, '', '',
1023       ],
1024       'primary_key' => 'exemptpkgnum',
1025       'unique' => [],
1026       'index'  => [ [ 'taxnum', 'year', 'month' ],
1027                     [ 'billpkgnum' ],
1028                     [ 'taxnum' ]
1029                   ],
1030     },
1031
1032     'router' => {
1033       'columns' => [
1034         'routernum', 'serial', '', '', '', '',
1035         'routername', 'varchar', '', $char_d, '', '',
1036         'svcnum', 'int', 'NULL', '', '', '',
1037       ],
1038       'primary_key' => 'routernum',
1039       'unique'      => [],
1040       'index'       => [],
1041     },
1042
1043     'part_svc_router' => {
1044       'columns' => [
1045         'svcrouternum', 'serial', '', '', '', '',
1046         'svcpart', 'int', '', '', '', '',
1047         'routernum', 'int', '', '', '', '',
1048       ],
1049       'primary_key' => 'svcrouternum',
1050       'unique'      => [],
1051       'index'       => [],
1052     },
1053
1054     'addr_block' => {
1055       'columns' => [
1056         'blocknum', 'serial', '', '', '', '',
1057         'routernum', 'int', '', '', '', '',
1058         'ip_gateway', 'varchar', '', 15, '', '',
1059         'ip_netmask', 'int', '', '', '', '',
1060       ],
1061       'primary_key' => 'blocknum',
1062       'unique'      => [ [ 'blocknum', 'routernum' ] ],
1063       'index'       => [],
1064     },
1065
1066     'svc_broadband' => {
1067       'columns' => [
1068         'svcnum', 'int', '', '', '', '',
1069         'blocknum', 'int', '', '', '', '',
1070         'speed_up', 'int', '', '', '', '',
1071         'speed_down', 'int', '', '', '', '',
1072         'ip_addr', 'varchar', '', 15, '', '',
1073       ],
1074       'primary_key' => 'svcnum',
1075       'unique'      => [],
1076       'index'       => [],
1077     },
1078
1079     'part_virtual_field' => {
1080       'columns' => [
1081         'vfieldpart', 'int', '', '', '', '',
1082         'dbtable', 'varchar', '', 32, '', '',
1083         'name', 'varchar', '', 32, '', '',
1084         'check_block', 'text', 'NULL', '', '', '',
1085         'length', 'int', 'NULL', '', '', '',
1086         'list_source', 'text', 'NULL', '', '', '',
1087         'label', 'varchar', 'NULL', 80, '', '',
1088       ],
1089       'primary_key' => 'vfieldpart',
1090       'unique' => [],
1091       'index' => [],
1092     },
1093
1094     'virtual_field' => {
1095       'columns' => [
1096         'vfieldnum', 'serial', '', '', '', '',
1097         'recnum', 'int', '', '', '', '',
1098         'vfieldpart', 'int', '', '', '', '',
1099         'value', 'varchar', '', 128, '', '',
1100       ],
1101       'primary_key' => 'vfieldnum',
1102       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1103       'index' => [],
1104     },
1105
1106     'acct_snarf' => {
1107       'columns' => [
1108         'snarfnum',  'int', '', '', '', '',
1109         'svcnum',    'int', '', '', '', '',
1110         'machine',   'varchar', '', 255, '', '',
1111         'protocol',  'varchar', '', $char_d, '', '',
1112         'username',  'varchar', '', $char_d, '', '',
1113         '_password', 'varchar', '', $char_d, '', '',
1114       ],
1115       'primary_key' => 'snarfnum',
1116       'unique' => [],
1117       'index'  => [ [ 'svcnum' ] ],
1118     },
1119
1120     'svc_external' => {
1121       'columns' => [
1122         'svcnum', 'int', '', '', '', '',
1123         'id',     'int', 'NULL', '', '', '',
1124         'title',  'varchar', 'NULL', $char_d, '', '',
1125       ],
1126       'primary_key' => 'svcnum',
1127       'unique'      => [],
1128       'index'       => [],
1129     },
1130
1131     'cust_pay_refund' => {
1132       'columns' => [
1133         'payrefundnum', 'serial', '', '', '', '',
1134         'paynum',  'int', '', '', '', '',
1135         'refundnum',  'int', '', '', '', '',
1136         '_date',    @date_type, '', '',
1137         'amount',   @money_type, '', '',
1138       ],
1139       'primary_key' => 'payrefundnum',
1140       'unique' => [],
1141       'index' => [ ['paynum'], ['refundnum'] ],
1142     },
1143
1144     'part_pkg_option' => {
1145       'columns' => [
1146         'optionnum', 'serial', '', '', '', '',
1147         'pkgpart', 'int', '', '', '', '',
1148         'optionname', 'varchar', '', $char_d, '', '',
1149         'optionvalue', 'text', 'NULL', '', '', '',
1150       ],
1151       'primary_key' => 'optionnum',
1152       'unique'      => [],
1153       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
1154     },
1155
1156     'rate' => {
1157       'columns' => [
1158         'ratenum',  'serial', '', '', '', '',
1159         'ratename', 'varchar', '', $char_d, '', '',
1160       ],
1161       'primary_key' => 'ratenum',
1162       'unique'      => [],
1163       'index'       => [],
1164     },
1165
1166     'rate_detail' => {
1167       'columns' => [
1168         'ratedetailnum',   'serial', '', '', '', '',
1169         'ratenum',         'int',     '', '', '', '',
1170         'orig_regionnum',  'int', 'NULL', '', '', '',
1171         'dest_regionnum',  'int',     '', '', '', '',
1172         'min_included',    'int',     '', '', '', '',
1173         #'min_charge',      @money_type, '', '',
1174         'min_charge',      'decimal', '', '10,5', '', '',
1175         'sec_granularity', 'int',     '', '', '', '',
1176         #time period (link to table of periods)?
1177       ],
1178       'primary_key' => 'ratedetailnum',
1179       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1180       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
1181     },
1182
1183     'rate_region' => {
1184       'columns' => [
1185         'regionnum',   'serial',      '', '', '', '',
1186         'regionname',  'varchar',     '', $char_d, '', '',
1187       ],
1188       'primary_key' => 'regionnum',
1189       'unique'      => [],
1190       'index'       => [],
1191     },
1192
1193     'rate_prefix' => {
1194       'columns' => [
1195         'prefixnum',   'serial',    '', '', '', '',
1196         'regionnum',   'int',       '', '',, '', '',
1197         'countrycode', 'varchar',     '', 3, '', '',
1198         'npa',         'varchar', 'NULL', 6, '', '',
1199         'nxx',         'varchar', 'NULL', 3, '', '',
1200       ],
1201       'primary_key' => 'prefixnum',
1202       'unique'      => [],
1203       'index'       => [ [ 'countrycode' ], [ 'regionnum' ] ],
1204     },
1205
1206     'reg_code' => {
1207       'columns' => [
1208         'codenum',   'serial',    '', '', '', '',
1209         'code',      'varchar',   '', $char_d, '', '',
1210         'agentnum',  'int',       '', '', '', '',
1211       ],
1212       'primary_key' => 'codenum',
1213       'unique'      => [ [ 'agentnum', 'code' ] ],
1214       'index'       => [ [ 'agentnum' ] ],
1215     },
1216
1217     'reg_code_pkg' => {
1218       'columns' => [
1219         'codepkgnum', 'serial', '', '', '', '',
1220         'codenum',   'int',    '', '', '', '',
1221         'pkgpart',   'int',    '', '', '', '',
1222       ],
1223       'primary_key' => 'codepkgnum',
1224       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
1225       'index'       => [ [ 'codenum' ] ],
1226     },
1227
1228     'clientapi_session' => {
1229       'columns' => [
1230         'sessionnum',  'serial',  '', '', '', '',
1231         'sessionid',  'varchar',  '', $char_d, '', '',
1232         'namespace',  'varchar',  '', $char_d, '', '',
1233       ],
1234       'primary_key' => 'sessionnum',
1235       'unique'      => [ [ 'sessionid', 'namespace' ] ],
1236       'index'       => [],
1237     },
1238
1239     'clientapi_session_field' => {
1240       'columns' => [
1241         'fieldnum',    'serial',     '', '', '', '',
1242         'sessionnum',     'int',     '', '', '', '',
1243         'fieldname',  'varchar',     '', $char_d, '', '',
1244         'fieldvalue',    'text', 'NULL', '', '', '',
1245       ],
1246       'primary_key' => 'fieldnum',
1247       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
1248       'index'       => [],
1249     },
1250
1251     'payment_gateway' => {
1252       'columns' => [
1253         'gatewaynum',       'serial',   '',     '', '', '',
1254         'gateway_module',   'varchar',  '',     $char_d, '', '',
1255         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
1256         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
1257         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
1258         'disabled',   'char',  'NULL',   1, '', '',
1259       ],
1260       'primary_key' => 'gatewaynum',
1261       'unique' => [],
1262       'index'  => [ [ 'disabled' ] ],
1263     },
1264
1265     'payment_gateway_option' => {
1266       'columns' => [
1267         'optionnum',   'serial',  '',     '', '', '',
1268         'gatewaynum',  'int',     '',     '', '', '',
1269         'optionname',  'varchar', '',     $char_d, '', '',
1270         'optionvalue', 'text',    'NULL', '', '', '',
1271       ],
1272       'primary_key' => 'optionnum',
1273       'unique'      => [],
1274       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1275     },
1276
1277     'agent_payment_gateway' => {
1278       'columns' => [
1279         'agentgatewaynum', 'serial', '', '', '', '',
1280         'agentnum',        'int', '', '', '', '',
1281         'gatewaynum',      'int', '', '', '', '',
1282         'cardtype',        'varchar', 'NULL', $char_d, '', '',
1283         'taxclass',        'varchar', 'NULL', $char_d, '', '',
1284       ],
1285       'primary_key' => 'agentgatewaynum',
1286       'unique'      => [],
1287       'index'       => [ [ 'agentnum', 'cardtype' ], ],
1288     },
1289
1290     'banned_pay' => {
1291       'columns' => [
1292         'bannum',  'serial',   '',     '', '', '',
1293         'payby',   'char',     '',       4, '', '',
1294         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
1295         #'paymask', 'varchar',  'NULL', $char_d, '', ''
1296         '_date',   @date_type, '', '',
1297         'otaker',  'varchar',  '',     32, '', '',
1298         'reason',  'varchar',  'NULL', $char_d, '', '',
1299       ],
1300       'primary_key' => 'bannum',
1301       'unique'      => [ [ 'payby', 'payinfo' ] ],
1302       'index'       => [],
1303     },
1304
1305     'cancel_reason' => {
1306       'columns' => [
1307         'reasonnum', 'serial',  '',     '', '', '',
1308         'reason',    'varchar', '',     $char_d, '', '',
1309         'disabled',  'char',    'NULL', 1, '', '',
1310       ],
1311       'primary_key' => 'reasonnum',
1312       'unique' => [],
1313       'index'  => [ [ 'disabled' ] ],
1314     },
1315
1316     'pkg_class' => {
1317       'columns' => [
1318         'classnum',   'serial',  '', '', '', '',
1319         'classname',  'varchar', '', $char_d, '', '',
1320       ],
1321       'primary_key' => 'classnum',
1322       'unique' => [],
1323       'index' => [],
1324     },
1325
1326     'cdr' => {
1327       'columns' => [
1328         # qw( name type null length default local );
1329
1330         ###
1331         #asterisk fields
1332         ###
1333
1334         'acctid',   'bigserial',  '', '', '', '',
1335         'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1336         'clid',        'varchar',  '', $char_d, \"''", '',
1337         'src',         'varchar',  '', $char_d, \"''", '',
1338         'dst',         'varchar',  '', $char_d, \"''", '',
1339         'dcontext',    'varchar',  '', $char_d, \"''", '',
1340         'channel',     'varchar',  '', $char_d, \"''", '',
1341         'dstchannel',  'varchar',  '', $char_d, \"''", '',
1342         'lastapp',     'varchar',  '', $char_d, \"''", '',
1343         'lastdata',    'varchar',  '', $char_d, \"''", '',
1344
1345         #these don't seem to be logged by most of the SQL cdr_* modules
1346         #except tds under sql-illegal names, so;
1347         # ... don't rely on them for rating?
1348         # and, what they hey, i went ahead and changed the names and data types
1349         # to freeside-style dates...
1350           #'start',  'timestamp', 'NULL',  '',    '', '',
1351           #'answer', 'timestamp', 'NULL',  '',    '', '',
1352           #'end',    'timestamp', 'NULL',  '',    '', '',
1353         'startdate',  @date_type, '', '',
1354         'answerdate', @date_type, '', '',
1355         'enddate',    @date_type, '', '',
1356         #
1357
1358         'duration',    'int',      '',      '',     0, '',
1359         'billsec',     'int',      '',      '',     0, '',
1360         'disposition', 'varchar',  '',      45, \"''", '',
1361         'amaflags',    'int',      '',      '',     0, '',
1362         'accountcode', 'varchar',  '',      20, \"''", '',
1363         'uniqueid',    'varchar',  '',      32, \"''", '',
1364         'userfield',   'varchar',  '',     255, \"''", '',
1365
1366         ###
1367         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1368         # defaults
1369         ###
1370
1371         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1372         'cdrtypenum',              'int', 'NULL',      '', '', '',
1373
1374         'charged_party',       'varchar', 'NULL', $char_d, '', '',
1375
1376         'upstream_currency',      'char', 'NULL',       3, '', '',
1377         'upstream_price',      'decimal', 'NULL',  '10,2', '', '',
1378         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
1379
1380         # how it was rated internally...
1381         'ratedetailnum',           'int', 'NULL',      '', '', '',
1382         'rated_price',         'decimal', 'NULL',  '10,2', '', '',
1383
1384         'distance',            'decimal', 'NULL',      '', '', '',
1385         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
1386
1387         #cdr_calltype: the big list in appendix 2
1388         'calltypenum',             'int', 'NULL',      '', '', '',
1389
1390         'description',         'varchar', 'NULL', $char_d, '', '',
1391         'quantity',                'int', 'NULL',      '', '', '',
1392
1393         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
1394         'carrierid',               'int', 'NULL',      '', '', '',
1395
1396         'upstream_rateid',         'int', 'NULL',      '', '', '',
1397
1398         ###
1399         #and now for our own fields
1400         ###
1401
1402         # a svcnum... right..?
1403         'svcnum',             'int',   'NULL',     '',   '', '',
1404
1405         #NULL, done (or something)
1406         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
1407
1408       ],
1409       'primary_key' => 'acctid',
1410       'unique' => [],
1411       'index' => [ [ 'calldate' ], [ 'dst' ], [ 'accountcode' ], [ 'freesidestatus' ] ],
1412     },
1413
1414     'cdr_calltype' => {
1415       'columns' => [
1416         'calltypenum',   'serial',  '', '', '', '',
1417         'calltypename',  'varchar', '', $char_d, '', '',
1418       ],
1419       'primary_key' => 'calltypenum',
1420       'unique'      => [],
1421       'index'       => [],
1422     },
1423
1424     'cdr_type' => {
1425       'columns' => [
1426         'cdrtypenum'  => 'serial',  '', '', '', '',
1427         'cdrtypename' => 'varchar', '', '', '', '',
1428       ],
1429       'primary_key' => 'cdrtypenum',
1430       'unique'      => [],
1431       'index'       => [],
1432     },
1433
1434     'cdr_carrier' => {
1435       'columns' => [
1436         'carrierid'   => 'serial',  '', '', '', '',
1437         'carriername' => 'varchar', '', '', '', '',
1438       ],
1439       'primary_key' => 'carrierid',
1440       'unique'      => [],
1441       'index'       => [],
1442     },
1443
1444     #map upstream rateid to ours...
1445     'cdr_upstream_rate' => {
1446       'columns' => [
1447         'upstreamratenum', 'serial',  '', '', '', '',
1448         'upstream_rateid', 'varchar', '', $char_d, '', '',
1449         'ratedetailnum',   'int', 'NULL', '', '', '',
1450       ],
1451       'primary_key' => 'upstreamratenum', #XXX need a primary key
1452       'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
1453       'index'  => [],
1454     },
1455
1456     'inventory_item' => {
1457       'columns' => [
1458         'itemnum',  'serial',      '',      '', '', '',
1459         'classnum', 'int',         '',      '', '', '',
1460         'item',     'varchar',     '', $char_d, '', '',
1461         'svcnum',   'int',     'NULL',      '', '', '',
1462       ],
1463       'primary_key' => 'itemnum',
1464       'unique' => [ [ 'classnum', 'item' ] ],
1465       'index'  => [ [ 'classnum' ], [ 'svcnum' ] ],
1466     },
1467
1468     'inventory_class' => {
1469       'columns' => [
1470         'classnum',  'serial',       '',      '', '', '',
1471         'classname', 'varchar',      '', $char_d, '', '',
1472       ],
1473       'primary_key' => 'classnum',
1474       'unique' => [],
1475       'index'  => [],
1476     },
1477
1478     'access_user' => {
1479       'columns' => [
1480         'usernum',   'serial',  '',      '', '', '',
1481         'username',  'varchar', '', $char_d, '', '',
1482         '_password', 'varchar', '', $char_d, '', '',
1483         'last',      'varchar', '', $char_d, '', '',
1484         'first',     'varchar', '', $char_d, '', '',
1485         'disabled',     'char', 'NULL',   1, '', '',
1486       ],
1487       'primary_key' => 'usernum',
1488       'unique' => [ [ 'username' ] ],
1489       'index'  => [],
1490     },
1491
1492     'access_user_pref' => {
1493       'columns' => [
1494         'prefnum',    'serial',       '', '', '', '',
1495         'usernum',     'int',       '', '', '', '',
1496         'prefname', 'varchar', '', $char_d, '', '',
1497         'prefvalue', 'text', 'NULL', '', '', '',
1498       ],
1499       'primary_key' => 'prefnum',
1500       'unique' => [],
1501       'index'  => [ [ 'usernum' ] ],
1502     },
1503
1504     'access_group' => {
1505       'columns' => [
1506         'groupnum',   'serial', '',      '', '', '',
1507         'groupname', 'varchar', '', $char_d, '', '',
1508       ],
1509       'primary_key' => 'groupnum',
1510       'unique' => [ [ 'groupname' ] ],
1511       'index'  => [],
1512     },
1513
1514     'access_usergroup' => {
1515       'columns' => [
1516         'usergroupnum', 'serial', '', '', '', '',
1517         'usernum',         'int', '', '', '', '',
1518         'groupnum',        'int', '', '', '', '',
1519       ],
1520       'primary_key' => 'usergroupnum',
1521       'unique' => [ [ 'usernum', 'groupnum' ] ],
1522       'index'  => [ [ 'usernum' ] ],
1523     },
1524
1525     'access_groupagent' => {
1526       'columns' => [
1527         'groupagentnum', 'serial', '', '', '', '',
1528         'groupnum',         'int', '', '', '', '',
1529         'agentnum',         'int', '', '', '', '',
1530       ],
1531       'primary_key' => 'groupagentnum',
1532       'unique' => [ [ 'groupnum', 'agentnum' ] ],
1533       'index'  => [ [ 'groupnum' ] ],
1534     },
1535
1536     'access_right' => {
1537       'columns' => [
1538         'rightnum',   'serial', '',      '', '', '',
1539         'righttype', 'varchar', '', $char_d, '', '',
1540         'rightobjnum',   'int', '',      '', '', '',
1541         'rightname', 'varchar', '',      '', '', '',
1542       ],
1543       'primary_key' => 'rightnum',
1544       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
1545       'index'  => [],
1546     },
1547
1548     'svc_phone' => {
1549       'columns' => [
1550         'svcnum',      'int',         '',      '', '', '',
1551         'countrycode', 'varchar',     '',       3, '', '',
1552         'phonenum',    'varchar',     '',      15, '', '',  #12 ?
1553         'pin',         'varchar', 'NULL', $char_d, '', '',
1554       ],
1555       'primary_key' => 'svcnum',
1556       'unique' => [],
1557       'index'  => [ [ 'countrycode', 'phonenum' ] ],
1558     },
1559
1560   };
1561
1562     #'new_table' => {
1563     #  'columns' => [
1564     #    'num', 'serial',       '', '', '', '',
1565     #  ],
1566     #  'primary_key' => 'num',
1567     #  'unique' => [],
1568     #  'index'  => [],
1569     #},
1570
1571 }
1572
1573 =back
1574
1575 =head1 BUGS
1576
1577 =head1 SEE ALSO
1578
1579 L<DBIx::DBSchema>
1580
1581 =cut
1582
1583 1;
1584