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