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