FS/FS/Schema.pm

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