FS/FS/Schema.pm

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