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