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.33;
   7 use DBIx::DBSchema::Table;
   8 use DBIx::DBSchema::Column 0.06;
   9 use DBIx::DBSchema::Index;
  10
  11 @ISA = qw(Exporter);
  12 @EXPORT_OK = qw( dbdef dbdef_dist reload_dbdef );
  13
  14 $DEBUG = 0;
  15 $me = '[FS::Schema]';
  16
  17 =head1 NAME
  18
  19 FS::Schema - Freeside database schema
  20
  21 =head1 SYNOPSYS
  22
  23     use FS::Schema qw(dbdef dbdef_dist reload_dbdef);
  24
  25     $dbdef = reload_dbdef;
  26     $dbdef = reload_dbdef "/non/standard/filename";
  27     $dbdef = dbdef;
  28     $dbdef_dist = dbdef_dist;
  29
  30 =head1 DESCRIPTION
  31
  32 This class represents the database schema.
  33
  34 =head1 METHODS
  35
  36 =over 4
  37
  38 =item reload_dbdef([FILENAME])
  39
  40 Load a database definition (see L<DBIx::DBSchema>), optionally from a
  41 non-default filename.  This command is executed at startup unless
  42 I<$FS::Schema::setup_hack> is true.  Returns a DBIx::DBSchema object.
  43
  44 =cut
  45
  46 sub reload_dbdef {
  47   my $file = shift;
  48
  49   unless ( exists $dbdef_cache{$file} ) {
  50     warn "[debug]$me loading dbdef for $file\n" if $DEBUG;
  51     $dbdef_cache{$file} = DBIx::DBSchema->load( $file )
  52       or die "can't load database schema from $file: $DBIx::DBSchema::errstr\n";
  53   } else {
  54     warn "[debug]$me re-using cached dbdef for $file\n" if $DEBUG;
  55   }
  56   $dbdef = $dbdef_cache{$file};
  57 }
  58
  59 =item dbdef
  60
  61 Returns the current database definition (represents the current database,
  62 assuming it is up-to-date).  See L<DBIx::DBSchema>.
  63
  64 =cut
  65
  66 sub dbdef { $dbdef; }
  67
  68 =item dbdef_dist [ DATASRC ]
  69
  70 Returns the current canoical database definition as defined in this file.
  71
  72 Optionally, pass a DBI data source to enable syntax specific to that database.
  73 Currently, this enables "TYPE=InnoDB" for MySQL databases.
  74
  75 =cut
  76
  77 sub dbdef_dist {
  78   my $datasrc = @_ ? shift : '';
  79
  80   my $local_options = '';
  81   if ( $datasrc =~ /^dbi:mysql/i ) {
  82     $local_options = 'TYPE=InnoDB';
  83   }
  84
  85   ###
  86   # create a dbdef object from the old data structure
  87   ###
  88
  89   my $tables_hashref = tables_hashref();
  90
  91   #turn it into objects
  92   my $dbdef = new DBIx::DBSchema map {
  93
  94     my $tablename = $_;
  95     my $indexnum = 1;
  96
  97     my @columns;
  98     while (@{$tables_hashref->{$tablename}{'columns'}}) {
  99       #my($name, $type, $null, $length, $default, $local) =
 100       my @coldef =
 101         splice @{$tables_hashref->{$tablename}{'columns'}}, 0, 6;
 102       my %hash = map { $_ => shift @coldef }
 103                      qw( name type null length default local );
 104
 105       #can be removed once we depend on DBIx::DBSchema 0.39;
 106       $hash{'type'} = 'LONGTEXT'
 107         if $hash{'type'} =~ /^TEXT$/i && $datasrc =~ /^dbi:mysql/i;
 108
 109       unless ( defined $hash{'default'} ) {
 110         warn "$tablename:\n".
 111              join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
 112       }
 113
 114       push @columns, new DBIx::DBSchema::Column ( \%hash );
 115     }
 116
 117     #false laziness w/sub indices in DBIx::DBSchema::DBD (well, sorta)
 118     #and sub sql_create_table in DBIx::DBSchema::Table (slighty more?)
 119     my $unique = $tables_hashref->{$tablename}{'unique'};
 120     my @index  = @{ $tables_hashref->{$tablename}{'index'} };
 121
 122     # kludge to avoid avoid "BLOB/TEXT column 'statustext' used in key
 123     #  specification without a key length".
 124     # better solution: teach DBIx::DBSchema to specify a default length for
 125     #  MySQL indices on text columns, or just to support an index length at all
 126     #  so we can pass something in.
 127     # best solution: eliminate need for this index in cust_main::retry_realtime
 128     @index = grep { @{$_}[0] ne 'statustext' } @index
 129       if $datasrc =~ /^dbi:mysql/i;
 130
 131     my @indices = ();
 132     push @indices, map {
 133                          DBIx::DBSchema::Index->new({
 134                            'name'    => $tablename. $indexnum++,
 135                            'unique'  => 1,
 136                            'columns' => $_,
 137                          });
 138                        }
 139                        @$unique;
 140     push @indices, map {
 141                          DBIx::DBSchema::Index->new({
 142                            'name'    => $tablename. $indexnum++,
 143                            'unique'  => 0,
 144                            'columns' => $_,
 145                          });
 146                        }
 147                        @index;
 148
 149     DBIx::DBSchema::Table->new({
 150       'name'          => $tablename,
 151       'primary_key'   => $tables_hashref->{$tablename}{'primary_key'},
 152       'columns'       => \@columns,
 153       'indices'       => \@indices,
 154       'local_options' => $local_options,
 155     });
 156
 157   } keys %$tables_hashref;
 158
 159   if ( $DEBUG ) {
 160     warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
 161     warn "[debug]$me   $_\n" foreach $dbdef->tables;
 162   }
 163
 164   #add radius attributes to svc_acct
 165   #
 166   #my($svc_acct)=$dbdef->table('svc_acct');
 167   #
 168   #my($attribute);
 169   #foreach $attribute (@attributes) {
 170   #  $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
 171   #    'radius_'. $attribute,
 172   #    'varchar',
 173   #    'NULL',
 174   #    $char_d,
 175   #  ));
 176   #}
 177   #
 178   #foreach $attribute (@check_attributes) {
 179   #  $svc_acct->addcolumn( new DBIx::DBSchema::Column (
 180   #    'rc_'. $attribute,
 181   #    'varchar',
 182   #    'NULL',
 183   #    $char_d,
 184   #  ));
 185   #}
 186
 187   #create history tables (false laziness w/create-history-tables)
 188   foreach my $table (
 189     grep { ! /^clientapi_session/ }
 190     grep { ! /^h_/ }
 191     $dbdef->tables
 192   ) {
 193     my $tableobj = $dbdef->table($table)
 194       or die "unknown table $table";
 195
 196     my %indices = $tableobj->indices;
 197
 198     my %h_indices = map {
 199                           ( "h_$_" =>
 200                               DBIx::DBSchema::Index->new({
 201                                 'name'    => 'h_'. $indices{$_}->name,
 202                                 'unique'  => 0,
 203                                 'columns' => [ @{$indices{$_}->columns} ],
 204                               })
 205                           );
 206                         }
 207                         keys %indices;
 208
 209     $h_indices{"h_${table}_srckey"} = DBIx::DBSchema::Index->new({
 210                                         'name'    => "h_${table}_srckey",
 211                                         'unique'  => 0,
 212                                         'columns' => [ 'history_action', #right?
 213                                                        $tableobj->primary_key,
 214                                                      ],
 215                                       });
 216
 217     $h_indices{"h_${table}_srckey2"} = DBIx::DBSchema::Index->new({
 218                                          'name'    => "h_${table}_srckey2",
 219                                          'unique'  => 0,
 220                                          'columns' => [ 'history_date',
 221                                                         $tableobj->primary_key,
 222                                                       ],
 223                                        });
 224
 225     my $h_tableobj = DBIx::DBSchema::Table->new( {
 226       'name'          => "h_$table",
 227       'primary_key'   => 'historynum',
 228       'indices'       => \%h_indices,
 229       'local_options' => $local_options,
 230       'columns'       => [
 231           DBIx::DBSchema::Column->new( {
 232             'name'    => 'historynum',
 233             'type'    => 'serial',
 234             'null'    => 'NOT NULL',
 235             'length'  => '',
 236             'default' => '',
 237             'local'   => '',
 238           } ),
 239           DBIx::DBSchema::Column->new( {
 240             'name'    => 'history_date',
 241             'type'    => 'int',
 242             'null'    => 'NULL',
 243             'length'  => '',
 244             'default' => '',
 245             'local'   => '',
 246           } ),
 247           DBIx::DBSchema::Column->new( {
 248             'name'    => 'history_user',
 249             'type'    => 'varchar',
 250             'null'    => 'NOT NULL',
 251             'length'  => '80',
 252             'default' => '',
 253             'local'   => '',
 254           } ),
 255           DBIx::DBSchema::Column->new( {
 256             'name'    => 'history_action',
 257             'type'    => 'varchar',
 258             'null'    => 'NOT NULL',
 259             'length'  => '80',
 260             'default' => '',
 261             'local'   => '',
 262           } ),
 263           map {
 264             my $column = $tableobj->column($_);
 265
 266             #clone so as to not disturb the original
 267             $column = DBIx::DBSchema::Column->new( {
 268               map { $_ => $column->$_() }
 269                 qw( name type null length default local )
 270             } );
 271
 272             if ( $column->type =~ /^(\w*)SERIAL$/i ) {
 273               $column->type(uc($1).'INT');
 274               $column->null('NULL');
 275             }
 276             #$column->default('')
 277             #  if $column->default =~ /^nextval\(/i;
 278             #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
 279             #$column->local($local);
 280             $column;
 281           } $tableobj->columns
 282       ],
 283     } );
 284     $dbdef->addtable($h_tableobj);
 285   }
 286
 287   if ( $datasrc =~ /^dbi:mysql/i ) {
 288
 289     my $dup_lock_table = DBIx::DBSchema::Table->new( {
 290       'name'          => 'duplicate_lock',
 291       'primary_key'   => 'duplocknum',
 292       'local_options' => $local_options,
 293       'columns'       => [
 294         DBIx::DBSchema::Column->new( {
 295           'name'    => 'duplocknum',
 296           'type'    => 'serial',
 297           'null'    => 'NOT NULL',
 298           'length'  => '',
 299           'default' => '',
 300           'local'   => '',
 301         } ),
 302         DBIx::DBSchema::Column->new( {
 303           'name'    => 'lockname',
 304           'type'    => 'varchar',
 305           'null'    => 'NOT NULL',
 306           'length'  => '80',
 307           'default' => '',
 308           'local'   => '',
 309         } ),
 310       ],
 311       'indices' => { 'duplicate_lock1' =>
 312                        DBIx::DBSchema::Index->new({
 313                          'name'    => 'duplicate_lock1',
 314                          'unique'  => 1,
 315                          'columns' => [ 'lockname' ],
 316                        })
 317                    },
 318     } );
 319
 320     $dbdef->addtable($dup_lock_table);
 321
 322   }
 323
 324   $dbdef;
 325
 326 }
 327
 328 sub tables_hashref {
 329
 330   my $char_d = 80; #default maxlength for text fields
 331
 332   #my(@date_type)  = ( 'timestamp', '', ''     );
 333   my @date_type  = ( 'int', 'NULL', ''     );
 334   my @perl_type = ( 'text', 'NULL', ''  );
 335   my @money_type = ( 'decimal',   '', '10,2' );
 336   my @money_typen = ( 'decimal',   'NULL', '10,2' );
 337   my @taxrate_type  = ( 'decimal',   '',     '14,8' ); # requires pg 8 for
 338   my @taxrate_typen = ( 'decimal',   'NULL', '14,8' ); # fs-upgrade to work
 339
 340   my $username_len = 32; #usernamemax config file
 341
 342     # name type nullability length default local
 343
 344   return {
 345
 346     'agent' => {
 347       'columns' => [
 348         'agentnum',          'serial',    '',       '', '', '',
 349         'agent',            'varchar',    '',  $char_d, '', '',
 350         'typenum',              'int',    '',       '', '', '',
 351         'ticketing_queueid',    'int', 'NULL',      '', '', '',
 352         'invoice_template', 'varchar', 'NULL', $char_d, '', '',
 353         'agent_custnum',        'int', 'NULL',      '', '', '',
 354         'disabled',            'char', 'NULL',       1, '', '',
 355         'username',         'varchar', 'NULL', $char_d, '', '', #deprecated
 356         '_password',        'varchar', 'NULL', $char_d, '', '', #deprecated
 357         'freq',              'int', 'NULL', '', '', '', #deprecated (never used)
 358         'prog',                     @perl_type, '', '', #deprecated (never used)
 359       ],
 360       'primary_key' => 'agentnum',
 361       #'unique' => [ [ 'agent_custnum' ] ], #one agent per customer?
 362                                             #insert is giving it a value, tho..
 363       #'index' => [ ['typenum'], ['disabled'] ],
 364       'unique' => [],
 365       'index' => [ ['typenum'], ['disabled'], ['agent_custnum'] ],
 366     },
 367
 368     'agent_type' => {
 369       'columns' => [
 370         'typenum',   'serial',  '', '', '', '',
 371         'atype',     'varchar', '', $char_d, '', '',
 372       ],
 373       'primary_key' => 'typenum',
 374       'unique' => [],
 375       'index' => [],
 376     },
 377
 378     'type_pkgs' => {
 379       'columns' => [
 380         'typepkgnum', 'serial', '', '', '', '',
 381         'typenum',   'int',  '', '', '', '',
 382         'pkgpart',   'int',  '', '', '', '',
 383       ],
 384       'primary_key' => 'typepkgnum',
 385       'unique' => [ ['typenum', 'pkgpart'] ],
 386       'index' => [ ['typenum'] ],
 387     },
 388
 389     'cust_attachment' => {
 390       'columns' => [
 391         'attachnum', 'serial', '', '', '', '',
 392         'custnum',   'int', '', '', '', '',
 393         '_date',     @date_type, '', '',
 394         'otaker',    'varchar', '', 32, '', '',
 395         'filename',  'varchar', '', 255, '', '',
 396         'mime_type', 'varchar', '', $char_d, '', '',
 397         'title',     'varchar', 'NULL', $char_d, '', '',
 398         'body',      'blob', 'NULL', '', '', '',
 399         'disabled',  @date_type, '', '',
 400       ],
 401       'primary_key' => 'attachnum',
 402       'unique'      => [],
 403       'index'       => [ ['custnum'] ],
 404     },
 405
 406     'cust_bill' => {
 407       'columns' => [
 408         #regular fields
 409         'invnum',    'serial',     '', '', '', '',
 410         'custnum',      'int',     '', '', '', '',
 411         '_date',        @date_type,        '', '',
 412         'charged',      @money_type,       '', '',
 413         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 414
 415         #customer balance info at invoice generation time
 416         'previous_balance',   @money_typen, '', '',  #eventually not nullable
 417         'billing_balance',    @money_typen, '', '',  #eventually not nullable
 418
 419         #deprecated (unused by now, right?)
 420         'printed',      'int',     '', '', '', '',
 421
 422         #specific use cases
 423         'closed',      'char', 'NULL',  1, '', '',
 424         'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
 425       ],
 426       'primary_key' => 'invnum',
 427       'unique' => [],
 428       'index' => [ ['custnum'], ['_date'], ['statementnum'], ],
 429     },
 430
 431     'cust_statement' => {
 432       'columns' => [
 433         'statementnum', 'serial', '', '', '', '',
 434         'custnum',         'int', '', '', '', '',
 435         '_date',           @date_type,    '', '',
 436       ],
 437       'primary_key' => 'statementnum',
 438       'unique' => [],
 439       'index' => [ ['custnum'], ['_date'], ],
 440     },
 441
 442     'cust_bill_event' => {
 443       'columns' => [
 444         'eventnum',    'serial',  '', '', '', '',
 445         'invnum',   'int',  '', '', '', '',
 446         'eventpart',   'int',  '', '', '', '',
 447         '_date',     @date_type, '', '',
 448         'status', 'varchar', '', $char_d, '', '',
 449         'statustext', 'text', 'NULL', '', '', '',
 450       ],
 451       'primary_key' => 'eventnum',
 452       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 453       'unique' => [],
 454       'index' => [ ['invnum'], ['status'], ['eventpart'],
 455                    ['statustext'], ['_date'],
 456                  ],
 457     },
 458
 459     'part_bill_event' => {
 460       'columns' => [
 461         'eventpart',    'serial',  '', '', '', '',
 462         'freq',        'varchar',       'NULL',     $char_d, '', '',
 463         'payby',       'char',  '', 4, '', '',
 464         'event',       'varchar',           '',     $char_d, '', '',
 465         'eventcode',    @perl_type, '', '',
 466         'seconds',     'int', 'NULL', '', '', '',
 467         'weight',      'int', '', '', '', '',
 468         'plan',       'varchar', 'NULL', $char_d, '', '',
 469         'plandata',   'text', 'NULL', '', '', '',
 470         'reason',     'int', 'NULL', '', '', '',
 471         'disabled',     'char', 'NULL', 1, '', '',
 472       ],
 473       'primary_key' => 'eventpart',
 474       'unique' => [],
 475       'index' => [ ['payby'], ['disabled'], ],
 476     },
 477
 478     'part_event' => {
 479       'columns' => [
 480         'eventpart',   'serial',      '',      '', '', '',
 481         'agentnum',    'int',     'NULL',      '', '', '',
 482         'event',       'varchar',     '', $char_d, '', '',
 483         'eventtable',  'varchar',     '', $char_d, '', '',
 484         'check_freq',  'varchar', 'NULL', $char_d, '', '',
 485         'weight',      'int',         '',      '', '', '',
 486         'action',      'varchar',     '', $char_d, '', '',
 487         'disabled',     'char',   'NULL',       1, '', '',
 488       ],
 489       'primary_key' => 'eventpart',
 490       'unique' => [],
 491       'index' => [ ['agentnum'], ['eventtable'], ['check_freq'], ['disabled'], ],
 492     },
 493
 494     'part_event_option' => {
 495       'columns' => [
 496         'optionnum', 'serial', '', '', '', '',
 497         'eventpart', 'int', '', '', '', '',
 498         'optionname', 'varchar', '', $char_d, '', '',
 499         'optionvalue', 'text', 'NULL', '', '', '',
 500       ],
 501       'primary_key' => 'optionnum',
 502       'unique'      => [],
 503       'index'       => [ [ 'eventpart' ], [ 'optionname' ] ],
 504     },
 505
 506     'part_event_condition' => {
 507       'columns' => [
 508         'eventconditionnum', 'serial', '', '', '', '',
 509         'eventpart', 'int', '', '', '', '',
 510         'conditionname', 'varchar', '', $char_d, '', '',
 511       ],
 512       'primary_key' => 'eventconditionnum',
 513       'unique'      => [],
 514       'index'       => [ [ 'eventpart' ], [ 'conditionname' ] ],
 515     },
 516
 517     'part_event_condition_option' => {
 518       'columns' => [
 519         'optionnum', 'serial', '', '', '', '',
 520         'eventconditionnum', 'int', '', '', '', '',
 521         'optionname', 'varchar', '', $char_d, '', '',
 522         'optionvalue', 'text', 'NULL', '', '', '',
 523       ],
 524       'primary_key' => 'optionnum',
 525       'unique'      => [],
 526       'index'       => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
 527     },
 528
 529     'part_event_condition_option_option' => {
 530       'columns' => [
 531         'optionoptionnum', 'serial', '', '', '', '',
 532         'optionnum', 'int', '', '', '', '',
 533         'optionname', 'varchar', '', $char_d, '', '',
 534         'optionvalue', 'text', 'NULL', '', '', '',
 535       ],
 536       'primary_key' => 'optionoptionnum',
 537       'unique'      => [],
 538       'index'       => [ [ 'optionnum' ], [ 'optionname' ] ],
 539     },
 540
 541     'cust_event' => {
 542       'columns' => [
 543         'eventnum',    'serial',  '', '', '', '',
 544         'eventpart',   'int',  '', '', '', '',
 545         'tablenum',   'int',  '', '', '', '',
 546         '_date',     @date_type, '', '',
 547         'status', 'varchar', '', $char_d, '', '',
 548         'statustext', 'text', 'NULL', '', '', '',
 549       ],
 550       'primary_key' => 'eventnum',
 551       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 552       'unique' => [],
 553       'index' => [ ['eventpart'], ['tablenum'], ['status'],
 554                    ['statustext'], ['_date'],
 555                  ],
 556     },
 557
 558     'cust_bill_pkg' => {
 559       'columns' => [
 560         'billpkgnum',        'serial',     '',      '', '', '',
 561         'invnum',               'int',     '',      '', '', '',
 562         'pkgnum',               'int',     '',      '', '', '',
 563         'pkgpart_override',     'int', 'NULL',      '', '', '',
 564         'setup',               @money_type,             '', '',
 565         'recur',               @money_type,             '', '',
 566         'sdate',               @date_type,              '', '',
 567         'edate',               @date_type,              '', '',
 568         'itemdesc',         'varchar', 'NULL', $char_d, '', '',
 569         'itemcomment',      'varchar', 'NULL', $char_d, '', '',
 570         'section',          'varchar', 'NULL', $char_d, '', '',
 571         'quantity',             'int', 'NULL',      '', '', '',
 572         'unitsetup',           @money_typen,            '', '',
 573         'unitrecur',           @money_typen,            '', '',
 574         'hidden',              'char', 'NULL',       1, '', '',
 575       ],
 576       'primary_key' => 'billpkgnum',
 577       'unique' => [],
 578       'index' => [ ['invnum'], [ 'pkgnum' ], [ 'itemdesc' ], ],
 579     },
 580
 581     'cust_bill_pkg_detail' => {
 582       'columns' => [
 583         'detailnum', 'serial', '', '', '', '',
 584         'billpkgnum', 'int', 'NULL', '', '', '',        # should not be nullable
 585         'pkgnum',  'int', 'NULL', '', '', '',           # deprecated
 586         'invnum',  'int', 'NULL', '', '', '',           # deprecated
 587         'amount',  'decimal', 'NULL', '10,4', '', '',
 588         'format',  'char', 'NULL', 1, '', '',
 589         'classnum', 'int', 'NULL', '', '', '',
 590         'duration', 'int', 'NULL', '',  0, '',
 591         'phonenum', 'varchar', 'NULL', 15, '', '',
 592         'regionname', 'varchar', 'NULL', $char_d, '', '',
 593         'detail',  'varchar', '', 255, '', '',
 594       ],
 595       'primary_key' => 'detailnum',
 596       'unique' => [],
 597       'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
 598     },
 599
 600     'cust_bill_pkg_display' => {
 601       'columns' => [
 602         'billpkgdisplaynum', 'serial', '', '', '', '',
 603         'billpkgnum', 'int', '', '', '', '',
 604         'section',  'varchar', 'NULL', $char_d, '', '',
 605         #'unitsetup', @money_typen, '', '',     #override the linked real one?
 606         #'unitrecur', @money_typen, '', '',     #this too?
 607         'post_total', 'char', 'NULL', 1, '', '',
 608         'type',       'char', 'NULL', 1, '', '',
 609         'summary',    'char', 'NULL', 1, '', '',
 610       ],
 611       'primary_key' => 'billpkgdisplaynum',
 612       'unique' => [],
 613       'index' => [ ['billpkgnum'], ],
 614     },
 615
 616     'cust_bill_pkg_tax_location' => {
 617       'columns' => [
 618         'billpkgtaxlocationnum', 'serial',      '', '', '', '',
 619         'billpkgnum',               'int',      '', '', '', '',
 620         'taxnum',                   'int',      '', '', '', '',
 621         'taxtype',              'varchar',      '', $char_d, '', '',
 622         'pkgnum',                   'int',      '', '', '', '',
 623         'locationnum',              'int',      '', '', '', '', #redundant?
 624         'amount',                   @money_type,        '', '',
 625       ],
 626       'primary_key' => 'billpkgtaxlocationnum',
 627       'unique' => [],
 628       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'pkgnum' ], [ 'locationnum' ] ],
 629     },
 630
 631     'cust_bill_pkg_tax_rate_location' => {
 632       'columns' => [
 633         'billpkgtaxratelocationnum', 'serial',      '', '', '', '',
 634         'billpkgnum',                   'int',      '', '', '', '',
 635         'taxnum',                       'int',      '', '', '', '',
 636         'taxtype',                  'varchar',      '', $char_d, '', '',
 637         'locationtaxid',            'varchar',  'NULL', $char_d, '', '',
 638         'taxratelocationnum',           'int',      '', '', '', '',
 639         'amount',                       @money_type,        '', '',
 640       ],
 641       'primary_key' => 'billpkgtaxratelocationnum',
 642       'unique' => [],
 643       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'taxratelocationnum' ] ],
 644     },
 645
 646     'cust_credit' => {
 647       'columns' => [
 648         'crednum',  'serial', '', '', '', '',
 649         'custnum',  'int', '', '', '', '',
 650         '_date',    @date_type, '', '',
 651         'amount',   @money_type, '', '',
 652         'otaker',   'varchar', '', 32, '', '',
 653         'reason',   'text', 'NULL', '', '', '',
 654         'reasonnum', 'int', 'NULL', '', '', '',
 655         'addlinfo', 'text', 'NULL', '', '', '',
 656         'closed',    'char', 'NULL', 1, '', '',
 657         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
 658         'eventnum', 'int', 'NULL', '', '', '', #triggering event for commission
 659       ],
 660       'primary_key' => 'crednum',
 661       'unique' => [],
 662       'index' => [ ['custnum'], ['_date'], ['eventnum'] ],
 663     },
 664
 665     'cust_credit_bill' => {
 666       'columns' => [
 667         'creditbillnum', 'serial', '', '', '', '',
 668         'crednum',  'int', '', '', '', '',
 669         'invnum',  'int', '', '', '', '',
 670         '_date',    @date_type, '', '',
 671         'amount',   @money_type, '', '',
 672         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
 673       ],
 674       'primary_key' => 'creditbillnum',
 675       'unique' => [],
 676       'index' => [ ['crednum'], ['invnum'] ],
 677     },
 678
 679     'cust_credit_bill_pkg' => {
 680       'columns' => [
 681         'creditbillpkgnum', 'serial', '',      '', '', '',
 682         'creditbillnum',       'int', '',      '', '', '',
 683         'billpkgnum',          'int', '',      '', '', '',
 684         'amount',            @money_type,          '', '',
 685         'setuprecur',      'varchar', '', $char_d, '', '',
 686         'sdate',   @date_type, '', '',
 687         'edate',   @date_type, '', '',
 688       ],
 689       'primary_key' => 'creditbillpkgnum',
 690       'unique'      => [],
 691       'index'       => [ [ 'creditbillnum' ], [ 'billpkgnum' ], ],
 692     },
 693
 694     'cust_main' => {
 695       'columns' => [
 696         'custnum',  'serial',  '',     '', '', '',
 697         'agentnum', 'int',  '',     '', '', '',
 698         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
 699         'custbatch', 'varchar', 'NULL', $char_d, '', '',
 700 #        'titlenum', 'int',  'NULL',   '', '', '',
 701         'last',     'varchar', '',     $char_d, '', '',
 702 #        'middle',   'varchar', 'NULL', $char_d, '', '',
 703         'first',    'varchar', '',     $char_d, '', '',
 704         'ss',       'varchar', 'NULL', 11, '', '',
 705         'stateid', 'varchar', 'NULL', $char_d, '', '',
 706         'stateid_state', 'varchar', 'NULL', $char_d, '', '',
 707         'birthdate' ,@date_type, '', '',
 708         'signupdate',@date_type, '', '',
 709         'dundate',   @date_type, '', '',
 710         'company',  'varchar', 'NULL', $char_d, '', '',
 711         'address1', 'varchar', '',     $char_d, '', '',
 712         'address2', 'varchar', 'NULL', $char_d, '', '',
 713         'city',     'varchar', '',     $char_d, '', '',
 714         'county',   'varchar', 'NULL', $char_d, '', '',
 715         'state',    'varchar', 'NULL', $char_d, '', '',
 716         'zip',      'varchar', 'NULL', 10, '', '',
 717         'country',  'char', '',     2, '', '',
 718         'daytime',  'varchar', 'NULL', 20, '', '',
 719         'night',    'varchar', 'NULL', 20, '', '',
 720         'fax',      'varchar', 'NULL', 12, '', '',
 721         'ship_last',     'varchar', 'NULL', $char_d, '', '',
 722 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '',
 723         'ship_first',    'varchar', 'NULL', $char_d, '', '',
 724         'ship_company',  'varchar', 'NULL', $char_d, '', '',
 725         'ship_address1', 'varchar', 'NULL', $char_d, '', '',
 726         'ship_address2', 'varchar', 'NULL', $char_d, '', '',
 727         'ship_city',     'varchar', 'NULL', $char_d, '', '',
 728         'ship_county',   'varchar', 'NULL', $char_d, '', '',
 729         'ship_state',    'varchar', 'NULL', $char_d, '', '',
 730         'ship_zip',      'varchar', 'NULL', 10, '', '',
 731         'ship_country',  'char', 'NULL', 2, '', '',
 732         'ship_daytime',  'varchar', 'NULL', 20, '', '',
 733         'ship_night',    'varchar', 'NULL', 20, '', '',
 734         'ship_fax',      'varchar', 'NULL', 12, '', '',
 735         'payby',    'char', '',     4, '', '',
 736         'payinfo',  'varchar', 'NULL', 512, '', '',
 737         'paycvv',   'varchar', 'NULL', 512, '', '',
 738         'paymask', 'varchar', 'NULL', $char_d, '', '',
 739         #'paydate',  @date_type, '', '',
 740         'paydate',  'varchar', 'NULL', 10, '', '',
 741         'paystart_month', 'int', 'NULL', '', '', '',
 742         'paystart_year',  'int', 'NULL', '', '', '',
 743         'payissue', 'varchar', 'NULL', 2, '', '',
 744         'payname',  'varchar', 'NULL', $char_d, '', '',
 745         'paystate', 'varchar', 'NULL', $char_d, '', '',
 746         'paytype',  'varchar', 'NULL', $char_d, '', '',
 747         'payip',    'varchar', 'NULL', 15, '', '',
 748         'geocode',  'varchar', 'NULL', 20,  '', '',
 749         'censustract', 'varchar', 'NULL', 20,  '', '', # 7 to save space?
 750         'tax',      'char', 'NULL', 1, '', '',
 751         'otaker',   'varchar', '',    32, '', '',
 752         'refnum',   'int',  '',     '', '', '',
 753         'referral_custnum', 'int',  'NULL', '', '', '',
 754         'comments', 'text', 'NULL', '', '', '',
 755         'spool_cdr','char', 'NULL', 1, '', '',
 756         'squelch_cdr','char', 'NULL', 1, '', '',
 757         'cdr_termination_percentage', 'decimal', 'NULL', '', '', '',
 758         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 759         'archived', 'char', 'NULL', 1, '', '',
 760         'email_csv_cdr', 'char', 'NULL', 1, '', '',
 761       ],
 762       'primary_key' => 'custnum',
 763       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
 764       #'index' => [ ['last'], ['company'] ],
 765       'index' => [
 766                    [ 'agentnum' ], [ 'refnum' ], [ 'custbatch' ],
 767                    [ 'referral_custnum' ],
 768                    [ 'payby' ], [ 'paydate' ],
 769                    [ 'archived' ],
 770                    #billing
 771                    [ 'last' ], [ 'company' ],
 772                    [ 'county' ], [ 'state' ], [ 'country' ],
 773                    [ 'zip' ],
 774                    [ 'daytime' ], [ 'night' ], [ 'fax' ],
 775                    #shipping
 776                    [ 'ship_last' ], [ 'ship_company' ],
 777                    [ 'ship_county' ], [ 'ship_state' ], [ 'ship_country' ],
 778                    [ 'ship_zip' ],
 779                    [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
 780                  ],
 781     },
 782
 783     'cust_recon' => {  # what purpose does this serve?
 784       'columns' => [
 785         'reconid',      'serial',  '',          '', '', '',
 786         'recondate',    @date_type,                 '', '',
 787         'custnum',      'int'   ,  '',          '', '', '',
 788         'agentnum',     'int',     '',          '', '', '',
 789         'last',         'varchar', '',     $char_d, '', '',
 790         'first',        'varchar', '',     $char_d, '', '',
 791         'address1',     'varchar', '',     $char_d, '', '',
 792         'address2',     'varchar', 'NULL', $char_d, '', '',
 793         'city',         'varchar', '',     $char_d, '', '',
 794         'state',        'varchar', 'NULL', $char_d, '', '',
 795         'zip',          'varchar', 'NULL',      10, '', '',
 796         'pkg',          'varchar', 'NULL', $char_d, '', '',
 797         'adjourn',      @date_type,                 '', '',
 798         'status',       'varchar', 'NULL',      10, '', '',
 799         'agent_custid', 'varchar',  '',    $char_d, '', '',
 800         'agent_pkg',    'varchar', 'NULL', $char_d, '', '',
 801         'agent_adjourn', @date_type,                '', '',
 802         'comments',     'text',    'NULL',      '', '', '',
 803       ],
 804       'primary_key' => 'reconid',
 805       'unique' => [],
 806       'index' => [],
 807     },
 808
 809     #eventually use for billing & ship from cust_main too
 810     #for now, just cust_pkg locations
 811     'cust_location' => {
 812       'columns' => [
 813         'locationnum',  'serial',     '',      '', '', '',
 814         'custnum',         'int',     '',      '', '', '',
 815         'address1',    'varchar',     '', $char_d, '', '',
 816         'address2',    'varchar', 'NULL', $char_d, '', '',
 817         'city',        'varchar',     '', $char_d, '', '',
 818         'county',      'varchar', 'NULL', $char_d, '', '',
 819         'state',       'varchar', 'NULL', $char_d, '', '',
 820         'zip',         'varchar', 'NULL',      10, '', '',
 821         'country',        'char',     '',       2, '', '',
 822         'geocode',     'varchar', 'NULL',      20, '', '',
 823       ],
 824       'primary_key' => 'locationnum',
 825       'unique'      => [],
 826       'index'       => [ [ 'custnum' ],
 827                          [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
 828                        ],
 829     },
 830
 831     'cust_main_invoice' => {
 832       'columns' => [
 833         'destnum',  'serial',  '',     '', '', '',
 834         'custnum',  'int',  '',     '', '', '',
 835         'dest',     'varchar', '',  $char_d, '', '',
 836       ],
 837       'primary_key' => 'destnum',
 838       'unique' => [],
 839       'index' => [ ['custnum'], ],
 840     },
 841
 842     'cust_main_note' => {
 843       'columns' => [
 844         'notenum',  'serial',  '',     '', '', '',
 845         'custnum',  'int',  '',     '', '', '',
 846         '_date',    @date_type, '', '',
 847         'otaker',   'varchar', '',    32, '', '',
 848         'comments', 'text', 'NULL', '', '', '',
 849       ],
 850       'primary_key' => 'notenum',
 851       'unique' => [],
 852       'index' => [ [ 'custnum' ], [ '_date' ], ],
 853     },
 854
 855     'cust_main_exemption' => {
 856       'columns' => [
 857         'exemptionnum', 'serial', '',      '', '', '',
 858         'custnum',         'int', '',      '', '', '',
 859         'taxname',     'varchar', '', $char_d, '', '',
 860         #start/end dates?  for reporting?
 861       ],
 862       'primary_key' => 'exemptionnum',
 863       'unique'      => [],
 864       'index'       => [ [ 'custnum' ] ],
 865     },
 866
 867     'cust_tax_adjustment' => {
 868       'columns' => [
 869         'adjustmentnum', 'serial',     '',      '', '', '',
 870         'custnum',          'int',     '',      '', '', '',
 871         'taxname',      'varchar',     '', $char_d, '', '',
 872         'amount',    @money_type,                   '', '',
 873         'comment',     'varchar',  'NULL', $char_d, '', '',
 874         'billpkgnum',       'int', 'NULL',      '', '', '',
 875         #more?  no cust_bill_pkg_tax_location?
 876       ],
 877       'primary_key' => 'adjustmentnum',
 878       'unique'      => [],
 879       'index'       => [ [ 'custnum' ], [ 'billpkgnum' ] ],
 880     },
 881
 882     'cust_main_county' => { #county+state+country are checked off the
 883                             #cust_main_county for validation and to provide
 884                             # a tax rate.
 885       'columns' => [
 886         'taxnum',   'serial',   '',    '', '', '',
 887         'state',    'varchar',  'NULL',    $char_d, '', '',
 888         'county',   'varchar',  'NULL',    $char_d, '', '',
 889         'country',  'char',  '', 2, '', '',
 890         'taxclass',   'varchar', 'NULL', $char_d, '', '',
 891         'exempt_amount', @money_type, '', '',
 892         'tax',      'real',  '',    '', '', '', #tax %
 893         'taxname',  'varchar',  'NULL',    $char_d, '', '',
 894         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
 895         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
 896       ],
 897       'primary_key' => 'taxnum',
 898       'unique' => [],
 899   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
 900       'index' => [ [ 'county' ], [ 'state' ], [ 'country' ],
 901                    [ 'taxclass' ],
 902                  ],
 903     },
 904
 905     'tax_rate'    => {
 906       'columns' => [
 907         'taxnum',       'serial',     '',      '', '', '',
 908         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
 909         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
 910         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
 911         'taxclassnum', 'int',      '',      '', '', '',
 912         'effective_date', @date_type, '', '',
 913         'tax',        @taxrate_type,      '', '',        # tax %
 914         'excessrate', @taxrate_typen,     '', '',        # second tax %
 915         'taxbase',    @money_typen, '', '',              # amount at first tax rate
 916         'taxmax',     @money_typen, '', '',              # maximum about at both rates
 917         'usetax',        @taxrate_typen,     '', '',     # tax % when non-local
 918         'useexcessrate', @taxrate_typen,     '', '',     # second tax % when non-local
 919         'unittype',    'int',  'NULL', '', '', '',      # for fee
 920         'fee',         @taxrate_typen,     '', '',      # amount tax per unit
 921         'excessfee',   @taxrate_typen,     '', '',      # second amount tax per unit
 922         'feebase',     @taxrate_typen,     '', '',      # units taxed at first rate
 923         'feemax',      @taxrate_typen,     '', '',      # maximum number of unit taxed
 924         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
 925         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
 926         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
 927         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
 928         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
 929         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
 930         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
 931         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
 932         'inoutcity',   'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
 933         'inoutlocal',  'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
 934         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
 935         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
 936       ],
 937       'primary_key' => 'taxnum',
 938       'unique' => [],
 939       'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
 940     },
 941
 942     'tax_rate_location' => {
 943       'columns' => [
 944         'taxratelocationnum', 'serial',  '',     '', '', '',
 945         'data_vendor',        'varchar', 'NULL', $char_d, '', '',
 946         'geocode',            'varchar', '',     20,      '', '',
 947         'city',               'varchar', 'NULL', $char_d, '', '',
 948         'county',             'varchar', 'NULL', $char_d, '', '',
 949         'state',              'char',    'NULL',       2, '', '',
 950         'disabled',           'char',    'NULL', 1, '', '',
 951       ],
 952       'primary_key' => 'taxratelocationnum',
 953       'unique' => [],
 954       'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
 955     },
 956
 957     'cust_tag' => {
 958       'columns' => [
 959         'custtagnum', 'serial', '', '', '', '',
 960         'custnum',       'int', '', '', '', '',
 961         'tagnum',        'int', '', '', '', '',
 962       ],
 963       'primary_key' => 'custtagnum',
 964       'unique'      => [ [ 'custnum', 'tagnum' ] ],
 965       'index'       => [ [ 'custnum' ] ],
 966     },
 967
 968     'part_tag' => {
 969       'columns' => [
 970         'tagnum',    'serial',     '',      '', '', '',
 971         'tagname',  'varchar',     '', $char_d, '', '',
 972         'tagdesc',  'varchar', 'NULL', $char_d, '', '',
 973         'tagcolor', 'varchar', 'NULL',       6, '', '',
 974         'disabled',    'char', 'NULL',       1, '', '',
 975       ],
 976       'primary_key' => 'tagnum',
 977       'unique'      => [], #[ [ 'tagname' ] ], #?
 978       'index'       => [ [ 'disabled' ] ],
 979     },
 980
 981     'cust_tax_location' => {
 982       'columns' => [
 983         'custlocationnum', 'serial',  '',     '', '', '',
 984         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
 985         'city',            'varchar', 'NULL', $char_d, '', '',
 986         'postalcity',      'varchar', 'NULL', $char_d, '', '',
 987         'county',          'varchar', 'NULL', $char_d, '', '',
 988         'zip',             'char',    '',     5,  '', '',
 989         'state',           'char',    '',     2,  '', '',
 990         'plus4hi',         'char',    'NULL', 4,  '', '',
 991         'plus4lo',         'char',    'NULL', 4,  '', '',
 992         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
 993         'cityflag',        'char',    'NULL', 1,  '', '', # I(n)/O(out)/B(oth)/NULL
 994         'geocode',         'varchar', '',    20,  '', '',
 995       ],
 996       'primary_key' => 'custlocationnum',
 997       'unique' => [],
 998       'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
 999     },
1000
1001     'tax_class' => {
1002       'columns' => [
1003         'taxclassnum',  'serial',  '',            '', '', '',
1004         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
1005         'taxclass',     'varchar', '',       $char_d, '', '',
1006         'description',  'varchar', '',     2*$char_d, '', '',
1007       ],
1008       'primary_key' => 'taxclassnum',
1009       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
1010       'index' => [],
1011     },
1012
1013     'cust_pay_pending' => {
1014       'columns' => [
1015         'paypendingnum','serial',      '',  '', '', '',
1016         'custnum',      'int',         '',  '', '', '',
1017         'paid',         @money_type,            '', '',
1018         '_date',        @date_type,             '', '',
1019         'payby',        'char',        '',   4, '', '', #CARD/BILL/COMP, should
1020                                                         # be index into payby
1021                                                         # table eventually
1022         'payinfo',      'varchar', 'NULL', 512, '', '', #see cust_main above
1023         'paymask',      'varchar', 'NULL', $char_d, '', '',
1024         'paydate',      'varchar', 'NULL', 10, '', '',
1025         'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
1026         #'paybatch',     'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1027         'payunique',    'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1028
1029         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1030         'status',       'varchar',     '', $char_d, '', '',
1031         'session_id',   'varchar', 'NULL', $char_d, '', '', #only need 32
1032         'statustext',   'text',    'NULL',  '', '', '',
1033         'gatewaynum',   'int',     'NULL',  '', '', '',
1034         #'cust_balance', @money_type,            '', '',
1035         'paynum',       'int',     'NULL',  '', '', '',
1036         'jobnum',       'int',     'NULL',  '', '', '',
1037       ],
1038       'primary_key' => 'paypendingnum',
1039       'unique'      => [ [ 'payunique' ] ],
1040       'index'       => [ [ 'custnum' ], [ 'status' ], ],
1041     },
1042
1043     'cust_pay' => {
1044       'columns' => [
1045         'paynum',   'serial',    '',   '', '', '',
1046         'custnum',  'int',    '',   '', '', '',
1047         '_date',    @date_type, '', '',
1048         'paid',     @money_type, '', '',
1049         'otaker',   'varchar', 'NULL', 32, '', '',  #NULL for the upgrade so we can create & populate the field
1050         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1051                                                  # index into payby table
1052                                                  # eventually
1053         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
1054         'paymask', 'varchar', 'NULL', $char_d, '', '',
1055         'paydate',  'varchar', 'NULL', 10, '', '',
1056         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1057         'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1058         'closed',    'char', 'NULL', 1, '', '',
1059         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1060       ],
1061       'primary_key' => 'paynum',
1062       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
1063       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
1064     },
1065
1066     'cust_pay_void' => {
1067       'columns' => [
1068         'paynum',    'int',    '',   '', '', '',
1069         'custnum',   'int',    '',   '', '', '',
1070         'paid',      @money_type, '', '',
1071         '_date',     @date_type, '', '',
1072         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1073                                                   # index into payby table
1074                                                   # eventually
1075         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
1076         'paymask', 'varchar', 'NULL', $char_d, '', '',
1077         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1078         'closed',    'char', 'NULL', 1, '', '',
1079         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1080         'void_date', @date_type, '', '',
1081         'reason',    'varchar',   'NULL', $char_d, '', '',
1082         'otaker',   'varchar', '', 32, '', '',
1083       ],
1084       'primary_key' => 'paynum',
1085       'unique' => [],
1086       'index' => [ [ 'custnum' ] ],
1087     },
1088
1089     'cust_bill_pay' => {
1090       'columns' => [
1091         'billpaynum', 'serial',     '',   '', '', '',
1092         'invnum',  'int',     '',   '', '', '',
1093         'paynum',  'int',     '',   '', '', '',
1094         'amount',  @money_type, '', '',
1095         '_date',   @date_type, '', '',
1096         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1097       ],
1098       'primary_key' => 'billpaynum',
1099       'unique' => [],
1100       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
1101     },
1102
1103     'cust_bill_pay_batch' => {
1104       'columns' => [
1105         'billpaynum', 'serial',     '',   '', '', '',
1106         'invnum',  'int',     '',   '', '', '',
1107         'paybatchnum',  'int',     '',   '', '', '',
1108         'amount',  @money_type, '', '',
1109         '_date',   @date_type, '', '',
1110       ],
1111       'primary_key' => 'billpaynum',
1112       'unique' => [],
1113       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1114     },
1115
1116     'cust_bill_pay_pkg' => {
1117       'columns' => [
1118         'billpaypkgnum', 'serial', '', '', '', '',
1119         'billpaynum',       'int', '', '', '', '',
1120         'billpkgnum',       'int', '', '', '', '',
1121         'amount',         @money_type,     '', '',
1122         'setuprecur',      'varchar', '', $char_d, '', '',
1123         'sdate',   @date_type, '', '',
1124         'edate',   @date_type, '', '',
1125       ],
1126       'primary_key' => 'billpaypkgnum',
1127       'unique'      => [],
1128       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1129     },
1130
1131     'pay_batch' => { #batches of payments to an external processor
1132       'columns' => [
1133         'batchnum',   'serial',    '',   '', '', '',
1134         'payby',      'char',      '',    4, '', '', # CARD/CHEK
1135         'status',     'char', 'NULL',     1, '', '',
1136         'download',   @date_type, '', '',
1137         'upload',     @date_type, '', '',
1138       ],
1139       'primary_key' => 'batchnum',
1140       'unique' => [],
1141       'index' => [],
1142     },
1143
1144     'cust_pay_batch' => { #what's this used for again?  list of customers
1145                           #in current CARD batch? (necessarily CARD?)
1146       'columns' => [
1147         'paybatchnum',   'serial',    '',   '', '', '',
1148         'batchnum',   'int',    '',   '', '', '',
1149         'invnum',   'int',    '',   '', '', '',
1150         'custnum',   'int',    '',   '', '', '',
1151         'last',     'varchar', '',     $char_d, '', '',
1152         'first',    'varchar', '',     $char_d, '', '',
1153         'address1', 'varchar', '',     $char_d, '', '',
1154         'address2', 'varchar', 'NULL', $char_d, '', '',
1155         'city',     'varchar', '',     $char_d, '', '',
1156         'state',    'varchar', 'NULL', $char_d, '', '',
1157         'zip',      'varchar', 'NULL', 10, '', '',
1158         'country',  'char', '',     2, '', '',
1159         #        'trancode', 'int', '', '', '', ''
1160         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1161         'payinfo',  'varchar', '',     512, '', '',
1162         #'exp',      @date_type, '', ''
1163         'exp',      'varchar', 'NULL',     11, '', '',
1164         'payname',  'varchar', 'NULL', $char_d, '', '',
1165         'amount',   @money_type, '', '',
1166         'status',   'varchar', 'NULL',     $char_d, '', '',
1167       ],
1168       'primary_key' => 'paybatchnum',
1169       'unique' => [],
1170       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1171     },
1172
1173     'cust_pkg' => {
1174       'columns' => [
1175         'pkgnum',           'serial',     '', '', '', '',
1176         'custnum',             'int',     '', '', '', '',
1177         'pkgpart',             'int',     '', '', '', '',
1178         'locationnum',         'int', 'NULL', '', '', '',
1179         'otaker',          'varchar',     '', 32, '', '',
1180         'start_date',     @date_type,             '', '',
1181         'setup',          @date_type,             '', '',
1182         'bill',           @date_type,             '', '',
1183         'last_bill',      @date_type,             '', '',
1184         'susp',           @date_type,             '', '',
1185         'adjourn',        @date_type,             '', '',
1186         'cancel',         @date_type,             '', '',
1187         'expire',         @date_type,             '', '',
1188         'change_date',    @date_type,             '', '',
1189         'change_pkgnum',       'int', 'NULL', '', '', '',
1190         'change_pkgpart',      'int', 'NULL', '', '', '',
1191         'change_locationnum',  'int', 'NULL', '', '', '',
1192         'manual_flag',        'char', 'NULL',  1, '', '',
1193         'quantity',            'int', 'NULL', '', '', '',
1194       ],
1195       'primary_key' => 'pkgnum',
1196       'unique' => [],
1197       'index' => [ ['custnum'], ['pkgpart'], [ 'locationnum' ],
1198                    [ 'start_date' ], ['setup'], ['last_bill'], ['bill'],
1199                    ['susp'], ['adjourn'], ['expire'], ['cancel'],
1200                    ['change_date'],
1201                  ],
1202     },
1203
1204     'cust_pkg_option' => {
1205       'columns' => [
1206         'optionnum', 'serial', '', '', '', '',
1207         'pkgnum', 'int', '', '', '', '',
1208         'optionname', 'varchar', '', $char_d, '', '',
1209         'optionvalue', 'text', 'NULL', '', '', '',
1210       ],
1211       'primary_key' => 'optionnum',
1212       'unique'      => [],
1213       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
1214     },
1215
1216     'cust_pkg_detail' => {
1217       'columns' => [
1218         'pkgdetailnum', 'serial', '',      '', '', '',
1219         'pkgnum',          'int', '',      '', '', '',
1220         'detail',      'varchar', '', $char_d, '', '',
1221         'detailtype',     'char', '',       1, '', '', # "I"nvoice or "C"omment
1222         'weight',          'int', '',      '', '', '',
1223       ],
1224       'primary_key' => 'pkgdetailnum',
1225       'unique' => [],
1226       'index'  => [ [ 'pkgnum', 'detailtype' ] ],
1227     },
1228
1229     'cust_pkg_reason' => {
1230       'columns' => [
1231         'num',      'serial',    '',   '', '', '',
1232         'pkgnum',   'int',    '',   '', '', '',
1233         'reasonnum','int',    '',   '', '', '',
1234         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
1235         'otaker',   'varchar', '', 32, '', '',
1236         'date',     @date_type, '', '',
1237       ],
1238       'primary_key' => 'num',
1239       'unique' => [],
1240       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], ],
1241     },
1242
1243     'cust_refund' => {
1244       'columns' => [
1245         'refundnum',    'serial',    '',   '', '', '',
1246         'custnum',  'int',    '',   '', '', '',
1247         '_date',        @date_type, '', '',
1248         'refund',       @money_type, '', '',
1249         'otaker',       'varchar',   '',   32, '', '',
1250         'reason',       'varchar',   '',   $char_d, '', '',
1251         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
1252                                                      # be index into payby
1253                                                      # table eventually
1254         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
1255         'paymask', 'varchar', 'NULL', $char_d, '', '',
1256         'paybatch',     'varchar',   'NULL', $char_d, '', '',
1257         'closed',    'char', 'NULL', 1, '', '',
1258       ],
1259       'primary_key' => 'refundnum',
1260       'unique' => [],
1261       'index' => [ ['custnum'], ['_date'] ],
1262     },
1263
1264     'cust_credit_refund' => {
1265       'columns' => [
1266         'creditrefundnum', 'serial',     '',   '', '', '',
1267         'crednum',  'int',     '',   '', '', '',
1268         'refundnum',  'int',     '',   '', '', '',
1269         'amount',  @money_type, '', '',
1270         '_date',   @date_type, '', '',
1271       ],
1272       'primary_key' => 'creditrefundnum',
1273       'unique' => [],
1274       'index' => [ ['crednum'], ['refundnum'] ],
1275     },
1276
1277
1278     'cust_svc' => {
1279       'columns' => [
1280         'svcnum',    'serial',    '',   '', '', '',
1281         'pkgnum',    'int',    'NULL',   '', '', '',
1282         'svcpart',   'int',    '',   '', '', '',
1283         'overlimit', @date_type, '', '',
1284       ],
1285       'primary_key' => 'svcnum',
1286       'unique' => [],
1287       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1288     },
1289
1290     'cust_svc_option' => {
1291       'columns' => [
1292         'optionnum',   'serial', '', '', '', '',
1293         'svcnum',      'int', '', '', '', '',
1294         'optionname',  'varchar', '', $char_d, '', '',
1295         'optionvalue', 'text', 'NULL', '', '', '',
1296       ],
1297       'primary_key' => 'optionnum',
1298       'unique'      => [],
1299       'index'       => [ [ 'svcnum' ], [ 'optionname' ] ],
1300     },
1301
1302     'part_pkg' => {
1303       'columns' => [
1304         'pkgpart',       'serial',    '',   '', '', '',
1305         'pkg',           'varchar',   '',   $char_d, '', '',
1306         'comment',       'varchar',   '',   $char_d, '', '',
1307         'promo_code',    'varchar', 'NULL', $char_d, '', '',
1308         'setup',         @perl_type, '', '',
1309         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
1310         'recur',         @perl_type, '', '',
1311         'setuptax',      'char', 'NULL', 1, '', '',
1312         'recurtax',      'char', 'NULL', 1, '', '',
1313         'plan',          'varchar', 'NULL', $char_d, '', '',
1314         'plandata',      'text', 'NULL', '', '', '',
1315         'disabled',      'char', 'NULL', 1, '', '',
1316         'custom',        'char', 'NULL', 1, '', '',
1317         'taxclass',      'varchar', 'NULL', $char_d, '', '',
1318         'classnum',      'int',     'NULL', '', '', '',
1319         'taxproductnum', 'int',     'NULL', '', '', '',
1320         'setup_cost',    @money_typen,          '', '',
1321         'recur_cost',    @money_typen,          '', '',
1322         'pay_weight',    'real',    'NULL', '', '', '',
1323         'credit_weight', 'real',    'NULL', '', '', '',
1324         'agentnum',      'int',     'NULL', '', '', '',
1325         'fcc_ds0s',      'int',     'NULL', '', '', '',
1326
1327       ],
1328       'primary_key' => 'pkgpart',
1329       'unique' => [],
1330       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
1331     },
1332
1333     'part_pkg_link' => {
1334       'columns' => [
1335         'pkglinknum',  'serial',   '',      '', '', '',
1336         'src_pkgpart', 'int',      '',      '', '', '',
1337         'dst_pkgpart', 'int',      '',      '', '', '',
1338         'link_type',   'varchar',  '', $char_d, '', '',
1339         'hidden',      'char', 'NULL',       1, '', '',
1340       ],
1341       'primary_key' => 'pkglinknum',
1342       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type', 'hidden' ] ],
1343       'index'  => [ [ 'src_pkgpart' ] ],
1344     },
1345     # XXX somewhat borked unique: we don't really want a hidden and unhidden
1346     # it turns out we'd prefer to use svc, bill, and invisibill (or something)
1347
1348     'part_pkg_taxclass' => {
1349       'columns' => [
1350         'taxclassnum',  'serial', '',       '', '', '',
1351         'taxclass',     'varchar', '', $char_d, '', '',
1352         'disabled', 'char',   'NULL',         1, '', '',
1353       ],
1354       'primary_key' => 'taxclassnum',
1355       'unique'      => [ [ 'taxclass' ] ],
1356       'index'       => [ [ 'disabled' ] ],
1357     },
1358
1359     'part_pkg_taxproduct' => {
1360       'columns' => [
1361         'taxproductnum', 'serial',      '',        '', '', '',
1362         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
1363         'taxproduct',    'varchar',     '',   $char_d, '', '',
1364         'description',   'varchar',     '', 3*$char_d, '', '',
1365       ],
1366       'primary_key' => 'taxproductnum',
1367       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
1368       'index'       => [],
1369     },
1370
1371     'part_pkg_taxrate' => {
1372       'columns' => [
1373         'pkgtaxratenum', 'serial',  '',     '',      '', '',
1374         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
1375         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
1376         'taxproductnum', 'int',  '',     '',       '', '',
1377         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
1378         'county',           'varchar', 'NULL', $char_d, '', '',
1379         'state',            'varchar', 'NULL', $char_d, '', '',
1380         'local',            'varchar', 'NULL', $char_d, '', '',
1381         'country',          'char',    'NULL', 2,       '', '',
1382         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
1383         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
1384         'taxclassnum',      'int',     'NULL', '',      '', '',
1385         'effdate',          @date_type, '', '',
1386         'taxable',          'char',    'NULL', 1,       '', '',
1387       ],
1388       'primary_key' => 'pkgtaxratenum',
1389       'unique' => [],
1390       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1391     },
1392
1393     'part_pkg_taxoverride' => {
1394       'columns' => [
1395         'taxoverridenum', 'serial', '', '', '', '',
1396         'pkgpart',           'int', '', '', '', '',
1397         'taxclassnum',       'int', '', '', '', '',
1398         'usage_class',    'varchar', 'NULL', $char_d, '', '',
1399       ],
1400       'primary_key' => 'taxoverridenum',
1401       'unique' => [],
1402       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1403     },
1404
1405 #    'part_title' => {
1406 #      'columns' => [
1407 #        'titlenum',   'int',    '',   '',
1408 #        'title',      'varchar',   '',   $char_d,
1409 #      ],
1410 #      'primary_key' => 'titlenum',
1411 #      'unique' => [ [] ],
1412 #      'index' => [ [] ],
1413 #    },
1414
1415     'pkg_svc' => {
1416       'columns' => [
1417         'pkgsvcnum',  'serial', '',  '', '', '',
1418         'pkgpart',    'int',    '',   '', '', '',
1419         'svcpart',    'int',    '',   '', '', '',
1420         'quantity',   'int',    '',   '', '', '',
1421         'primary_svc','char', 'NULL',  1, '', '',
1422       ],
1423       'primary_key' => 'pkgsvcnum',
1424       'unique' => [ ['pkgpart', 'svcpart'] ],
1425       'index' => [ ['pkgpart'], ['quantity'] ],
1426     },
1427
1428     'part_referral' => {
1429       'columns' => [
1430         'refnum',   'serial',     '',        '', '', '',
1431         'referral', 'varchar',    '',   $char_d, '', '',
1432         'disabled', 'char',   'NULL',         1, '', '',
1433         'agentnum', 'int',    'NULL',        '', '', '',
1434       ],
1435       'primary_key' => 'refnum',
1436       'unique' => [],
1437       'index' => [ ['disabled'], ['agentnum'], ],
1438     },
1439
1440     'part_svc' => {
1441       'columns' => [
1442         'svcpart',    'serial',    '',   '', '', '',
1443         'svc',        'varchar',   '',   $char_d, '', '',
1444         'svcdb',      'varchar',   '',   $char_d, '', '',
1445         'disabled',   'char',  'NULL',   1, '', '',
1446       ],
1447       'primary_key' => 'svcpart',
1448       'unique' => [],
1449       'index' => [ [ 'disabled' ] ],
1450     },
1451
1452     'part_svc_column' => {
1453       'columns' => [
1454         'columnnum',   'serial',         '', '', '', '',
1455         'svcpart',     'int',         '', '', '', '',
1456         'columnname',  'varchar',     '', 64, '', '',
1457         'columnlabel', 'varchar', 'NULL', $char_d, '', '',
1458         'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1459         'columnflag',  'char',    'NULL', 1, '', '',
1460       ],
1461       'primary_key' => 'columnnum',
1462       'unique' => [ [ 'svcpart', 'columnname' ] ],
1463       'index' => [ [ 'svcpart' ] ],
1464     },
1465
1466     #(this should be renamed to part_pop)
1467     'svc_acct_pop' => {
1468       'columns' => [
1469         'popnum',    'serial',    '',   '', '', '',
1470         'city',      'varchar',   '',   $char_d, '', '',
1471         'state',     'varchar',   '',   $char_d, '', '',
1472         'ac',        'char',   '',   3, '', '',
1473         'exch',      'char',   '',   3, '', '',
1474         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
1475       ],
1476       'primary_key' => 'popnum',
1477       'unique' => [],
1478       'index' => [ [ 'state' ] ],
1479     },
1480
1481     'part_pop_local' => {
1482       'columns' => [
1483         'localnum',  'serial',     '',     '', '', '',
1484         'popnum',    'int',     '',     '', '', '',
1485         'city',      'varchar', 'NULL', $char_d, '', '',
1486         'state',     'char',    'NULL', 2, '', '',
1487         'npa',       'char',    '',     3, '', '',
1488         'nxx',       'char',    '',     3, '', '',
1489       ],
1490       'primary_key' => 'localnum',
1491       'unique' => [],
1492       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1493     },
1494
1495     'svc_acct' => {
1496       'columns' => [
1497         'svcnum',    'int',    '',   '', '', '',
1498         'username',  'varchar',   '',   $username_len, '', '',
1499         '_password', 'varchar',   'NULL',  512, '', '',
1500         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1501         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
1502         'popnum',    'int',    'NULL',   '', '', '',
1503         'uid',       'int', 'NULL',   '', '', '',
1504         'gid',       'int', 'NULL',   '', '', '',
1505         'finger',    'varchar',   'NULL',   $char_d, '', '',
1506         'dir',       'varchar',   'NULL',   $char_d, '', '',
1507         'shell',     'varchar',   'NULL',   $char_d, '', '',
1508         'quota',     'varchar',   'NULL',   $char_d, '', '',
1509         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
1510         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
1511         'seconds_threshold',   'int', 'NULL',   '', '', '',
1512         'upbytes',   'bigint', 'NULL',   '', '', '',
1513         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
1514         'downbytes', 'bigint', 'NULL',   '', '', '',
1515         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
1516         'totalbytes','bigint', 'NULL',   '', '', '',
1517         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
1518         'domsvc',    'int',     '', '', '', '',
1519         'pbxsvc',    'int', 'NULL', '', '', '',
1520         'last_login',  @date_type, '', '',
1521         'last_logout', @date_type, '', '',
1522         #communigate pro fields (quota = MaxAccountSize)
1523         'cgp_aliases',     'varchar', 'NULL',     255, '', '',
1524         #settings
1525         'cgp_type',        'varchar', 'NULL', $char_d, '', '', #AccountType
1526         'file_quota',      'varchar', 'NULL', $char_d, '', '', #MaxWebSize
1527         'file_maxnum',     'varchar', 'NULL', $char_d, '', '', #MaxWebFiles
1528         'file_maxsize',    'varchar', 'NULL', $char_d, '', '', #MaxFileSize
1529         'cgp_accessmodes', 'varchar', 'NULL',     255, '', '', #AccessModes
1530         'password_selfchange','char', 'NULL',       1, '', '', #PWDAllowed
1531         'password_recover',   'char', 'NULL',       1, 'Y','', #PasswordRecovery
1532         'cgp_rulesallowed','varchar', 'NULL', $char_d, '', '', #RulesAllowed
1533         'cgp_rpopallowed',    'char', 'NULL',       1, '', '', #RPOPAllowed
1534         'cgp_mailtoall',      'char', 'NULL',       1, '', '', #MailToAll
1535         'cgp_addmailtrailer', 'char', 'NULL',       1, '', '', #AddMailTrailer
1536         #XXX archive messages, mailing lists
1537         #preferences
1538         'cgp_deletemode',     'varchar', 'NULL', $char_d, '', '',#DeleteMode
1539         'cgp_emptytrash',     'varchar', 'NULL', $char_d, '', '',#EmptyTrash
1540         'cgp_language',       'varchar', 'NULL', $char_d, '', '',#Language
1541         'cgp_timezone',       'varchar', 'NULL', $char_d, '', '',#TimeZone
1542         'cgp_skinname',       'varchar', 'NULL', $char_d, '', '',#SkinName
1543         'cgp_prontoskinname', 'varchar', 'NULL', $char_d, '', '',#ProntoSkinName
1544         'cgp_sendmdnmode',    'varchar', 'NULL', $char_d, '', '',#SendMDNMode
1545         #mail
1546 #vacation message, redirect all mail, mail rules
1547         #XXX RPOP settings
1548       ],
1549       'primary_key' => 'svcnum',
1550       #'unique' => [ [ 'username', 'domsvc' ] ],
1551       'unique' => [],
1552       'index' => [ ['username'], ['domsvc'], ['pbxsvc'] ],
1553     },
1554
1555     'acct_rt_transaction' => {
1556       'columns' => [
1557         'svcrtid',   'int',    '',   '', '', '',
1558         'svcnum',    'int',    '',   '', '', '',
1559         'transaction_id',       'int', '',   '', '', '',
1560         '_date',   @date_type, '', '',
1561         'seconds',   'int', '',   '', '', '', #uhhhh
1562         'support',   'int', '',   '', '', '',
1563       ],
1564       'primary_key' => 'svcrtid',
1565       'unique' => [],
1566       'index' => [ ['svcnum', 'transaction_id'] ],
1567     },
1568
1569     #'svc_charge' => {
1570     #  'columns' => [
1571     #    'svcnum',    'int',    '',   '',
1572     #    'amount',    @money_type,
1573     #  ],
1574     #  'primary_key' => 'svcnum',
1575     #  'unique' => [ [] ],
1576     #  'index' => [ [] ],
1577     #},
1578
1579     'svc_domain' => {
1580       'columns' => [
1581         'svcnum',           'int',    '',        '', '', '',
1582         'domain',       'varchar',    '',   $char_d, '', '',
1583         'suffix',       'varchar', 'NULL',  $char_d, '', '',
1584         'catchall',         'int', 'NULL',       '', '', '',
1585         'parent_svcnum',    'int', 'NULL',       '', '', '',
1586         'registrarnum',     'int', 'NULL',       '', '', '',
1587         'registrarkey', 'varchar', 'NULL',      512, '', '',
1588         'setup_date',      @date_type, '', '',
1589         'renewal_interval', 'int', 'NULL',       '', '', '',
1590         'expiration_date', @date_type, '', '',
1591         #communigate pro fields (quota = MaxAccountSize)
1592         'max_accounts',     'int', 'NULL',       '', '', '',
1593         'trailer',         'text', 'NULL',       '', '', '',
1594         'cgp_aliases',  'varchar', 'NULL',      255, '', '',
1595         'cgp_accessmodes','varchar','NULL',     255, '', '', #DomainAccessModes
1596         #settings
1597         'acct_def_password_selfchange',   'char', 'NULL',       1,  '', '',
1598         'acct_def_password_recover',      'char', 'NULL',       1, 'Y', '',
1599         'acct_def_cgp_accessmodes',    'varchar', 'NULL',     255,  '', '',
1600         'acct_def_quota',              'varchar', 'NULL', $char_d,  '', '',
1601         'acct_def_file_quota',         'varchar', 'NULL', $char_d,  '', '',
1602         'acct_def_file_maxnum',        'varchar', 'NULL', $char_d,  '', '',
1603         'acct_def_file_maxsize',       'varchar', 'NULL', $char_d,  '', '',
1604         'acct_def_cgp_rulesallowed',   'varchar', 'NULL', $char_d,  '', '',
1605         'acct_def_cgp_rpopallowed',       'char', 'NULL',       1,  '', '',
1606         'acct_def_cgp_mailtoall',         'char', 'NULL',       1,  '', '',
1607         'acct_def_cgp_addmailtrailer',    'char', 'NULL',       1,  '', '',
1608         #XXX archive messages
1609         #preferences
1610         'acct_def_cgp_deletemode',     'varchar', 'NULL', $char_d,  '', '',
1611         'acct_def_cgp_emptytrash',     'varchar', 'NULL', $char_d,  '', '',
1612         'acct_def_cgp_language',       'varchar', 'NULL', $char_d,  '', '',
1613         'acct_def_cgp_timezone',       'varchar', 'NULL', $char_d,  '', '',
1614         'acct_def_cgp_skinname',       'varchar', 'NULL', $char_d,  '', '',
1615         'acct_def_cgp_prontoskinname', 'varchar', 'NULL', $char_d,  '', '',
1616         'acct_def_cgp_sendmdnmode',    'varchar', 'NULL', $char_d,  '', '',
1617         #mail
1618         #XXX rules, archive rule, spam foldering rule(s)
1619       ],
1620       'primary_key' => 'svcnum',
1621       'unique' => [ ],
1622       'index' => [ ['domain'] ],
1623     },
1624
1625     'domain_record' => {
1626       'columns' => [
1627         'recnum',    'serial',     '',  '', '', '',
1628         'svcnum',    'int',     '',  '', '', '',
1629         'reczone',   'varchar', '',  255, '', '',
1630         'recaf',     'char',    '',  2, '', '',
1631         'rectype',   'varchar',    '',  5, '', '',
1632         'recdata',   'varchar', '',  255, '', '',
1633       ],
1634       'primary_key' => 'recnum',
1635       'unique'      => [],
1636       'index'       => [ ['svcnum'] ],
1637     },
1638
1639     'registrar' => {
1640       'columns' => [
1641         'registrarnum',   'serial', '',      '', '', '',
1642         'registrarname', 'varchar', '', $char_d, '', '',
1643       ],
1644       'primary_key' => 'registrarnum',
1645       'unique'      => [],
1646       'index'       => [],
1647     },
1648
1649     'cgp_rule' => {
1650       'columns' => [
1651         'rulenum',  'serial',     '',      '', '', '',
1652         'name',    'varchar',     '', $char_d, '', '',
1653         'comment', 'varchar', 'NULL', $char_d, '', '',
1654         'svcnum',      'int',     '',      '', '', '',
1655         'priority',    'int',     '',      '', '', '',
1656       ],
1657       'primary_key' => 'rulenum',
1658       'unique'      => [ [ 'svcnum', 'name' ] ],
1659       'index'       => [ [ 'svcnum' ] ],
1660     },
1661
1662     'cgp_rule_condition' => {
1663       'columns' => [
1664         'ruleconditionnum',  'serial',     '',      '', '', '',
1665         'conditionname',    'varchar',     '', $char_d, '', '',
1666         'op',               'varchar', 'NULL', $char_d, '', '',
1667         'params',           'varchar', 'NULL',     255, '', '',
1668         'rulenum',              'int',     '',      '', '', '',
1669       ],
1670       'primary_key' => 'ruleconditionnum',
1671       'unique'      => [],
1672       'index'       => [ [ 'rulenum' ] ],
1673     },
1674
1675     'cgp_rule_action' => {
1676        'columns' => [
1677         'ruleactionnum',  'serial',     '',      '', '', '',
1678         'action',        'varchar',     '', $char_d, '', '',
1679         'params',        'varchar', 'NULL',     255, '', '',
1680         'rulenum',           'int',     '',      '', '', '',
1681       ],
1682       'primary_key' => 'ruleactionnum',
1683       'unique'      => [],
1684       'index'       => [ [ 'rulenum' ] ],
1685    },
1686
1687     'svc_forward' => {
1688       'columns' => [
1689         'svcnum',   'int',            '',   '', '', '',
1690         'srcsvc',   'int',        'NULL',   '', '', '',
1691         'src',      'varchar',    'NULL',  255, '', '',
1692         'dstsvc',   'int',        'NULL',   '', '', '',
1693         'dst',      'varchar',    'NULL',  255, '', '',
1694       ],
1695       'primary_key' => 'svcnum',
1696       'unique'      => [],
1697       'index'       => [ ['srcsvc'], ['dstsvc'] ],
1698     },
1699
1700     'svc_www' => {
1701       'columns' => [
1702         'svcnum',   'int',      '',  '', '', '',
1703         'recnum',   'int',      '',  '', '', '',
1704         'usersvc',  'int',  'NULL',  '', '', '',
1705         'config',   'text', 'NULL',  '', '', '',
1706       ],
1707       'primary_key' => 'svcnum',
1708       'unique'      => [],
1709       'index'       => [],
1710     },
1711
1712     #'svc_wo' => {
1713     #  'columns' => [
1714     #    'svcnum',    'int',    '',   '',
1715     #    'svcnum',    'int',    '',   '',
1716     #    'svcnum',    'int',    '',   '',
1717     #    'worker',    'varchar',   '',   $char_d,
1718     #    '_date',     @date_type,
1719     #  ],
1720     #  'primary_key' => 'svcnum',
1721     #  'unique' => [ [] ],
1722     #  'index' => [ [] ],
1723     #},
1724
1725     'prepay_credit' => {
1726       'columns' => [
1727         'prepaynum',   'serial',     '',   '', '', '',
1728         'identifier',  'varchar', '', $char_d, '', '',
1729         'amount',      @money_type, '', '',
1730         'seconds',     'int',     'NULL', '', '', '',
1731         'upbytes',     'bigint',     'NULL', '', '', '',
1732         'downbytes',   'bigint',     'NULL', '', '', '',
1733         'totalbytes',  'bigint',     'NULL', '', '', '',
1734         'agentnum',    'int',     'NULL', '', '', '',
1735       ],
1736       'primary_key' => 'prepaynum',
1737       'unique'      => [ ['identifier'] ],
1738       'index'       => [],
1739     },
1740
1741     'port' => {
1742       'columns' => [
1743         'portnum',  'serial',     '',   '', '', '',
1744         'ip',       'varchar', 'NULL', 15, '', '',
1745         'nasport',  'int',     'NULL', '', '', '',
1746         'nasnum',   'int',     '',   '', '', '',
1747       ],
1748       'primary_key' => 'portnum',
1749       'unique'      => [],
1750       'index'       => [],
1751     },
1752
1753     'nas' => {
1754       'columns' => [
1755         'nasnum',   'serial',     '',    '', '', '',
1756         'nas',      'varchar', '',    $char_d, '', '',
1757         'nasip',    'varchar', '',    15, '', '',
1758         'nasfqdn',  'varchar', '',    $char_d, '', '',
1759         'last',     'int',     '',    '', '', '',
1760       ],
1761       'primary_key' => 'nasnum',
1762       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
1763       'index'       => [ [ 'last' ] ],
1764     },
1765
1766 #    'session' => {
1767 #      'columns' => [
1768 #        'sessionnum', 'serial',       '',   '', '', '',
1769 #        'portnum',    'int',       '',   '', '', '',
1770 #        'svcnum',     'int',       '',   '', '', '',
1771 #        'login',      @date_type, '', '',
1772 #        'logout',     @date_type, '', '',
1773 #      ],
1774 #      'primary_key' => 'sessionnum',
1775 #      'unique'      => [],
1776 #      'index'       => [ [ 'portnum' ] ],
1777 #    },
1778
1779     'queue' => {
1780       'columns' => [
1781         'jobnum',      'serial',     '',      '', '', '',
1782         'job',        'varchar',     '',     512, '', '',
1783         '_date',          'int',     '',      '', '', '',
1784         'status',     'varchar',     '', $char_d, '', '',
1785         'statustext',    'text', 'NULL',      '', '', '',
1786         'svcnum',         'int', 'NULL',      '', '', '',
1787         'custnum',        'int', 'NULL',      '', '', '',
1788         'secure',        'char', 'NULL',       1, '', '',
1789         'priority',       'int', 'NULL',      '', '', '',
1790       ],
1791       'primary_key' => 'jobnum',
1792       'unique'      => [],
1793       'index'       => [ [ 'secure' ], [ 'priority' ],
1794                          [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
1795                        ],
1796     },
1797
1798     'queue_arg' => {
1799       'columns' => [
1800         'argnum', 'serial', '', '', '', '',
1801         'jobnum', 'int', '', '', '', '',
1802         'frozen', 'char', 'NULL',       1, '', '',
1803         'arg', 'text', 'NULL', '', '', '',
1804       ],
1805       'primary_key' => 'argnum',
1806       'unique'      => [],
1807       'index'       => [ [ 'jobnum' ] ],
1808     },
1809
1810     'queue_depend' => {
1811       'columns' => [
1812         'dependnum', 'serial', '', '', '', '',
1813         'jobnum', 'int', '', '', '', '',
1814         'depend_jobnum', 'int', '', '', '', '',
1815       ],
1816       'primary_key' => 'dependnum',
1817       'unique'      => [],
1818       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1819     },
1820
1821     'export_svc' => {
1822       'columns' => [
1823         'exportsvcnum' => 'serial', '', '', '', '',
1824         'exportnum'    => 'int', '', '', '', '',
1825         'svcpart'      => 'int', '', '', '', '',
1826       ],
1827       'primary_key' => 'exportsvcnum',
1828       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
1829       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
1830     },
1831
1832     'export_device' => {
1833       'columns' => [
1834         'exportdevicenum' => 'serial', '', '', '', '',
1835         'exportnum'    => 'int', '', '', '', '',
1836         'devicepart'      => 'int', '', '', '', '',
1837       ],
1838       'primary_key' => 'exportdevicenum',
1839       'unique'      => [ [ 'exportnum', 'devicepart' ] ],
1840       'index'       => [ [ 'exportnum' ], [ 'devicepart' ] ],
1841     },
1842
1843     'part_export' => {
1844       'columns' => [
1845         'exportnum', 'serial', '', '', '', '',
1846         'machine', 'varchar', '', $char_d, '', '',
1847         'exporttype', 'varchar', '', $char_d, '', '',
1848         'nodomain',     'char', 'NULL', 1, '', '',
1849       ],
1850       'primary_key' => 'exportnum',
1851       'unique'      => [],
1852       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
1853     },
1854
1855     'part_export_option' => {
1856       'columns' => [
1857         'optionnum', 'serial', '', '', '', '',
1858         'exportnum', 'int', '', '', '', '',
1859         'optionname', 'varchar', '', $char_d, '', '',
1860         'optionvalue', 'text', 'NULL', '', '', '',
1861       ],
1862       'primary_key' => 'optionnum',
1863       'unique'      => [],
1864       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
1865     },
1866
1867     'radius_usergroup' => {
1868       'columns' => [
1869         'usergroupnum', 'serial', '', '', '', '',
1870         'svcnum',       'int', '', '', '', '',
1871         'groupname',    'varchar', '', $char_d, '', '',
1872       ],
1873       'primary_key' => 'usergroupnum',
1874       'unique'      => [],
1875       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
1876     },
1877
1878     'msgcat' => {
1879       'columns' => [
1880         'msgnum', 'serial', '', '', '', '',
1881         'msgcode', 'varchar', '', $char_d, '', '',
1882         'locale', 'varchar', '', 16, '', '',
1883         'msg', 'text', '', '', '', '',
1884       ],
1885       'primary_key' => 'msgnum',
1886       'unique'      => [ [ 'msgcode', 'locale' ] ],
1887       'index'       => [],
1888     },
1889
1890     'cust_tax_exempt' => {
1891       'columns' => [
1892         'exemptnum', 'serial', '', '', '', '',
1893         'custnum',   'int', '', '', '', '',
1894         'taxnum',    'int', '', '', '', '',
1895         'year',      'int', '', '', '', '',
1896         'month',     'int', '', '', '', '',
1897         'amount',   @money_type, '', '',
1898       ],
1899       'primary_key' => 'exemptnum',
1900       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1901       'index'       => [],
1902     },
1903
1904     'cust_tax_exempt_pkg' => {
1905       'columns' => [
1906         'exemptpkgnum',  'serial', '', '', '', '',
1907         #'custnum',      'int', '', '', '', ''
1908         'billpkgnum',   'int', '', '', '', '',
1909         'taxnum',       'int', '', '', '', '',
1910         'year',         'int', '', '', '', '',
1911         'month',        'int', '', '', '', '',
1912         'amount',       @money_type, '', '',
1913       ],
1914       'primary_key' => 'exemptpkgnum',
1915       'unique' => [],
1916       'index'  => [ [ 'taxnum', 'year', 'month' ],
1917                     [ 'billpkgnum' ],
1918                     [ 'taxnum' ]
1919                   ],
1920     },
1921
1922     'router' => {
1923       'columns' => [
1924         'routernum', 'serial', '', '', '', '',
1925         'routername', 'varchar', '', $char_d, '', '',
1926         'svcnum', 'int', 'NULL', '', '', '',
1927         'agentnum',   'int', 'NULL', '', '', '',
1928       ],
1929       'primary_key' => 'routernum',
1930       'unique'      => [],
1931       'index'       => [],
1932     },
1933
1934     'part_svc_router' => {
1935       'columns' => [
1936         'svcrouternum', 'serial', '', '', '', '',
1937         'svcpart', 'int', '', '', '', '',
1938         'routernum', 'int', '', '', '', '',
1939       ],
1940       'primary_key' => 'svcrouternum',
1941       'unique'      => [],
1942       'index'       => [],
1943     },
1944
1945     'addr_block' => {
1946       'columns' => [
1947         'blocknum', 'serial', '', '', '', '',
1948         'routernum', 'int', '', '', '', '',
1949         'ip_gateway', 'varchar', '', 15, '', '',
1950         'ip_netmask', 'int', '', '', '', '',
1951         'agentnum',   'int', 'NULL', '', '', '',
1952         'manual_flag', 'char', 'NULL', 1, '', '',
1953       ],
1954       'primary_key' => 'blocknum',
1955       'unique'      => [ [ 'blocknum', 'routernum' ] ],
1956       'index'       => [],
1957     },
1958
1959     'svc_broadband' => {
1960       'columns' => [
1961         'svcnum', 'int', '', '', '', '',
1962         'description', 'varchar', 'NULL', $char_d, '', '',
1963         'blocknum', 'int', 'NULL', '', '', '',
1964         'speed_up', 'int', '', '', '', '',
1965         'speed_down', 'int', '', '', '', '',
1966         'ip_addr', 'varchar', 'NULL', 15, '', '',
1967         'mac_addr', 'varchar', 'NULL', 12, '', '',
1968         'authkey',  'varchar', 'NULL', 32, '', '',
1969         'latitude', 'decimal', 'NULL', '', '', '',
1970         'longitude', 'decimal', 'NULL', '', '', '',
1971         'altitude', 'decimal', 'NULL', '', '', '',
1972         'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1973         'performance_profile', 'varchar', 'NULL', $char_d, '', '',
1974       ],
1975       'primary_key' => 'svcnum',
1976       'unique'      => [ [ 'mac_addr' ] ],
1977       'index'       => [],
1978     },
1979
1980     'part_virtual_field' => {
1981       'columns' => [
1982         'vfieldpart', 'serial', '', '', '', '',
1983         'dbtable', 'varchar', '', 32, '', '',
1984         'name', 'varchar', '', 32, '', '',
1985         'check_block', 'text', 'NULL', '', '', '',
1986         'length', 'int', 'NULL', '', '', '',
1987         'list_source', 'text', 'NULL', '', '', '',
1988         'label', 'varchar', 'NULL', 80, '', '',
1989       ],
1990       'primary_key' => 'vfieldpart',
1991       'unique' => [],
1992       'index' => [],
1993     },
1994
1995     'virtual_field' => {
1996       'columns' => [
1997         'vfieldnum', 'serial', '', '', '', '',
1998         'recnum', 'int', '', '', '', '',
1999         'vfieldpart', 'int', '', '', '', '',
2000         'value', 'varchar', '', 128, '', '',
2001       ],
2002       'primary_key' => 'vfieldnum',
2003       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
2004       'index' => [],
2005     },
2006
2007     'acct_snarf' => {
2008       'columns' => [
2009         'snarfnum',  'int', '', '', '', '',
2010         'svcnum',    'int', '', '', '', '',
2011         'machine',   'varchar', '', 255, '', '',
2012         'protocol',  'varchar', '', $char_d, '', '',
2013         'username',  'varchar', '', $char_d, '', '',
2014         '_password', 'varchar', '', $char_d, '', '',
2015       ],
2016       'primary_key' => 'snarfnum',
2017       'unique' => [],
2018       'index'  => [ [ 'svcnum' ] ],
2019     },
2020
2021     'svc_external' => {
2022       'columns' => [
2023         'svcnum', 'int', '', '', '', '',
2024         'id',     'int', 'NULL', '', '', '',
2025         'title',  'varchar', 'NULL', $char_d, '', '',
2026       ],
2027       'primary_key' => 'svcnum',
2028       'unique'      => [],
2029       'index'       => [],
2030     },
2031
2032     'cust_pay_refund' => {
2033       'columns' => [
2034         'payrefundnum', 'serial', '', '', '', '',
2035         'paynum',  'int', '', '', '', '',
2036         'refundnum',  'int', '', '', '', '',
2037         '_date',    @date_type, '', '',
2038         'amount',   @money_type, '', '',
2039       ],
2040       'primary_key' => 'payrefundnum',
2041       'unique' => [],
2042       'index' => [ ['paynum'], ['refundnum'] ],
2043     },
2044
2045     'part_pkg_option' => {
2046       'columns' => [
2047         'optionnum', 'serial', '', '', '', '',
2048         'pkgpart', 'int', '', '', '', '',
2049         'optionname', 'varchar', '', $char_d, '', '',
2050         'optionvalue', 'text', 'NULL', '', '', '',
2051       ],
2052       'primary_key' => 'optionnum',
2053       'unique'      => [],
2054       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
2055     },
2056
2057     'part_pkg_report_option' => {
2058       'columns' => [
2059         'num',      'serial',   '',      '', '', '',
2060         'name',     'varchar',  '', $char_d, '', '',
2061         'disabled', 'char', 'NULL',       1, '', '',
2062       ],
2063       'primary_key' => 'num',
2064       'unique' => [ [ 'name' ] ],
2065       'index' => [ [ 'disabled' ] ],
2066     },
2067
2068     'rate' => {
2069       'columns' => [
2070         'ratenum',  'serial', '', '', '', '',
2071         'ratename', 'varchar', '', $char_d, '', '',
2072       ],
2073       'primary_key' => 'ratenum',
2074       'unique'      => [],
2075       'index'       => [],
2076     },
2077
2078     'rate_detail' => {
2079       'columns' => [
2080         'ratedetailnum',   'serial',  '',     '', '', '',
2081         'ratenum',         'int',     '',     '', '', '',
2082         'orig_regionnum',  'int', 'NULL',     '', '', '',
2083         'dest_regionnum',  'int',     '',     '', '', '',
2084         'min_included',    'int',     '',     '', '', '',
2085         'conn_charge',     @money_type, '0', '', #'decimal','','10,5','0','',
2086         'conn_sec',        'int',     '',     '', '0', '',
2087         'min_charge',      'decimal', '', '10,5', '', '', #@money_type, '', '',
2088         'sec_granularity', 'int',     '',     '', '', '',
2089         #time period (link to table of periods)?
2090         'classnum',        'int', 'NULL',     '', '', '',
2091       ],
2092       'primary_key' => 'ratedetailnum',
2093       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
2094       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
2095     },
2096
2097     'rate_region' => {
2098       'columns' => [
2099         'regionnum',   'serial',      '', '', '', '',
2100         'regionname',  'varchar',     '', $char_d, '', '',
2101       ],
2102       'primary_key' => 'regionnum',
2103       'unique'      => [],
2104       'index'       => [],
2105     },
2106
2107     'rate_prefix' => {
2108       'columns' => [
2109         'prefixnum',   'serial',      '', '', '', '',
2110         'regionnum',   'int',         '', '', '', '',
2111         'countrycode', 'varchar',     '',  3, '', '',
2112         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
2113         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
2114       ],
2115       'primary_key' => 'prefixnum',
2116       'unique'      => [],
2117       'index'       => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
2118     },
2119
2120     'usage_class' => {
2121       'columns' => [
2122         'classnum',    'serial',      '',      '', '', '',
2123         'weight',      'int',     'NULL',      '', '', '',
2124         'classname',   'varchar',     '', $char_d, '', '',
2125         'format',      'varchar', 'NULL', $char_d, '', '',
2126         'disabled',    'char',    'NULL',       1, '', '',
2127       ],
2128       'primary_key' => 'classnum',
2129       'unique' => [],
2130       'index' => [ ['disabled'] ],
2131     },
2132
2133     'reg_code' => {
2134       'columns' => [
2135         'codenum',   'serial',    '', '', '', '',
2136         'code',      'varchar',   '', $char_d, '', '',
2137         'agentnum',  'int',       '', '', '', '',
2138       ],
2139       'primary_key' => 'codenum',
2140       'unique'      => [ [ 'agentnum', 'code' ] ],
2141       'index'       => [ [ 'agentnum' ] ],
2142     },
2143
2144     'reg_code_pkg' => {
2145       'columns' => [
2146         'codepkgnum', 'serial', '', '', '', '',
2147         'codenum',   'int',    '', '', '', '',
2148         'pkgpart',   'int',    '', '', '', '',
2149       ],
2150       'primary_key' => 'codepkgnum',
2151       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
2152       'index'       => [ [ 'codenum' ] ],
2153     },
2154
2155     'clientapi_session' => {
2156       'columns' => [
2157         'sessionnum',  'serial',  '', '', '', '',
2158         'sessionid',  'varchar',  '', $char_d, '', '',
2159         'namespace',  'varchar',  '', $char_d, '', '',
2160       ],
2161       'primary_key' => 'sessionnum',
2162       'unique'      => [ [ 'sessionid', 'namespace' ] ],
2163       'index'       => [],
2164     },
2165
2166     'clientapi_session_field' => {
2167       'columns' => [
2168         'fieldnum',    'serial',     '', '', '', '',
2169         'sessionnum',     'int',     '', '', '', '',
2170         'fieldname',  'varchar',     '', $char_d, '', '',
2171         'fieldvalue',    'text', 'NULL', '', '', '',
2172       ],
2173       'primary_key' => 'fieldnum',
2174       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
2175       'index'       => [],
2176     },
2177
2178     'payment_gateway' => {
2179       'columns' => [
2180         'gatewaynum',       'serial',   '',     '', '', '',
2181         'gateway_namespace','varchar',  'NULL', $char_d, '', '',
2182         'gateway_module',   'varchar',  '',     $char_d, '', '',
2183         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
2184         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
2185         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
2186         'gateway_callback_url', 'varchar',  'NULL', $char_d, '', '',
2187         'disabled',   'char',  'NULL',   1, '', '',
2188       ],
2189       'primary_key' => 'gatewaynum',
2190       'unique' => [],
2191       'index'  => [ [ 'disabled' ] ],
2192     },
2193
2194     'payment_gateway_option' => {
2195       'columns' => [
2196         'optionnum',   'serial',  '',     '', '', '',
2197         'gatewaynum',  'int',     '',     '', '', '',
2198         'optionname',  'varchar', '',     $char_d, '', '',
2199         'optionvalue', 'text',    'NULL', '', '', '',
2200       ],
2201       'primary_key' => 'optionnum',
2202       'unique'      => [],
2203       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
2204     },
2205
2206     'agent_payment_gateway' => {
2207       'columns' => [
2208         'agentgatewaynum', 'serial', '', '', '', '',
2209         'agentnum',        'int', '', '', '', '',
2210         'gatewaynum',      'int', '', '', '', '',
2211         'cardtype',        'varchar', 'NULL', $char_d, '', '',
2212         'taxclass',        'varchar', 'NULL', $char_d, '', '',
2213       ],
2214       'primary_key' => 'agentgatewaynum',
2215       'unique'      => [],
2216       'index'       => [ [ 'agentnum', 'cardtype' ], ],
2217     },
2218
2219     'banned_pay' => {
2220       'columns' => [
2221         'bannum',  'serial',   '',     '', '', '',
2222         'payby',   'char',     '',       4, '', '',
2223         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
2224         #'paymask', 'varchar',  'NULL', $char_d, '', ''
2225         '_date',   @date_type, '', '',
2226         'otaker',  'varchar',  '',     32, '', '',
2227         'reason',  'varchar',  'NULL', $char_d, '', '',
2228       ],
2229       'primary_key' => 'bannum',
2230       'unique'      => [ [ 'payby', 'payinfo' ] ],
2231       'index'       => [],
2232     },
2233
2234     'pkg_category' => {
2235       'columns' => [
2236         'categorynum',   'serial',  '', '', '', '',
2237         'categoryname',  'varchar', '', $char_d, '', '',
2238         'weight',         'int', 'NULL',  '', '', '',
2239         'condense',      'char', 'NULL',   1, '', '',
2240         'disabled',      'char', 'NULL',   1, '', '',
2241       ],
2242       'primary_key' => 'categorynum',
2243       'unique' => [],
2244       'index' => [ ['disabled'] ],
2245     },
2246
2247     'pkg_class' => {
2248       'columns' => [
2249         'classnum',    'serial',   '',      '', '', '',
2250         'classname',   'varchar',  '', $char_d, '', '',
2251         'categorynum', 'int',  'NULL',      '', '', '',
2252         'disabled',    'char', 'NULL',       1, '', '',
2253       ],
2254       'primary_key' => 'classnum',
2255       'unique' => [],
2256       'index' => [ ['disabled'] ],
2257     },
2258
2259     'cdr' => {
2260       'columns' => [
2261         # qw( name type null length default local );
2262
2263         ###
2264         #asterisk fields
2265         ###
2266
2267         'acctid',   'bigserial',  '', '', '', '',
2268         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
2269         'calldate', 'timestamp',   '',      '', \'now()', '',
2270         'clid',        'varchar',  '', $char_d, \"''", '',
2271         'src',         'varchar',  '', $char_d, \"''", '',
2272         'dst',         'varchar',  '', $char_d, \"''", '',
2273         'dcontext',    'varchar',  '', $char_d, \"''", '',
2274         'channel',     'varchar',  '', $char_d, \"''", '',
2275         'dstchannel',  'varchar',  '', $char_d, \"''", '',
2276         'lastapp',     'varchar',  '', $char_d, \"''", '',
2277         'lastdata',    'varchar',  '', $char_d, \"''", '',
2278
2279         #these don't seem to be logged by most of the SQL cdr_* modules
2280         #except tds under sql-illegal names, so;
2281         # ... don't rely on them for rating?
2282         # and, what they hey, i went ahead and changed the names and data types
2283         # to freeside-style dates...
2284           #'start',  'timestamp', 'NULL',  '',    '', '',
2285           #'answer', 'timestamp', 'NULL',  '',    '', '',
2286           #'end',    'timestamp', 'NULL',  '',    '', '',
2287         'startdate',  @date_type, '', '',
2288         'answerdate', @date_type, '', '',
2289         'enddate',    @date_type, '', '',
2290         #
2291
2292         'duration',    'int',      '',      '',     0, '',
2293         'billsec',     'int',      '',      '',     0, '',
2294         'disposition', 'varchar',  '',      45, \"''", '',
2295         'amaflags',    'int',      '',      '',     0, '',
2296         'accountcode', 'varchar',  '',      20, \"''", '',
2297         'uniqueid',    'varchar',  '',      32, \"''", '',
2298         'userfield',   'varchar',  '',     255, \"''", '',
2299
2300         ###
2301         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
2302         # defaults
2303         # though these are now used elsewhere:
2304         # charged_party, upstream_price, rated_price, carrierid
2305         ###
2306
2307         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
2308         'cdrtypenum',              'int', 'NULL',      '', '', '',
2309
2310         'charged_party',       'varchar', 'NULL', $char_d, '', '',
2311
2312         'upstream_currency',      'char', 'NULL',       3, '', '',
2313         'upstream_price',      'decimal', 'NULL',  '10,2', '', '',
2314         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
2315
2316         # how it was rated internally...
2317         'ratedetailnum',           'int', 'NULL',      '', '', '',
2318         'rated_price',         'decimal', 'NULL',  '10,4', '', '',
2319
2320         'distance',            'decimal', 'NULL',      '', '', '',
2321         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
2322
2323         #cdr_calltype: the big list in appendix 2
2324         'calltypenum',             'int', 'NULL',      '', '', '',
2325
2326         'description',         'varchar', 'NULL', $char_d, '', '',
2327         'quantity',                'int', 'NULL',      '', '', '',
2328
2329         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
2330         'carrierid',               'int', 'NULL',      '', '', '',
2331
2332         'upstream_rateid',         'int', 'NULL',      '', '', '',
2333
2334         ###
2335         #and now for our own fields
2336         ###
2337
2338         # a svcnum... right..?
2339         'svcnum',             'int',   'NULL',     '',   '', '',
2340
2341         #NULL, done (or something)
2342         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
2343
2344         #NULL, done (or something)
2345         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '',
2346
2347         #an indexed place to put big numbers
2348         'cdrid',         'bigint',     'NULL',     '',  '', '',
2349
2350         #old
2351         'cdrbatch', 'varchar', 'NULL', 255, '', '',
2352         #new
2353         'cdrbatchnum', 'int', 'NULL', '', '', '',
2354
2355       ],
2356       'primary_key' => 'acctid',
2357       'unique' => [],
2358       'index' => [ [ 'calldate' ],
2359                    [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
2360                    [ 'accountcode' ], [ 'carrierid' ], [ 'cdrid' ],
2361                    [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
2362                    [ 'cdrbatch' ], [ 'cdrbatchnum' ],
2363                  ],
2364     },
2365
2366     'cdr_batch' => {
2367       'columns' => [
2368         'cdrbatchnum',   'serial',    '',   '', '', '',
2369         'cdrbatch', 'varchar', 'NULL', 255, '', '',
2370         '_date',     @date_type, '', '',
2371       ],
2372       'primary_key' => 'cdrbatchnum',
2373       'unique' => [ [ 'cdrbatch' ] ],
2374       'index' => [],
2375     },
2376
2377     'cdr_termination' => {
2378       'columns' => [
2379         'cdrtermnum', 'bigserial',     '',      '', '', '',
2380         'acctid',        'bigint',     '',      '', '', '',
2381         'termpart',         'int',     '',      '', '', '',#future use see below
2382         'rated_price',  'decimal', 'NULL',  '10,4', '', '',
2383         'status',       'varchar', 'NULL',      32, '', '',
2384       ],
2385       'primary_key' => 'cdrtermnum',
2386       'unique'      => [ [ 'acctid', 'termpart' ] ],
2387       'index'       => [ [ 'acctid' ], [ 'status' ], ],
2388     },
2389
2390     #to handle multiple termination/settlement passes...
2391    # 'part_termination' => {
2392    #   'columns' => [
2393    #     'termpart',       'int', '',      '', '', '',
2394    #     'termname',   'varchar', '', $char_d, '', '',
2395    #     'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
2396    #   ],
2397    #   'primary_key' => 'termpart',
2398    #   'unique' => [],
2399    #   'index'  => [],
2400    # },
2401
2402     #the remaining cdr_ tables are not really used
2403     'cdr_calltype' => {
2404       'columns' => [
2405         'calltypenum',   'serial',  '', '', '', '',
2406         'calltypename',  'varchar', '', $char_d, '', '',
2407       ],
2408       'primary_key' => 'calltypenum',
2409       'unique'      => [],
2410       'index'       => [],
2411     },
2412
2413     'cdr_type' => {
2414       'columns' => [
2415         'cdrtypenum'  => 'serial',  '', '', '', '',
2416         'cdrtypename' => 'varchar', '', $char_d, '', '',
2417       ],
2418       'primary_key' => 'cdrtypenum',
2419       'unique'      => [],
2420       'index'       => [],
2421     },
2422
2423     'cdr_carrier' => {
2424       'columns' => [
2425         'carrierid'   => 'serial',  '', '', '', '',
2426         'carriername' => 'varchar', '', $char_d, '', '',
2427       ],
2428       'primary_key' => 'carrierid',
2429       'unique'      => [],
2430       'index'       => [],
2431     },
2432
2433     #'cdr_file' => {
2434     #  'columns' => [
2435     #    'filenum',    'serial',     '', '', '', '',
2436     #    'filename',  'varchar',     '', '', '', '',
2437     #    'status',    'varchar', 'NULL', '', '', '',
2438     #  ],
2439     #  'primary_key' => 'filenum',
2440     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
2441     #                                   # agent-virtualize or have a customer
2442     #                                   # with dup-filename needs or something
2443     #                                   # (only used by cdr.http_and_import for
2444     #                                   #  chrissakes)
2445     #  'index'  => [],
2446     #},
2447
2448     'inventory_item' => {
2449       'columns' => [
2450         'itemnum',  'serial',      '',      '', '', '',
2451         'classnum', 'int',         '',      '', '', '',
2452         'item',     'varchar',     '', $char_d, '', '',
2453         'svcnum',   'int',     'NULL',      '', '', '',
2454       ],
2455       'primary_key' => 'itemnum',
2456       'unique' => [ [ 'classnum', 'item' ] ],
2457       'index'  => [ [ 'classnum' ], [ 'svcnum' ] ],
2458     },
2459
2460     'inventory_class' => {
2461       'columns' => [
2462         'classnum',  'serial',       '',      '', '', '',
2463         'classname', 'varchar',      '', $char_d, '', '',
2464       ],
2465       'primary_key' => 'classnum',
2466       'unique' => [],
2467       'index'  => [],
2468     },
2469
2470     'access_user' => {
2471       'columns' => [
2472         'usernum',   'serial',  '',      '', '', '',
2473         'username',  'varchar', '', $char_d, '', '',
2474         '_password', 'varchar', '', $char_d, '', '',
2475         'last',      'varchar', '', $char_d, '', '',
2476         'first',     'varchar', '', $char_d, '', '',
2477         'user_custnum',  'int', 'NULL',  '', '', '',
2478         'disabled',     'char', 'NULL',   1, '', '',
2479       ],
2480       'primary_key' => 'usernum',
2481       'unique' => [ [ 'username' ] ],
2482       'index'  => [ [ 'user_custnum' ] ],
2483     },
2484
2485     'access_user_pref' => {
2486       'columns' => [
2487         'prefnum',    'serial',       '', '', '', '',
2488         'usernum',     'int',       '', '', '', '',
2489         'prefname', 'varchar', '', $char_d, '', '',
2490         'prefvalue', 'text', 'NULL', '', '', '',
2491         'expiration', @date_type, '', '',
2492       ],
2493       'primary_key' => 'prefnum',
2494       'unique' => [],
2495       'index'  => [ [ 'usernum' ] ],
2496     },
2497
2498     'access_group' => {
2499       'columns' => [
2500         'groupnum',   'serial', '',      '', '', '',
2501         'groupname', 'varchar', '', $char_d, '', '',
2502       ],
2503       'primary_key' => 'groupnum',
2504       'unique' => [ [ 'groupname' ] ],
2505       'index'  => [],
2506     },
2507
2508     'access_usergroup' => {
2509       'columns' => [
2510         'usergroupnum', 'serial', '', '', '', '',
2511         'usernum',         'int', '', '', '', '',
2512         'groupnum',        'int', '', '', '', '',
2513       ],
2514       'primary_key' => 'usergroupnum',
2515       'unique' => [ [ 'usernum', 'groupnum' ] ],
2516       'index'  => [ [ 'usernum' ] ],
2517     },
2518
2519     'access_groupagent' => {
2520       'columns' => [
2521         'groupagentnum', 'serial', '', '', '', '',
2522         'groupnum',         'int', '', '', '', '',
2523         'agentnum',         'int', '', '', '', '',
2524       ],
2525       'primary_key' => 'groupagentnum',
2526       'unique' => [ [ 'groupnum', 'agentnum' ] ],
2527       'index'  => [ [ 'groupnum' ] ],
2528     },
2529
2530     'access_right' => {
2531       'columns' => [
2532         'rightnum',   'serial', '',      '', '', '',
2533         'righttype', 'varchar', '', $char_d, '', '',
2534         'rightobjnum',   'int', '',      '', '', '',
2535         'rightname', 'varchar', '', $char_d, '', '',
2536       ],
2537       'primary_key' => 'rightnum',
2538       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2539       'index'  => [],
2540     },
2541
2542     'svc_phone' => {
2543       'columns' => [
2544         'svcnum',       'int',         '',      '', '', '',
2545         'countrycode',  'varchar',     '',       3, '', '',
2546         'phonenum',     'varchar',     '',      15, '', '',  #12 ?
2547         'pin',          'varchar', 'NULL', $char_d, '', '',
2548         'sip_password', 'varchar', 'NULL', $char_d, '', '',
2549         'phone_name',   'varchar', 'NULL', $char_d, '', '',
2550         'pbxsvc',           'int', 'NULL',      '', '', '',
2551         'domsvc',           'int', 'NULL',      '', '', '',
2552         'locationnum',      'int', 'NULL', '', '', '',
2553       ],
2554       'primary_key' => 'svcnum',
2555       'unique' => [],
2556       'index'  => [ ['countrycode', 'phonenum'], ['pbxsvc'], ['domsvc'],
2557                     ['locationnum'],
2558                   ],
2559     },
2560
2561     'phone_device' => {
2562       'columns' => [
2563         'devicenum', 'serial',     '', '', '', '',
2564         'devicepart',   'int',     '', '', '', '',
2565         'svcnum',       'int',     '', '', '', '',
2566         'mac_addr', 'varchar', 'NULL', 12, '', '',
2567       ],
2568       'primary_key' => 'devicenum',
2569       'unique' => [ [ 'mac_addr' ], ],
2570       'index'  => [ [ 'devicepart' ], [ 'svcnum' ], ],
2571     },
2572
2573     'part_device' => {
2574       'columns' => [
2575         'devicepart', 'serial',  '',      '', '', '',
2576         'devicename', 'varchar', '', $char_d, '', '',
2577         #'classnum', #tie to an inventory class?
2578       ],
2579       'primary_key' => 'devicepart',
2580       'unique' => [ [ 'devicename' ] ], #?
2581       'index'  => [],
2582     },
2583
2584     'phone_avail' => {
2585       'columns' => [
2586         'availnum',    'serial',      '',      '', '', '',
2587         'exportnum',   'int',         '',      '', '', '',
2588         'countrycode', 'varchar',     '',       3, '', '',
2589         'state',       'char',    'NULL',       2, '', '',
2590         'npa',         'char',        '',       3, '', '',
2591         'nxx',         'char',    'NULL',       3, '', '',
2592         'station',     'char',    'NULL',       4, '', '',
2593         'name',        'varchar', 'NULL', $char_d, '', '',
2594         'svcnum',      'int',     'NULL',      '', '', '',
2595         'availbatch', 'varchar',  'NULL', $char_d, '', '',
2596       ],
2597       'primary_key' => 'availnum',
2598       'unique' => [],
2599       'index'  => [ [ 'exportnum', 'countrycode', 'state' ],     #npa search
2600                     [ 'exportnum', 'countrycode', 'npa' ],       #nxx search
2601                     [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
2602                     [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
2603                     [ 'svcnum' ],
2604                     [ 'availbatch' ],
2605                   ],
2606     },
2607
2608     'reason_type' => {
2609       'columns' => [
2610         'typenum',   'serial',  '', '', '', '',
2611         'class',     'char', '', 1, '', '',
2612         'type',     'varchar', '', $char_d, '', '',
2613       ],
2614       'primary_key' => 'typenum',
2615       'unique' => [],
2616       'index' => [],
2617     },
2618
2619     'reason' => {
2620       'columns' => [
2621         'reasonnum',     'serial',  '', '', '', '',
2622         'reason_type',   'int',  '', '', '', '',
2623         'reason',        'text', '', '', '', '',
2624         'disabled',      'char',    'NULL', 1, '', '',
2625       ],
2626       'primary_key' => 'reasonnum',
2627       'unique' => [],
2628       'index' => [],
2629     },
2630
2631     'conf' => {
2632       'columns' => [
2633         'confnum',  'serial',  '', '', '', '',
2634         'agentnum', 'int',  'NULL', '', '', '',
2635         'name',     'varchar', '', $char_d, '', '',
2636         'value',    'text', 'NULL', '', '', '',
2637       ],
2638       'primary_key' => 'confnum',
2639       'unique' => [ [ 'agentnum', 'name' ]],
2640       'index' => [],
2641     },
2642
2643     'pkg_referral' => {
2644       'columns' => [
2645         'pkgrefnum',     'serial', '', '', '', '',
2646         'pkgnum',        'int',    '', '', '', '',
2647         'refnum',        'int',    '', '', '', '',
2648       ],
2649       'primary_key' => 'pkgrefnum',
2650       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
2651       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
2652     },
2653
2654     'svc_pbx' => {
2655       'columns' => [
2656         'svcnum',         'int',     '',      '', '', '',
2657         'id',             'int', 'NULL',      '', '', '',
2658         'title',      'varchar', 'NULL', $char_d, '', '',
2659         'max_extensions', 'int', 'NULL',      '', '', '',
2660       ],
2661       'primary_key' => 'svcnum',
2662       'unique' => [],
2663       'index'  => [ [ 'id' ] ],
2664     },
2665
2666     'svc_mailinglist' => { #svc_group?
2667       'columns' => [
2668         'svcnum',            'int',     '',            '', '', '',
2669         'username',      'varchar',     '', $username_len, '', '',
2670         'domsvc',            'int',     '',            '', '', '',
2671         'listnum',           'int',     '',            '', '', '',
2672         'reply_to',         'char', 'NULL',             1, '', '',#SetReplyTo
2673         'remove_from',      'char', 'NULL',             1, '', '',#RemoveAuthor
2674         'reject_auto',      'char', 'NULL',             1, '', '',#RejectAuto
2675         'remove_to_and_cc', 'char', 'NULL',             1, '', '',#RemoveToAndCc
2676       ],
2677       'primary_key' => 'svcnum',
2678       'unique' => [],
2679       'index'  => [ ['username'], ['domsvc'], ['listnum'] ],
2680     },
2681
2682     'mailinglist' => {
2683       'columns' => [
2684         'listnum',   'serial', '',      '', '', '',
2685         'listname', 'varchar', '', $char_d, '', '',
2686       ],
2687       'primary_key' => 'listnum',
2688       'unique' => [],
2689       'index'  => [],
2690     },
2691
2692     'mailinglistmember' => {
2693       'columns' => [
2694         'membernum',        'serial',     '',   '', '', '',
2695         'listnum',             'int',     '',   '', '', '',
2696         'svcnum',              'int', 'NULL',   '', '', '',
2697         'email',           'varchar', 'NULL',  255, '', '',
2698       ],
2699       'primary_key' => 'membernum',
2700       'unique'      => [],
2701       'index'       => [['listnum'],['svcnum'],['email']],
2702     },
2703
2704     'msg_template' => {
2705       'columns' => [
2706         'msgnum',     'serial',     '',      '', '', '',
2707         'msgname',   'varchar',     '', $char_d, '', '',
2708         'agentnum',      'int', 'NULL',      '', '', '',
2709         'mime_type', 'varchar',     '', $char_d, '', '',
2710         'body',         'blob', 'NULL',      '', '', '',
2711         'disabled',     'char', 'NULL',       1, '', '',
2712         'from_addr', 'varchar', 'NULL',     255, '', '',
2713       ],
2714       'primary_key' => 'msgnum',
2715       'unique'      => [ ['msgname', 'mime_type'] ],
2716       'index'       => [ ['agentnum'], ]
2717     },
2718
2719
2720     # name type nullability length default local
2721
2722     #'new_table' => {
2723     #  'columns' => [
2724     #    'num', 'serial',       '', '', '', '',
2725     #  ],
2726     #  'primary_key' => 'num',
2727     #  'unique' => [],
2728     #  'index'  => [],
2729     #},
2730
2731   };
2732
2733 }
2734
2735 =back
2736
2737 =head1 BUGS
2738
2739 =head1 SEE ALSO
2740
2741 L<DBIx::DBSchema>
2742
2743 =cut
2744
2745 1;
2746