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