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