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