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