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