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