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