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 #ask FS::UID to run this stuff for us later
  20 FS::UID->install_callback( sub {
  21   #$conf = new FS::Conf;
  22   &reload_dbdef("/usr/local/etc/freeside/dbdef.". datasrc)
  23     unless $setup_hack; #$setup_hack needed now?
  24 } );
  25
  26 =head1 NAME
  27
  28 FS::Schema - Freeside database schema
  29
  30 =head1 SYNOPSYS
  31
  32     use FS::Schema qw(dbdef dbdef_dist reload_dbdef);
  33
  34     $dbdef = reload_dbdef;
  35     $dbdef = reload_dbdef "/non/standard/filename";
  36     $dbdef = dbdef;
  37     $dbdef_dist = dbdef_dist;
  38
  39 =head1 DESCRIPTION
  40
  41 This class represents the database schema.
  42
  43 =head1 METHODS
  44
  45 =over 4
  46
  47 =item reload_dbdef([FILENAME])
  48
  49 Load a database definition (see L<DBIx::DBSchema>), optionally from a
  50 non-default filename.  This command is executed at startup unless
  51 I<$FS::Schema::setup_hack> is true.  Returns a DBIx::DBSchema object.
  52
  53 =cut
  54
  55 sub reload_dbdef {
  56   my $file = shift;
  57
  58   unless ( exists $dbdef_cache{$file} ) {
  59     warn "[debug]$me loading dbdef for $file\n" if $DEBUG;
  60     $dbdef_cache{$file} = DBIx::DBSchema->load( $file )
  61                             or die "can't load database schema from $file";
  62   } else {
  63     warn "[debug]$me re-using cached dbdef for $file\n" if $DEBUG;
  64   }
  65   $dbdef = $dbdef_cache{$file};
  66 }
  67
  68 =item dbdef
  69
  70 Returns the current database definition (represents the current database,
  71 assuming it is up-to-date).  See L<DBIx::DBSchema>.
  72
  73 =cut
  74
  75 sub dbdef { $dbdef; }
  76
  77 =item dbdef_dist [ OPTION => VALUE ... ]
  78
  79 Returns the current canoical database definition as defined in this file.
  80
  81 =cut
  82
  83 sub dbdef_dist {
  84
  85   ###
  86   # create a dbdef object from the old data structure
  87   ###
  88
  89   my $tables_hashref = tables_hashref();
  90
  91   #turn it into objects
  92   my $dbdef = new DBIx::DBSchema map {
  93     my @columns;
  94     while (@{$tables_hashref->{$_}{'columns'}}) {
  95       #my($name, $type, $null, $length, $default, $local) =
  96       my @coldef =
  97         splice @{$tables_hashref->{$_}{'columns'}}, 0, 6;
  98       my %hash = map { $_ => shift @coldef }
  99                      qw( name type null length default local );
 100
 101       unless ( defined $hash{'default'} ) {
 102         warn "$_:\n".
 103              join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
 104       }
 105
 106       push @columns, new DBIx::DBSchema::Column ( \%hash );
 107     }
 108     DBIx::DBSchema::Table->new(
 109       $_,
 110       $tables_hashref->{$_}{'primary_key'},
 111       DBIx::DBSchema::ColGroup::Unique->new($tables_hashref->{$_}{'unique'}),
 112       DBIx::DBSchema::ColGroup::Index->new($tables_hashref->{$_}{'index'}),
 113       @columns,
 114     );
 115   } keys %$tables_hashref;
 116
 117   if ( $DEBUG ) {
 118     warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
 119     warn "[debug]$me   $_\n" foreach $dbdef->tables;
 120   }
 121
 122   my $cust_main = $dbdef->table('cust_main');
 123   #unless ($ship) { #remove ship_ from cust_main
 124   #  $cust_main->delcolumn($_) foreach ( grep /^ship_/, $cust_main->columns );
 125   #} else { #add indices
 126     push @{$cust_main->index->lol_ref},
 127       map { [ "ship_$_" ] } qw( last company daytime night fax );
 128   #}
 129
 130   #add radius attributes to svc_acct
 131   #
 132   #my($svc_acct)=$dbdef->table('svc_acct');
 133   #
 134   #my($attribute);
 135   #foreach $attribute (@attributes) {
 136   #  $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
 137   #    'radius_'. $attribute,
 138   #    'varchar',
 139   #    'NULL',
 140   #    $char_d,
 141   #  ));
 142   #}
 143   #
 144   #foreach $attribute (@check_attributes) {
 145   #  $svc_acct->addcolumn( new DBIx::DBSchema::Column (
 146   #    'rc_'. $attribute,
 147   #    'varchar',
 148   #    'NULL',
 149   #    $char_d,
 150   #  ));
 151   #}
 152
 153   #create history tables (false laziness w/create-history-tables)
 154   foreach my $table (
 155     grep { ! /^clientapi_session/ }
 156     grep { ! /^h_/ }
 157     $dbdef->tables
 158   ) {
 159     my $tableobj = $dbdef->table($table)
 160       or die "unknown table $table";
 161
 162     die "unique->lol_ref undefined for $table"
 163       unless defined $tableobj->unique->lol_ref;
 164     die "index->lol_ref undefined for $table"
 165       unless defined $tableobj->index->lol_ref;
 166
 167     my $h_tableobj = DBIx::DBSchema::Table->new( {
 168       name        => "h_$table",
 169       primary_key => 'historynum',
 170       unique      => DBIx::DBSchema::ColGroup::Unique->new( [] ),
 171       'index'     => DBIx::DBSchema::ColGroup::Index->new( [
 172                        @{$tableobj->unique->lol_ref},
 173                        @{$tableobj->index->lol_ref}
 174                      ] ),
 175       columns     => [
 176                        DBIx::DBSchema::Column->new( {
 177                          'name'    => 'historynum',
 178                          'type'    => 'serial',
 179                          'null'    => 'NOT NULL',
 180                          'length'  => '',
 181                          'default' => '',
 182                          'local'   => '',
 183                        } ),
 184                        DBIx::DBSchema::Column->new( {
 185                          'name'    => 'history_date',
 186                          'type'    => 'int',
 187                          'null'    => 'NULL',
 188                          'length'  => '',
 189                          'default' => '',
 190                          'local'   => '',
 191                        } ),
 192                        DBIx::DBSchema::Column->new( {
 193                          'name'    => 'history_user',
 194                          'type'    => 'varchar',
 195                          'null'    => 'NOT NULL',
 196                          'length'  => '80',
 197                          'default' => '',
 198                          'local'   => '',
 199                        } ),
 200                        DBIx::DBSchema::Column->new( {
 201                          'name'    => 'history_action',
 202                          'type'    => 'varchar',
 203                          'null'    => 'NOT NULL',
 204                          'length'  => '80',
 205                          'default' => '',
 206                          'local'   => '',
 207                        } ),
 208                        map {
 209                          my $column = $tableobj->column($_);
 210
 211                          #clone so as to not disturb the original
 212                          $column = DBIx::DBSchema::Column->new( {
 213                            map { $_ => $column->$_() }
 214                              qw( name type null length default local )
 215                          } );
 216
 217                          if ( $column->type eq 'serial' ) {
 218                            $column->type('int');
 219                            $column->null('NULL');
 220                          }
 221                          #$column->default('')
 222                          #  if $column->default =~ /^nextval\(/i;
 223                          #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
 224                          #$column->local($local);
 225                          $column;
 226                        } $tableobj->columns
 227                      ],
 228     } );
 229     $dbdef->addtable($h_tableobj);
 230   }
 231
 232   $dbdef;
 233
 234 }
 235
 236 sub tables_hashref {
 237
 238   my $char_d = 80; #default maxlength for text fields
 239
 240   #my(@date_type)  = ( 'timestamp', '', ''     );
 241   my @date_type  = ( 'int', 'NULL', ''     );
 242   my @perl_type = ( 'text', 'NULL', ''  );
 243   my @money_type = ( 'decimal',   '', '10,2' );
 244
 245   my $username_len = 32; #usernamemax config file
 246
 247   return {
 248
 249     'agent' => {
 250       'columns' => [
 251         'agentnum', 'serial',            '',     '', '', '',
 252         'agent',    'varchar',           '',     $char_d, '', '',
 253         'typenum',  'int',            '',     '', '', '',
 254         'freq',     'int',       'NULL', '', '', '',
 255         'prog',     @perl_type, '', '',
 256         'disabled',     'char', 'NULL', 1, '', '',
 257         'username', 'varchar',       'NULL',     $char_d, '', '',
 258         '_password','varchar',       'NULL',     $char_d, '', '',
 259         'ticketing_queueid', 'int', 'NULL', '', '', '',
 260       ],
 261       'primary_key' => 'agentnum',
 262       'unique' => [],
 263       'index' => [ ['typenum'], ['disabled'] ],
 264     },
 265
 266     'agent_type' => {
 267       'columns' => [
 268         'typenum',   'serial',  '', '', '', '',
 269         'atype',     'varchar', '', $char_d, '', '',
 270       ],
 271       'primary_key' => 'typenum',
 272       'unique' => [],
 273       'index' => [],
 274     },
 275
 276     'type_pkgs' => {
 277       'columns' => [
 278         'typepkgnum', 'serial', '', '', '', '',
 279         'typenum',   'int',  '', '', '', '',
 280         'pkgpart',   'int',  '', '', '', '',
 281       ],
 282       'primary_key' => 'typepkgnum',
 283       'unique' => [ ['typenum', 'pkgpart'] ],
 284       'index' => [ ['typenum'] ],
 285     },
 286
 287     'cust_bill' => {
 288       'columns' => [
 289         'invnum',    'serial',  '', '', '', '',
 290         'custnum',   'int',  '', '', '', '',
 291         '_date',     @date_type, '', '',
 292         'charged',   @money_type, '', '',
 293         'printed',   'int',  '', '', '', '',
 294         'closed',    'char', 'NULL', 1, '', '',
 295       ],
 296       'primary_key' => 'invnum',
 297       'unique' => [],
 298       'index' => [ ['custnum'], ['_date'] ],
 299     },
 300
 301     'cust_bill_event' => {
 302       'columns' => [
 303         'eventnum',    'serial',  '', '', '', '',
 304         'invnum',   'int',  '', '', '', '',
 305         'eventpart',   'int',  '', '', '', '',
 306         '_date',     @date_type, '', '',
 307         'status', 'varchar', '', $char_d, '', '',
 308         'statustext', 'text', 'NULL', '', '', '',
 309       ],
 310       'primary_key' => 'eventnum',
 311       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 312       'unique' => [],
 313       'index' => [ ['invnum'], ['status'] ],
 314     },
 315
 316     'part_bill_event' => {
 317       'columns' => [
 318         'eventpart',    'serial',  '', '', '', '',
 319         'freq',        'varchar',       'NULL',     $char_d, '', '',
 320         'payby',       'char',  '', 4, '', '',
 321         'event',       'varchar',           '',     $char_d, '', '',
 322         'eventcode',    @perl_type, '', '',
 323         'seconds',     'int', 'NULL', '', '', '',
 324         'weight',      'int', '', '', '', '',
 325         'plan',       'varchar', 'NULL', $char_d, '', '',
 326         'plandata',   'text', 'NULL', '', '', '',
 327         'disabled',     'char', 'NULL', 1, '', '',
 328       ],
 329       'primary_key' => 'eventpart',
 330       'unique' => [],
 331       'index' => [ ['payby'], ['disabled'], ],
 332     },
 333
 334     'cust_bill_pkg' => {
 335       'columns' => [
 336         'billpkgnum', 'serial', '', '', '', '',
 337         'pkgnum',  'int', '', '', '', '',
 338         'invnum',  'int', '', '', '', '',
 339         'setup',   @money_type, '', '',
 340         'recur',   @money_type, '', '',
 341         'sdate',   @date_type, '', '',
 342         'edate',   @date_type, '', '',
 343         'itemdesc', 'varchar', 'NULL', $char_d, '', '',
 344       ],
 345       'primary_key' => 'billpkgnum',
 346       'unique' => [],
 347       'index' => [ ['invnum'], [ 'pkgnum' ] ],
 348     },
 349
 350     'cust_bill_pkg_detail' => {
 351       'columns' => [
 352         'detailnum', 'serial', '', '', '', '',
 353         'pkgnum',  'int', '', '', '', '',
 354         'invnum',  'int', '', '', '', '',
 355         'detail',  'varchar', '', $char_d, '', '',
 356       ],
 357       'primary_key' => 'detailnum',
 358       'unique' => [],
 359       'index' => [ [ 'pkgnum', 'invnum' ] ],
 360     },
 361
 362     'cust_credit' => {
 363       'columns' => [
 364         'crednum',  'serial', '', '', '', '',
 365         'custnum',  'int', '', '', '', '',
 366         '_date',    @date_type, '', '',
 367         'amount',   @money_type, '', '',
 368         'otaker',   'varchar', '', 32, '', '',
 369         'reason',   'text', 'NULL', '', '', '',
 370         'closed',    'char', 'NULL', 1, '', '',
 371       ],
 372       'primary_key' => 'crednum',
 373       'unique' => [],
 374       'index' => [ ['custnum'] ],
 375     },
 376
 377     'cust_credit_bill' => {
 378       'columns' => [
 379         'creditbillnum', 'serial', '', '', '', '',
 380         'crednum',  'int', '', '', '', '',
 381         'invnum',  'int', '', '', '', '',
 382         '_date',    @date_type, '', '',
 383         'amount',   @money_type, '', '',
 384       ],
 385       'primary_key' => 'creditbillnum',
 386       'unique' => [],
 387       'index' => [ ['crednum'], ['invnum'] ],
 388     },
 389
 390     'cust_main' => {
 391       'columns' => [
 392         'custnum',  'serial',  '',     '', '', '',
 393         'agentnum', 'int',  '',     '', '', '',
 394 #        'titlenum', 'int',  'NULL',   '', '', '',
 395         'last',     'varchar', '',     $char_d, '', '',
 396 #        'middle',   'varchar', 'NULL', $char_d, '', '',
 397         'first',    'varchar', '',     $char_d, '', '',
 398         'ss',       'varchar', 'NULL', 11, '', '',
 399         'company',  'varchar', 'NULL', $char_d, '', '',
 400         'address1', 'varchar', '',     $char_d, '', '',
 401         'address2', 'varchar', 'NULL', $char_d, '', '',
 402         'city',     'varchar', '',     $char_d, '', '',
 403         'county',   'varchar', 'NULL', $char_d, '', '',
 404         'state',    'varchar', 'NULL', $char_d, '', '',
 405         'zip',      'varchar', 'NULL', 10, '', '',
 406         'country',  'char', '',     2, '', '',
 407         'daytime',  'varchar', 'NULL', 20, '', '',
 408         'night',    'varchar', 'NULL', 20, '', '',
 409         'fax',      'varchar', 'NULL', 12, '', '',
 410         'ship_last',     'varchar', 'NULL', $char_d, '', '',
 411 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '',
 412         'ship_first',    'varchar', 'NULL', $char_d, '', '',
 413         'ship_company',  'varchar', 'NULL', $char_d, '', '',
 414         'ship_address1', 'varchar', 'NULL', $char_d, '', '',
 415         'ship_address2', 'varchar', 'NULL', $char_d, '', '',
 416         'ship_city',     'varchar', 'NULL', $char_d, '', '',
 417         'ship_county',   'varchar', 'NULL', $char_d, '', '',
 418         'ship_state',    'varchar', 'NULL', $char_d, '', '',
 419         'ship_zip',      'varchar', 'NULL', 10, '', '',
 420         'ship_country',  'char', 'NULL', 2, '', '',
 421         'ship_daytime',  'varchar', 'NULL', 20, '', '',
 422         'ship_night',    'varchar', 'NULL', 20, '', '',
 423         'ship_fax',      'varchar', 'NULL', 12, '', '',
 424         'payby',    'char', '',     4, '', '',
 425         'payinfo',  'varchar', 'NULL', 512, '', '',
 426         'paycvv',   'varchar', 'NULL', 512, '', '',
 427         'paymask', 'varchar', 'NULL', $char_d, '', '',
 428         #'paydate',  @date_type, '', '',
 429         'paydate',  'varchar', 'NULL', 10, '', '',
 430         'paystart_month', 'int', 'NULL', '', '', '',
 431         'paystart_year',  'int', 'NULL', '', '', '',
 432         'payissue', 'varchar', 'NULL', 2, '', '',
 433         'payname',  'varchar', 'NULL', $char_d, '', '',
 434         'payip',    'varchar', 'NULL', 15, '', '',
 435         'tax',      'char', 'NULL', 1, '', '',
 436         'otaker',   'varchar', '',    32, '', '',
 437         'refnum',   'int',  '',     '', '', '',
 438         'referral_custnum', 'int',  'NULL', '', '', '',
 439         'comments', 'text', 'NULL', '', '', '',
 440       ],
 441       'primary_key' => 'custnum',
 442       'unique' => [],
 443       #'index' => [ ['last'], ['company'] ],
 444       'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ],
 445                    [ 'daytime' ], [ 'night' ], [ 'fax' ], [ 'refnum' ],
 446                    [ 'county' ], [ 'state' ], [ 'country' ]
 447                  ],
 448     },
 449
 450     'cust_main_invoice' => {
 451       'columns' => [
 452         'destnum',  'serial',  '',     '', '', '',
 453         'custnum',  'int',  '',     '', '', '',
 454         'dest',     'varchar', '',  $char_d, '', '',
 455       ],
 456       'primary_key' => 'destnum',
 457       'unique' => [],
 458       'index' => [ ['custnum'], ],
 459     },
 460
 461     'cust_main_county' => { #county+state+country are checked off the
 462                             #cust_main_county for validation and to provide
 463                             # a tax rate.
 464       'columns' => [
 465         'taxnum',   'serial',   '',    '', '', '',
 466         'state',    'varchar',  'NULL',    $char_d, '', '',
 467         'county',   'varchar',  'NULL',    $char_d, '', '',
 468         'country',  'char',  '', 2, '', '',
 469         'taxclass',   'varchar', 'NULL', $char_d, '', '',
 470         'exempt_amount', @money_type, '', '',
 471         'tax',      'real',  '',    '', '', '', #tax %
 472         'taxname',  'varchar',  'NULL',    $char_d, '', '',
 473         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
 474         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
 475       ],
 476       'primary_key' => 'taxnum',
 477       'unique' => [],
 478   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
 479       'index' => [ [ 'county' ], [ 'state' ], [ 'country' ] ],
 480     },
 481
 482     'cust_pay' => {
 483       'columns' => [
 484         'paynum',   'serial',    '',   '', '', '',
 485         #now cust_bill_pay #'invnum',   'int',    '',   '', '', '',
 486         'custnum',  'int',    '',   '', '', '',
 487         'paid',     @money_type, '', '',
 488         '_date',    @date_type, '', '',
 489         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 490                                                  # index into payby table
 491                                                  # eventually
 492         'payinfo',  'varchar',   'NULL', $char_d, '', '', #see cust_main above
 493         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 494         'closed',    'char', 'NULL', 1, '', '',
 495       ],
 496       'primary_key' => 'paynum',
 497       'unique' => [],
 498       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
 499     },
 500
 501     'cust_pay_void' => {
 502       'columns' => [
 503         'paynum',    'int',    '',   '', '', '',
 504         'custnum',   'int',    '',   '', '', '',
 505         'paid',      @money_type, '', '',
 506         '_date',     @date_type, '', '',
 507         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 508                                                   # index into payby table
 509                                                   # eventually
 510         'payinfo',   'varchar',   'NULL', $char_d, '', '', #see cust_main above
 511         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 512         'closed',    'char', 'NULL', 1, '', '',
 513         'void_date', @date_type, '', '',
 514         'reason',    'varchar',   'NULL', $char_d, '', '',
 515         'otaker',   'varchar', '', 32, '', '',
 516       ],
 517       'primary_key' => 'paynum',
 518       'unique' => [],
 519       'index' => [ [ 'custnum' ] ],
 520     },
 521
 522     'cust_bill_pay' => {
 523       'columns' => [
 524         'billpaynum', 'serial',     '',   '', '', '',
 525         'invnum',  'int',     '',   '', '', '',
 526         'paynum',  'int',     '',   '', '', '',
 527         'amount',  @money_type, '', '',
 528         '_date',   @date_type, '', '',
 529       ],
 530       'primary_key' => 'billpaynum',
 531       'unique' => [],
 532       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
 533     },
 534
 535     'cust_pay_batch' => { #what's this used for again?  list of customers
 536                           #in current CARD batch? (necessarily CARD?)
 537       'columns' => [
 538         'paybatchnum',   'serial',    '',   '', '', '',
 539         'invnum',   'int',    '',   '', '', '',
 540         'custnum',   'int',    '',   '', '', '',
 541         'last',     'varchar', '',     $char_d, '', '',
 542         'first',    'varchar', '',     $char_d, '', '',
 543         'address1', 'varchar', '',     $char_d, '', '',
 544         'address2', 'varchar', 'NULL', $char_d, '', '',
 545         'city',     'varchar', '',     $char_d, '', '',
 546         'state',    'varchar', 'NULL', $char_d, '', '',
 547         'zip',      'varchar', 'NULL', 10, '', '',
 548         'country',  'char', '',     2, '', '',
 549         #        'trancode', 'int', '', '', '', ''
 550         'cardnum',  'varchar', '',     16, '', '',
 551         #'exp',      @date_type, '', ''
 552         'exp',      'varchar', '',     11, '', '',
 553         'payname',  'varchar', 'NULL', $char_d, '', '',
 554         'amount',   @money_type, '', '',
 555       ],
 556       'primary_key' => 'paybatchnum',
 557       'unique' => [],
 558       'index' => [ ['invnum'], ['custnum'] ],
 559     },
 560
 561     'cust_pkg' => {
 562       'columns' => [
 563         'pkgnum',    'serial',    '',   '', '', '',
 564         'custnum',   'int',    '',   '', '', '',
 565         'pkgpart',   'int',    '',   '', '', '',
 566         'otaker',    'varchar', '', 32, '', '',
 567         'setup',     @date_type, '', '',
 568         'bill',      @date_type, '', '',
 569         'last_bill', @date_type, '', '',
 570         'susp',      @date_type, '', '',
 571         'cancel',    @date_type, '', '',
 572         'expire',    @date_type, '', '',
 573         'manual_flag', 'char', 'NULL', 1, '', '',
 574       ],
 575       'primary_key' => 'pkgnum',
 576       'unique' => [],
 577       'index' => [ ['custnum'], ['pkgpart'] ],
 578     },
 579
 580     'cust_refund' => {
 581       'columns' => [
 582         'refundnum',    'serial',    '',   '', '', '',
 583         #now cust_credit_refund #'crednum',      'int',    '',   '', '', '',
 584         'custnum',  'int',    '',   '', '', '',
 585         '_date',        @date_type, '', '',
 586         'refund',       @money_type, '', '',
 587         'otaker',       'varchar',   '',   32, '', '',
 588         'reason',       'varchar',   '',   $char_d, '', '',
 589         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
 590                                                      # be index into payby
 591                                                      # table eventually
 592         'payinfo',      'varchar',   'NULL', $char_d, '', '', #see cust_main above
 593         'paybatch',     'varchar',   'NULL', $char_d, '', '',
 594         'closed',    'char', 'NULL', 1, '', '',
 595       ],
 596       'primary_key' => 'refundnum',
 597       'unique' => [],
 598       'index' => [],
 599     },
 600
 601     'cust_credit_refund' => {
 602       'columns' => [
 603         'creditrefundnum', 'serial',     '',   '', '', '',
 604         'crednum',  'int',     '',   '', '', '',
 605         'refundnum',  'int',     '',   '', '', '',
 606         'amount',  @money_type, '', '',
 607         '_date',   @date_type, '', '',
 608       ],
 609       'primary_key' => 'creditrefundnum',
 610       'unique' => [],
 611       'index' => [ [ 'crednum', 'refundnum' ] ],
 612     },
 613
 614
 615     'cust_svc' => {
 616       'columns' => [
 617         'svcnum',    'serial',    '',   '', '', '',
 618         'pkgnum',    'int',    'NULL',   '', '', '',
 619         'svcpart',   'int',    '',   '', '', '',
 620       ],
 621       'primary_key' => 'svcnum',
 622       'unique' => [],
 623       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
 624     },
 625
 626     'part_pkg' => {
 627       'columns' => [
 628         'pkgpart',    'serial',    '',   '', '', '',
 629         'pkg',        'varchar',   '',   $char_d, '', '',
 630         'comment',    'varchar',   '',   $char_d, '', '',
 631         'promo_code', 'varchar', 'NULL', $char_d, '', '',
 632         'setup',      @perl_type, '', '',
 633         'freq',       'varchar',   '',   $char_d, '', '', #billing frequency
 634         'recur',      @perl_type, '', '',
 635         'setuptax',  'char', 'NULL', 1, '', '',
 636         'recurtax',  'char', 'NULL', 1, '', '',
 637         'plan',       'varchar', 'NULL', $char_d, '', '',
 638         'plandata',   'text', 'NULL', '', '', '',
 639         'disabled',   'char', 'NULL', 1, '', '',
 640         'taxclass',   'varchar', 'NULL', $char_d, '', '',
 641         'classnum',   'int',     'NULL', '', '', '',
 642       ],
 643       'primary_key' => 'pkgpart',
 644       'unique' => [],
 645       'index' => [ [ 'promo_code' ], [ 'disabled' ] ],
 646     },
 647
 648 #    'part_title' => {
 649 #      'columns' => [
 650 #        'titlenum',   'int',    '',   '',
 651 #        'title',      'varchar',   '',   $char_d,
 652 #      ],
 653 #      'primary_key' => 'titlenum',
 654 #      'unique' => [ [] ],
 655 #      'index' => [ [] ],
 656 #    },
 657
 658     'pkg_svc' => {
 659       'columns' => [
 660         'pkgsvcnum',  'serial', '',  '', '', '',
 661         'pkgpart',    'int',    '',   '', '', '',
 662         'svcpart',    'int',    '',   '', '', '',
 663         'quantity',   'int',    '',   '', '', '',
 664         'primary_svc','char', 'NULL',  1, '', '',
 665       ],
 666       'primary_key' => 'pkgsvcnum',
 667       'unique' => [ ['pkgpart', 'svcpart'] ],
 668       'index' => [ ['pkgpart'] ],
 669     },
 670
 671     'part_referral' => {
 672       'columns' => [
 673         'refnum',   'serial',    '',   '', '', '',
 674         'referral', 'varchar',   '',   $char_d, '', '',
 675         'disabled',     'char', 'NULL', 1, '', '',
 676       ],
 677       'primary_key' => 'refnum',
 678       'unique' => [],
 679       'index' => [ ['disabled'] ],
 680     },
 681
 682     'part_svc' => {
 683       'columns' => [
 684         'svcpart',    'serial',    '',   '', '', '',
 685         'svc',        'varchar',   '',   $char_d, '', '',
 686         'svcdb',      'varchar',   '',   $char_d, '', '',
 687         'disabled',   'char',  'NULL',   1, '', '',
 688       ],
 689       'primary_key' => 'svcpart',
 690       'unique' => [],
 691       'index' => [ [ 'disabled' ] ],
 692     },
 693
 694     'part_svc_column' => {
 695       'columns' => [
 696         'columnnum',   'serial',         '', '', '', '',
 697         'svcpart',     'int',         '', '', '', '',
 698         'columnname',  'varchar',     '', 64, '', '',
 699         'columnvalue', 'varchar', 'NULL', $char_d, '', '',
 700         'columnflag',  'char',    'NULL', 1, '', '',
 701       ],
 702       'primary_key' => 'columnnum',
 703       'unique' => [ [ 'svcpart', 'columnname' ] ],
 704       'index' => [ [ 'svcpart' ] ],
 705     },
 706
 707     #(this should be renamed to part_pop)
 708     'svc_acct_pop' => {
 709       'columns' => [
 710         'popnum',    'serial',    '',   '', '', '',
 711         'city',      'varchar',   '',   $char_d, '', '',
 712         'state',     'varchar',   '',   $char_d, '', '',
 713         'ac',        'char',   '',   3, '', '',
 714         'exch',      'char',   '',   3, '', '',
 715         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
 716       ],
 717       'primary_key' => 'popnum',
 718       'unique' => [],
 719       'index' => [ [ 'state' ] ],
 720     },
 721
 722     'part_pop_local' => {
 723       'columns' => [
 724         'localnum',  'serial',     '',     '', '', '',
 725         'popnum',    'int',     '',     '', '', '',
 726         'city',      'varchar', 'NULL', $char_d, '', '',
 727         'state',     'char',    'NULL', 2, '', '',
 728         'npa',       'char',    '',     3, '', '',
 729         'nxx',       'char',    '',     3, '', '',
 730       ],
 731       'primary_key' => 'localnum',
 732       'unique' => [],
 733       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
 734     },
 735
 736     'svc_acct' => {
 737       'columns' => [
 738         'svcnum',    'int',    '',   '', '', '',
 739         'username',  'varchar',   '',   $username_len, '', '', #unique (& remove dup code)
 740         '_password', 'varchar',   '',   72, '', '', #13 for encryped pw's plus ' *SUSPENDED* (md5 passwords can be 34, blowfish 60)
 741         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
 742         'popnum',    'int',    'NULL',   '', '', '',
 743         'uid',       'int', 'NULL',   '', '', '',
 744         'gid',       'int', 'NULL',   '', '', '',
 745         'finger',    'varchar',   'NULL',   $char_d, '', '',
 746         'dir',       'varchar',   'NULL',   $char_d, '', '',
 747         'shell',     'varchar',   'NULL',   $char_d, '', '',
 748         'quota',     'varchar',   'NULL',   $char_d, '', '',
 749         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
 750         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
 751         'domsvc',    'int', '',   '', '', '',
 752       ],
 753       'primary_key' => 'svcnum',
 754       #'unique' => [ [ 'username', 'domsvc' ] ],
 755       'unique' => [],
 756       'index' => [ ['username'], ['domsvc'] ],
 757     },
 758
 759     #'svc_charge' => {
 760     #  'columns' => [
 761     #    'svcnum',    'int',    '',   '',
 762     #    'amount',    @money_type,
 763     #  ],
 764     #  'primary_key' => 'svcnum',
 765     #  'unique' => [ [] ],
 766     #  'index' => [ [] ],
 767     #},
 768
 769     'svc_domain' => {
 770       'columns' => [
 771         'svcnum',    'int',    '',   '', '', '',
 772         'domain',    'varchar',    '',   $char_d, '', '',
 773         'catchall',  'int', 'NULL',    '', '', '',
 774       ],
 775       'primary_key' => 'svcnum',
 776       'unique' => [ ['domain'] ],
 777       'index' => [],
 778     },
 779
 780     'domain_record' => {
 781       'columns' => [
 782         'recnum',    'serial',     '',  '', '', '',
 783         'svcnum',    'int',     '',  '', '', '',
 784         'reczone',   'varchar', '',  255, '', '',
 785         'recaf',     'char',    '',  2, '', '',
 786         'rectype',   'varchar',    '',  5, '', '',
 787         'recdata',   'varchar', '',  255, '', '',
 788       ],
 789       'primary_key' => 'recnum',
 790       'unique'      => [],
 791       'index'       => [ ['svcnum'] ],
 792     },
 793
 794     'svc_forward' => {
 795       'columns' => [
 796         'svcnum',   'int',            '',   '', '', '',
 797         'srcsvc',   'int',        'NULL',   '', '', '',
 798         'src',      'varchar',    'NULL',  255, '', '',
 799         'dstsvc',   'int',        'NULL',   '', '', '',
 800         'dst',      'varchar',    'NULL',  255, '', '',
 801       ],
 802       'primary_key' => 'svcnum',
 803       'unique'      => [],
 804       'index'       => [ ['srcsvc'], ['dstsvc'] ],
 805     },
 806
 807     'svc_www' => {
 808       'columns' => [
 809         'svcnum',   'int',    '',  '', '', '',
 810         'recnum',   'int',    '',  '', '', '',
 811         'usersvc',  'int',    '',  '', '', '',
 812       ],
 813       'primary_key' => 'svcnum',
 814       'unique'      => [],
 815       'index'       => [],
 816     },
 817
 818     #'svc_wo' => {
 819     #  'columns' => [
 820     #    'svcnum',    'int',    '',   '',
 821     #    'svcnum',    'int',    '',   '',
 822     #    'svcnum',    'int',    '',   '',
 823     #    'worker',    'varchar',   '',   $char_d,
 824     #    '_date',     @date_type,
 825     #  ],
 826     #  'primary_key' => 'svcnum',
 827     #  'unique' => [ [] ],
 828     #  'index' => [ [] ],
 829     #},
 830
 831     'prepay_credit' => {
 832       'columns' => [
 833         'prepaynum',   'serial',     '',   '', '', '',
 834         'identifier',  'varchar', '', $char_d, '', '',
 835         'amount',      @money_type, '', '',
 836         'seconds',     'int',     'NULL', '', '', '',
 837         'agentnum',    'int',     'NULL', '', '', '',
 838       ],
 839       'primary_key' => 'prepaynum',
 840       'unique'      => [ ['identifier'] ],
 841       'index'       => [],
 842     },
 843
 844     'port' => {
 845       'columns' => [
 846         'portnum',  'serial',     '',   '', '', '',
 847         'ip',       'varchar', 'NULL', 15, '', '',
 848         'nasport',  'int',     'NULL', '', '', '',
 849         'nasnum',   'int',     '',   '', '', '',
 850       ],
 851       'primary_key' => 'portnum',
 852       'unique'      => [],
 853       'index'       => [],
 854     },
 855
 856     'nas' => {
 857       'columns' => [
 858         'nasnum',   'serial',     '',    '', '', '',
 859         'nas',      'varchar', '',    $char_d, '', '',
 860         'nasip',    'varchar', '',    15, '', '',
 861         'nasfqdn',  'varchar', '',    $char_d, '', '',
 862         'last',     'int',     '',    '', '', '',
 863       ],
 864       'primary_key' => 'nasnum',
 865       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
 866       'index'       => [ [ 'last' ] ],
 867     },
 868
 869     'session' => {
 870       'columns' => [
 871         'sessionnum', 'serial',       '',   '', '', '',
 872         'portnum',    'int',       '',   '', '', '',
 873         'svcnum',     'int',       '',   '', '', '',
 874         'login',      @date_type, '', '',
 875         'logout',     @date_type, '', '',
 876       ],
 877       'primary_key' => 'sessionnum',
 878       'unique'      => [],
 879       'index'       => [ [ 'portnum' ] ],
 880     },
 881
 882     'queue' => {
 883       'columns' => [
 884         'jobnum', 'serial', '', '', '', '',
 885         'job', 'text', '', '', '', '',
 886         '_date', 'int', '', '', '', '',
 887         'status', 'varchar', '', $char_d, '', '',
 888         'statustext', 'text', 'NULL', '', '', '',
 889         'svcnum', 'int', 'NULL', '', '', '',
 890       ],
 891       'primary_key' => 'jobnum',
 892       'unique'      => [],
 893       'index'       => [ [ 'svcnum' ], [ 'status' ] ],
 894     },
 895
 896     'queue_arg' => {
 897       'columns' => [
 898         'argnum', 'serial', '', '', '', '',
 899         'jobnum', 'int', '', '', '', '',
 900         'arg', 'text', 'NULL', '', '', '',
 901       ],
 902       'primary_key' => 'argnum',
 903       'unique'      => [],
 904       'index'       => [ [ 'jobnum' ] ],
 905     },
 906
 907     'queue_depend' => {
 908       'columns' => [
 909         'dependnum', 'serial', '', '', '', '',
 910         'jobnum', 'int', '', '', '', '',
 911         'depend_jobnum', 'int', '', '', '', '',
 912       ],
 913       'primary_key' => 'dependnum',
 914       'unique'      => [],
 915       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
 916     },
 917
 918     'export_svc' => {
 919       'columns' => [
 920         'exportsvcnum' => 'serial', '', '', '', '',
 921         'exportnum'    => 'int', '', '', '', '',
 922         'svcpart'      => 'int', '', '', '', '',
 923       ],
 924       'primary_key' => 'exportsvcnum',
 925       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
 926       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
 927     },
 928
 929     'part_export' => {
 930       'columns' => [
 931         'exportnum', 'serial', '', '', '', '',
 932         'machine', 'varchar', '', $char_d, '', '',
 933         'exporttype', 'varchar', '', $char_d, '', '',
 934         'nodomain',     'char', 'NULL', 1, '', '',
 935       ],
 936       'primary_key' => 'exportnum',
 937       'unique'      => [],
 938       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
 939     },
 940
 941     'part_export_option' => {
 942       'columns' => [
 943         'optionnum', 'serial', '', '', '', '',
 944         'exportnum', 'int', '', '', '', '',
 945         'optionname', 'varchar', '', $char_d, '', '',
 946         'optionvalue', 'text', 'NULL', '', '', '',
 947       ],
 948       'primary_key' => 'optionnum',
 949       'unique'      => [],
 950       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
 951     },
 952
 953     'radius_usergroup' => {
 954       'columns' => [
 955         'usergroupnum', 'serial', '', '', '', '',
 956         'svcnum',       'int', '', '', '', '',
 957         'groupname',    'varchar', '', $char_d, '', '',
 958       ],
 959       'primary_key' => 'usergroupnum',
 960       'unique'      => [],
 961       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
 962     },
 963
 964     'msgcat' => {
 965       'columns' => [
 966         'msgnum', 'serial', '', '', '', '',
 967         'msgcode', 'varchar', '', $char_d, '', '',
 968         'locale', 'varchar', '', 16, '', '',
 969         'msg', 'text', '', '', '', '',
 970       ],
 971       'primary_key' => 'msgnum',
 972       'unique'      => [ [ 'msgcode', 'locale' ] ],
 973       'index'       => [],
 974     },
 975
 976     'cust_tax_exempt' => {
 977       'columns' => [
 978         'exemptnum', 'serial', '', '', '', '',
 979         'custnum',   'int', '', '', '', '',
 980         'taxnum',    'int', '', '', '', '',
 981         'year',      'int', '', '', '', '',
 982         'month',     'int', '', '', '', '',
 983         'amount',   @money_type, '', '',
 984       ],
 985       'primary_key' => 'exemptnum',
 986       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
 987       'index'       => [],
 988     },
 989
 990     'cust_tax_exempt_pkg' => {
 991       'columns' => [
 992         'exemptpkgnum',  'serial', '', '', '', '',
 993         #'custnum',      'int', '', '', '', ''
 994         'billpkgnum',   'int', '', '', '', '',
 995         'taxnum',       'int', '', '', '', '',
 996         'year',         'int', '', '', '', '',
 997         'month',        'int', '', '', '', '',
 998         'amount',       @money_type, '', '',
 999       ],
1000       'primary_key' => 'exemptpkgnum',
1001       'unique' => [],
1002       'index'  => [ [ 'taxnum', 'year', 'month' ],
1003                     [ 'billpkgnum' ],
1004                     [ 'taxnum' ]
1005                   ],
1006     },
1007
1008     'router' => {
1009       'columns' => [
1010         'routernum', 'serial', '', '', '', '',
1011         'routername', 'varchar', '', $char_d, '', '',
1012         'svcnum', 'int', 'NULL', '', '', '',
1013       ],
1014       'primary_key' => 'routernum',
1015       'unique'      => [],
1016       'index'       => [],
1017     },
1018
1019     'part_svc_router' => {
1020       'columns' => [
1021         'svcrouternum', 'serial', '', '', '', '',
1022         'svcpart', 'int', '', '', '', '',
1023         'routernum', 'int', '', '', '', '',
1024       ],
1025       'primary_key' => 'svcrouternum',
1026       'unique'      => [],
1027       'index'       => [],
1028     },
1029
1030     'addr_block' => {
1031       'columns' => [
1032         'blocknum', 'serial', '', '', '', '',
1033         'routernum', 'int', '', '', '', '',
1034         'ip_gateway', 'varchar', '', 15, '', '',
1035         'ip_netmask', 'int', '', '', '', '',
1036       ],
1037       'primary_key' => 'blocknum',
1038       'unique'      => [ [ 'blocknum', 'routernum' ] ],
1039       'index'       => [],
1040     },
1041
1042     'svc_broadband' => {
1043       'columns' => [
1044         'svcnum', 'int', '', '', '', '',
1045         'blocknum', 'int', '', '', '', '',
1046         'speed_up', 'int', '', '', '', '',
1047         'speed_down', 'int', '', '', '', '',
1048         'ip_addr', 'varchar', '', 15, '', '',
1049       ],
1050       'primary_key' => 'svcnum',
1051       'unique'      => [],
1052       'index'       => [],
1053     },
1054
1055     'part_virtual_field' => {
1056       'columns' => [
1057         'vfieldpart', 'int', '', '', '', '',
1058         'dbtable', 'varchar', '', 32, '', '',
1059         'name', 'varchar', '', 32, '', '',
1060         'check_block', 'text', 'NULL', '', '', '',
1061         'length', 'int', 'NULL', '', '', '',
1062         'list_source', 'text', 'NULL', '', '', '',
1063         'label', 'varchar', 'NULL', 80, '', '',
1064       ],
1065       'primary_key' => 'vfieldpart',
1066       'unique' => [],
1067       'index' => [],
1068     },
1069
1070     'virtual_field' => {
1071       'columns' => [
1072         'vfieldnum', 'serial', '', '', '', '',
1073         'recnum', 'int', '', '', '', '',
1074         'vfieldpart', 'int', '', '', '', '',
1075         'value', 'varchar', '', 128, '', '',
1076       ],
1077       'primary_key' => 'vfieldnum',
1078       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1079       'index' => [],
1080     },
1081
1082     'acct_snarf' => {
1083       'columns' => [
1084         'snarfnum',  'int', '', '', '', '',
1085         'svcnum',    'int', '', '', '', '',
1086         'machine',   'varchar', '', 255, '', '',
1087         'protocol',  'varchar', '', $char_d, '', '',
1088         'username',  'varchar', '', $char_d, '', '',
1089         '_password', 'varchar', '', $char_d, '', '',
1090       ],
1091       'primary_key' => 'snarfnum',
1092       'unique' => [],
1093       'index'  => [ [ 'svcnum' ] ],
1094     },
1095
1096     'svc_external' => {
1097       'columns' => [
1098         'svcnum', 'int', '', '', '', '',
1099         'id',     'int', 'NULL', '', '', '',
1100         'title',  'varchar', 'NULL', $char_d, '', '',
1101       ],
1102       'primary_key' => 'svcnum',
1103       'unique'      => [],
1104       'index'       => [],
1105     },
1106
1107     'cust_pay_refund' => {
1108       'columns' => [
1109         'payrefundnum', 'serial', '', '', '', '',
1110         'paynum',  'int', '', '', '', '',
1111         'refundnum',  'int', '', '', '', '',
1112         '_date',    @date_type, '', '',
1113         'amount',   @money_type, '', '',
1114       ],
1115       'primary_key' => 'payrefundnum',
1116       'unique' => [],
1117       'index' => [ ['paynum'], ['refundnum'] ],
1118     },
1119
1120     'part_pkg_option' => {
1121       'columns' => [
1122         'optionnum', 'serial', '', '', '', '',
1123         'pkgpart', 'int', '', '', '', '',
1124         'optionname', 'varchar', '', $char_d, '', '',
1125         'optionvalue', 'text', 'NULL', '', '', '',
1126       ],
1127       'primary_key' => 'optionnum',
1128       'unique'      => [],
1129       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
1130     },
1131
1132     'rate' => {
1133       'columns' => [
1134         'ratenum',  'serial', '', '', '', '',
1135         'ratename', 'varchar', '', $char_d, '', '',
1136       ],
1137       'primary_key' => 'ratenum',
1138       'unique'      => [],
1139       'index'       => [],
1140     },
1141
1142     'rate_detail' => {
1143       'columns' => [
1144         'ratedetailnum',   'serial', '', '', '', '',
1145         'ratenum',         'int',     '', '', '', '',
1146         'orig_regionnum',  'int', 'NULL', '', '', '',
1147         'dest_regionnum',  'int',     '', '', '', '',
1148         'min_included',    'int',     '', '', '', '',
1149         'min_charge',      @money_type, '', '',
1150         'sec_granularity', 'int',     '', '', '', '',
1151         #time period (link to table of periods)?
1152       ],
1153       'primary_key' => 'ratedetailnum',
1154       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1155       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
1156     },
1157
1158     'rate_region' => {
1159       'columns' => [
1160         'regionnum',   'serial',      '', '', '', '',
1161         'regionname',  'varchar',     '', $char_d, '', '',
1162       ],
1163       'primary_key' => 'regionnum',
1164       'unique'      => [],
1165       'index'       => [],
1166     },
1167
1168     'rate_prefix' => {
1169       'columns' => [
1170         'prefixnum',   'serial',    '', '', '', '',
1171         'regionnum',   'int',       '', '',, '', '',
1172         'countrycode', 'varchar',     '', 3, '', '',
1173         'npa',         'varchar', 'NULL', 6, '', '',
1174         'nxx',         'varchar', 'NULL', 3, '', '',
1175       ],
1176       'primary_key' => 'prefixnum',
1177       'unique'      => [],
1178       'index'       => [ [ 'countrycode' ], [ 'regionnum' ] ],
1179     },
1180
1181     'reg_code' => {
1182       'columns' => [
1183         'codenum',   'serial',    '', '', '', '',
1184         'code',      'varchar',   '', $char_d, '', '',
1185         'agentnum',  'int',       '', '', '', '',
1186       ],
1187       'primary_key' => 'codenum',
1188       'unique'      => [ [ 'agentnum', 'code' ] ],
1189       'index'       => [ [ 'agentnum' ] ],
1190     },
1191
1192     'reg_code_pkg' => {
1193       'columns' => [
1194         'codepkgnum', 'serial', '', '', '', '',
1195         'codenum',   'int',    '', '', '', '',
1196         'pkgpart',   'int',    '', '', '', '',
1197       ],
1198       'primary_key' => 'codepkgnum',
1199       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
1200       'index'       => [ [ 'codenum' ] ],
1201     },
1202
1203     'clientapi_session' => {
1204       'columns' => [
1205         'sessionnum',  'serial',  '', '', '', '',
1206         'sessionid',  'varchar',  '', $char_d, '', '',
1207         'namespace',  'varchar',  '', $char_d, '', '',
1208       ],
1209       'primary_key' => 'sessionnum',
1210       'unique'      => [ [ 'sessionid', 'namespace' ] ],
1211       'index'       => [],
1212     },
1213
1214     'clientapi_session_field' => {
1215       'columns' => [
1216         'fieldnum',    'serial',     '', '', '', '',
1217         'sessionnum',     'int',     '', '', '', '',
1218         'fieldname',  'varchar',     '', $char_d, '', '',
1219         'fieldvalue',    'text', 'NULL', '', '', '',
1220       ],
1221       'primary_key' => 'fieldnum',
1222       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
1223       'index'       => [],
1224     },
1225
1226     'payment_gateway' => {
1227       'columns' => [
1228         'gatewaynum',       'serial',   '',     '', '', '',
1229         'gateway_module',   'varchar',  '',     $char_d, '', '',
1230         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
1231         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
1232         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
1233         'disabled',   'char',  'NULL',   1, '', '',
1234       ],
1235       'primary_key' => 'gatewaynum',
1236       'unique' => [],
1237       'index'  => [ [ 'disabled' ] ],
1238     },
1239
1240     'payment_gateway_option' => {
1241       'columns' => [
1242         'optionnum',   'serial',  '',     '', '', '',
1243         'gatewaynum',  'int',     '',     '', '', '',
1244         'optionname',  'varchar', '',     $char_d, '', '',
1245         'optionvalue', 'text',    'NULL', '', '', '',
1246       ],
1247       'primary_key' => 'optionnum',
1248       'unique'      => [],
1249       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1250     },
1251
1252     'agent_payment_gateway' => {
1253       'columns' => [
1254         'agentgatewaynum', 'serial', '', '', '', '',
1255         'agentnum',        'int', '', '', '', '',
1256         'gatewaynum',      'int', '', '', '', '',
1257         'cardtype',        'varchar', 'NULL', $char_d, '', '',
1258         'taxclass',        'varchar', 'NULL', $char_d, '', '',
1259       ],
1260       'primary_key' => 'agentgatewaynum',
1261       'unique'      => [],
1262       'index'       => [ [ 'agentnum', 'cardtype' ], ],
1263     },
1264
1265     'banned_pay' => {
1266       'columns' => [
1267         'bannum',  'serial',   '',     '', '', '',
1268         'payby',   'char',     '',       4, '', '',
1269         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
1270         #'paymask', 'varchar',  'NULL', $char_d, '', ''
1271         '_date',   @date_type, '', '',
1272         'otaker',  'varchar',  '',     32, '', '',
1273         'reason',  'varchar',  'NULL', $char_d, '', '',
1274       ],
1275       'primary_key' => 'bannum',
1276       'unique'      => [ [ 'payby', 'payinfo' ] ],
1277       'index'       => [],
1278     },
1279
1280     'cancel_reason' => {
1281       'columns' => [
1282         'reasonnum', 'serial',  '',     '', '', '',
1283         'reason',    'varchar', '',     $char_d, '', '',
1284         'disabled',  'char',    'NULL', 1, '', '',
1285       ],
1286       'primary_key' => 'reasonnum',
1287       'unique' => [],
1288       'index'  => [ [ 'disabled' ] ],
1289     },
1290
1291     'pkg_class' => {
1292       'columns' => [
1293         'classnum',   'serial',  '', '', '', '',
1294         'classname',  'varchar', '', $char_d, '', '',
1295       ],
1296       'primary_key' => 'classnum',
1297       'unique' => [],
1298       'index' => [],
1299     },
1300
1301     'cdr' => {
1302       'columns' => [
1303         # qw( name type null length default local );
1304
1305         ###
1306         #asterisk fields
1307         ###
1308
1309         'acctid',   'bigserial',  '', '', '', '',
1310         'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1311         'clid',        'varchar',  '', $char_d, \"''", '',
1312         'src',         'varchar',  '', $char_d, \"''", '',
1313         'dst',         'varchar',  '', $char_d, \"''", '',
1314         'dcontext',    'varchar',  '', $char_d, \"''", '',
1315         'channel',     'varchar',  '', $char_d, \"''", '',
1316         'dstchannel',  'varchar',  '', $char_d, \"''", '',
1317         'lastapp',     'varchar',  '', $char_d, \"''", '',
1318         'lastdata',    'varchar',  '', $char_d, \"''", '',
1319
1320         #these don't seem to be logged by most of the SQL cdr_* modules
1321         #except tds under sql-illegal names, so;
1322         # ... don't rely on them for rating?
1323         # and, what they hey, i went ahead and changed the names and data types
1324         # to freeside-style dates...
1325           #'start',  'timestamp', 'NULL',  '',    '', '',
1326           #'answer', 'timestamp', 'NULL',  '',    '', '',
1327           #'end',    'timestamp', 'NULL',  '',    '', '',
1328         'startdate',  @date_type, '', '',
1329         'answerdate', @date_type, '', '',
1330         'enddate',    @date_type, '', '',
1331         #
1332
1333         'duration',    'int',      '',      '',     0, '',
1334         'billsec',     'int',      '',      '',     0, '',
1335         'disposition', 'varchar',  '',      45, \"''", '',
1336         'amaflags',    'int',      '',      '',     0, '',
1337         'accountcode', 'varchar',  '',      20, \"''", '',
1338         'uniqueid',    'varchar',  '',      32, \"''", '',
1339         'userfield',   'varchar',  '',     255, \"''", '',
1340
1341         ###
1342         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1343         # defaults
1344         ###
1345
1346         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1347         'cdrtypenum',              'int', 'NULL',      '', '', '',
1348
1349         'charged_party',       'varchar', 'NULL', $char_d, '', '',
1350
1351         'upstream_currency',      'char', 'NULL',       3, '', '',
1352         'upstream_price',      'decimal', 'NULL',  '10,2', '', '',
1353         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
1354
1355         'distance',            'decimal', 'NULL',      '', '', '',
1356         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
1357
1358         #cdr_calltype: the big list in appendix 2
1359         'calltypenum',             'int', 'NULL',      '', '', '',
1360
1361         'description',         'varchar', 'NULL', $char_d, '', '',
1362         'quantity',                'int', 'NULL',      '', '', '',
1363
1364         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
1365         'carrierid',               'int', 'NULL',      '', '', '',
1366
1367         'upstream_rateid',         'int', 'NULL',      '', '', '',
1368
1369         ###
1370         #and now for our own fields
1371         ###
1372
1373         # a svcnum... right..?
1374         'svcnum',             'int',   'NULL',     '',   '', '',
1375
1376         #NULL, done, skipped, pushed_downstream (or something)
1377         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
1378
1379       ],
1380       'primary_key' => 'acctid',
1381       'unique' => [],
1382       'index' => [ [ 'calldate' ], [ 'dst' ], [ 'accountcode' ], [ 'freesidestatus' ] ],
1383     },
1384
1385     'cdr_calltype' => {
1386       'columns' => [
1387         'calltypenum',   'serial',  '', '', '', '',
1388         'calltypename',  'varchar', '', $char_d, '', '',
1389       ],
1390       'primary_key' => 'calltypenum',
1391       'unique'      => [],
1392       'index'       => [],
1393     },
1394
1395     'cdr_type' => {
1396       'columns' => [
1397         'cdrtypenum'  => 'serial',  '', '', '', '',
1398         'cdrtypename' => 'varchar', '', '', '', '',
1399       ],
1400       'primary_key' => 'cdrtypenum',
1401       'unique'      => [],
1402       'index'       => [],
1403     },
1404
1405     'cdr_carrier' => {
1406       'columns' => [
1407         'carrierid'   => 'serial',  '', '', '', '',
1408         'carriername' => 'varchar', '', '', '', '',
1409       ],
1410       'primary_key' => 'carrierid',
1411       'unique'      => [],
1412       'index'       => [],
1413     },
1414
1415
1416   };
1417
1418 }
1419
1420 =back
1421
1422 =head1 BUGS
1423
1424 =head1 SEE ALSO
1425
1426 L<DBIx::DBSchema>
1427
1428 =cut
1429
1430 1;
1431