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