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