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.40; #0.40 for mysql upgrade fixes
   7 use DBIx::DBSchema::Table;
   8 use DBIx::DBSchema::Column;
   9 use DBIx::DBSchema::Index;
  10 #can't use this yet, dependency bs #use FS::Conf;
  11
  12 @ISA = qw(Exporter);
  13 @EXPORT_OK = qw( dbdef dbdef_dist reload_dbdef );
  14
  15 $DEBUG = 0;
  16 $me = '[FS::Schema]';
  17
  18 =head1 NAME
  19
  20 FS::Schema - Freeside database schema
  21
  22 =head1 SYNOPSYS
  23
  24     use FS::Schema qw(dbdef dbdef_dist reload_dbdef);
  25
  26     $dbdef = reload_dbdef;
  27     $dbdef = reload_dbdef "/non/standard/filename";
  28     $dbdef = dbdef;
  29     $dbdef_dist = dbdef_dist;
  30
  31 =head1 DESCRIPTION
  32
  33 This class represents the database schema.
  34
  35 =head1 METHODS
  36
  37 =over 4
  38
  39 =item reload_dbdef([FILENAME])
  40
  41 Load a database definition (see L<DBIx::DBSchema>), optionally from a
  42 non-default filename.  This command is executed at startup unless
  43 I<$FS::Schema::setup_hack> is true.  Returns a DBIx::DBSchema object.
  44
  45 =cut
  46
  47 sub reload_dbdef {
  48   my $file = shift;
  49
  50   unless ( exists $dbdef_cache{$file} ) {
  51     warn "[debug]$me loading dbdef for $file\n" if $DEBUG;
  52     $dbdef_cache{$file} = DBIx::DBSchema->load( $file )
  53       or die "can't load database schema from $file: $DBIx::DBSchema::errstr\n";
  54   } else {
  55     warn "[debug]$me re-using cached dbdef for $file\n" if $DEBUG;
  56   }
  57   $dbdef = $dbdef_cache{$file};
  58 }
  59
  60 =item dbdef
  61
  62 Returns the current database definition (represents the current database,
  63 assuming it is up-to-date).  See L<DBIx::DBSchema>.
  64
  65 =cut
  66
  67 sub dbdef { $dbdef; }
  68
  69 =item dbdef_dist [ DATASRC ]
  70
  71 Returns the current canoical database definition as defined in this file.
  72
  73 Optionally, pass a DBI data source to enable syntax specific to that database.
  74 Currently, this enables "ENGINE=InnoDB" for MySQL databases.
  75
  76 =cut
  77
  78 sub dbdef_dist {
  79   my $datasrc = @_ && !ref($_[0]) ? shift : '';
  80   my $opt = @_ ? shift : {};
  81
  82   my $local_options = '';
  83   if ( $datasrc =~ /^dbi:mysql/i ) {
  84     $local_options = 'ENGINE=InnoDB';
  85   }
  86
  87   ###
  88   # create a dbdef object from the old data structure
  89   ###
  90
  91   my $tables_hashref = tables_hashref();
  92
  93   #turn it into objects
  94   my $dbdef = new DBIx::DBSchema map {
  95
  96     my $tablename = $_;
  97     my $indexnum = 1;
  98
  99     my @columns;
 100     while (@{$tables_hashref->{$tablename}{'columns'}}) {
 101       #my($name, $type, $null, $length, $default, $local) =
 102       my @coldef =
 103         splice @{$tables_hashref->{$tablename}{'columns'}}, 0, 6;
 104       my %hash = map { $_ => shift @coldef }
 105                      qw( name type null length default local );
 106
 107       #can be removed once we depend on DBIx::DBSchema 0.39;
 108       $hash{'type'} = 'LONGTEXT'
 109         if $hash{'type'} =~ /^TEXT$/i && $datasrc =~ /^dbi:mysql/i;
 110
 111       unless ( defined $hash{'default'} ) {
 112         warn "$tablename:\n".
 113              join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
 114       }
 115
 116       push @columns, new DBIx::DBSchema::Column ( \%hash );
 117     }
 118
 119     #false laziness w/sub indices in DBIx::DBSchema::DBD (well, sorta)
 120     #and sub sql_create_table in DBIx::DBSchema::Table (slighty more?)
 121     my $unique = $tables_hashref->{$tablename}{'unique'};
 122     warn "missing index for $tablename\n" unless defined $tables_hashref->{$tablename}{'index'};
 123     my @index  = @{ $tables_hashref->{$tablename}{'index'} };
 124
 125     # kludge to avoid avoid "BLOB/TEXT column 'statustext' used in key
 126     #  specification without a key length".
 127     # better solution: teach DBIx::DBSchema to specify a default length for
 128     #  MySQL indices on text columns, or just to support an index length at all
 129     #  so we can pass something in.
 130     # best solution: eliminate need for this index in cust_main::retry_realtime
 131     @index = grep { @{$_}[0] ne 'statustext' } @index
 132       if $datasrc =~ /^dbi:mysql/i;
 133
 134     my @indices = ();
 135     push @indices, map {
 136                          DBIx::DBSchema::Index->new({
 137                            'name'    => $tablename. $indexnum++,
 138                            'unique'  => 1,
 139                            'columns' => $_,
 140                          });
 141                        }
 142                        @$unique;
 143     push @indices, map {
 144                          DBIx::DBSchema::Index->new({
 145                            'name'    => $tablename. $indexnum++,
 146                            'unique'  => 0,
 147                            'columns' => $_,
 148                          });
 149                        }
 150                        @index;
 151
 152     DBIx::DBSchema::Table->new({
 153       'name'          => $tablename,
 154       'primary_key'   => $tables_hashref->{$tablename}{'primary_key'},
 155       'columns'       => \@columns,
 156       'indices'       => \@indices,
 157       'local_options' => $local_options,
 158     });
 159
 160   } keys %$tables_hashref;
 161
 162   if ( $DEBUG ) {
 163     warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
 164     warn "[debug]$me   $_\n" foreach $dbdef->tables;
 165   }
 166
 167   #add radius attributes to svc_acct
 168   #
 169   #my($svc_acct)=$dbdef->table('svc_acct');
 170   #
 171   #my($attribute);
 172   #foreach $attribute (@attributes) {
 173   #  $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
 174   #    'radius_'. $attribute,
 175   #    'varchar',
 176   #    'NULL',
 177   #    $char_d,
 178   #  ));
 179   #}
 180   #
 181   #foreach $attribute (@check_attributes) {
 182   #  $svc_acct->addcolumn( new DBIx::DBSchema::Column (
 183   #    'rc_'. $attribute,
 184   #    'varchar',
 185   #    'NULL',
 186   #    $char_d,
 187   #  ));
 188   #}
 189
 190   my $tables_hashref_torrus = tables_hashref_torrus();
 191
 192   #create history tables (false laziness w/create-history-tables)
 193   foreach my $table (
 194     grep {    ! /^clientapi_session/
 195            && ! /^h_/
 196            && ! /^log(_context)?$/
 197            && ! /^legacy_cust_history$/
 198            && ( ! /^queue(_arg|_depend|_stat)?$/ || ! $opt->{'queue-no_history'} )
 199            && ! $tables_hashref_torrus->{$_}
 200            && ! /^cacti_page$/
 201          }
 202       $dbdef->tables
 203   ) {
 204     my $tableobj = $dbdef->table($table)
 205       or die "unknown table $table";
 206
 207     my %h_indices = ();
 208
 209     unless ( $table eq 'cust_event' || $table eq 'cdr' ) { #others?
 210
 211       my %indices = $tableobj->indices;
 212
 213       %h_indices = map {
 214                          ( "h_$_" =>
 215                              DBIx::DBSchema::Index->new({
 216                                'name'    => 'h_'. $indices{$_}->name,
 217                                'unique'  => 0,
 218                                'columns' => [ @{$indices{$_}->columns} ],
 219                              })
 220                          );
 221                        }
 222                        keys %indices;
 223
 224       $h_indices{"h_${table}_srckey"} =
 225         DBIx::DBSchema::Index->new({
 226           'name'    => "h_${table}_srckey",
 227           'unique'  => 0,
 228           'columns' => [ 'history_action', #right?
 229                          $tableobj->primary_key,
 230                        ],
 231         });
 232
 233       $h_indices{"h_${table}_srckey2"} =
 234          DBIx::DBSchema::Index->new({
 235            'name'    => "h_${table}_srckey2",
 236            'unique'  => 0,
 237            'columns' => [ 'history_date',
 238                           $tableobj->primary_key,
 239                         ],
 240          });
 241
 242     }
 243
 244     my $historynum_type = ( $tableobj->column($tableobj->primary_key)->type
 245                               =~ /^(bigserial|bigint|int8)$/i
 246                                 ? 'bigserial'
 247                                 : 'serial'
 248                           );
 249
 250     my $h_tableobj = DBIx::DBSchema::Table->new( {
 251       'name'          => "h_$table",
 252       'primary_key'   => 'historynum',
 253       'indices'       => \%h_indices,
 254       'local_options' => $local_options,
 255       'columns'       => [
 256           DBIx::DBSchema::Column->new( {
 257             'name'    => 'historynum',
 258             'type'    => $historynum_type,
 259             'null'    => 'NOT NULL',
 260             'length'  => '',
 261             'default' => '',
 262             'local'   => '',
 263           } ),
 264           DBIx::DBSchema::Column->new( {
 265             'name'    => 'history_date',
 266             'type'    => 'int',
 267             'null'    => 'NULL',
 268             'length'  => '',
 269             'default' => '',
 270             'local'   => '',
 271           } ),
 272           DBIx::DBSchema::Column->new( {
 273             'name'    => 'history_user',
 274             'type'    => 'varchar',
 275             'null'    => 'NOT NULL',
 276             'length'  => '80',
 277             'default' => '',
 278             'local'   => '',
 279           } ),
 280           DBIx::DBSchema::Column->new( {
 281             'name'    => 'history_action',
 282             'type'    => 'varchar',
 283             'null'    => 'NOT NULL',
 284             'length'  => '80',
 285             'default' => '',
 286             'local'   => '',
 287           } ),
 288           map {
 289             my $column = $tableobj->column($_);
 290
 291             #clone so as to not disturb the original
 292             $column = DBIx::DBSchema::Column->new( {
 293               map { $_ => $column->$_() }
 294                 qw( name type null length default local )
 295             } );
 296
 297             if ( $column->type =~ /^(\w*)SERIAL$/i ) {
 298               $column->type(uc($1).'INT');
 299               $column->null('NULL');
 300             }
 301             #$column->default('')
 302             #  if $column->default =~ /^nextval\(/i;
 303             #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
 304             #$column->local($local);
 305             $column;
 306           } $tableobj->columns
 307       ],
 308     } );
 309     $dbdef->addtable($h_tableobj);
 310   }
 311
 312   if ( $datasrc =~ /^dbi:mysql/i ) {
 313
 314     my $dup_lock_table = DBIx::DBSchema::Table->new( {
 315       'name'          => 'duplicate_lock',
 316       'primary_key'   => 'duplocknum',
 317       'local_options' => $local_options,
 318       'columns'       => [
 319         DBIx::DBSchema::Column->new( {
 320           'name'    => 'duplocknum',
 321           'type'    => 'serial',
 322           'null'    => 'NOT NULL',
 323           'length'  => '',
 324           'default' => '',
 325           'local'   => '',
 326         } ),
 327         DBIx::DBSchema::Column->new( {
 328           'name'    => 'lockname',
 329           'type'    => 'varchar',
 330           'null'    => 'NOT NULL',
 331           'length'  => '80',
 332           'default' => '',
 333           'local'   => '',
 334         } ),
 335       ],
 336       'indices' => { 'duplicate_lock1' =>
 337                        DBIx::DBSchema::Index->new({
 338                          'name'    => 'duplicate_lock1',
 339                          'unique'  => 1,
 340                          'columns' => [ 'lockname' ],
 341                        })
 342                    },
 343     } );
 344
 345     $dbdef->addtable($dup_lock_table);
 346
 347   }
 348
 349   $dbdef;
 350
 351 }
 352
 353 #torrus tables http://torrus.org/reporting_setup.pod.html#create_sql_tables
 354 sub tables_hashref_torrus {
 355
 356   return {
 357
 358     # Collector export table. It usually grows at several megabytes
 359     # per month, and is updated every 5 minutes
 360     'srvexport' => {
 361       'columns' => [
 362         'id',         'serial', '', '', '', '',
 363         'srv_date',     'date', '', '', '', '',#date and time of the data sample
 364         'srv_time',     'time', '', '', '', '',
 365         'serviceid', 'varchar', '', 64, '', '',#unique service ID per counter
 366         'value',     'double precision', '', '', '', '',#collected rate or gauge value
 367         'intvl', 'int', '', '', '', '', # collection interval - for counter volume calculation
 368       ],
 369       'primary_key' => 'id',
 370       'unique' => [],
 371       'index'  => [ ['srv_date'], ['srv_date', 'srv_time'], ['serviceid'], ],
 372     },
 373
 374     #Tables for (currently monthly only) report contents.
 375     #These are updated usually once per month, and read at the moment of
 376     #rendering the report output (HTML now, PDF or XML or Excel or whatever
 377     #in the future)
 378
 379     #DBIx::Sequence backend, theplatform-independent inplementation
 380     #of sequences
 381     'dbix_sequence_state' => {
 382       'columns' => [
 383         'id',       'serial', '', '', '', '',
 384         'dataset', 'varchar', '', 50, '', '',
 385         'state_id',    'int', '', '', '', '',
 386       ],
 387       'primary_key' => 'id',
 388       #CONSTRAINT pk_dbix_sequence PRIMARY KEY (dataset, state_id)
 389       'unique' => [ [ 'dataset', 'state_id' ], ],
 390       'index'  => [],
 391     },
 392
 393     'dbix_sequence_release' => {
 394       'columns' => [
 395         'id',       'serial', '', '', '', '',
 396         'dataset', 'varchar', '', 50, '', '',
 397         'released_id', 'int', '', '', '', '',
 398       ],
 399       'primary_key' => 'id',
 400       #CONSTRAINT pk_dbi_release PRIMARY KEY (dataset, released_id)
 401       'unique' => [ [ 'dataset', 'released_id', ] ],
 402       'index'  => [],
 403     },
 404
 405     #Each report is characterized by name, date and time.
 406     #Monthly reports are automatically assigned 00:00 of the 1st day
 407     #in the month. The report contains fields for every service ID
 408     #defined across all datasource trees.
 409     'reports' => {
 410       'columns' => [
 411         'id',          'serial', '', '', '', '',
 412         'rep_date',      'date', '', '', '', '',#Start date of the report
 413         'rep_time',      'time', '', '', '', '',#Start time of the report
 414         'reportname', 'varchar', '', 64, '', '',#Report name, such as
 415                                                 # MonthlyUsage
 416         'iscomplete',     'int', '', '', '', '',#0 when the report is in
 417                                                 # progress, 1 when it is ready
 418       ],
 419       'primary_key' => 'id',
 420       'unique' => [ [ qw(rep_date rep_time reportname) ] ],
 421       'index'  => [ [ 'rep_date' ] ],
 422     },
 423
 424     #Each report contains fields. For each service ID,
 425     #the report may contain several fields for various statistics.
 426     #Each field contains information about the units of the value it
 427     #contains
 428     'reportfields' => {
 429       'columns' => [
 430         'id',              'serial',     '', '',    '', '',
 431         'rep_id',             'int', 'NULL', '',    '', '',
 432         'name',           'varchar',     '', 64,    '', '',#name of the field,
 433                                                            # such as AVG or MAX
 434         'serviceid',      'varchar',     '', 64,    '', '',#service ID
 435         'value', 'double precision',     '', '',    '', '',#Numeric value
 436         'units',          'varchar',     '', 64, \"''", '',#Units, such as bytes
 437                                                            # or Mbps
 438       ],
 439       'primary_key', => 'id',
 440       'unique' => [ [ qw(rep_id name serviceid) ] ],
 441       'index'  => [],
 442     },
 443
 444   };
 445
 446 }
 447
 448 sub tables_hashref {
 449
 450   my $char_d = 80; #default maxlength for text fields
 451
 452   #my(@date_type)  = ( 'timestamp', '', ''     );
 453   my @date_type = ( 'int', 'NULL', ''     );
 454   my @perl_type = ( 'text', 'NULL', ''  );
 455   my @money_type = ( 'decimal',   '', '10,2' );
 456   my @money_typen = ( 'decimal',   'NULL', '10,2' );
 457   my @taxrate_type  = ( 'decimal',   '',     '14,8' ); # requires pg 8 for
 458   my @taxrate_typen = ( 'decimal',   'NULL', '14,8' ); # fs-upgrade to work
 459
 460   my $username_len = 64; #usernamemax config file
 461
 462     # name type nullability length default local
 463
 464   return {
 465
 466     'agent' => {
 467       'columns' => [
 468         'agentnum',          'serial',    '',       '', '', '',
 469         'agent',            'varchar',    '',  $char_d, '', '',
 470         'typenum',              'int',    '',       '', '', '',
 471         'ticketing_queueid',    'int', 'NULL',      '', '', '',
 472         'invoice_template', 'varchar', 'NULL', $char_d, '', '',
 473         'agent_custnum',        'int', 'NULL',      '', '', '',
 474         'disabled',            'char', 'NULL',       1, '', '',
 475         'username',         'varchar', 'NULL', $char_d, '', '',
 476         '_password',        'varchar', 'NULL', $char_d, '', '',
 477         'freq',              'int', 'NULL', '', '', '', #deprecated (never used)
 478         'prog',                     @perl_type, '', '', #deprecated (never used)
 479       ],
 480       'primary_key' => 'agentnum',
 481       #'unique' => [ [ 'agent_custnum' ] ], #one agent per customer?
 482                                             #insert is giving it a value, tho..
 483       #'index' => [ ['typenum'], ['disabled'] ],
 484       'unique' => [],
 485       'index' => [ ['typenum'], ['disabled'], ['agent_custnum'] ],
 486     },
 487
 488     'agent_pkg_class' => {
 489       'columns' => [
 490         'agentpkgclassnum',    'serial',     '',    '', '', '',
 491         'agentnum',               'int',     '',    '', '', '',
 492         'classnum',               'int', 'NULL',    '', '', '',
 493         'commission_percent', 'decimal',     '', '7,4', '', '',
 494       ],
 495       'primary_key' => 'agentpkgclassnum',
 496       'unique'      => [ [ 'agentnum', 'classnum' ], ],
 497       'index'       => [],
 498     },
 499
 500     'agent_type' => {
 501       'columns' => [
 502         'typenum',  'serial',      '',      '', '', '',
 503         'atype',    'varchar',     '', $char_d, '', '',
 504         'disabled',    'char', 'NULL',       1, '', '',
 505       ],
 506       'primary_key' => 'typenum',
 507       'unique' => [],
 508       'index' => [ ['disabled'] ],
 509     },
 510
 511     'type_pkgs' => {
 512       'columns' => [
 513         'typepkgnum', 'serial', '', '', '', '',
 514         'typenum',   'int',  '', '', '', '',
 515         'pkgpart',   'int',  '', '', '', '',
 516       ],
 517       'primary_key' => 'typepkgnum',
 518       'unique' => [ ['typenum', 'pkgpart'] ],
 519       'index' => [ ['typenum'] ],
 520     },
 521
 522     'sales' => {
 523       'columns' => [
 524         'salesnum',          'serial',    '',       '', '', '',
 525         'salesperson',      'varchar',    '',  $char_d, '', '',
 526         'agentnum',             'int', 'NULL',      '', '', '',
 527         'sales_custnum',        'int', 'NULL',      '', '', '',
 528         'disabled',            'char', 'NULL',       1, '', '',
 529       ],
 530       'primary_key' => 'salesnum',
 531       'unique' => [],
 532       'index' => [ ['salesnum'], ['disabled'] ],
 533     },
 534
 535     'sales_pkg_class' => {
 536       'columns' => [
 537         'salespkgclassnum',    'serial',     '',    '', '', '',
 538         'salesnum',               'int',     '',    '', '', '',
 539         'classnum',               'int', 'NULL',    '', '', '',
 540         'commission_percent', 'decimal',     '', '7,4', '', '',
 541         'commission_duration',    'int', 'NULL',    '', '', '',
 542       ],
 543       'primary_key' => 'salespkgclassnum',
 544       'unique'      => [ [ 'salesnum', 'classnum' ], ],
 545       'index'       => [],
 546     },
 547
 548     'cust_attachment' => {
 549       'columns' => [
 550         'attachnum', 'serial', '', '', '', '',
 551         'custnum',   'int', '', '', '', '',
 552         '_date',     @date_type, '', '',
 553         'otaker',    'varchar', 'NULL', 32, '', '',
 554         'usernum',   'int', 'NULL', '', '', '',
 555         'filename',  'varchar', '', 255, '', '',
 556         'mime_type', 'varchar', '', $char_d, '', '',
 557         'title',     'varchar', 'NULL', $char_d, '', '',
 558         'body',      'blob', 'NULL', '', '', '',
 559         'disabled',  @date_type, '', '',
 560       ],
 561       'primary_key' => 'attachnum',
 562       'unique'      => [],
 563       'index'       => [ ['custnum'], ['usernum'], ],
 564     },
 565
 566     'cust_bill' => {
 567       'columns' => [
 568         #regular fields
 569         'invnum',    'serial',     '', '', '', '',
 570         'custnum',      'int',     '', '', '', '',
 571         '_date',        @date_type,        '', '',
 572         'charged',      @money_type,       '', '',
 573         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 574
 575         #customer balance info at invoice generation time
 576         #(deprecated)
 577         'previous_balance',   @money_typen, '', '',  #eventually not nullable
 578         'billing_balance',    @money_typen, '', '',  #eventually not nullable
 579
 580         #deprecated (unused by now, right?)
 581         'printed',      'int',     '', '', '', '',
 582
 583         #specific use cases
 584         'closed',      'char', 'NULL',  1, '', '', #not yet used much
 585         'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
 586         'agent_invid',  'int', 'NULL', '', '', '', #(varchar?) importing legacy
 587         'promised_date', @date_type,       '', '',
 588       ],
 589       'primary_key' => 'invnum',
 590       'unique' => [ [ 'custnum', 'agent_invid' ] ], #agentnum?  huh
 591       'index' => [ ['custnum'], ['_date'], ['statementnum'], ['agent_invid'] ],
 592     },
 593
 594     'cust_bill_void' => {
 595       'columns' => [
 596         #regular fields
 597         'invnum',       'int',     '', '', '', '',
 598         'custnum',      'int',     '', '', '', '',
 599         '_date',        @date_type,        '', '',
 600         'charged',      @money_type,       '', '',
 601         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 602
 603         #customer balance info at invoice generation time
 604         'previous_balance',   @money_typen, '', '',  #eventually not nullable
 605         'billing_balance',    @money_typen, '', '',  #eventually not nullable
 606
 607         #specific use cases
 608         'closed',      'char', 'NULL',  1, '', '', #not yet used much
 609         'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
 610         'agent_invid',  'int', 'NULL', '', '', '', #(varchar?) importing legacy
 611         'promised_date', @date_type,       '', '',
 612
 613         #void fields
 614         'void_date', @date_type, '', '',
 615         'reason',    'varchar',   'NULL', $char_d, '', '',
 616         'void_usernum',   'int', 'NULL', '', '', '',
 617       ],
 618       'primary_key' => 'invnum',
 619       'unique' => [ [ 'custnum', 'agent_invid' ] ], #agentnum?  huh
 620       'index' => [ ['custnum'], ['_date'], ['statementnum'], ['agent_invid'], [ 'void_usernum' ] ],
 621     },
 622
 623     #for importing invoices from a legacy system for display purposes only
 624     # no effect upon balance
 625     'legacy_cust_bill' => {
 626       'columns' => [
 627         'legacyinvnum',  'serial',     '',      '', '', '',
 628         'legacyid',     'varchar', 'NULL', $char_d, '', '',
 629         'custnum',          'int',     '',      '', '', '',
 630         '_date',       @date_type,                  '', '',
 631         'charged',    @money_type,                  '', '',
 632         'content_pdf',     'blob', 'NULL',      '', '', '',
 633         'content_html',    'text', 'NULL',      '', '', '',
 634         'locale',       'varchar', 'NULL',      16, '', '',
 635       ],
 636       'primary_key' => 'legacyinvnum',
 637       'unique' => [],
 638       'index'  => [ ['legacyid', 'custnum', 'locale' ], ],
 639     },
 640
 641     'legacy_cust_history' => {
 642       'columns' => [
 643         'legacyhistorynum', 'serial',     '',        '', '', '',
 644         'custnum',             'int',     '',        '', '', '',
 645         'history_action',  'varchar',     '',   $char_d, '', '',
 646         'history_date',           @date_type,            '', '',
 647         'history_usernum',     'int', 'NULL',        '', '', '',
 648         'item',            'varchar', 'NULL',   $char_d, '', '',
 649         'description',     'varchar', 'NULL', 2*$char_d, '', '',
 650         'change_data',        'text', 'NULL',        '', '', '',
 651       ],
 652       'primary_key'  => 'legacyhistorynum',
 653       'unique'       => [],
 654       'index'        => [ ['custnum'], ['history_date'], ],
 655     },
 656
 657     'cust_statement' => {
 658       'columns' => [
 659         'statementnum', 'serial', '', '', '', '',
 660         'custnum',         'int', '', '', '', '',
 661         '_date',           @date_type,    '', '',
 662       ],
 663       'primary_key' => 'statementnum',
 664       'unique' => [],
 665       'index' => [ ['custnum'], ['_date'], ],
 666     },
 667
 668     'cust_bill_event' => {
 669       'columns' => [
 670         'eventnum',    'serial',  '', '', '', '',
 671         'invnum',   'int',  '', '', '', '',
 672         'eventpart',   'int',  '', '', '', '',
 673         '_date',     @date_type, '', '',
 674         'status', 'varchar', '', $char_d, '', '',
 675         'statustext', 'text', 'NULL', '', '', '',
 676       ],
 677       'primary_key' => 'eventnum',
 678       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 679       'unique' => [],
 680       'index' => [ ['invnum'], ['status'], ['eventpart'],
 681                    ['statustext'], ['_date'],
 682                  ],
 683     },
 684
 685     'part_bill_event' => {
 686       'columns' => [
 687         'eventpart',    'serial',  '', '', '', '',
 688         'freq',        'varchar',       'NULL',     $char_d, '', '',
 689         'payby',       'char',  '', 4, '', '',
 690         'event',       'varchar',           '',     $char_d, '', '',
 691         'eventcode',    @perl_type, '', '',
 692         'seconds',     'int', 'NULL', '', '', '',
 693         'weight',      'int', '', '', '', '',
 694         'plan',       'varchar', 'NULL', $char_d, '', '',
 695         'plandata',   'text', 'NULL', '', '', '',
 696         'reason',     'int', 'NULL', '', '', '',
 697         'disabled',     'char', 'NULL', 1, '', '',
 698       ],
 699       'primary_key' => 'eventpart',
 700       'unique' => [],
 701       'index' => [ ['payby'], ['disabled'], ],
 702     },
 703
 704     'part_event' => {
 705       'columns' => [
 706         'eventpart',   'serial',      '',      '', '', '',
 707         'agentnum',    'int',     'NULL',      '', '', '',
 708         'event',       'varchar',     '', $char_d, '', '',
 709         'eventtable',  'varchar',     '', $char_d, '', '',
 710         'check_freq',  'varchar', 'NULL', $char_d, '', '',
 711         'weight',      'int',         '',      '', '', '',
 712         'action',      'varchar',     '', $char_d, '', '',
 713         'disabled',     'char',   'NULL',       1, '', '',
 714       ],
 715       'primary_key' => 'eventpart',
 716       'unique' => [],
 717       'index' => [ ['agentnum'], ['eventtable'], ['check_freq'], ['disabled'], ],
 718     },
 719
 720     'part_event_option' => {
 721       'columns' => [
 722         'optionnum', 'serial', '', '', '', '',
 723         'eventpart', 'int', '', '', '', '',
 724         'optionname', 'varchar', '', $char_d, '', '',
 725         'optionvalue', 'text', 'NULL', '', '', '',
 726       ],
 727       'primary_key' => 'optionnum',
 728       'unique'      => [],
 729       'index'       => [ [ 'eventpart' ], [ 'optionname' ] ],
 730     },
 731
 732     'part_event_condition' => {
 733       'columns' => [
 734         'eventconditionnum', 'serial', '', '', '', '',
 735         'eventpart', 'int', '', '', '', '',
 736         'conditionname', 'varchar', '', $char_d, '', '',
 737       ],
 738       'primary_key' => 'eventconditionnum',
 739       'unique'      => [],
 740       'index'       => [ [ 'eventpart' ], [ 'conditionname' ] ],
 741     },
 742
 743     'part_event_condition_option' => {
 744       'columns' => [
 745         'optionnum', 'serial', '', '', '', '',
 746         'eventconditionnum', 'int', '', '', '', '',
 747         'optionname', 'varchar', '', $char_d, '', '',
 748         'optionvalue', 'text', 'NULL', '', '', '',
 749       ],
 750       'primary_key' => 'optionnum',
 751       'unique'      => [],
 752       'index'       => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
 753     },
 754
 755     'part_event_condition_option_option' => {
 756       'columns' => [
 757         'optionoptionnum', 'serial', '', '', '', '',
 758         'optionnum', 'int', '', '', '', '',
 759         'optionname', 'varchar', '', $char_d, '', '',
 760         'optionvalue', 'text', 'NULL', '', '', '',
 761       ],
 762       'primary_key' => 'optionoptionnum',
 763       'unique'      => [],
 764       'index'       => [ [ 'optionnum' ], [ 'optionname' ] ],
 765     },
 766
 767     'cust_event' => {
 768       'columns' => [
 769         'eventnum',    'serial',  '', '', '', '',
 770         'eventpart',   'int',  '', '', '', '',
 771         'tablenum',   'int',  '', '', '', '',
 772         '_date',     @date_type, '', '',
 773         'status', 'varchar', '', $char_d, '', '',
 774         'statustext', 'text', 'NULL', '', '', '',
 775       ],
 776       'primary_key' => 'eventnum',
 777       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 778       'unique' => [],
 779       'index' => [ ['eventpart'], ['tablenum'], ['status'],
 780                    ['statustext'], ['_date'],
 781                  ],
 782     },
 783
 784     'cust_event_fee' => {
 785       'columns' => [
 786         'eventfeenum', 'serial', '', '', '', '',
 787         'eventnum',       'int', '', '', '', '',
 788         'billpkgnum',     'int', 'NULL', '', '', '',
 789         'feepart',        'int', '', '', '', '',
 790         'nextbill',      'char', 'NULL',  1, '', '',
 791       ],
 792       'primary_key'  => 'eventfeenum', # I'd rather just use eventnum
 793       'unique' => [ [ 'billpkgnum' ], [ 'eventnum' ] ], # one-to-one link
 794       'index'  => [ [ 'feepart' ] ],
 795     },
 796
 797     'cust_bill_pkg' => {
 798       'columns' => [
 799         'billpkgnum',        'serial',     '',      '', '', '',
 800         'invnum',               'int',     '',      '', '', '',
 801         'pkgnum',               'int',     '',      '', '', '',
 802         'pkgpart_override',     'int', 'NULL',      '', '', '',
 803         'setup',               @money_type,             '', '',
 804         'recur',               @money_type,             '', '',
 805         'sdate',               @date_type,              '', '',
 806         'edate',               @date_type,              '', '',
 807         'itemdesc',         'varchar', 'NULL', $char_d, '', '',
 808         'itemcomment',      'varchar', 'NULL', $char_d, '', '',
 809         'section',          'varchar', 'NULL', $char_d, '', '',
 810         'freq',             'varchar', 'NULL', $char_d, '', '',
 811         'quantity',             'int', 'NULL',      '', '', '',
 812         'unitsetup',           @money_typen,            '', '',
 813         'unitrecur',           @money_typen,            '', '',
 814         'hidden',              'char', 'NULL',       1, '', '',
 815         'feepart',              'int', 'NULL',      '', '', '',
 816       ],
 817       'primary_key' => 'billpkgnum',
 818       'unique' => [],
 819       'index' => [ ['invnum'], [ 'pkgnum' ], [ 'itemdesc' ], ],
 820     },
 821
 822     'cust_bill_pkg_detail' => {
 823       'columns' => [
 824         'detailnum', 'serial', '', '', '', '',
 825         'billpkgnum', 'int', 'NULL', '', '', '',        # should not be nullable
 826         'pkgnum',  'int', 'NULL', '', '', '',           # deprecated
 827         'invnum',  'int', 'NULL', '', '', '',           # deprecated
 828         'amount',  'decimal', 'NULL', '10,4', '', '',
 829         'format',  'char', 'NULL', 1, '', '',
 830         'classnum', 'int', 'NULL', '', '', '',
 831         'duration', 'int', 'NULL', '',  0, '',
 832         'phonenum', 'varchar', 'NULL', 25, '', '',
 833         'accountcode', 'varchar',  'NULL',      32, '', '',
 834         'startdate',  @date_type, '', '',
 835         'regionname', 'varchar', 'NULL', $char_d, '', '',
 836         'detail',  'varchar', '', 255, '', '',
 837       ],
 838       'primary_key' => 'detailnum',
 839       'unique' => [],
 840       'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
 841     },
 842
 843     'cust_bill_pkg_display' => {
 844       'columns' => [
 845         'billpkgdisplaynum', 'serial', '', '', '', '',
 846         'billpkgnum', 'int', '', '', '', '',
 847         'section',  'varchar', 'NULL', $char_d, '', '',
 848         #'unitsetup', @money_typen, '', '',     #override the linked real one?
 849         #'unitrecur', @money_typen, '', '',     #this too?
 850         'post_total', 'char', 'NULL', 1, '', '',
 851         'type',       'char', 'NULL', 1, '', '',
 852         'summary',    'char', 'NULL', 1, '', '',
 853       ],
 854       'primary_key' => 'billpkgdisplaynum',
 855       'unique' => [],
 856       'index' => [ ['billpkgnum'], ],
 857     },
 858
 859     'cust_bill_pkg_fee' => {
 860       'columns' => [
 861         'billpkgfeenum',    'serial', '', '', '', '',
 862         'billpkgnum',          'int', '', '', '', '',
 863         'base_invnum',       'int', '', '', '', '',
 864         'base_billpkgnum',   'int', 'NULL', '', '', '',
 865         'amount',        @money_type,         '', '',
 866       ],
 867       'primary_key' => 'billpkgfeenum',
 868       'unique'      => [],
 869       'index'       => [ ['billpkgnum'],
 870                          ['base_invnum'],
 871                          ['base_billpkgnum'],
 872                        ],
 873     },
 874
 875     'cust_bill_pkg_fee_void' => {
 876       'columns' => [
 877         'billpkgfeenum',    'serial', '', '', '', '',
 878         'billpkgnum',          'int', '', '', '', '',
 879         'base_invnum',       'int', '', '', '', '',
 880         'base_billpkgnum',   'int', 'NULL', '', '', '',
 881         'amount',        @money_type,         '', '',
 882       ],
 883       'primary_key' => 'billpkgfeenum',
 884       'unique'      => [],
 885       'index'       => [ ['billpkgnum'],
 886                          ['base_invnum'],
 887                          ['base_billpkgnum'],
 888                        ],
 889     },
 890
 891
 892     'cust_bill_pkg_tax_location' => {
 893       'columns' => [
 894         'billpkgtaxlocationnum', 'serial',      '', '', '', '',
 895         'billpkgnum',               'int',      '', '', '', '',
 896         'taxnum',                   'int',      '', '', '', '',
 897         'taxtype',              'varchar',      '', $char_d, '', '',
 898         'pkgnum',                   'int',      '', '', '', '', #redundant
 899         'locationnum',              'int',      '', '', '', '', #redundant
 900         'amount',                   @money_type,        '', '',
 901         'taxable_billpkgnum',       'int',  'NULL', '', '', '',
 902       ],
 903       'primary_key' => 'billpkgtaxlocationnum',
 904       'unique' => [],
 905       'index'  => [ [ 'billpkgnum' ],
 906                     [ 'taxnum' ],
 907                     [ 'pkgnum' ],
 908                     [ 'locationnum' ],
 909                     [ 'taxable_billpkgnum' ],
 910                   ],
 911     },
 912
 913     'cust_bill_pkg_tax_rate_location' => {
 914       'columns' => [
 915         'billpkgtaxratelocationnum', 'serial',      '', '', '', '',
 916         'billpkgnum',                   'int',      '', '', '', '',
 917         'taxnum',                       'int',      '', '', '', '',
 918         'taxtype',                  'varchar',      '', $char_d, '', '',
 919         'locationtaxid',            'varchar',  'NULL', $char_d, '', '',
 920         'taxratelocationnum',           'int',      '', '', '', '',
 921         'amount',                       @money_type,        '', '',
 922         'taxable_billpkgnum',       'int',  'NULL', '', '', '',
 923         'taxclass',             'varchar',  'NULL', 10, '', '',
 924       ],
 925       'primary_key' => 'billpkgtaxratelocationnum',
 926       'unique' => [],
 927       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'taxratelocationnum' ],
 928                     [ 'taxable_billpkgnum' ], ],
 929     },
 930
 931     'cust_bill_pkg_void' => {
 932       'columns' => [
 933         'billpkgnum',           'int',     '',      '', '', '',
 934         'invnum',               'int',     '',      '', '', '',
 935         'pkgnum',               'int',     '',      '', '', '',
 936         'pkgpart_override',     'int', 'NULL',      '', '', '',
 937         'setup',               @money_type,             '', '',
 938         'recur',               @money_type,             '', '',
 939         'sdate',               @date_type,              '', '',
 940         'edate',               @date_type,              '', '',
 941         'itemdesc',         'varchar', 'NULL', $char_d, '', '',
 942         'itemcomment',      'varchar', 'NULL', $char_d, '', '',
 943         'section',          'varchar', 'NULL', $char_d, '', '',
 944         'freq',             'varchar', 'NULL', $char_d, '', '',
 945         'quantity',             'int', 'NULL',      '', '', '',
 946         'unitsetup',           @money_typen,            '', '',
 947         'unitrecur',           @money_typen,            '', '',
 948         'hidden',              'char', 'NULL',       1, '', '',
 949         'feepart',              'int', 'NULL',      '', '', '',
 950         #void fields
 951         'void_date', @date_type, '', '',
 952         'reason',    'varchar',   'NULL', $char_d, '', '',
 953         'void_usernum',   'int', 'NULL', '', '', '',
 954       ],
 955       'primary_key' => 'billpkgnum',
 956       'unique' => [],
 957       'index' => [ ['invnum'], [ 'pkgnum' ], [ 'itemdesc' ], [ 'void_usernum' ], ],
 958     },
 959
 960     'cust_bill_pkg_detail_void' => {
 961       'columns' => [
 962         'detailnum',  'int', '', '', '', '',
 963         'billpkgnum', 'int', 'NULL', '', '', '',        # should not be nullable
 964         'pkgnum',  'int', 'NULL', '', '', '',           # deprecated
 965         'invnum',  'int', 'NULL', '', '', '',           # deprecated
 966         'amount',  'decimal', 'NULL', '10,4', '', '',
 967         'format',  'char', 'NULL', 1, '', '',
 968         'classnum', 'int', 'NULL', '', '', '',
 969         'duration', 'int', 'NULL', '',  0, '',
 970         'phonenum', 'varchar', 'NULL', 25, '', '',
 971         'accountcode', 'varchar',  'NULL',      32, '', '',
 972         'startdate',  @date_type, '', '',
 973         'regionname', 'varchar', 'NULL', $char_d, '', '',
 974         'detail',  'varchar', '', 255, '', '',
 975       ],
 976       'primary_key' => 'detailnum',
 977       'unique' => [],
 978       'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
 979     },
 980
 981     'cust_bill_pkg_display_void' => {
 982       'columns' => [
 983         'billpkgdisplaynum',    'int', '', '', '', '',
 984         'billpkgnum', 'int', '', '', '', '',
 985         'section',  'varchar', 'NULL', $char_d, '', '',
 986         #'unitsetup', @money_typen, '', '',     #override the linked real one?
 987         #'unitrecur', @money_typen, '', '',     #this too?
 988         'post_total', 'char', 'NULL', 1, '', '',
 989         'type',       'char', 'NULL', 1, '', '',
 990         'summary',    'char', 'NULL', 1, '', '',
 991       ],
 992       'primary_key' => 'billpkgdisplaynum',
 993       'unique' => [],
 994       'index' => [ ['billpkgnum'], ],
 995     },
 996
 997     'cust_bill_pkg_tax_location_void' => {
 998       'columns' => [
 999         'billpkgtaxlocationnum',    'int',      '', '', '', '',
1000         'billpkgnum',               'int',      '', '', '', '',
1001         'taxnum',                   'int',      '', '', '', '',
1002         'taxtype',              'varchar',      '', $char_d, '', '',
1003         'pkgnum',                   'int',      '', '', '', '',
1004         'locationnum',              'int',      '', '', '', '', #redundant?
1005         'amount',                   @money_type,        '', '',
1006         'taxable_billpkgnum',       'int',  'NULL', '', '', '',
1007       ],
1008       'primary_key' => 'billpkgtaxlocationnum',
1009       'unique' => [],
1010       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'pkgnum' ], [ 'locationnum' ] ],
1011     },
1012
1013     'cust_bill_pkg_tax_rate_location_void' => {
1014       'columns' => [
1015         'billpkgtaxratelocationnum',    'int',      '', '', '', '',
1016         'billpkgnum',                   'int',      '', '', '', '',
1017         'taxnum',                       'int',      '', '', '', '',
1018         'taxtype',                  'varchar',      '', $char_d, '', '',
1019         'locationtaxid',            'varchar',  'NULL', $char_d, '', '',
1020         'taxratelocationnum',           'int',      '', '', '', '',
1021         'amount',                       @money_type,        '', '',
1022       ],
1023       'primary_key' => 'billpkgtaxratelocationnum',
1024       'unique' => [],
1025       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'taxratelocationnum' ] ],
1026     },
1027
1028     'cust_credit' => {
1029       'columns' => [
1030         'crednum',  'serial', '', '', '', '',
1031         'custnum',  'int', '', '', '', '',
1032         '_date',    @date_type, '', '',
1033         'amount',   @money_type, '', '',
1034         'otaker',   'varchar', 'NULL', 32, '', '',
1035         'usernum',   'int', 'NULL', '', '', '',
1036         'reason',   'text', 'NULL', '', '', '',
1037         'reasonnum', 'int', 'NULL', '', '', '',
1038         'addlinfo', 'text', 'NULL', '', '', '',
1039         'closed',    'char', 'NULL', 1, '', '',
1040         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1041         'eventnum', 'int', 'NULL', '', '', '', #triggering event for commission
1042         'commission_agentnum', 'int', 'NULL', '', '', '', #
1043         'commission_salesnum', 'int', 'NULL', '', '', '', #
1044         'commission_pkgnum',   'int', 'NULL', '', '', '', #
1045         'credbatch',    'varchar', 'NULL', $char_d, '', '',
1046       ],
1047       'primary_key' => 'crednum',
1048       'unique' => [],
1049       'index' => [ ['custnum'], ['_date'], ['usernum'], ['eventnum'],
1050                    ['commission_salesnum'], ['credbatch'],
1051                  ],
1052     },
1053
1054     'cust_credit_void' => {
1055       'columns' => [
1056         'crednum',  'serial',     '', '', '', '',
1057         'custnum',     'int',     '', '', '', '',
1058         '_date',  @date_type,             '', '',
1059         'amount',@money_type,             '', '',
1060         'currency',   'char', 'NULL',  3, '', '',
1061         'otaker',  'varchar', 'NULL', 32, '', '',
1062         'usernum',     'int', 'NULL', '', '', '',
1063         'reason',     'text', 'NULL', '', '', '',
1064         'reasonnum',   'int', 'NULL', '', '', '',
1065         'addlinfo',   'text', 'NULL', '', '', '',
1066         'closed',     'char', 'NULL',  1, '', '',
1067         'pkgnum',      'int', 'NULL', '', '','',
1068         'eventnum',    'int', 'NULL', '', '','',
1069         'commission_agentnum', 'int', 'NULL', '', '', '',
1070         'commission_salesnum', 'int', 'NULL', '', '', '',
1071         'commission_pkgnum',   'int', 'NULL', '', '', '',
1072         #void fields
1073         'void_date',  @date_type,                  '', '',
1074         'void_reason', 'varchar', 'NULL', $char_d, '', '',
1075         'void_reasonnum', 'int', 'NULL', '', '', '',
1076         'void_usernum',    'int', 'NULL',      '', '', '',
1077       ],
1078       'primary_key' => 'crednum',
1079       'unique' => [],
1080       'index' => [ ['custnum'], ['_date'], ['usernum'], ['eventnum'],
1081                    [ 'commission_salesnum' ],
1082                  ],
1083     },
1084
1085
1086     'cust_credit_bill' => {
1087       'columns' => [
1088         'creditbillnum', 'serial', '', '', '', '',
1089         'crednum',  'int', '', '', '', '',
1090         'invnum',  'int', '', '', '', '',
1091         '_date',    @date_type, '', '',
1092         'amount',   @money_type, '', '',
1093         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1094       ],
1095       'primary_key' => 'creditbillnum',
1096       'unique' => [],
1097       'index' => [ ['crednum'], ['invnum'] ],
1098     },
1099
1100     'cust_credit_bill_pkg' => {
1101       'columns' => [
1102         'creditbillpkgnum', 'serial', '',      '', '', '',
1103         'creditbillnum',       'int', '',      '', '', '',
1104         'billpkgnum',          'int', '',      '', '', '',
1105         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
1106         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
1107         'amount',            @money_type,          '', '',
1108         'setuprecur',      'varchar', '', $char_d, '', '',
1109         'sdate',   @date_type, '', '',
1110         'edate',   @date_type, '', '',
1111       ],
1112       'primary_key' => 'creditbillpkgnum',
1113       'unique'      => [],
1114       'index'       => [ [ 'creditbillnum' ],
1115                          [ 'billpkgnum' ],
1116                          [ 'billpkgtaxlocationnum' ],
1117                          [ 'billpkgtaxratelocationnum' ],
1118                        ],
1119     },
1120
1121     'cust_main' => {
1122       'columns' => [
1123         'custnum',  'serial',  '',     '', '', '',
1124         'agentnum', 'int',  '',     '', '', '',
1125         'salesnum', 'int',  'NULL', '', '', '',
1126         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
1127         'classnum', 'int', 'NULL', '', '', '',
1128         'custbatch', 'varchar', 'NULL', $char_d, '', '',
1129 #        'titlenum', 'int',  'NULL',   '', '', '',
1130         'last',     'varchar', '',   2*$char_d, '', '',
1131 #        'middle',   'varchar', 'NULL', $char_d, '', '',
1132         'first',    'varchar', '',     $char_d, '', '',
1133         'ss',       'varchar', 'NULL', 11, '', '',
1134         'stateid', 'varchar', 'NULL', $char_d, '', '',
1135         'stateid_state', 'varchar', 'NULL', $char_d, '', '',
1136         'national_id', 'varchar', 'NULL', $char_d, '', '',
1137         'birthdate' ,@date_type, '', '',
1138         'spouse_last',  'varchar', 'NULL', 2*$char_d, '', '',
1139         'spouse_first', 'varchar', 'NULL', $char_d, '', '',
1140         'spouse_birthdate', @date_type, '', '',
1141         'anniversary_date', @date_type, '', '',
1142         'signupdate',@date_type, '', '',
1143         'dundate',   @date_type, '', '',
1144         'company',  'varchar', 'NULL', $char_d, '', '',
1145         'address1', 'varchar', 'NULL', $char_d, '', '',
1146         'address2', 'varchar', 'NULL', $char_d, '', '',
1147         'city',     'varchar', 'NULL', $char_d, '', '',
1148         'county',   'varchar', 'NULL', $char_d, '', '',
1149         'state',    'varchar', 'NULL', $char_d, '', '',
1150         'zip',      'varchar', 'NULL', 10, '', '',
1151         'country',  'char',    'NULL',  2, '', '',
1152         'latitude', 'decimal', 'NULL', '10,7', '', '',
1153         'longitude','decimal', 'NULL', '10,7', '', '',
1154         'coord_auto',  'char', 'NULL',  1, '', '',
1155         'addr_clean',  'char', 'NULL',  1, '', '',
1156         'daytime',  'varchar', 'NULL', 20, '', '',
1157         'night',    'varchar', 'NULL', 20, '', '',
1158         'fax',      'varchar', 'NULL', 12, '', '',
1159         'mobile',   'varchar', 'NULL', 12, '', '',
1160         'ship_last',     'varchar', 'NULL', 2*$char_d, '', '',
1161 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '',
1162         'ship_first',    'varchar', 'NULL', $char_d, '', '',
1163         'ship_company',  'varchar', 'NULL', $char_d, '', '',
1164         'ship_address1', 'varchar', 'NULL', $char_d, '', '',
1165         'ship_address2', 'varchar', 'NULL', $char_d, '', '',
1166         'ship_city',     'varchar', 'NULL', $char_d, '', '',
1167         'ship_county',   'varchar', 'NULL', $char_d, '', '',
1168         'ship_state',    'varchar', 'NULL', $char_d, '', '',
1169         'ship_zip',      'varchar', 'NULL', 10, '', '',
1170         'ship_country',  'char', 'NULL', 2, '', '',
1171         'ship_latitude', 'decimal', 'NULL', '10,7', '', '',
1172         'ship_longitude','decimal', 'NULL', '10,7', '', '',
1173         'ship_coord_auto',  'char', 'NULL',  1, '', '',
1174         'ship_addr_clean',  'char', 'NULL',  1, '', '',
1175         'ship_daytime',  'varchar', 'NULL', 20, '', '',
1176         'ship_night',    'varchar', 'NULL', 20, '', '',
1177         'ship_fax',      'varchar', 'NULL', 12, '', '',
1178         'ship_mobile',   'varchar', 'NULL', 12, '', '',
1179         'payby',    'char', '',     4, '', '',
1180         'payinfo',  'varchar', 'NULL', 512, '', '',
1181         'paycvv',   'varchar', 'NULL', 512, '', '',
1182         'paymask', 'varchar', 'NULL', $char_d, '', '',
1183         #'paydate',  @date_type, '', '',
1184         'paydate',  'varchar', 'NULL', 10, '', '',
1185         'paystart_month', 'int', 'NULL', '', '', '',
1186         'paystart_year',  'int', 'NULL', '', '', '',
1187         'payissue', 'varchar', 'NULL', 2, '', '',
1188         'payname',  'varchar', 'NULL', 2*$char_d, '', '',
1189         'paystate', 'varchar', 'NULL', $char_d, '', '',
1190         'paytype',  'varchar', 'NULL', $char_d, '', '',
1191         'payip',    'varchar', 'NULL', 15, '', '',
1192         'geocode',  'varchar', 'NULL', 20,  '', '',
1193         'censustract', 'varchar', 'NULL', 20,  '', '', # 7 to save space?
1194         'censusyear', 'char', 'NULL', 4, '', '',
1195         'district', 'varchar', 'NULL', 20, '', '',
1196         'tax',      'char', 'NULL', 1, '', '',
1197         'otaker',   'varchar', 'NULL',    32, '', '',
1198         'usernum',   'int', 'NULL', '', '', '',
1199         'refnum',   'int',  '',     '', '', '',
1200         'referral_custnum', 'int',  'NULL', '', '', '',
1201         'comments', 'text', 'NULL', '', '', '',
1202         'spool_cdr','char', 'NULL', 1, '', '',
1203         'squelch_cdr','char', 'NULL', 1, '', '',
1204         'cdr_termination_percentage', 'decimal', 'NULL', '7,4', '', '',
1205         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
1206         'credit_limit', @money_typen, '', '',
1207         'archived', 'char', 'NULL', 1, '', '',
1208         'email_csv_cdr', 'char', 'NULL', 1, '', '',
1209         'accountcode_cdr', 'char', 'NULL', 1, '', '',
1210         'billday',   'int', 'NULL', '', '', '',
1211         'prorate_day',   'int', 'NULL', '', '', '',
1212         'edit_subject', 'char', 'NULL', 1, '', '',
1213         'locale', 'varchar', 'NULL', 16, '', '',
1214         'calling_list_exempt', 'char', 'NULL', 1, '', '',
1215         'invoice_noemail', 'char', 'NULL', 1, '', '',
1216         'message_noemail', 'char', 'NULL', 1, '', '',
1217         'bill_locationnum', 'int', 'NULL', '', '', '',
1218         'ship_locationnum', 'int', 'NULL', '', '', '',
1219         'invoice_ship_address', 'char', 'NULL', 1, '', '',
1220       ],
1221       'primary_key' => 'custnum',
1222       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
1223       #'index' => [ ['last'], ['company'] ],
1224       'index' => [
1225                    [ 'agentnum' ], [ 'refnum' ], [ 'classnum' ], [ 'usernum' ],
1226                    [ 'custbatch' ],
1227                    [ 'referral_custnum' ],
1228                    [ 'payby' ], [ 'paydate' ],
1229                    [ 'archived' ],
1230                    [ 'ship_locationnum' ],
1231                    [ 'bill_locationnum' ],
1232                  ],
1233     },
1234
1235     'cust_recon' => {  # (some sort of not-well understood thing for OnPac)
1236       'columns' => [
1237         'reconid',      'serial',  '',          '', '', '',
1238         'recondate',    @date_type,                 '', '',
1239         'custnum',      'int'   ,  '',          '', '', '',
1240         'agentnum',     'int',     '',          '', '', '',
1241         'last',         'varchar', '',     $char_d, '', '',
1242         'first',        'varchar', '',     $char_d, '', '',
1243         'address1',     'varchar', '',     $char_d, '', '',
1244         'address2',     'varchar', 'NULL', $char_d, '', '',
1245         'city',         'varchar', '',     $char_d, '', '',
1246         'state',        'varchar', 'NULL', $char_d, '', '',
1247         'zip',          'varchar', 'NULL',      10, '', '',
1248         'pkg',          'varchar', 'NULL', $char_d, '', '',
1249         'adjourn',      @date_type,                 '', '',
1250         'status',       'varchar', 'NULL',      10, '', '',
1251         'agent_custid', 'varchar',  '',    $char_d, '', '',
1252         'agent_pkg',    'varchar', 'NULL', $char_d, '', '',
1253         'agent_adjourn', @date_type,                '', '',
1254         'comments',     'text',    'NULL',      '', '', '',
1255       ],
1256       'primary_key' => 'reconid',
1257       'unique' => [],
1258       'index' => [],
1259     },
1260
1261     'contact_class' => {
1262       'columns' => [
1263         'classnum',    'serial',   '',      '', '', '',
1264         'classname',   'varchar',  '', $char_d, '', '',
1265         'disabled',    'char', 'NULL',       1, '', '',
1266       ],
1267       'primary_key' => 'classnum',
1268       'unique' => [],
1269       'index' => [ ['disabled'] ],
1270     },
1271
1272     'contact' => {
1273       'columns' => [
1274         'contactnum', 'serial',     '',      '', '', '',
1275         'prospectnum',   'int', 'NULL',      '', '', '',
1276         'custnum',       'int', 'NULL',      '', '', '',
1277         'locationnum',   'int', 'NULL',      '', '', '', #not yet
1278         'classnum',      'int', 'NULL',      '', '', '',
1279 #        'titlenum',      'int', 'NULL',      '', '', '', #eg Mr. Mrs. Dr. Rev.
1280         'last',      'varchar',     '', $char_d, '', '',
1281 #        'middle',    'varchar', 'NULL', $char_d, '', '',
1282         'first',     'varchar',     '', $char_d, '', '',
1283         'title',     'varchar', 'NULL', $char_d, '', '', #eg Head Bottle Washer
1284         'comment',   'varchar', 'NULL',     255, '', '',
1285         'selfservice_access',    'char', 'NULL',       1, '', '',
1286         '_password',          'varchar', 'NULL', $char_d, '', '',
1287         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1288         'disabled',              'char', 'NULL',       1, '', '',
1289       ],
1290       'primary_key' => 'contactnum',
1291       'unique'      => [],
1292       'index'       => [ [ 'prospectnum' ], [ 'custnum' ], [ 'locationnum' ],
1293                          [ 'last' ], [ 'first' ],
1294                        ],
1295     },
1296
1297     'contact_phone' => {
1298       'columns' => [
1299         'contactphonenum', 'serial',     '', '', '', '',
1300         'contactnum',         'int',     '', '', '', '',
1301         'phonetypenum',       'int',     '', '', '', '',
1302         'countrycode',    'varchar',     '',  3, '', '',
1303         'phonenum',       'varchar',     '', 14, '', '',
1304         'extension',      'varchar', 'NULL',  7, '', '',
1305         #?#'comment',        'varchar',     '', $char_d, '', '',
1306       ],
1307       'primary_key' => 'contactphonenum',
1308       'unique'      => [],
1309       'index'       => [],
1310     },
1311
1312     'phone_type' => {
1313       'columns' => [
1314         'phonetypenum',  'serial', '',      '', '', '',
1315         'typename',     'varchar', '', $char_d, '', '',
1316         'weight',           'int', '',      '', '', '',
1317       ],
1318       'primary_key' => 'phonetypenum',
1319       'unique'      => [ [ 'typename' ], ],
1320       'index'       => [],
1321     },
1322
1323     'contact_email' => {
1324       'columns' => [
1325         'contactemailnum', 'serial', '',      '', '', '',
1326         'contactnum',         'int', '',      '', '', '',
1327         'emailaddress',   'varchar', '', $char_d, '', '',
1328       ],
1329       'primary_key' => 'contactemailnum',
1330       #'unique'       => [ [ 'contactnum', 'emailaddress' ], ],
1331       'unique'       => [ [ 'emailaddress' ], ],
1332       'index'       => [],
1333     },
1334
1335     'prospect_main' => {
1336       'columns' => [
1337         'prospectnum',  'serial',     '',      '', '', '',
1338         'agentnum',        'int',     '',      '', '', '',
1339         'company',     'varchar', 'NULL', $char_d, '', '',
1340         'add_date',   @date_type,                  '', '',
1341         'disabled',       'char', 'NULL',       1, '', '',
1342         'custnum',         'int', 'NULL',      '', '', '',
1343         'refnum',          'int', 'NULL',      '', '', '',
1344       ],
1345       'primary_key' => 'prospectnum',
1346       'unique'      => [],
1347       'index'        => [ ['company'], ['agentnum'], ['disabled'], ['refnum'] ],
1348     },
1349
1350     'quotation' => {
1351       'columns' => [
1352         #regular fields
1353         'quotationnum',   'serial',     '', '', '', '',
1354         'prospectnum',       'int', 'NULL', '', '', '',
1355         'custnum',           'int', 'NULL', '', '', '',
1356         '_date',        @date_type,             '', '',
1357         'disabled',         'char', 'NULL',  1, '', '',
1358         'usernum',           'int', 'NULL', '', '', '',
1359         #'total',      @money_type,       '', '',
1360         #'quotation_term', 'varchar', 'NULL', $char_d, '', '',
1361       ],
1362       'primary_key' => 'quotationnum',
1363       'unique' => [],
1364       'index' => [ [ 'prospectnum' ], ['custnum'], ['disabled'], ],
1365     },
1366
1367     'quotation_pkg' => {
1368       'columns' => [
1369         'quotationpkgnum',   'serial',     '', '', '', '',
1370         'quotationnum',         'int', 'NULL', '', '', '', #shouldn't be null,
1371                                                            # but history...
1372         'pkgpart',              'int',     '', '', '', '',
1373         'locationnum',          'int', 'NULL', '', '', '',
1374         'start_date',      @date_type,             '', '',
1375         'contract_end',    @date_type,             '', '',
1376         'quantity',             'int', 'NULL', '', '', '',
1377         'waive_setup',         'char', 'NULL',  1, '', '',
1378         'unitsetup',     @money_typen,             '', '',
1379         'unitrecur',     @money_typen,             '', '',
1380       ],
1381       'primary_key' => 'quotationpkgnum',
1382       'unique' => [],
1383       'index' => [ ['pkgpart'], ],
1384     },
1385
1386     'quotation_pkg_discount' => {
1387       'columns' => [
1388         'quotationpkgdiscountnum', 'serial', '', '', '', '',
1389         'quotationpkgnum',            'int', '', '', '', '',
1390         'discountnum',                'int', '', '', '', '',
1391         'setup_amount',        @money_typen,         '', '',
1392         'recur_amount',        @money_typen,         '', '',
1393         #'end_date',              @date_type,         '', '',
1394       ],
1395       'primary_key' => 'quotationpkgdiscountnum',
1396       'unique' => [],
1397       'index'  => [ [ 'quotationpkgnum' ], ], #[ 'discountnum' ] ],
1398     },
1399
1400     'quotation_pkg_tax' => {
1401       'columns' => [
1402         'quotationtaxnum',  'serial',     '',      '', '', '',
1403         'quotationpkgnum',     'int',     '',      '', '', '',
1404         'itemdesc',        'varchar',     '', $char_d, '', '',
1405         'taxnum',              'int',     '',      '', '', '',
1406         'taxtype',         'varchar',     '', $char_d, '', '',
1407         'setup_amount',    @money_type,                '', '',
1408         'recur_amount',    @money_type,                '', '',
1409       ],
1410       'primary_key' => 'quotationtaxnum',,
1411       'unique' => [],
1412       'index'  => [ [ 'quotationpkgnum' ] ],
1413     },
1414
1415     'cust_location' => { #'location' now that its prospects too, but...
1416       'columns' => [
1417         'locationnum',      'serial',     '',      '', '', '',
1418         'prospectnum',         'int', 'NULL',      '', '', '',
1419         'custnum',             'int', 'NULL',      '', '', '',
1420         'locationname',    'varchar', 'NULL', $char_d, '', '',
1421         'address1',        'varchar',     '', $char_d, '', '',
1422         'address2',        'varchar', 'NULL', $char_d, '', '',
1423         'city',            'varchar',     '', $char_d, '', '',
1424         'county',          'varchar', 'NULL', $char_d, '', '',
1425         'state',           'varchar', 'NULL', $char_d, '', '',
1426         'zip',             'varchar', 'NULL',      10, '', '',
1427         'latitude',        'decimal', 'NULL',  '10,7', '', '',
1428         'longitude',       'decimal', 'NULL',  '10,7', '', '',
1429         'coord_auto',         'char', 'NULL',       1, '', '',
1430         'addr_clean',         'char', 'NULL',       1, '', '',
1431         'country',            'char',     '',       2, '', '',
1432         'geocode',         'varchar', 'NULL',      20, '', '',
1433         'district',        'varchar', 'NULL',      20, '', '',
1434         'censustract',     'varchar', 'NULL',      20, '', '',
1435         'censusyear',         'char', 'NULL',       4, '', '',
1436         'location_type',   'varchar', 'NULL',      20, '', '',
1437         'location_number', 'varchar', 'NULL',      20, '', '',
1438         'location_kind',      'char', 'NULL',       1, '', '',
1439         'disabled',           'char', 'NULL',       1, '', '',
1440       ],
1441       'primary_key' => 'locationnum',
1442       'unique'      => [],
1443       'index'       => [ [ 'prospectnum' ], [ 'custnum' ],
1444                          [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
1445                          [ 'city' ], [ 'district' ]
1446                        ],
1447     },
1448
1449     'cust_main_invoice' => {
1450       'columns' => [
1451         'destnum',  'serial',  '',     '', '', '',
1452         'custnum',  'int',  '',     '', '', '',
1453         'dest',     'varchar', '',  $char_d, '', '',
1454       ],
1455       'primary_key' => 'destnum',
1456       'unique' => [],
1457       'index' => [ ['custnum'], ],
1458     },
1459
1460     'cust_main_credit_limit' => {
1461       'columns' => [
1462         'creditlimitnum',   'serial', '', '', '', '',
1463         'custnum',             'int', '', '', '', '',
1464         '_date',          @date_type,         '', '',
1465         'amount',       @money_typen,         '', '',
1466         #'amount_currency', 'char', 'NULL',  3, '', '',
1467         'credit_limit', @money_typen,         '', '',
1468         #'credit_limit_currency', 'char', 'NULL',  3, '', '',
1469       ],
1470       'primary_key'  => 'creditlimitnum',
1471       'unique'       => [],
1472       'index'        => [ ['custnum'], ],
1473     },
1474
1475     'cust_main_note' => {
1476       'columns' => [
1477         'notenum',   'serial',    '',  '', '', '',
1478         'custnum',      'int',    '',  '', '', '',
1479         'classnum',     'int', 'NULL', '', '', '',
1480         '_date',          @date_type,      '', '',
1481         'otaker',   'varchar', 'NULL', 32, '', '',
1482         'usernum',      'int', 'NULL', '', '', '',
1483         'comments',    'text', 'NULL', '', '', '',
1484         'sticky',       'int',     '', '',  0, '',
1485       ],
1486       'primary_key' => 'notenum',
1487       'unique' => [],
1488       'index' => [ [ 'custnum' ], [ '_date' ], [ 'usernum' ], ],
1489     },
1490
1491     'cust_note_class' => {
1492       'columns' => [
1493         'classnum',    'serial',   '',      '', '', '',
1494         'classname',   'varchar',  '', $char_d, '', '',
1495         'disabled',    'char', 'NULL',       1, '', '',
1496       ],
1497       'primary_key' => 'classnum',
1498       'unique' => [],
1499       'index' => [ ['disabled'] ],
1500     },
1501
1502     'cust_category' => {
1503       'columns' => [
1504         'categorynum',   'serial',  '', '', '', '',
1505         'categoryname',  'varchar', '', $char_d, '', '',
1506         'weight',         'int', 'NULL',  '', '', '',
1507         'disabled',      'char', 'NULL',   1, '', '',
1508       ],
1509       'primary_key' => 'categorynum',
1510       'unique' => [],
1511       'index' => [ ['disabled'] ],
1512     },
1513
1514     'cust_class' => {
1515       'columns' => [
1516         'classnum',     'serial',     '',      '', '', '',
1517         'classname',   'varchar',     '', $char_d, '', '',
1518         'categorynum',     'int', 'NULL',      '', '', '',
1519         'tax',            'char', 'NULL',       1, '', '',
1520         'disabled',       'char', 'NULL',       1, '', '',
1521       ],
1522       'primary_key' => 'classnum',
1523       'unique' => [],
1524       'index' => [ ['disabled'] ],
1525     },
1526
1527     'cust_tag' => {
1528       'columns' => [
1529         'custtagnum', 'serial', '', '', '', '',
1530         'custnum',       'int', '', '', '', '',
1531         'tagnum',        'int', '', '', '', '',
1532       ],
1533       'primary_key' => 'custtagnum',
1534       'unique'      => [ [ 'custnum', 'tagnum' ] ],
1535       'index'       => [ [ 'custnum' ] ],
1536     },
1537
1538     'part_tag' => {
1539       'columns' => [
1540         'tagnum',    'serial',     '',      '', '', '',
1541         'tagname',  'varchar',     '', $char_d, '', '',
1542         'tagdesc',  'varchar', 'NULL', $char_d, '', '',
1543         'tagcolor', 'varchar', 'NULL',       6, '', '',
1544         'by_default',  'char', 'NULL',       1, '', '',
1545         'disabled',    'char', 'NULL',       1, '', '',
1546       ],
1547       'primary_key' => 'tagnum',
1548       'unique'      => [], #[ [ 'tagname' ] ], #?
1549       'index'       => [ [ 'disabled' ] ],
1550     },
1551
1552     'cust_main_exemption' => {
1553       'columns' => [
1554         'exemptionnum',   'serial',     '',      '', '', '',
1555         'custnum',           'int',     '',      '', '', '',
1556         'taxname',       'varchar',     '', $char_d, '', '',
1557         'exempt_number', 'varchar', 'NULL', $char_d, '', '',
1558         #start/end dates?  for reporting?
1559       ],
1560       'primary_key' => 'exemptionnum',
1561       'unique'      => [],
1562       'index'       => [ [ 'custnum' ] ],
1563     },
1564
1565     'cust_tax_adjustment' => {
1566       'columns' => [
1567         'adjustmentnum', 'serial',     '',      '', '', '',
1568         'custnum',          'int',     '',      '', '', '',
1569         'taxname',      'varchar',     '', $char_d, '', '',
1570         'amount',    @money_type,                   '', '',
1571         'comment',     'varchar',  'NULL', $char_d, '', '',
1572         'billpkgnum',       'int', 'NULL',      '', '', '',
1573         #more?  no cust_bill_pkg_tax_location?
1574       ],
1575       'primary_key' => 'adjustmentnum',
1576       'unique'      => [],
1577       'index'       => [ [ 'custnum' ], [ 'billpkgnum' ] ],
1578     },
1579
1580     'cust_main_county' => { #district+city+county+state+country are checked
1581                             #off the cust_main_county for validation and to
1582                             #provide a tax rate.
1583       'columns' => [
1584         'taxnum',   'serial',   '',    '', '', '',
1585         'district', 'varchar',  'NULL',    20, '', '',
1586         'city',     'varchar',  'NULL',    $char_d, '', '',
1587         'county',   'varchar',  'NULL',    $char_d, '', '',
1588         'state',    'varchar',  'NULL',    $char_d, '', '',
1589         'country',  'char',  '', 2, '', '',
1590         'taxclass',   'varchar', 'NULL', $char_d, '', '',
1591         'exempt_amount', @money_type, '', '',
1592         'tax',      'real',  '',    '', '', '', #tax %
1593         'taxname',  'varchar',  'NULL',    $char_d, '', '',
1594         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
1595         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
1596       ],
1597       'primary_key' => 'taxnum',
1598       'unique' => [],
1599   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
1600       'index' => [ [ 'district' ], [ 'city' ], [ 'county' ], [ 'state' ],
1601                    [ 'country' ],
1602                    [ 'taxclass' ],
1603                  ],
1604     },
1605
1606     'tax_rate'    => {
1607       'columns' => [
1608         'taxnum',       'serial',     '',      '', '', '',
1609         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
1610         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
1611         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
1612         'taxclassnum', 'int',      '',      '', '', '',
1613         'effective_date', @date_type, '', '',
1614         'tax',        @taxrate_type,      '', '',        # tax %
1615         'excessrate', @taxrate_typen,     '', '',        # second tax %
1616         'taxbase',    @money_typen, '', '',              # amount at first tax rate
1617         'taxmax',     @money_typen, '', '',              # maximum about at both rates
1618         'usetax',        @taxrate_typen,     '', '',     # tax % when non-local
1619         'useexcessrate', @taxrate_typen,     '', '',     # second tax % when non-local
1620         'unittype',    'int',  'NULL', '', '', '',      # for fee
1621         'fee',         @taxrate_typen,     '', '',      # amount tax per unit
1622         'excessfee',   @taxrate_typen,     '', '',      # second amount tax per unit
1623         'feebase',     @taxrate_typen,     '', '',      # units taxed at first rate
1624         'feemax',      @taxrate_typen,     '', '',      # maximum number of unit taxed
1625         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
1626         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
1627         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
1628         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
1629         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
1630         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
1631         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
1632         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
1633         'inoutcity',   'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1634         'inoutlocal',  'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1635         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
1636         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
1637       ],
1638       'primary_key' => 'taxnum',
1639       'unique' => [],
1640       'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
1641     },
1642
1643     'tax_rate_location' => {
1644       'columns' => [
1645         'taxratelocationnum', 'serial',  '',     '', '', '',
1646         'data_vendor',        'varchar', 'NULL', $char_d, '', '',
1647         'geocode',            'varchar', '',     20,      '', '',
1648         'city',               'varchar', 'NULL', $char_d, '', '',
1649         'county',             'varchar', 'NULL', $char_d, '', '',
1650         'state',              'char',    'NULL',       2, '', '',
1651         'disabled',           'char',    'NULL', 1, '', '',
1652       ],
1653       'primary_key' => 'taxratelocationnum',
1654       'unique' => [],
1655       'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
1656     },
1657
1658     'cust_tax_location' => {
1659       'columns' => [
1660         'custlocationnum', 'serial',  '',     '', '', '',
1661         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
1662         'city',            'varchar', 'NULL', $char_d, '', '',
1663         'postalcity',      'varchar', 'NULL', $char_d, '', '',
1664         'county',          'varchar', 'NULL', $char_d, '', '',
1665         'zip',             'char',    '',     5,  '', '',
1666         'state',           'char',    '',     2,  '', '',
1667         'plus4hi',         'char',    'NULL', 4,  '', '',
1668         'plus4lo',         'char',    'NULL', 4,  '', '',
1669         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
1670         'cityflag',        'char',    'NULL', 1,  '', '', # I(n)/O(out)/B(oth)/NULL
1671         'geocode',         'varchar', '',    20,  '', '',
1672       ],
1673       'primary_key' => 'custlocationnum',
1674       'unique' => [],
1675       'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
1676     },
1677
1678     'tax_class' => {
1679       'columns' => [
1680         'taxclassnum',  'serial',  '',            '', '', '',
1681         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
1682         'taxclass',     'varchar', '',       $char_d, '', '',
1683         'description',  'varchar', '',     2*$char_d, '', '',
1684       ],
1685       'primary_key' => 'taxclassnum',
1686       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
1687       'index' => [],
1688     },
1689
1690     'cust_pay_pending' => {
1691       'columns' => [
1692         'paypendingnum','serial',      '',  '', '', '',
1693         'custnum',      'int',         '',  '', '', '',
1694         'paid',         @money_type,            '', '',
1695         '_date',        @date_type,             '', '',
1696         'payby',        'char',        '',   4, '', '', #CARD/BILL/COMP, should
1697                                                         # be index into payby
1698                                                         # table eventually
1699         'payinfo',      'varchar', 'NULL', 512, '', '', #see cust_main above
1700         'paymask',      'varchar', 'NULL', $char_d, '', '',
1701         'paydate',      'varchar', 'NULL', 10, '', '',
1702         'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
1703         #'paybatch',     'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1704         'payunique',    'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1705
1706         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1707         'status',       'varchar',     '', $char_d, '', '',
1708         'session_id',   'varchar', 'NULL', 1024, '', '', # SHA-512-hex
1709         'statustext',   'text',    'NULL',  '', '', '',
1710         'gatewaynum',   'int',     'NULL',  '', '', '',
1711         #'cust_balance', @money_type,            '', '',
1712         'paynum',       'int',     'NULL',  '', '', '',
1713         'void_paynum',  'int',     'NULL',  '', '', '',
1714         'jobnum',    'bigint',     'NULL',  '', '', '',
1715         'invnum',       'int',     'NULL',  '', '', '',
1716         'manual',       'char',    'NULL',   1, '', '',
1717         'discount_term','int',     'NULL',  '', '', '',
1718       ],
1719       'primary_key' => 'paypendingnum',
1720       'unique'      => [ [ 'payunique' ] ],
1721       'index'       => [ [ 'custnum' ], [ 'status' ], ],
1722     },
1723
1724     'cust_pay' => {
1725       'columns' => [
1726         'paynum',   'serial',    '',   '', '', '',
1727         'custnum',  'int',    '',   '', '', '',
1728         '_date',    @date_type, '', '',
1729         'paid',     @money_type, '', '',
1730         'otaker',   'varchar', 'NULL', 32, '', '',
1731         'usernum',   'int', 'NULL', '', '', '',
1732         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1733                                                  # index into payby table
1734                                                  # eventually
1735         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
1736         'paymask', 'varchar', 'NULL', $char_d, '', '',
1737         'paydate',  'varchar', 'NULL', 10, '', '',
1738         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1739         'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1740         'closed',    'char', 'NULL', 1, '', '',
1741         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1742         # cash/check deposit info fields
1743         'bank',       'varchar', 'NULL', $char_d, '', '',
1744         'depositor',  'varchar', 'NULL', $char_d, '', '',
1745         'account',    'varchar', 'NULL', 20,      '', '',
1746         'teller',     'varchar', 'NULL', 20,      '', '',
1747
1748         'batchnum',       'int', 'NULL', '', '', '', #pay_batch foreign key
1749
1750         # credit card/EFT fields (formerly in paybatch)
1751         'gatewaynum',     'int', 'NULL', '', '', '', # payment_gateway FK
1752         'processor',  'varchar', 'NULL', $char_d, '', '', # module name
1753         'auth',       'varchar','NULL',16, '', '', # CC auth number
1754         'order_number','varchar','NULL',$char_d, '', '', # transaction number
1755       ],
1756       'primary_key' => 'paynum',
1757       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
1758       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ], [ 'usernum' ] ],
1759     },
1760
1761     'cust_pay_void' => {
1762       'columns' => [
1763         'paynum',    'int',    '',   '', '', '',
1764         'custnum',   'int',    '',   '', '', '',
1765         '_date',     @date_type, '', '',
1766         'paid',      @money_type, '', '',
1767         'otaker',   'varchar', 'NULL', 32, '', '',
1768         'usernum',   'int', 'NULL', '', '', '',
1769         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1770                                                   # index into payby table
1771                                                   # eventually
1772         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
1773         'paymask', 'varchar', 'NULL', $char_d, '', '',
1774         #'paydate' ?
1775         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1776         'closed',    'char', 'NULL', 1, '', '',
1777         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1778         # cash/check deposit info fields
1779         'bank',       'varchar', 'NULL', $char_d, '', '',
1780         'depositor',  'varchar', 'NULL', $char_d, '', '',
1781         'account',    'varchar', 'NULL', 20,      '', '',
1782         'teller',     'varchar', 'NULL', 20,      '', '',
1783         'batchnum',       'int', 'NULL', '', '', '', #pay_batch foreign key
1784
1785         # credit card/EFT fields (formerly in paybatch)
1786         'gatewaynum',     'int', 'NULL', '', '', '', # payment_gateway FK
1787         'processor',  'varchar', 'NULL', $char_d, '', '', # module name
1788         'auth',       'varchar','NULL',16, '', '', # CC auth number
1789         'order_number', 'varchar','NULL',$char_d, '', '', # transaction number
1790
1791         #void fields
1792         'void_date', @date_type, '', '',
1793         'reason',    'varchar',   'NULL', $char_d, '', '',
1794         'void_usernum',   'int', 'NULL', '', '', '',
1795       ],
1796       'primary_key' => 'paynum',
1797       'unique' => [],
1798       'index' => [ [ 'custnum' ], [ 'usernum' ], [ 'void_usernum' ] ],
1799     },
1800
1801     'cust_bill_pay' => {
1802       'columns' => [
1803         'billpaynum', 'serial',     '',   '', '', '',
1804         'invnum',  'int',     '',   '', '', '',
1805         'paynum',  'int',     '',   '', '', '',
1806         'amount',  @money_type, '', '',
1807         '_date',   @date_type, '', '',
1808         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1809       ],
1810       'primary_key' => 'billpaynum',
1811       'unique' => [],
1812       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
1813     },
1814
1815     'cust_bill_pay_batch' => {
1816       'columns' => [
1817         'billpaynum', 'serial',     '',   '', '', '',
1818         'invnum',  'int',     '',   '', '', '',
1819         'paybatchnum',  'int',     '',   '', '', '',
1820         'amount',  @money_type, '', '',
1821         '_date',   @date_type, '', '',
1822       ],
1823       'primary_key' => 'billpaynum',
1824       'unique' => [],
1825       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1826     },
1827
1828     'cust_bill_pay_pkg' => {
1829       'columns' => [
1830         'billpaypkgnum', 'serial', '', '', '', '',
1831         'billpaynum',       'int', '', '', '', '',
1832         'billpkgnum',       'int', '', '', '', '',
1833         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
1834         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
1835         'amount',         @money_type,     '', '',
1836         'setuprecur',      'varchar', '', $char_d, '', '',
1837         'sdate',   @date_type, '', '',
1838         'edate',   @date_type, '', '',
1839       ],
1840       'primary_key' => 'billpaypkgnum',
1841       'unique'      => [],
1842       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1843     },
1844
1845     'pay_batch' => { #batches of payments to an external processor
1846       'columns' => [
1847         'batchnum', 'serial',     '', '', '', '',
1848         'agentnum',    'int', 'NULL', '', '', '',
1849         'payby',      'char',     '',  4, '', '', # CARD/CHEK
1850         'status',     'char', 'NULL',  1, '', '',
1851         'download',       @date_type,     '', '',
1852         'upload',         @date_type,     '', '',
1853         'title',   'varchar', 'NULL',255, '', '',
1854         'processor_id',   'varchar', 'NULL',255, '', '',
1855       ],
1856       'primary_key' => 'batchnum',
1857       'unique' => [],
1858       'index' => [],
1859     },
1860
1861     'cust_pay_batch' => { #list of customers in current CARD/CHEK batch
1862       'columns' => [
1863         'paybatchnum',   'serial',    '',   '', '', '',
1864         'batchnum',   'int',    '',   '', '', '',
1865         'invnum',   'int',    '',   '', '', '',
1866         'custnum',   'int',    '',   '', '', '',
1867         'last',     'varchar', '',     $char_d, '', '',
1868         'first',    'varchar', '',     $char_d, '', '',
1869         'address1', 'varchar', '',     $char_d, '', '',
1870         'address2', 'varchar', 'NULL', $char_d, '', '',
1871         'city',     'varchar', '',     $char_d, '', '',
1872         'state',    'varchar', 'NULL', $char_d, '', '',
1873         'zip',      'varchar', 'NULL', 10, '', '',
1874         'country',  'char', '',     2, '', '',
1875         #        'trancode', 'int', '', '', '', ''
1876         'payby',    'char',        '',       4, '', '',
1877         'payinfo',  'varchar', 'NULL',     512, '', '',
1878         #'exp',      @date_type, '', ''
1879         'exp',      'varchar', 'NULL',      11, '', '',
1880         'payname',  'varchar', 'NULL', $char_d, '', '',
1881         'amount',   @money_type, '', '',
1882         'status',   'varchar', 'NULL', $char_d, '', '',
1883         'error_message',   'varchar', 'NULL', $char_d, '', '',
1884       ],
1885       'primary_key' => 'paybatchnum',
1886       'unique' => [],
1887       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1888     },
1889
1890     'fcc477map' => {
1891       'columns' => [
1892         'formkey',   'varchar',     '', 255, '', '',
1893         'formvalue',    'text', 'NULL',  '', '', '',
1894       ],
1895       'primary_key' => 'formkey',
1896       'unique'      => [],
1897       'index'       => [],
1898     },
1899
1900     'cust_pkg' => {
1901       'columns' => [
1902         'pkgnum',           'serial',     '', '', '', '',
1903         'custnum',             'int',     '', '', '', '',
1904         'pkgpart',             'int',     '', '', '', '',
1905         'pkgbatch',        'varchar', 'NULL', $char_d, '', '',
1906         'contactnum',          'int', 'NULL', '', '', '',
1907         'locationnum',         'int', 'NULL', '', '', '',
1908         'otaker',          'varchar', 'NULL', 32, '', '',
1909         'usernum',             'int', 'NULL', '', '', '',
1910         'salesnum',            'int', 'NULL', '', '', '',
1911         'order_date',     @date_type,             '', '',
1912         'start_date',     @date_type,             '', '',
1913         'setup',          @date_type,             '', '',
1914         'bill',           @date_type,             '', '',
1915         'last_bill',      @date_type,             '', '',
1916         'susp',           @date_type,             '', '',
1917         'adjourn',        @date_type,             '', '',
1918         'resume',         @date_type,             '', '',
1919         'cancel',         @date_type,             '', '',
1920         'uncancel',       @date_type,             '', '',
1921         'uncancel_pkgnum',     'int', 'NULL', '', '', '',
1922         'expire',         @date_type,             '', '',
1923         'contract_end',   @date_type,             '', '',
1924         'dundate',        @date_type,             '', '',
1925         'change_date',    @date_type,             '', '',
1926         'change_pkgnum',       'int', 'NULL', '', '', '',
1927         'change_pkgpart',      'int', 'NULL', '', '', '',
1928         'change_locationnum',  'int', 'NULL', '', '', '',
1929         'change_custnum',      'int', 'NULL', '', '', '',
1930         'main_pkgnum',         'int', 'NULL', '', '', '',
1931         'pkglinknum',          'int', 'NULL', '', '', '',
1932         'manual_flag',        'char', 'NULL',  1, '', '',
1933         'no_auto',            'char', 'NULL',  1, '', '',
1934         'quantity',            'int', 'NULL', '', '', '',
1935         'agent_pkgid',     'varchar', 'NULL', $char_d, '', '',
1936         'waive_setup',        'char', 'NULL',  1, '', '',
1937         'recur_show_zero',    'char', 'NULL',  1, '', '',
1938         'setup_show_zero',    'char', 'NULL',  1, '', '',
1939         'change_to_pkgnum',    'int', 'NULL', '', '', '',
1940         'separate_bill',      'char', 'NULL',  1, '', '',
1941       ],
1942       'primary_key' => 'pkgnum',
1943       'unique' => [],
1944       'index' => [ ['custnum'], ['pkgpart'], [ 'pkgbatch' ], [ 'locationnum' ],
1945                    [ 'usernum' ], [ 'agent_pkgid' ],
1946                    ['order_date'], [ 'start_date' ], ['setup'], ['bill'],
1947                    ['last_bill'], ['susp'], ['adjourn'], ['resume'],
1948                    ['cancel'], ['expire'], ['contract_end'],
1949                    ['change_date'],
1950                    ['no_auto'],
1951                    #['contactnum'],
1952                    ['salesnum'],
1953                    #['uncancel_pkgnum'],
1954                    #['change_pkgnum'], ['change_locationnum'],
1955                    #['change_custnum'],
1956                    ['main_pkgnum'],
1957                    #['pkglinknum'], ['change_to_pkgnum'],
1958                  ],
1959     },
1960
1961     'cust_pkg_option' => {
1962       'columns' => [
1963         'optionnum', 'serial', '', '', '', '',
1964         'pkgnum', 'int', '', '', '', '',
1965         'optionname', 'varchar', '', $char_d, '', '',
1966         'optionvalue', 'text', 'NULL', '', '', '',
1967       ],
1968       'primary_key' => 'optionnum',
1969       'unique'      => [],
1970       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
1971     },
1972
1973     'cust_pkg_detail' => {
1974       'columns' => [
1975         'pkgdetailnum', 'serial', '',        '', '', '',
1976         'pkgnum',          'int', '',        '', '', '',
1977         'detail',      'varchar', '', 2*$char_d, '', '',
1978         'detailtype',     'char', '',         1, '', '', #"I"nvoice or "C"omment
1979         'weight',          'int', '',        '', '', '',
1980       ],
1981       'primary_key' => 'pkgdetailnum',
1982       'unique' => [],
1983       'index'  => [ [ 'pkgnum', 'detailtype' ] ],
1984     },
1985
1986     'cust_pkg_reason' => {
1987       'columns' => [
1988         'num',      'serial',    '',   '', '', '',
1989         'pkgnum',   'int',    '',   '', '', '',
1990         'reasonnum','int',    '',   '', '', '',
1991         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
1992         'otaker',   'varchar', 'NULL', 32, '', '',
1993         'usernum',   'int', 'NULL', '', '', '',
1994         'date',     @date_type, '', '',
1995       ],
1996       'primary_key' => 'num',
1997       'unique' => [],
1998       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], [ 'usernum' ], ],
1999     },
2000
2001     'cust_pkg_reason_fee' => {
2002       'columns' => [
2003         'pkgreasonfeenum', 'serial', '', '', '', '',
2004         'pkgreasonnum',       'int', '', '', '', '',
2005         'billpkgnum',         'int', 'NULL', '', '', '',
2006         'feepart',            'int', '', '', '', '',
2007         'nextbill',          'char', 'NULL',  1, '', '',
2008       ],
2009       'primary_key'  => 'pkgreasonfeenum',
2010       'unique' => [ [ 'billpkgnum' ], [ 'pkgreasonnum' ] ], # one-to-one link
2011       'index'  => [ [ 'feepart' ] ],
2012     },
2013
2014     'cust_pkg_discount' => {
2015       'columns' => [
2016         'pkgdiscountnum', 'serial', '',        '', '', '',
2017         'pkgnum',            'int', '',        '', '', '',
2018         'discountnum',       'int', '',        '', '', '',
2019         'months_used',   'decimal', 'NULL', '7,4', '', '',
2020         'end_date',     @date_type,                '', '',
2021         'otaker',        'varchar', 'NULL',    32, '', '',
2022         'usernum',           'int', 'NULL',    '', '', '',
2023         'disabled',         'char', 'NULL',     1, '', '',
2024       ],
2025       'primary_key' => 'pkgdiscountnum',
2026       'unique' => [],
2027       'index'  => [ [ 'pkgnum' ], [ 'discountnum' ], [ 'usernum' ], ],
2028     },
2029
2030     'cust_pkg_usage' => {
2031       'columns' => [
2032         'pkgusagenum', 'serial', '', '', '', '',
2033         'pkgnum',         'int', '', '', '', '',
2034         'minutes',        'double precision', '', '', '', '',
2035         'pkgusagepart',   'int', '', '', '', '',
2036       ],
2037       'primary_key' => 'pkgusagenum',
2038       'unique' => [],
2039       'index'  => [ [ 'pkgnum' ], [ 'pkgusagepart' ] ],
2040     },
2041
2042     'cdr_cust_pkg_usage' => {
2043       'columns' => [
2044         'cdrusagenum', 'bigserial', '', '', '', '',
2045         'acctid',      'bigint',    '', '', '', '',
2046         'pkgusagenum', 'int',       '', '', '', '',
2047         'minutes',     'double precision',       '', '', '', '',
2048       ],
2049       'primary_key' => 'cdrusagenum',
2050       'unique' => [],
2051       'index'  => [ [ 'pkgusagenum' ], [ 'acctid' ] ],
2052     },
2053
2054     'cust_bill_pkg_discount' => {
2055       'columns' => [
2056         'billpkgdiscountnum', 'serial',        '', '', '', '',
2057         'billpkgnum',            'int',        '', '', '', '',
2058         'pkgdiscountnum',        'int',        '', '', '', '',
2059         'amount',          @money_type,                '', '',
2060         'months',            'decimal', 'NULL', '7,4', '', '',
2061       ],
2062       'primary_key' => 'billpkgdiscountnum',
2063       'unique' => [],
2064       'index' => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
2065     },
2066
2067     'cust_bill_pkg_discount_void' => {
2068       'columns' => [
2069         'billpkgdiscountnum',    'int',        '', '', '', '',
2070         'billpkgnum',            'int',        '', '', '', '',
2071         'pkgdiscountnum',        'int',        '', '', '', '',
2072         'amount',          @money_type,                '', '',
2073         'months',            'decimal', 'NULL', '7,4', '', '',
2074       ],
2075       'primary_key' => 'billpkgdiscountnum',
2076       'unique' => [],
2077       'index' => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
2078     },
2079
2080     'discount' => {
2081       'columns' => [
2082         'discountnum', 'serial',     '',      '', '', '',
2083         #'agentnum',       'int', 'NULL',      '', '', '',
2084         'classnum',       'int', 'NULL',      '', '', '',
2085         'name',       'varchar', 'NULL', $char_d, '', '',
2086         'amount',   @money_type,                  '', '',
2087         'percent',    'decimal',     '',   '7,4', '', '',
2088         'months',     'decimal', 'NULL',   '7,4', '', '',
2089         'disabled',      'char', 'NULL',       1, '', '',
2090         'setup',         'char', 'NULL',       1, '', '',
2091         #'linked',        'char', 'NULL',       1, '', '',
2092       ],
2093       'primary_key' => 'discountnum',
2094       'unique' => [],
2095       'index'  => [], # [ 'agentnum' ], ],
2096     },
2097
2098     'discount_class' => {
2099       'columns' => [
2100         'classnum',    'serial',   '',      '', '', '',
2101         'classname',   'varchar',  '', $char_d, '', '',
2102         #'categorynum', 'int',  'NULL',      '', '', '',
2103         'disabled',    'char', 'NULL',       1, '', '',
2104       ],
2105       'primary_key' => 'classnum',
2106       'unique' => [],
2107       'index' => [ ['disabled'] ],
2108     },
2109
2110     'cust_refund' => {
2111       'columns' => [
2112         'refundnum',    'serial',    '',   '', '', '',
2113         'custnum',  'int',    '',   '', '', '',
2114         '_date',        @date_type, '', '',
2115         'refund',       @money_type, '', '',
2116         'otaker',       'varchar',   'NULL',   32, '', '',
2117         'usernum',   'int', 'NULL', '', '', '',
2118         'reason',       'varchar',   '',   $char_d, '', '',
2119         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
2120                                                      # be index into payby
2121                                                      # table eventually
2122         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
2123         'paymask', 'varchar', 'NULL', $char_d, '', '',
2124         'paybatch',     'varchar',   'NULL', $char_d, '', '',
2125         'closed',    'char', 'NULL', 1, '', '',
2126         # credit card/EFT fields (formerly in paybatch)
2127         'gatewaynum',     'int', 'NULL', '', '', '', # payment_gateway FK
2128         'processor',  'varchar', 'NULL', $char_d, '', '', # module name
2129         'auth',       'varchar','NULL',16, '', '', # CC auth number
2130         'order_number', 'varchar','NULL',$char_d, '', '', # transaction number
2131       ],
2132       'primary_key' => 'refundnum',
2133       'unique' => [],
2134       'index' => [ ['custnum'], ['_date'], [ 'usernum' ], ],
2135     },
2136
2137     'cust_credit_refund' => {
2138       'columns' => [
2139         'creditrefundnum', 'serial',     '',   '', '', '',
2140         'crednum',  'int',     '',   '', '', '',
2141         'refundnum',  'int',     '',   '', '', '',
2142         'amount',  @money_type, '', '',
2143         '_date',   @date_type, '', '',
2144       ],
2145       'primary_key' => 'creditrefundnum',
2146       'unique' => [],
2147       'index' => [ ['crednum'], ['refundnum'] ],
2148     },
2149
2150
2151     'cust_svc' => {
2152       'columns' => [
2153         'svcnum',      'serial',     '', '', '', '',
2154         'pkgnum',         'int', 'NULL', '', '', '',
2155         'svcpart',        'int',     '', '', '', '',
2156         'agent_svcid',    'int', 'NULL', '', '', '',
2157         'overlimit',           @date_type,   '', '',
2158       ],
2159       'primary_key' => 'svcnum',
2160       'unique' => [],
2161       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'], [ 'agent_svcid' ] ],
2162     },
2163
2164     'cust_svc_option' => {
2165       'columns' => [
2166         'optionnum',   'serial', '', '', '', '',
2167         'svcnum',      'int', '', '', '', '',
2168         'optionname',  'varchar', '', $char_d, '', '',
2169         'optionvalue', 'text', 'NULL', '', '', '',
2170       ],
2171       'primary_key' => 'optionnum',
2172       'unique'      => [],
2173       'index'       => [ [ 'svcnum' ], [ 'optionname' ] ],
2174     },
2175
2176     'svc_export_machine' => {
2177       'columns' => [
2178         'svcexportmachinenum', 'serial', '', '', '', '',
2179         'svcnum',                 'int', '', '', '', '',
2180         'exportnum',              'int', '', '', '', '',
2181         'machinenum',             'int', '', '', '', '',
2182       ],
2183       'primary_key' => 'svcexportmachinenum',
2184       'unique'      => [ ['svcnum', 'exportnum'] ],
2185       'index'       => [],
2186     },
2187
2188     'part_export_machine' => {
2189       'columns' => [
2190         'machinenum', 'serial', '', '', '', '',
2191         'exportnum',     'int', '', '', '', '',
2192         'machine',    'varchar', 'NULL', $char_d, '', '',
2193         'disabled',      'char', 'NULL',       1, '', '',
2194       ],
2195       'primary_key' => 'machinenum',
2196       'unique'      => [ [ 'exportnum', 'machine' ] ],
2197       'index'       => [ [ 'exportnum' ] ],
2198     },
2199
2200    'part_pkg' => {
2201       'columns' => [
2202         'pkgpart',       'serial',    '',   '', '', '',
2203         'pkgpartbatch',  'varchar', 'NULL', $char_d, '', '',
2204         'pkg',           'varchar',   '',   $char_d, '', '',
2205         'comment',       'varchar', 'NULL', 2*$char_d, '', '',
2206         'promo_code',    'varchar', 'NULL', $char_d, '', '',
2207         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
2208         'setuptax',      'char', 'NULL', 1, '', '',
2209         'recurtax',      'char', 'NULL', 1, '', '',
2210         'plan',          'varchar', 'NULL', $char_d, '', '',
2211         'disabled',      'char', 'NULL', 1, '', '',
2212         'custom',        'char', 'NULL', 1, '', '',
2213         'taxclass',      'varchar', 'NULL', $char_d, '', '',
2214         'classnum',      'int',     'NULL', '', '', '',
2215         'addon_classnum','int',     'NULL', '', '', '',
2216         'taxproductnum', 'int',     'NULL', '', '', '',
2217         'setup_cost',    @money_typen,          '', '',
2218         'recur_cost',    @money_typen,          '', '',
2219         'pay_weight',    'real',    'NULL', '', '', '',
2220         'credit_weight', 'real',    'NULL', '', '', '',
2221         'agentnum',      'int',     'NULL', '', '', '',
2222         'fcc_ds0s',      'int',     'NULL', '', '', '',
2223         'fcc_voip_class','char',    'NULL',  1, '', '',
2224         'no_auto',          'char', 'NULL',  1, '', '',
2225         'recur_show_zero',  'char', 'NULL',  1, '', '',
2226         'setup_show_zero',  'char', 'NULL',  1, '', '',
2227         'successor',     'int',     'NULL', '', '', '',
2228         'family_pkgpart','int',     'NULL', '', '', '',
2229         'delay_start',   'int',     'NULL', '', '', '',
2230         'start_on_hold', 'char',    'NULL',  1, '', '',
2231         'agent_pkgpartid', 'varchar', 'NULL', 20, '', '',
2232       ],
2233       'primary_key' => 'pkgpart',
2234       'unique' => [],
2235       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'classnum' ],
2236                    [ 'agentnum' ], ['no_auto'], ['agent_pkgpartid'],
2237                  ],
2238     },
2239
2240     'part_pkg_msgcat' => {
2241       'columns' => [
2242         'pkgpartmsgnum',  'serial',     '',        '', '', '',
2243         'pkgpart',           'int',     '',        '', '', '',
2244         'locale',        'varchar',     '',        16, '', '',
2245         'pkg',           'varchar',     '',   $char_d, '', '', #longer/no limit?
2246         'comment',       'varchar', 'NULL', 2*$char_d, '', '', #longer/no limit?
2247       ],
2248       'primary_key' => 'pkgpartmsgnum',
2249       'unique'      => [ [ 'pkgpart', 'locale' ] ],
2250       'index'       => [],
2251     },
2252
2253     'part_fee' => {
2254       'columns' => [
2255         'feepart',       'serial',    '',   '', '', '',
2256         'itemdesc',      'varchar',   '',   $char_d,   '', '',
2257         'comment',       'varchar', 'NULL', 2*$char_d, '', '',
2258         'disabled',      'char',    'NULL',  1, '', '',
2259         'classnum',      'int',     'NULL', '', '', '',
2260         'taxclass',      'varchar', 'NULL', $char_d, '', '',
2261         'taxproductnum', 'int',     'NULL', '', '', '',
2262         'pay_weight',    'real',    'NULL', '', '', '',
2263         'credit_weight', 'real',    'NULL', '', '', '',
2264         'agentnum',      'int',     'NULL', '', '', '',
2265         'amount',   @money_type,                '', '',
2266         'percent',     'decimal',    '', '7,4', '', '',
2267         'basis',         'varchar',  '',    16, '', '',
2268         'minimum',    @money_typen,             '', '',
2269         'maximum',    @money_typen,             '', '',
2270         'limit_credit',  'char',    'NULL',  1, '', '',
2271         'setuprecur',    'char',     '',     5, '', '',
2272         'taxable',       'char',    'NULL',  1, '', '',
2273       ],
2274       'primary_key'  => 'feepart',
2275       'unique'       => [],
2276       'index'        => [ [ 'disabled' ], [ 'classnum' ], [ 'agentnum' ]
2277                         ],
2278     },
2279
2280     'part_fee_msgcat' => {
2281       'columns' => [
2282         'feepartmsgnum',  'serial',     '',        '', '', '',
2283         'feepart',           'int',     '',        '', '', '',
2284         'locale',        'varchar',     '',        16, '', '',
2285         'itemdesc',      'varchar',     '',   $char_d, '', '', #longer/no limit?
2286         'comment',       'varchar', 'NULL', 2*$char_d, '', '', #longer/no limit?
2287       ],
2288       'primary_key'  => 'feepartmsgnum',
2289       'unique'       => [ [ 'feepart', 'locale' ] ],
2290       'index'        => [],
2291     },
2292
2293     'part_fee_usage' => {
2294       'columns' => [
2295         'feepartusagenum','serial',     '',        '', '', '',
2296         'feepart',           'int',     '',        '', '', '',
2297         'classnum',          'int',     '',        '', '', '',
2298         'amount',   @money_type,                '', '',
2299         'percent',     'decimal',    '', '7,4', '', '',
2300       ],
2301       'primary_key'  => 'feepartusagenum',
2302       'unique'       => [ [ 'feepart', 'classnum' ] ],
2303       'index'        => [],
2304     },
2305
2306     'part_pkg_link' => {
2307       'columns' => [
2308         'pkglinknum',  'serial',   '',      '', '', '',
2309         'src_pkgpart', 'int',      '',      '', '', '',
2310         'dst_pkgpart', 'int',      '',      '', '', '',
2311         'link_type',   'varchar',  '', $char_d, '', '',
2312         'hidden',      'char', 'NULL',       1, '', '',
2313       ],
2314       'primary_key' => 'pkglinknum',
2315       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type', 'hidden' ] ],
2316       'index'  => [ [ 'src_pkgpart' ] ],
2317     },
2318     # XXX somewhat borked unique: we don't really want a hidden and unhidden
2319     # it turns out we'd prefer to use svc, bill, and invisibill (or something)
2320
2321     'part_pkg_discount' => {
2322       'columns' => [
2323         'pkgdiscountnum', 'serial',   '',      '', '', '',
2324         'pkgpart',        'int',      '',      '', '', '',
2325         'discountnum',    'int',      '',      '', '', '',
2326       ],
2327       'primary_key' => 'pkgdiscountnum',
2328       'unique' => [ [ 'pkgpart', 'discountnum' ] ],
2329       'index'  => [],
2330     },
2331
2332     'part_pkg_taxclass' => {
2333       'columns' => [
2334         'taxclassnum',  'serial', '',       '', '', '',
2335         'taxclass',     'varchar', '', $char_d, '', '',
2336         'disabled', 'char',   'NULL',         1, '', '',
2337       ],
2338       'primary_key' => 'taxclassnum',
2339       'unique'      => [ [ 'taxclass' ] ],
2340       'index'       => [ [ 'disabled' ] ],
2341     },
2342
2343     'part_pkg_taxproduct' => {
2344       'columns' => [
2345         'taxproductnum', 'serial',      '',        '', '', '',
2346         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
2347         'taxproduct',    'varchar',     '',   $char_d, '', '',
2348         'description',   'varchar',     '', 3*$char_d, '', '',
2349       ],
2350       'primary_key' => 'taxproductnum',
2351       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
2352       'index'       => [],
2353     },
2354
2355     'part_pkg_taxrate' => {
2356       'columns' => [
2357         'pkgtaxratenum', 'serial',  '',     '',      '', '',
2358         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
2359         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
2360         'taxproductnum', 'int',  '',     '',       '', '',
2361         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
2362         'county',           'varchar', 'NULL', $char_d, '', '',
2363         'state',            'varchar', 'NULL', $char_d, '', '',
2364         'local',            'varchar', 'NULL', $char_d, '', '',
2365         'country',          'char',    'NULL', 2,       '', '',
2366         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
2367         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
2368         'taxclassnum',      'int',     'NULL', '',      '', '',
2369         'effdate',          @date_type, '', '',
2370         'taxable',          'char',    'NULL', 1,       '', '',
2371       ],
2372       'primary_key' => 'pkgtaxratenum',
2373       'unique' => [],
2374       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
2375     },
2376
2377     'part_pkg_taxoverride' => {
2378       'columns' => [
2379         'taxoverridenum', 'serial', '', '', '', '',
2380         'pkgpart',           'int', '', '', '', '',
2381         'taxclassnum',       'int', '', '', '', '',
2382         'usage_class',    'varchar', 'NULL', $char_d, '', '',
2383       ],
2384       'primary_key' => 'taxoverridenum',
2385       'unique' => [],
2386       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
2387     },
2388
2389 #    'part_title' => {
2390 #      'columns' => [
2391 #        'titlenum',   'int',    '',   '',
2392 #        'title',      'varchar',   '',   $char_d,
2393 #      ],
2394 #      'primary_key' => 'titlenum',
2395 #      'unique' => [ [] ],
2396 #      'index' => [ [] ],
2397 #    },
2398
2399     'pkg_svc' => {
2400       'columns' => [
2401         'pkgsvcnum',  'serial', '',  '', '', '',
2402         'pkgpart',    'int',    '',   '', '', '',
2403         'svcpart',    'int',    '',   '', '', '',
2404         'quantity',   'int',    '',   '', '', '',
2405         'primary_svc','char', 'NULL',  1, '', '',
2406         'hidden',     'char', 'NULL',  1, '', '',
2407       ],
2408       'primary_key' => 'pkgsvcnum',
2409       'unique' => [ ['pkgpart', 'svcpart'] ],
2410       'index' => [ ['pkgpart'], ['quantity'] ],
2411     },
2412
2413     'part_referral' => {
2414       'columns' => [
2415         'refnum',   'serial',     '',        '', '', '',
2416         'referral', 'varchar',    '',   $char_d, '', '',
2417         'disabled', 'char',   'NULL',         1, '', '',
2418         'agentnum', 'int',    'NULL',        '', '', '',
2419       ],
2420       'primary_key' => 'refnum',
2421       'unique' => [],
2422       'index' => [ ['disabled'], ['agentnum'], ],
2423     },
2424
2425     'part_svc' => {
2426       'columns' => [
2427         'svcpart',             'serial',     '',        '', '', '',
2428         'svc',                'varchar',     '',   $char_d, '', '',
2429         'svcdb',              'varchar',     '',   $char_d, '', '',
2430         'disabled',              'char', 'NULL',         1, '', '',
2431         'preserve',              'char', 'NULL',         1, '', '',
2432         'selfservice_access', 'varchar', 'NULL',   $char_d, '', '',
2433         'classnum',               'int', 'NULL',        '', '', '',
2434         'restrict_edit_password','char', 'NULL',         1, '', '',
2435         'has_router',            'char', 'NULL',         1, '', '',
2436 ],
2437       'primary_key' => 'svcpart',
2438       'unique' => [],
2439       'index' => [ [ 'disabled' ] ],
2440     },
2441
2442     'part_svc_column' => {
2443       'columns' => [
2444         'columnnum',   'serial',      '',      '', '', '',
2445         'svcpart',     'int',         '',      '', '', '',
2446         'columnname',  'varchar',     '',      64, '', '',
2447         'columnlabel', 'varchar', 'NULL', $char_d, '', '',
2448         'columnvalue', 'varchar', 'NULL',     512, '', '',
2449         'columnflag',  'char',    'NULL',       1, '', '',
2450       ],
2451       'primary_key' => 'columnnum',
2452       'unique' => [ [ 'svcpart', 'columnname' ] ],
2453       'index' => [ [ 'svcpart' ] ],
2454     },
2455
2456     'part_svc_class' => {
2457       'columns' => [
2458         'classnum',    'serial',   '',      '', '', '',
2459         'classname',   'varchar',  '', $char_d, '', '',
2460         'disabled',    'char', 'NULL',       1, '', '',
2461       ],
2462       'primary_key' => 'classnum',
2463       'unique' => [],
2464       'index' => [ ['disabled'] ],
2465     },
2466
2467     #(this should be renamed to part_pop)
2468     'svc_acct_pop' => {
2469       'columns' => [
2470         'popnum',    'serial',    '',   '', '', '',
2471         'city',      'varchar',   '',   $char_d, '', '',
2472         'state',     'varchar',   '',   $char_d, '', '',
2473         'ac',        'char',   '',   3, '', '',
2474         'exch',      'char',   '',   3, '', '',
2475         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
2476       ],
2477       'primary_key' => 'popnum',
2478       'unique' => [],
2479       'index' => [ [ 'state' ] ],
2480     },
2481
2482     'part_pop_local' => {
2483       'columns' => [
2484         'localnum',  'serial',     '',     '', '', '',
2485         'popnum',    'int',     '',     '', '', '',
2486         'city',      'varchar', 'NULL', $char_d, '', '',
2487         'state',     'char',    'NULL', 2, '', '',
2488         'npa',       'char',    '',     3, '', '',
2489         'nxx',       'char',    '',     3, '', '',
2490       ],
2491       'primary_key' => 'localnum',
2492       'unique' => [],
2493       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
2494     },
2495
2496     'qual' => {
2497       'columns' => [
2498         'qualnum',  'serial',     '',     '', '', '',
2499         'custnum',    'int',     'NULL',     '', '', '',
2500         'prospectnum',    'int',     'NULL',     '', '', '',
2501         'locationnum',    'int',     'NULL',     '', '', '',
2502         'phonenum',     'varchar', 'NULL',       24, '', '',
2503         'exportnum',      'int', 'NULL', '', '', '',
2504         'vendor_qual_id',      'varchar', 'NULL', $char_d, '', '',
2505         'status',      'char', '', 1, '', '',
2506       ],
2507       'primary_key' => 'qualnum',
2508       'unique' => [],
2509       'index' => [ [ 'locationnum' ], ['custnum'], ['prospectnum'],
2510                     ['phonenum'], ['vendor_qual_id'] ],
2511     },
2512
2513     'qual_option' => {
2514       'columns' => [
2515         'optionnum', 'serial', '', '', '', '',
2516         'qualnum',  'int',     '',     '', '', '',
2517         'optionname', 'varchar', '', $char_d, '', '',
2518         'optionvalue', 'text', 'NULL', '', '', '',
2519       ],
2520       'primary_key' => 'optionnum',
2521       'unique' => [],
2522       'index' => [],
2523     },
2524
2525     'svc_acct' => {
2526       'columns' => [
2527         'svcnum',    'int',    '',   '', '', '',
2528         'username',  'varchar',   '',   $username_len, '', '',
2529         '_password', 'varchar',   'NULL',  512, '', '',
2530         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
2531         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
2532         'popnum',    'int',    'NULL',   '', '', '',
2533         'sectornum', 'int', 'NULL',      '', '', '',
2534         'uid',       'int', 'NULL',   '', '', '',
2535         'gid',       'int', 'NULL',   '', '', '',
2536         'finger',    'varchar',   'NULL',   2*$char_d, '', '',
2537         'dir',       'varchar',   'NULL',   $char_d, '', '',
2538         'shell',     'varchar',   'NULL',   $char_d, '', '',
2539         'quota',     'varchar',   'NULL',   $char_d, '', '',
2540         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
2541         # IP address mgmt
2542         'routernum', 'int', 'NULL',      '', '', '',
2543         'blocknum',  'int', 'NULL',      '', '', '',
2544         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
2545         'seconds_threshold',   'int', 'NULL',   '', '', '',
2546         'upbytes',   'bigint', 'NULL',   '', '', '',
2547         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
2548         'downbytes', 'bigint', 'NULL',   '', '', '',
2549         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
2550         'totalbytes','bigint', 'NULL',   '', '', '',
2551         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
2552         'domsvc',    'int',     '', '', '', '',
2553         'pbxsvc',    'int', 'NULL', '', '', '',
2554         'last_login',  @date_type, '', '',
2555         'last_logout', @date_type, '', '',
2556         #cardfortress field(s)
2557         'cf_privatekey',      'text', 'NULL',      '', '', '',
2558         #communigate pro fields (quota = MaxAccountSize)
2559         'cgp_aliases',     'varchar', 'NULL',     255, '', '',
2560         #settings
2561         'cgp_type',        'varchar', 'NULL', $char_d, '', '', #AccountType
2562         'file_quota',      'varchar', 'NULL', $char_d, '', '', #MaxWebSize
2563         'file_maxnum',     'varchar', 'NULL', $char_d, '', '', #MaxWebFiles
2564         'file_maxsize',    'varchar', 'NULL', $char_d, '', '', #MaxFileSize
2565         'cgp_accessmodes', 'varchar', 'NULL',     255, '', '', #AccessModes
2566         'password_selfchange','char', 'NULL',       1, '', '', #PWDAllowed
2567         'password_recover',   'char', 'NULL',       1, 'Y','', #PasswordRecovery
2568         'cgp_rulesallowed','varchar', 'NULL', $char_d, '', '', #RulesAllowed
2569         'cgp_rpopallowed',    'char', 'NULL',       1, '', '', #RPOPAllowed
2570         'cgp_mailtoall',      'char', 'NULL',       1, '', '', #MailToAll
2571         'cgp_addmailtrailer', 'char', 'NULL',       1, '', '', #AddMailTrailer
2572         'cgp_archiveafter',    'int', 'NULL',      '', '', '', #ArchiveMessagesAfter
2573         #XXX mailing lists
2574         #preferences
2575         'cgp_deletemode',     'varchar', 'NULL', $char_d, '', '',#DeleteMode
2576         'cgp_emptytrash',     'varchar', 'NULL', $char_d, '', '',#EmptyTrash
2577         'cgp_language',       'varchar', 'NULL', $char_d, '', '',#Language
2578         'cgp_timezone',       'varchar', 'NULL', $char_d, '', '',#TimeZone
2579         'cgp_skinname',       'varchar', 'NULL', $char_d, '', '',#SkinName
2580         'cgp_prontoskinname', 'varchar', 'NULL', $char_d, '', '',#ProntoSkinName
2581         'cgp_sendmdnmode',    'varchar', 'NULL', $char_d, '', '',#SendMDNMode
2582         #mail
2583         #XXX RPOP settings
2584         #
2585       ],
2586       'primary_key' => 'svcnum',
2587       #'unique' => [ [ 'username', 'domsvc' ] ],
2588       'unique' => [],
2589       'index' => [ ['username'], ['domsvc'], ['pbxsvc'] ],
2590     },
2591
2592     'acct_rt_transaction' => {
2593       'columns' => [
2594         'svcrtid',   'int',    '',   '', '', '',
2595         'svcnum',    'int',    '',   '', '', '',
2596         'transaction_id',       'int', '',   '', '', '',
2597         '_date',   @date_type, '', '',
2598         'seconds',   'int', '',   '', '', '', #uhhhh
2599         'support',   'int', '',   '', '', '',
2600       ],
2601       'primary_key' => 'svcrtid',
2602       'unique' => [],
2603       'index' => [ ['svcnum', 'transaction_id'] ],
2604     },
2605
2606     #'svc_charge' => {
2607     #  'columns' => [
2608     #    'svcnum',    'int',    '',   '',
2609     #    'amount',    @money_type,
2610     #  ],
2611     #  'primary_key' => 'svcnum',
2612     #  'unique' => [ [] ],
2613     #  'index' => [ [] ],
2614     #},
2615
2616     'svc_domain' => {
2617       'columns' => [
2618         'svcnum',           'int',    '',        '', '', '',
2619         'domain',       'varchar',    '',   $char_d, '', '',
2620         'suffix',       'varchar', 'NULL',  $char_d, '', '',
2621         'catchall',         'int', 'NULL',       '', '', '',
2622         'parent_svcnum',    'int', 'NULL',       '', '', '',
2623         'quota',        'varchar', 'NULL',  $char_d, '', '',
2624
2625         #registration info
2626         'registrarnum',     'int', 'NULL',       '', '', '',
2627         'registrarkey', 'varchar', 'NULL',      512, '', '',
2628         'setup_date',      @date_type, '', '',
2629         'renewal_interval', 'int', 'NULL',       '', '', '',
2630         'expiration_date', @date_type, '', '',
2631
2632         #some weird shit australia-specific shit?  yuck.. seems totally unused
2633         'au_registrant_name',       'varchar', 'NULL',  $char_d, '', '',
2634         'au_eligibility_type',      'varchar', 'NULL',  $char_d, '', '',
2635
2636         #communigate pro fields (quota = MaxAccountSize)
2637         'max_accounts',     'int', 'NULL',       '', '', '',
2638         'trailer',         'text', 'NULL',       '', '', '',
2639         'cgp_aliases',  'varchar', 'NULL',      255, '', '',
2640         'cgp_accessmodes','varchar','NULL',     255, '', '', #DomainAccessModes
2641         'cgp_certificatetype','varchar','NULL', $char_d, '', '',
2642
2643         #(account default) settings
2644         'acct_def_password_selfchange',   'char', 'NULL',       1,  '', '',
2645         'acct_def_password_recover',      'char', 'NULL',       1, 'Y', '',
2646         'acct_def_cgp_accessmodes',    'varchar', 'NULL',     255,  '', '',
2647         'acct_def_quota',              'varchar', 'NULL', $char_d,  '', '',
2648         'acct_def_file_quota',         'varchar', 'NULL', $char_d,  '', '',
2649         'acct_def_file_maxnum',        'varchar', 'NULL', $char_d,  '', '',
2650         'acct_def_file_maxsize',       'varchar', 'NULL', $char_d,  '', '',
2651         'acct_def_cgp_rulesallowed',   'varchar', 'NULL', $char_d,  '', '',
2652         'acct_def_cgp_rpopallowed',       'char', 'NULL',       1,  '', '',
2653         'acct_def_cgp_mailtoall',         'char', 'NULL',       1,  '', '',
2654         'acct_def_cgp_addmailtrailer',    'char', 'NULL',       1,  '', '',
2655         'acct_def_cgp_archiveafter',       'int', 'NULL',      '',  '', '',
2656
2657         #(account default) preferences
2658         'acct_def_cgp_deletemode',     'varchar', 'NULL', $char_d,  '', '',
2659         'acct_def_cgp_emptytrash',     'varchar', 'NULL', $char_d,  '', '',
2660         'acct_def_cgp_language',       'varchar', 'NULL', $char_d,  '', '',
2661         'acct_def_cgp_timezone',       'varchar', 'NULL', $char_d,  '', '',
2662         'acct_def_cgp_skinname',       'varchar', 'NULL', $char_d,  '', '',
2663         'acct_def_cgp_prontoskinname', 'varchar', 'NULL', $char_d,  '', '',
2664         'acct_def_cgp_sendmdnmode',    'varchar', 'NULL', $char_d,  '', '',
2665       ],
2666       'primary_key' => 'svcnum',
2667       'unique' => [ ],
2668       'index' => [ ['domain'] ],
2669     },
2670
2671     'svc_dsl' => {
2672       'columns' => [
2673         'svcnum',                    'int',    '',        '', '', '',
2674         'pushed',                    'int', 'NULL',       '', '', '',
2675         'desired_due_date',          'int', 'NULL',       '', '', '',
2676         'due_date',                  'int', 'NULL',       '', '', '',
2677         'vendor_order_id',       'varchar', 'NULL', $char_d,  '', '',
2678         'vendor_qual_id',        'varchar', 'NULL', $char_d,  '', '',
2679         'vendor_order_type',     'varchar', 'NULL', $char_d,  '', '',
2680         'vendor_order_status',   'varchar', 'NULL', $char_d,  '', '',
2681         'first',                 'varchar', 'NULL', $char_d,  '', '',
2682         'last',                  'varchar', 'NULL', $char_d,  '', '',
2683         'company',               'varchar', 'NULL', $char_d,  '', '',
2684         'phonenum',              'varchar', 'NULL',      24, '', '',
2685         'gateway_access_number', 'varchar', 'NULL',      24, '', '',
2686         'loop_type',                'char', 'NULL',       1, '', '',
2687         'local_voice_provider',  'varchar', 'NULL', $char_d, '', '',
2688         'circuitnum',            'varchar', 'NULL', $char_d, '', '',
2689         'rate_band',             'varchar', 'NULL', $char_d, '', '',
2690         'vpi',                       'int', 'NULL',      '', '', '',
2691         'vci',                       'int', 'NULL',      '', '', '',
2692         'isp_chg',                  'char', 'NULL',       1, '', '',
2693         'isp_prev',              'varchar', 'NULL', $char_d, '', '',
2694         'username',              'varchar', 'NULL', $char_d, '', '',
2695         'password',              'varchar', 'NULL', $char_d, '', '',
2696         'staticips',                'text', 'NULL',      '', '', '',
2697         'monitored',                'char', 'NULL',       1, '', '',
2698         'last_pull',                 'int', 'NULL',      '', '', '',
2699       ],
2700       'primary_key' => 'svcnum',
2701       'unique' => [ ],
2702       'index' => [ ['phonenum'], ['vendor_order_id'] ],
2703     },
2704
2705     'dsl_device' => {
2706       'columns' => [
2707         'devicenum', 'serial',     '', '', '', '',
2708         #part_device?  or our own part_dsl_device?
2709         #'devicepart',   'int',     '', '', '', '',
2710         'svcnum',       'int',     '', '', '', '',
2711         'mac_addr', 'varchar',     '', 12, '', '',
2712       ],
2713       'primary_key' => 'devicenum',
2714       'unique' => [ [ 'mac_addr' ], ],
2715       'index'  => [ [ 'svcnum' ], ], # [ 'devicepart' ] ],
2716     },
2717
2718     'dsl_note' => {
2719       'columns' => [
2720         'notenum',           'serial',    '',        '', '', '',
2721         'svcnum',     'int', '',       '', '', '',
2722         'author',     'varchar', 'NULL', $char_d,  '', '',
2723         'priority',   'char', 'NULL',       1,  '', '',
2724         '_date',     'int', 'NULL',       '', '', '',
2725         'note',     'text', '',       '', '', '',
2726       ],
2727       'primary_key' => 'notenum',
2728       'unique' => [ ],
2729       'index' => [ ['svcnum'] ],
2730     },
2731
2732     'svc_dish' => {
2733       'columns' => [
2734         'svcnum',   'int',     '',     '', '', '',
2735         'acctnum',  'varchar', '',     16, '', '',
2736         'installdate', @date_type,         '', '',
2737         'note',     'text',    'NULL', '', '', '',
2738       ],
2739       'primary_key' => 'svcnum',
2740       'unique' => [ ],
2741       'index' => [ ],
2742     },
2743
2744     'svc_hardware' => {
2745       'columns' => [
2746         'svcnum',   'int',     '',          '', '', '',
2747         'typenum',  'int',     '',          '', '', '',
2748         'serial',   'varchar', 'NULL', $char_d, '', '',
2749         'ip_addr',  'varchar', 'NULL',      40, '', '',
2750         'hw_addr',  'varchar', 'NULL',      12, '', '',
2751         'smartcard','varchar', 'NULL',      30, '', '',
2752         'statusnum','int',     'NULL',      '', '', '',
2753         'note',     'text',    'NULL',      '', '', '',
2754       ],
2755       'primary_key' => 'svcnum',
2756       'unique' => [ ],
2757       'index' => [ ],
2758     },
2759
2760     'hardware_class' => {
2761       'columns' => [
2762         'classnum',   'serial', '',      '', '', '',
2763         'classname', 'varchar', '', $char_d, '', '',
2764       ],
2765       'primary_key' => 'classnum',
2766       'unique' => [ ],
2767       'index'  => [ ],
2768     },
2769
2770     'hardware_type' => {
2771       'columns' => [
2772         'typenum',  'serial',     '',      '', '', '',
2773         'classnum',    'int',     '',      '', '', '',
2774         'model',   'varchar',     '', $char_d, '', '',
2775         'revision','varchar', 'NULL', $char_d, '', '',
2776       ],
2777       'primary_key' => 'typenum',
2778       'unique' => [ [ 'classnum', 'model', 'revision' ] ],
2779       'index'  => [ ],
2780     },
2781
2782     'hardware_status' => {
2783       'columns' => [
2784         'statusnum', 'serial', '',      '', '', '',
2785         'label'    ,'varchar', '', $char_d, '', '',
2786         'disabled',    'char', 'NULL',   1, '', '',
2787       ],
2788       'primary_key' => 'statusnum',
2789       'unique' => [ ],
2790       'index'  => [ ],
2791     },
2792
2793     'domain_record' => {
2794       'columns' => [
2795         'recnum',    'serial',     '',  '', '', '',
2796         'svcnum',    'int',     '',  '', '', '',
2797         'reczone',   'varchar', '',  255, '', '',
2798         'recaf',     'char',    '',  2, '', '',
2799         'rectype',   'varchar',    '',  5, '', '',
2800         'recdata',   'varchar', '',  255, '', '',
2801         'ttl',       'int',     'NULL', '', '', '',
2802       ],
2803       'primary_key' => 'recnum',
2804       'unique'      => [],
2805       'index'       => [ ['svcnum'] ],
2806     },
2807
2808     'registrar' => {
2809       'columns' => [
2810         'registrarnum',   'serial', '',      '', '', '',
2811         'registrarname', 'varchar', '', $char_d, '', '',
2812       ],
2813       'primary_key' => 'registrarnum',
2814       'unique'      => [],
2815       'index'       => [],
2816     },
2817
2818     'cgp_rule' => {
2819       'columns' => [
2820         'rulenum',  'serial',     '',      '', '', '',
2821         'name',    'varchar',     '', $char_d, '', '',
2822         'comment', 'varchar', 'NULL', $char_d, '', '',
2823         'svcnum',      'int',     '',      '', '', '',
2824         'priority',    'int',     '',      '', '', '',
2825       ],
2826       'primary_key' => 'rulenum',
2827       'unique'      => [ [ 'svcnum', 'name' ] ],
2828       'index'       => [ [ 'svcnum' ] ],
2829     },
2830
2831     'cgp_rule_condition' => {
2832       'columns' => [
2833         'ruleconditionnum',  'serial',     '',      '', '', '',
2834         'conditionname',    'varchar',     '', $char_d, '', '',
2835         'op',               'varchar', 'NULL', $char_d, '', '',
2836         'params',           'varchar', 'NULL',     255, '', '',
2837         'rulenum',              'int',     '',      '', '', '',
2838       ],
2839       'primary_key' => 'ruleconditionnum',
2840       'unique'      => [],
2841       'index'       => [ [ 'rulenum' ] ],
2842     },
2843
2844     'cgp_rule_action' => {
2845        'columns' => [
2846         'ruleactionnum',  'serial',     '',      '', '', '',
2847         'action',        'varchar',     '', $char_d, '', '',
2848         'params',        'varchar', 'NULL',     255, '', '',
2849         'rulenum',           'int',     '',      '', '', '',
2850       ],
2851       'primary_key' => 'ruleactionnum',
2852       'unique'      => [],
2853       'index'       => [ [ 'rulenum' ] ],
2854    },
2855
2856     'svc_forward' => {
2857       'columns' => [
2858         'svcnum',   'int',            '',   '', '', '',
2859         'srcsvc',   'int',        'NULL',   '', '', '',
2860         'src',      'varchar',    'NULL',  255, '', '',
2861         'dstsvc',   'int',        'NULL',   '', '', '',
2862         'dst',      'varchar',    'NULL',  255, '', '',
2863       ],
2864       'primary_key' => 'svcnum',
2865       'unique'      => [],
2866       'index'       => [ ['srcsvc'], ['dstsvc'] ],
2867     },
2868
2869     'svc_www' => {
2870       'columns' => [
2871         'svcnum',   'int',      '',  '', '', '',
2872         'recnum',   'int',      '',  '', '', '',
2873         'usersvc',  'int',  'NULL',  '', '', '',
2874         'config',   'text', 'NULL',  '', '', '',
2875       ],
2876       'primary_key' => 'svcnum',
2877       'unique'      => [],
2878       'index'       => [],
2879     },
2880
2881     #'svc_wo' => {
2882     #  'columns' => [
2883     #    'svcnum',    'int',    '',   '',
2884     #    'svcnum',    'int',    '',   '',
2885     #    'svcnum',    'int',    '',   '',
2886     #    'worker',    'varchar',   '',   $char_d,
2887     #    '_date',     @date_type,
2888     #  ],
2889     #  'primary_key' => 'svcnum',
2890     #  'unique' => [ [] ],
2891     #  'index' => [ [] ],
2892     #},
2893
2894     'prepay_credit' => {
2895       'columns' => [
2896         'prepaynum',   'serial',     '',   '', '', '',
2897         'identifier',  'varchar', '', $char_d, '', '',
2898         'amount',      @money_type, '', '',
2899         'seconds',     'int',     'NULL', '', '', '',
2900         'upbytes',     'bigint',     'NULL', '', '', '',
2901         'downbytes',   'bigint',     'NULL', '', '', '',
2902         'totalbytes',  'bigint',     'NULL', '', '', '',
2903         'agentnum',    'int',     'NULL', '', '', '',
2904       ],
2905       'primary_key' => 'prepaynum',
2906       'unique'      => [ ['identifier'] ],
2907       'index'       => [ ['agentnum'] ],
2908     },
2909
2910     'port' => {
2911       'columns' => [
2912         'portnum',  'serial',     '',   '', '', '',
2913         'ip',       'varchar', 'NULL', 15, '', '',
2914         'nasport',  'int',     'NULL', '', '', '',
2915         'nasnum',   'int',     '',   '', '', '',
2916       ],
2917       'primary_key' => 'portnum',
2918       'unique'      => [],
2919       'index'       => [],
2920     },
2921
2922     'nas' => {
2923       'columns' => [
2924         'nasnum',       'serial',     '',  '',              '', '',
2925         'nasname',     'varchar',     '', 128,              '', '',
2926         'shortname',   'varchar', 'NULL',  32,              '', '',
2927         'type',        'varchar',     '',  30,         'other', '',
2928         'ports',           'int', 'NULL',  '',              '', '',
2929         'secret',      'varchar',     '',  60,        'secret', '',
2930         'server',      'varchar', 'NULL',  64,              '', '',
2931         'community',   'varchar', 'NULL',  50,              '', '',
2932         'description', 'varchar',     '', 200, 'RADIUS Client', '',
2933         'svcnum',          'int', 'NULL',  '',              '', '',
2934       ],
2935       'primary_key' => 'nasnum',
2936       'unique'      => [ [ 'nasname' ], ],
2937       'index'       => [],
2938     },
2939
2940     'export_nas' => {
2941       'columns' => [
2942         'exportnasnum', 'serial', '', '', '', '',
2943         'exportnum',       'int', '', '', '', '',
2944         'nasnum',          'int', '', '', '', '',
2945       ],
2946       'primary_key' => 'exportnasnum',
2947       'unique'      => [ [ 'exportnum', 'nasnum' ] ],
2948       'index'       => [ [ 'exportnum' ], [ 'nasnum' ] ],
2949     },
2950
2951     'queue' => {
2952       'columns' => [
2953         'jobnum',   'bigserial',     '',      '', '', '',
2954         'job',        'varchar',     '',     512, '', '',
2955         '_date',          'int',     '',      '', '', '',
2956         'status',     'varchar',     '', $char_d, '', '',
2957         'statustext',    'text', 'NULL',      '', '', '',
2958         'svcnum',         'int', 'NULL',      '', '', '',
2959         'custnum',        'int', 'NULL',      '', '', '',
2960         'secure',        'char', 'NULL',       1, '', '',
2961         'priority',       'int', 'NULL',      '', '', '',
2962       ],
2963       'primary_key' => 'jobnum',
2964       'unique'      => [],
2965       'index'       => [ [ 'secure' ], [ 'priority' ],
2966                          [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
2967                        ],
2968     },
2969
2970     'queue_arg' => {
2971       'columns' => [
2972         'argnum', 'bigserial',     '', '', '', '',
2973         'jobnum',    'bigint',     '', '', '', '',
2974         'frozen',      'char', 'NULL',  1, '', '',
2975         'arg',         'text', 'NULL', '', '', '',
2976       ],
2977       'primary_key' => 'argnum',
2978       'unique'      => [],
2979       'index'       => [ [ 'jobnum' ] ],
2980     },
2981
2982     'queue_depend' => {
2983       'columns' => [
2984         'dependnum',  'bigserial', '', '', '', '',
2985         'jobnum',        'bigint', '', '', '', '',
2986         'depend_jobnum', 'bigint', '', '', '', '',
2987       ],
2988       'primary_key' => 'dependnum',
2989       'unique'      => [],
2990       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
2991     },
2992
2993     'queue_stat' => {
2994       'columns' => [
2995         'statnum', 'bigserial',     '',  '', '', '',
2996         'jobnum',     'bigint',     '',  '', '', '',
2997         'job',       'varchar',     '', 512, '', '',
2998         'custnum',       'int', 'NULL',  '', '', '',
2999         'insert_date', @date_type, '', '',
3000         'start_date',  @date_type, '', '',
3001         'end_date',    @date_type, '', '',
3002       ],
3003       'primary_key'  => 'statnum',
3004       'unique'       => [], #[ ['jobnum'] ],
3005       'index'        => [],
3006     },
3007
3008     'export_svc' => {
3009       'columns' => [
3010         'exportsvcnum' => 'serial', '', '', '', '',
3011         'exportnum'    => 'int', '', '', '', '',
3012         'svcpart'      => 'int', '', '', '', '',
3013         'role'         => 'varchar', 'NULL', 16, '', '',
3014       ],
3015       'primary_key' => 'exportsvcnum',
3016       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
3017       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
3018     },
3019
3020     'export_device' => {
3021       'columns' => [
3022         'exportdevicenum' => 'serial', '', '', '', '',
3023         'exportnum'    => 'int', '', '', '', '',
3024         'devicepart'      => 'int', '', '', '', '',
3025       ],
3026       'primary_key' => 'exportdevicenum',
3027       'unique'      => [ [ 'exportnum', 'devicepart' ] ],
3028       'index'       => [ [ 'exportnum' ], [ 'devicepart' ] ],
3029     },
3030
3031     'part_export' => {
3032       'columns' => [
3033         'exportnum',   'serial',     '',      '', '', '',
3034         'exportname', 'varchar', 'NULL', $char_d, '', '',
3035         'machine',    'varchar', 'NULL', $char_d, '', '',
3036         'exporttype', 'varchar',     '', $char_d, '', '',
3037         'nodomain',      'char', 'NULL',       1, '', '',
3038         'default_machine','int', 'NULL',      '', '', '',
3039       ],
3040       'primary_key' => 'exportnum',
3041       'unique'      => [],
3042       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
3043     },
3044
3045     'part_export_option' => {
3046       'columns' => [
3047         'optionnum', 'serial', '', '', '', '',
3048         'exportnum', 'int', '', '', '', '',
3049         'optionname', 'varchar', '', $char_d, '', '',
3050         'optionvalue', 'text', 'NULL', '', '', '',
3051       ],
3052       'primary_key' => 'optionnum',
3053       'unique'      => [],
3054       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
3055     },
3056
3057     'radius_usergroup' => {
3058       'columns' => [
3059         'usergroupnum', 'serial', '', '', '', '',
3060         'svcnum',       'int', '', '', '', '',
3061         'groupname',    'varchar', 'NULL', $char_d, '', '',
3062         'groupnum',     'int', 'NULL', '', '', '',
3063       ],
3064       'primary_key' => 'usergroupnum',
3065       'unique'      => [],
3066       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
3067     },
3068
3069     'radius_group' => {
3070       'columns' => [
3071         'groupnum', 'serial', '', '', '', '',
3072         'groupname',    'varchar', '', $char_d, '', '',
3073         'description',  'varchar', 'NULL', $char_d, '', '',
3074         'priority', 'int', '', '', '1', '',
3075         'speed_up', 'int', 'NULL', '', '', '',
3076         'speed_down', 'int', 'NULL', '', '', '',
3077       ],
3078       'primary_key' => 'groupnum',
3079       'unique'      => [ ['groupname'] ],
3080       'index'       => [],
3081     },
3082
3083     'radius_attr' => {
3084       'columns' => [
3085         'attrnum',   'serial', '',      '', '', '',
3086         'groupnum',     'int', '',      '', '', '',
3087         'attrname', 'varchar', '', $char_d, '', '',
3088         'value',    'varchar', '',     255, '', '',
3089         'attrtype',    'char', '',       1, '', '',
3090         'op',          'char', '',       2, '', '',
3091       ],
3092       'primary_key' => 'attrnum',
3093       'unique'      => [],
3094       'index'       => [ ['groupnum'], ],
3095     },
3096
3097     'msgcat' => {
3098       'columns' => [
3099         'msgnum', 'serial', '', '', '', '',
3100         'msgcode', 'varchar', '', 255, '', '',
3101         'locale', 'varchar', '', 16, '', '',
3102         'msg', 'text', '', '', '', '',
3103       ],
3104       'primary_key' => 'msgnum',
3105       'unique'      => [ [ 'msgcode', 'locale' ] ],
3106       'index'       => [],
3107     },
3108
3109     'cust_tax_exempt' => {
3110       'columns' => [
3111         'exemptnum', 'serial', '', '', '', '',
3112         'custnum',   'int', '', '', '', '',
3113         'taxnum',    'int', '', '', '', '',
3114         'year',      'int', '', '', '', '',
3115         'month',     'int', '', '', '', '',
3116         'amount',   @money_type, '', '',
3117       ],
3118       'primary_key' => 'exemptnum',
3119       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
3120       'index'       => [],
3121     },
3122
3123     'cust_tax_exempt_pkg' => {
3124       'columns' => [
3125         'exemptpkgnum',  'serial', '', '', '', '',
3126         #'custnum',      'int', '', '', '', ''
3127         'billpkgnum',   'int', '', '', '', '',
3128         'taxnum',       'int', '', '', '', '',
3129         'taxtype',  'varchar', 'NULL', $char_d, '', '',
3130         'year',         'int', 'NULL', '', '', '',
3131         'month',        'int', 'NULL', '', '', '',
3132         'creditbillpkgnum', 'int', 'NULL', '', '', '',
3133         'amount',       @money_type, '', '',
3134         # exemption type flags
3135         'exempt_cust',          'char', 'NULL', 1, '', '',
3136         'exempt_setup',         'char', 'NULL', 1, '', '',
3137         'exempt_recur',         'char', 'NULL', 1, '', '',
3138         'exempt_cust_taxname',  'char', 'NULL', 1, '', '',
3139         'exempt_monthly',       'char', 'NULL', 1, '', '',
3140       ],
3141       'primary_key' => 'exemptpkgnum',
3142       'unique' => [],
3143       'index'  => [ [ 'taxnum', 'year', 'month' ],
3144                     [ 'billpkgnum' ],
3145                     [ 'taxnum', 'taxtype' ],
3146                     [ 'creditbillpkgnum' ],
3147                   ],
3148     },
3149
3150     'cust_tax_exempt_pkg_void' => {
3151       'columns' => [
3152         'exemptpkgnum',  'int', '', '', '', '',
3153         #'custnum',      'int', '', '', '', ''
3154         'billpkgnum',   'int', '', '', '', '',
3155         'taxnum',       'int', '', '', '', '',
3156         'taxtype',  'varchar', 'NULL', $char_d, '', '',
3157         'year',         'int', 'NULL', '', '', '',
3158         'month',        'int', 'NULL', '', '', '',
3159         'creditbillpkgnum', 'int', 'NULL', '', '', '',
3160         'amount',       @money_type, '', '',
3161         # exemption type flags
3162         'exempt_cust',          'char', 'NULL', 1, '', '',
3163         'exempt_setup',         'char', 'NULL', 1, '', '',
3164         'exempt_recur',         'char', 'NULL', 1, '', '',
3165         'exempt_cust_taxname',  'char', 'NULL', 1, '', '',
3166         'exempt_monthly',       'char', 'NULL', 1, '', '',
3167       ],
3168       'primary_key' => 'exemptpkgnum',
3169       'unique' => [],
3170       'index'  => [ [ 'taxnum', 'year', 'month' ],
3171                     [ 'billpkgnum' ],
3172                     [ 'taxnum', 'taxtype' ],
3173                     [ 'creditbillpkgnum' ],
3174                   ],
3175     },
3176
3177     'router' => {
3178       'columns' => [
3179         'routernum', 'serial', '', '', '', '',
3180         'routername', 'varchar', '', $char_d, '', '',
3181         'svcnum', 'int', 'NULL', '', '', '',
3182         'agentnum',   'int', 'NULL', '', '', '',
3183         'manual_addr', 'char', 'NULL', 1, '', '',
3184       ],
3185       'primary_key' => 'routernum',
3186       'unique'      => [],
3187       'index'       => [],
3188     },
3189
3190     'part_svc_router' => {
3191       'columns' => [
3192         'svcrouternum', 'serial', '', '', '', '',
3193         'svcpart', 'int', '', '', '', '',
3194         'routernum', 'int', '', '', '', '',
3195       ],
3196       'primary_key' => 'svcrouternum',
3197       'unique'      => [],
3198       'index'       => [],
3199     },
3200
3201     'addr_block' => {
3202       'columns' => [
3203         'blocknum', 'serial', '', '', '', '',
3204         'routernum', 'int', '', '', '', '',
3205         'ip_gateway', 'varchar', '', 15, '', '',
3206         'ip_netmask', 'int', '', '', '', '',
3207         'agentnum',   'int', 'NULL', '', '', '',
3208         'manual_flag', 'char', 'NULL', 1, '', '',
3209       ],
3210       'primary_key' => 'blocknum',
3211       'unique'      => [ [ 'blocknum', 'routernum' ] ],
3212       'index'       => [],
3213     },
3214
3215     'addr_range' => {
3216       'columns' => [
3217         'rangenum', 'serial', '', '', '', '',
3218         'start',    'varchar', '', 15, '', '',
3219         'length',   'int', '', '', '', '',
3220         'status',   'varchar', 'NULL', 32, '', '',
3221       ],
3222       'primary_key' => 'rangenum',
3223       'unique'      => [],
3224       'index'       => [],
3225     },
3226
3227     'svc_broadband' => {
3228       'columns' => [
3229         'svcnum',                  'int',     '',        '', '', '',
3230         'description',         'varchar', 'NULL',   $char_d, '', '',
3231         'routernum',               'int', 'NULL',        '', '', '',
3232         'blocknum',                'int', 'NULL',        '', '', '',
3233         'sectornum',               'int', 'NULL',        '', '', '',
3234         'speed_up',                'int', 'NULL',        '', '', '',
3235         'speed_down',              'int', 'NULL',        '', '', '',
3236         'ip_addr',             'varchar', 'NULL',        15, '', '',
3237         'mac_addr',            'varchar', 'NULL',        12, '', '',
3238         'authkey',             'varchar', 'NULL',        32, '', '',
3239         'latitude',            'decimal', 'NULL',    '10,7', '', '',
3240         'longitude',           'decimal', 'NULL',    '10,7', '', '',
3241         'altitude',            'decimal', 'NULL',        '', '', '',
3242         'vlan_profile',        'varchar', 'NULL',   $char_d, '', '',
3243         'performance_profile', 'varchar', 'NULL',   $char_d, '', '',
3244         'plan_id',             'varchar', 'NULL',   $char_d, '', '',
3245         'radio_serialnum',     'varchar', 'NULL',   $char_d, '', '',
3246         'radio_location',      'varchar', 'NULL', 2*$char_d, '', '',
3247         'poe_location',        'varchar', 'NULL', 2*$char_d, '', '',
3248         'rssi',                    'int', 'NULL',        '', '', '',
3249         'suid',                    'int', 'NULL',        '', '', '',
3250         'shared_svcnum',           'int', 'NULL',        '', '', '',
3251         'serviceid',           'varchar', 'NULL',        64, '', '',#srvexport/reportfields
3252       ],
3253       'primary_key' => 'svcnum',
3254       'unique'      => [ [ 'ip_addr' ], [ 'mac_addr' ] ],
3255       'index'       => [],
3256     },
3257
3258     'tower' => {
3259       'columns' => [
3260         'towernum',    'serial',     '',      '', '', '',
3261         #'agentnum',       'int', 'NULL',      '', '', '',
3262         'towername',  'varchar',     '', $char_d, '', '',
3263         'disabled',      'char', 'NULL',       1, '', '',
3264         'latitude',   'decimal', 'NULL',  '10,7', '', '',
3265         'longitude',  'decimal', 'NULL',  '10,7', '', '',
3266         'coord_auto',    'char', 'NULL',       1, '', '',
3267         'altitude',   'decimal', 'NULL',      '', '', '',
3268         'height',     'decimal', 'NULL',      '', '', '',
3269         'veg_height', 'decimal', 'NULL',      '', '', '',
3270         'color',      'varchar', 'NULL',       6, '', '',
3271       ],
3272       'primary_key' => 'towernum',
3273       'unique'      => [ [ 'towername' ] ], # , 'agentnum' ] ],
3274       'index'       => [],
3275     },
3276
3277     'tower_sector' => {
3278       'columns' => [
3279         'sectornum',     'serial',     '',      '', '', '',
3280         'towernum',         'int',     '',      '', '', '',
3281         'sectorname',   'varchar',     '', $char_d, '', '',
3282         'ip_addr',      'varchar', 'NULL',      15, '', '',
3283         'height',       'decimal', 'NULL',      '', '', '',
3284         'freq_mhz',         'int', 'NULL',      '', '', '',
3285         'direction',        'int', 'NULL',      '', '', '',
3286         'width',            'int', 'NULL',      '', '', '',
3287         #downtilt etc? rfpath has profile files for devices/antennas you upload?
3288         'sector_range', 'decimal', 'NULL',      '', '', '',  #?
3289       ],
3290       'primary_key' => 'sectornum',
3291       'unique'      => [ [ 'towernum', 'sectorname' ], [ 'ip_addr' ], ],
3292       'index'       => [ [ 'towernum' ] ],
3293     },
3294
3295     'part_virtual_field' => {
3296       'columns' => [
3297         'vfieldpart', 'serial', '', '', '', '',
3298         'dbtable', 'varchar', '', 32, '', '',
3299         'name', 'varchar', '', 32, '', '',
3300         'length', 'int', 'NULL', '', '', '',
3301         'label', 'varchar', 'NULL', 80, '', '',
3302       ],
3303       'primary_key' => 'vfieldpart',
3304       'unique' => [],
3305       'index' => [],
3306     },
3307
3308     'virtual_field' => {
3309       'columns' => [
3310         'vfieldnum', 'serial', '', '', '', '',
3311         'recnum', 'int', '', '', '', '',
3312         'vfieldpart', 'int', '', '', '', '',
3313         'value', 'varchar', '', 128, '', '',
3314       ],
3315       'primary_key' => 'vfieldnum',
3316       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
3317       'index' => [],
3318     },
3319
3320     'acct_snarf' => {
3321       'columns' => [
3322         'snarfnum',    'serial',     '',      '', '', '',
3323         'snarfname',  'varchar', 'NULL', $char_d, '', '',
3324         'svcnum',         'int',     '',      '', '', '',
3325         'machine',    'varchar',     '',     255, '', '',
3326         'protocol',   'varchar',     '', $char_d, '', '',
3327         'username',   'varchar',     '', $char_d, '', '',
3328         '_password',  'varchar',     '', $char_d, '', '',
3329         'check_freq',     'int', 'NULL',      '', '', '',
3330         'leavemail',     'char', 'NULL',       1, '', '',
3331         'apop',          'char', 'NULL',       1, '', '',
3332         'tls',           'char', 'NULL',       1, '', '',
3333         'mailbox',    'varchar', 'NULL', $char_d, '', '',
3334       ],
3335       'primary_key' => 'snarfnum',
3336       'unique' => [],
3337       'index'  => [ [ 'svcnum' ] ],
3338     },
3339
3340     'svc_external' => {
3341       'columns' => [
3342         'svcnum',     'int',     '',      '', '', '',
3343         'id',      'bigint', 'NULL',      '', '', '',
3344         'title',  'varchar', 'NULL', $char_d, '', '',
3345       ],
3346       'primary_key' => 'svcnum',
3347       'unique'      => [],
3348       'index'       => [],
3349     },
3350
3351     'cust_pay_refund' => {
3352       'columns' => [
3353         'payrefundnum', 'serial', '', '', '', '',
3354         'paynum',  'int', '', '', '', '',
3355         'refundnum',  'int', '', '', '', '',
3356         '_date',    @date_type, '', '',
3357         'amount',   @money_type, '', '',
3358       ],
3359       'primary_key' => 'payrefundnum',
3360       'unique' => [],
3361       'index' => [ ['paynum'], ['refundnum'] ],
3362     },
3363
3364     'part_pkg_option' => {
3365       'columns' => [
3366         'optionnum', 'serial', '', '', '', '',
3367         'pkgpart', 'int', '', '', '', '',
3368         'optionname', 'varchar', '', $char_d, '', '',
3369         'optionvalue', 'text', 'NULL', '', '', '',
3370       ],
3371       'primary_key' => 'optionnum',
3372       'unique'      => [],
3373       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
3374     },
3375
3376     'part_pkg_vendor' => {
3377       'columns' => [
3378         'num', 'serial', '', '', '', '',
3379         'pkgpart', 'int', '', '', '', '',
3380         'exportnum', 'int', '', '', '', '',
3381         'vendor_pkg_id', 'varchar', '', $char_d, '', '',
3382       ],
3383       'primary_key' => 'num',
3384       'unique' => [ [ 'pkgpart', 'exportnum' ] ],
3385       'index'       => [ [ 'pkgpart' ] ],
3386     },
3387
3388     'part_pkg_report_option' => {
3389       'columns' => [
3390         'num',      'serial',   '',      '', '', '',
3391         'name',     'varchar',  '', $char_d, '', '',
3392         'disabled', 'char', 'NULL',       1, '', '',
3393       ],
3394       'primary_key' => 'num',
3395       'unique' => [ [ 'name' ] ],
3396       'index' => [ [ 'disabled' ] ],
3397     },
3398
3399     'part_pkg_usage' => {
3400       'columns' => [
3401         'pkgusagepart', 'serial',   '', '', '', '',
3402         'pkgpart',  'int',      '', '', '', '',
3403         'minutes',  'double precision',      '', '', '', '',
3404         'priority', 'int',  'NULL', '', '', '',
3405         'shared',   'char', 'NULL',  1, '', '',
3406         'rollover', 'char', 'NULL',  1, '', '',
3407         'description',  'varchar', 'NULL', $char_d, '', '',
3408       ],
3409       'primary_key' => 'pkgusagepart',
3410       'unique'      => [],
3411       'index'       => [ [ 'pkgpart' ] ],
3412     },
3413
3414     'part_pkg_usage_class' => {
3415       'columns' => [
3416         'num',       'serial',  '', '', '', '',
3417         'pkgusagepart', 'int',  '', '', '', '',
3418         'classnum',     'int','NULL', '', '', '',
3419       ],
3420       'primary_key' => 'num',
3421       'unique'      => [ [ 'pkgusagepart', 'classnum' ] ],
3422       'index'       => [],
3423     },
3424
3425     'part_pkg_fcc_option' => {
3426       'columns' => [
3427         'num',        'serial', '', '', '', '',
3428         'fccoptionname', 'varchar', '', $char_d, '', '',
3429         'pkgpart',       'int', '', '', '', '',
3430         'optionvalue',   'varchar', 'NULL', $char_d, '', '',
3431       ],
3432       'primary_key' => 'num',
3433       'unique'      => [ [ 'fccoptionname', 'pkgpart' ] ],
3434       'index'       => [],
3435     },
3436
3437     'rate' => {
3438       'columns' => [
3439         'ratenum',          'serial',     '', '', '', '',
3440         'ratename',        'varchar', '',$char_d, '', '',
3441         'agentnum',            'int', 'NULL', '', '', '',
3442         'default_detailnum',   'int', 'NULL', '', '', '',
3443       ],
3444       'primary_key' => 'ratenum',
3445       'unique'      => [],
3446       'index'       => [],
3447     },
3448
3449     'rate_detail' => {
3450       'columns' => [
3451         'ratedetailnum',   'serial',  '',     '',      '', '',
3452         'ratenum',         'int',     '',     '',      '', '',
3453         'orig_regionnum',  'int', 'NULL',     '',      '', '',
3454         'dest_regionnum',  'int', 'NULL',     '',      '', '',
3455         'min_included',    'int',     '',     '',      '', '',
3456         'conn_charge',     'decimal', '', '10,4', '0.0000', '',
3457         'conn_cost',       'decimal', '', '10,4', '0.0000', '',
3458         'conn_sec',        'int',     '',     '',      '0', '',
3459         'min_charge',      'decimal', '', '10,5',       '', '',
3460         'min_cost',        'decimal', '', '10,5','0.00000', '',
3461         'sec_granularity', 'int',     '',     '',       '', '',
3462         'ratetimenum',     'int', 'NULL',     '',       '', '',
3463         'classnum',        'int', 'NULL',     '',       '', '',
3464         'cdrtypenum',      'int', 'NULL',     '',       '', '',
3465         'region_group',   'char', 'NULL',      1,       '', '',
3466         'upstream_mult_charge',  'decimal',  '', '10,4', '0.0000', '',
3467         'upstream_mult_cost',    'decimal',  '', '10,4', '0.0000', '',
3468       ],
3469       'primary_key' => 'ratedetailnum',
3470       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
3471       'index'       => [ [ 'ratenum', 'dest_regionnum' ],
3472                          [ 'ratenum', 'ratetimenum' ]
3473                        ],
3474     },
3475
3476     'rate_region' => {
3477       'columns' => [
3478         'regionnum',   'serial',      '', '', '', '',
3479         'regionname',  'varchar',     '', $char_d, '', '',
3480         'exact_match', 'char',    'NULL',  1, '', '',
3481       ],
3482       'primary_key' => 'regionnum',
3483       'unique'      => [],
3484       'index'       => [],
3485     },
3486
3487     'rate_prefix' => {
3488       'columns' => [
3489         'prefixnum',   'serial',      '', '', '', '',
3490         'regionnum',   'int',         '', '', '', '',
3491         'countrycode', 'varchar',     '',  3, '', '',
3492         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
3493         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
3494         'latanum',     'int',     'NULL',      '', '', '',
3495         'state',       'char',    'NULL',       2, '', '',
3496         'ocn',         'char',    'NULL',       4, '', '',
3497       ],
3498       'primary_key' => 'prefixnum',
3499       'unique'      => [],
3500       'index'       => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
3501     },
3502
3503     'rate_time' => {
3504       'columns' => [
3505         'ratetimenum', 'serial',      '',      '', '', '',
3506         'ratetimename',   'varchar',      '', $char_d, '', '',
3507       ],
3508       'primary_key' => 'ratetimenum',
3509       'unique'      => [],
3510       'index'       => [],
3511     },
3512
3513     'rate_time_interval' => {
3514       'columns' => [
3515         'intervalnum', 'serial', '', '', '', '',
3516         'stime',          'int', '', '', '', '',
3517         'etime',          'int', '', '', '', '',
3518         'ratetimenum',    'int', '', '', '', '',
3519       ],
3520       'primary_key' => 'intervalnum',
3521       'unique'      => [],
3522       'index'       => [],
3523     },
3524
3525     #not really part of the above rate_ stuff (used with flat rate rather than
3526     # rated billing), but could be eventually, and its a rate
3527     'rate_tier' => {
3528       'columns' => [
3529         'tiernum',   'serial', '',      '', '', '',
3530         'tiername', 'varchar', '', $char_d, '', '',
3531       ],
3532       'primary_key' => 'tiernum',
3533       'unique'      => [ [ 'tiername'], ],
3534       'index'       => [],
3535     },
3536
3537     'rate_tier_detail' => {
3538       'columns' => [
3539         'tierdetailnum', 'serial', '',     '', '', '',
3540         'tiernum',          'int', '',     '', '', '',
3541         'min_quan',         'int', '',     '', '', '',
3542         'min_charge',   'decimal', '', '10,4', '', '',
3543       ],
3544       'primary_key' => 'tierdetailnum',
3545       'unique'      => [],
3546       'index'       => [ ['tiernum'], ],
3547     },
3548
3549     'usage_class' => {
3550       'columns' => [
3551         'classnum',    'serial',      '',      '', '', '',
3552         'weight',      'int',     'NULL',      '', '', '',
3553         'classname',   'varchar',     '', $char_d, '', '',
3554         'format',      'varchar', 'NULL', $char_d, '', '',
3555         'disabled',    'char',    'NULL',       1, '', '',
3556       ],
3557       'primary_key' => 'classnum',
3558       'unique' => [],
3559       'index' => [ ['disabled'] ],
3560     },
3561
3562     'reg_code' => {
3563       'columns' => [
3564         'codenum',   'serial',    '', '', '', '',
3565         'code',      'varchar',   '', $char_d, '', '',
3566         'agentnum',  'int',       '', '', '', '',
3567       ],
3568       'primary_key' => 'codenum',
3569       'unique'      => [ [ 'agentnum', 'code' ] ],
3570       'index'       => [ [ 'agentnum' ] ],
3571     },
3572
3573     'reg_code_pkg' => {
3574       'columns' => [
3575         'codepkgnum', 'serial', '', '', '', '',
3576         'codenum',   'int',    '', '', '', '',
3577         'pkgpart',   'int',    '', '', '', '',
3578       ],
3579       'primary_key' => 'codepkgnum',
3580       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
3581       'index'       => [ [ 'codenum' ] ],
3582     },
3583
3584     'clientapi_session' => {
3585       'columns' => [
3586         'sessionnum',  'serial',  '', '', '', '',
3587         'sessionid',  'varchar',  '', $char_d, '', '',
3588         'namespace',  'varchar',  '', $char_d, '', '',
3589       ],
3590       'primary_key' => 'sessionnum',
3591       'unique'      => [ [ 'sessionid', 'namespace' ] ],
3592       'index'       => [],
3593     },
3594
3595     'clientapi_session_field' => {
3596       'columns' => [
3597         'fieldnum',    'serial',     '', '', '', '',
3598         'sessionnum',     'int',     '', '', '', '',
3599         'fieldname',  'varchar',     '', $char_d, '', '',
3600         'fieldvalue',    'text', 'NULL', '', '', '',
3601       ],
3602       'primary_key' => 'fieldnum',
3603       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
3604       'index'       => [],
3605     },
3606
3607     'payment_gateway' => {
3608       'columns' => [
3609         'gatewaynum',       'serial',   '',     '', '', '',
3610         'gateway_namespace','varchar',  'NULL', $char_d, '', '',
3611         'gateway_module',   'varchar',  '',     $char_d, '', '',
3612         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
3613         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
3614         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
3615         'gateway_callback_url', 'varchar',  'NULL', 255, '', '',
3616         'gateway_cancel_url',   'varchar',  'NULL', 255, '', '',
3617         'disabled',   'char',  'NULL',   1, '', '',
3618       ],
3619       'primary_key' => 'gatewaynum',
3620       'unique' => [],
3621       'index'  => [ [ 'disabled' ] ],
3622     },
3623
3624     'payment_gateway_option' => {
3625       'columns' => [
3626         'optionnum',   'serial',  '',     '', '', '',
3627         'gatewaynum',  'int',     '',     '', '', '',
3628         'optionname',  'varchar', '',     $char_d, '', '',
3629         'optionvalue', 'text',    'NULL', '', '', '',
3630       ],
3631       'primary_key' => 'optionnum',
3632       'unique'      => [],
3633       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
3634     },
3635
3636     'agent_payment_gateway' => {
3637       'columns' => [
3638         'agentgatewaynum', 'serial', '', '', '', '',
3639         'agentnum',        'int', '', '', '', '',
3640         'gatewaynum',      'int', '', '', '', '',
3641         'cardtype',        'varchar', 'NULL', $char_d, '', '',
3642         'taxclass',        'varchar', 'NULL', $char_d, '', '',
3643       ],
3644       'primary_key' => 'agentgatewaynum',
3645       'unique'      => [],
3646       'index'       => [ [ 'agentnum', 'cardtype' ], ],
3647     },
3648
3649     'banned_pay' => {
3650       'columns' => [
3651         'bannum',  'serial',   '',     '', '', '',
3652         'payby',   'char',     '',       4, '', '',
3653         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
3654         #'paymask', 'varchar',  'NULL', $char_d, '', ''
3655         '_date',            @date_type,         '', '',
3656         'end_date',         @date_type,         '', '',
3657         'otaker',  'varchar',  'NULL',      32, '', '',
3658         'usernum',     'int',  'NULL',      '', '', '',
3659         'bantype', 'varchar',  'NULL', $char_d, '', '',
3660         'reason',  'varchar',  'NULL', $char_d, '', '',
3661       ],
3662       'primary_key' => 'bannum',
3663       'unique'      => [],
3664       'index'       => [ [ 'payby', 'payinfo' ], [ 'usernum' ], ],
3665     },
3666
3667     'pkg_category' => {
3668       'columns' => [
3669         'categorynum',        'serial',     '',      '', '', '',
3670         'categoryname',      'varchar',     '', $char_d, '', '',
3671         'weight',                'int', 'NULL',      '', '', '',
3672         'ticketing_queueid',     'int', 'NULL',      '', '', '',
3673         'condense',             'char', 'NULL',       1, '', '',
3674         'disabled',             'char', 'NULL',       1, '', '',
3675       ],
3676       'primary_key' => 'categorynum',
3677       'unique' => [],
3678       'index' => [ ['disabled'] ],
3679     },
3680
3681     'pkg_class' => {
3682       'columns' => [
3683         'classnum',    'serial',   '',      '', '', '',
3684         'classname',   'varchar',  '', $char_d, '', '',
3685         'categorynum', 'int',  'NULL',      '', '', '',
3686         'disabled',    'char', 'NULL',       1, '', '',
3687         'fcc_ds0s',      'int',     'NULL', '', '', '',
3688       ],
3689       'primary_key' => 'classnum',
3690       'unique' => [],
3691       'index' => [ ['disabled'] ],
3692     },
3693
3694     'cdr' => {
3695       'columns' => [
3696         # qw( name type null length default local );
3697
3698         ###
3699         #asterisk fields
3700         ###
3701
3702         'acctid',   'bigserial',  '', '', '', '',
3703         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
3704         'calldate', 'timestamp',   '',      '', \'now()', '',
3705         'clid',        'varchar',  '', $char_d, \"''", '',
3706         'src',         'varchar',  '', $char_d, \"''", '',
3707         'dst',         'varchar',  '', $char_d, \"''", '',
3708         'dcontext',    'varchar',  '', $char_d, \"''", '',
3709         'channel',     'varchar',  '', $char_d, \"''", '',
3710         'dstchannel',  'varchar',  '', $char_d, \"''", '',
3711         'lastapp',     'varchar',  '', $char_d, \"''", '',
3712         'lastdata',    'varchar',  '',     255, \"''", '',
3713
3714         #currently only opensips
3715         'src_ip_addr', 'varchar',  'NULL',  15,    '', '',
3716         'dst_ip_addr', 'varchar',  'NULL',  15,    '', '',
3717
3718         #currently only u4:
3719         # terminating number (as opposed to dialed destination)
3720         'dst_term',    'varchar',  'NULL', $char_d, '', '',
3721
3722         #these don't seem to be logged by most of the SQL cdr_* modules
3723         #except tds under sql-illegal names, so;
3724         # ... don't rely on them for rating?
3725         # and, what they hey, i went ahead and changed the names and data types
3726         # to freeside-style dates...
3727           #'start',  'timestamp', 'NULL',  '',    '', '',
3728           #'answer', 'timestamp', 'NULL',  '',    '', '',
3729           #'end',    'timestamp', 'NULL',  '',    '', '',
3730         'startdate',  @date_type, '', '',
3731         'answerdate', @date_type, '', '',
3732         'enddate',    @date_type, '', '',
3733         #
3734
3735         'duration',    'int',      '',      '',     0, '',
3736         'billsec',     'int',      '',      '',     0, '',
3737         'disposition', 'varchar',  '',      45, \"''", '',
3738         'amaflags',    'int',      '',      '',     0, '',
3739         'accountcode', 'varchar',  '',      32, \"''", '',
3740         'uniqueid',    'varchar',  '', $char_d, \"''", '',
3741         'userfield',   'varchar',  '',     512, \"''", '',
3742
3743         'max_callers', 'int',  'NULL',      '',    '', '',
3744
3745         ###
3746         # old fields for unitel/RSLCOM/convergent that don't map to asterisk
3747         # ones we adoped moved to "own fields" section below
3748         # charged_party, upstream_price, rated_price, carrierid, cdrtypenum
3749         ###
3750
3751         'upstream_currency',      'char', 'NULL',       3, '', '',
3752         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
3753
3754         # how it was rated internally...
3755         'ratedetailnum',           'int', 'NULL',      '', '', '',
3756
3757         'distance',            'decimal', 'NULL',      '', '', '',
3758         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
3759
3760         #cdr_calltype: the big list in appendix 2
3761         'calltypenum',             'int', 'NULL',      '', '', '',
3762
3763         'description',         'varchar', 'NULL', $char_d, '', '',
3764         'quantity',                'int', 'NULL',      '', '', '',
3765
3766         'upstream_rateid',         'int', 'NULL',      '', '', '',
3767
3768         ###
3769         # more fields, for GSM imports
3770         ###
3771         'servicecode',             'int', 'NULL',      '', '', '',
3772         'quantity_able',           'int', 'NULL',      '', '', '',
3773
3774         ###
3775         #and now for our own fields
3776         ###
3777
3778         'cdrtypenum',              'int', 'NULL',      '', '', '',
3779
3780         'charged_party',       'varchar', 'NULL', $char_d, '', '',
3781         'charged_party_imsi',  'varchar', 'NULL', $char_d, '', '',
3782
3783         'upstream_price',      'decimal', 'NULL',  '10,5', '', '',
3784         'upstream_src_regionname', 'varchar', 'NULL', $char_d, '', '',
3785         'upstream_dst_regionname', 'varchar', 'NULL', $char_d, '', '',
3786
3787         # how it was rated internally...
3788         'rated_pretty_dst',       'varchar', 'NULL', $char_d, '', '',
3789         'rated_regionname',       'varchar', 'NULL', $char_d, '', '',
3790         'rated_price',            'decimal', 'NULL',  '10,4', '', '',
3791         'rated_seconds',              'int', 'NULL',      '', '', '',
3792         'rated_minutes', 'double precision', 'NULL',      '', '', '',
3793         'rated_granularity',          'int', 'NULL',      '', '', '',
3794         'rated_ratedetailnum',        'int', 'NULL',      '', '', '',
3795         'rated_classnum',             'int', 'NULL',      '', '', '',
3796         'rated_ratename',         'varchar', 'NULL', $char_d, '', '',
3797
3798         'carrierid',               'bigint', 'NULL',      '', '', '',
3799
3800         # service it was matched to
3801         'svcnum',             'int',   'NULL',     '',   '', '',
3802
3803         #NULL, done (or something)
3804         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
3805
3806         #NULL, done (or something)
3807         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '',
3808
3809         #an indexed place to put big numbers
3810         'cdrid',         'bigint',     'NULL',     '',  '', '',
3811
3812         #for taqua accountcode rewriting, for starters
3813         'sessionnum',       'int',    'NULL',      '', '', '',
3814         'subscriber',   'varchar',    'NULL', $char_d, '', '',
3815
3816         #old
3817         'cdrbatch',     'varchar',    'NULL',     255, '', '',
3818         #new
3819         'cdrbatchnum',      'int',    'NULL',      '', '', '',
3820
3821       ],
3822       'primary_key' => 'acctid',
3823       'unique' => [],
3824       'index' => [ [ 'calldate' ],
3825                    [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
3826                    [ 'lastapp' ],
3827                    ['accountcode'], ['uniqueid'], ['carrierid'], ['cdrid'],
3828                    [ 'sessionnum' ], [ 'subscriber' ],
3829                    [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
3830                    [ 'cdrbatch' ], [ 'cdrbatchnum' ],
3831                    [ 'src_ip_addr' ], [ 'dst_ip_addr' ], [ 'dst_term' ],
3832                  ],
3833     },
3834
3835     'cdr_batch' => {
3836       'columns' => [
3837         'cdrbatchnum',   'serial',    '',   '', '', '',
3838         'cdrbatch', 'varchar', 'NULL', 255, '', '',
3839         '_date',     @date_type, '', '',
3840       ],
3841       'primary_key' => 'cdrbatchnum',
3842       'unique' => [ [ 'cdrbatch' ] ],
3843       'index' => [],
3844     },
3845
3846     'cdr_termination' => {
3847       'columns' => [
3848         'cdrtermnum', 'bigserial',     '',      '', '', '',
3849         'acctid',        'bigint',     '',      '', '', '',
3850         'termpart',         'int',     '',      '', '', '',#future use see below
3851         'rated_price',  'decimal', 'NULL',  '10,4', '', '',
3852         'rated_seconds',    'int', 'NULL',      '', '', '',
3853         'rated_minutes', 'double precision', 'NULL',   '', '', '',
3854         'status',       'varchar', 'NULL',      32, '', '',
3855         'svcnum',           'int', 'NULL',      '', '', '',
3856       ],
3857       'primary_key' => 'cdrtermnum',
3858       'unique'      => [ [ 'acctid', 'termpart' ] ],
3859       'index'       => [ [ 'acctid' ], [ 'status' ], ],
3860     },
3861
3862     #to handle multiple termination/settlement passes...
3863    # 'part_termination' => {
3864    #   'columns' => [
3865    #     'termpart',       'int', '',      '', '', '',
3866    #     'termname',   'varchar', '', $char_d, '', '',
3867    #     'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
3868    #   ],
3869    #   'primary_key' => 'termpart',
3870    #   'unique' => [],
3871    #   'index'  => [],
3872    # },
3873
3874     #the remaining cdr_ tables are not really used
3875     'cdr_calltype' => {
3876       'columns' => [
3877         'calltypenum',   'serial',  '', '', '', '',
3878         'calltypename',  'varchar', '', $char_d, '', '',
3879       ],
3880       'primary_key' => 'calltypenum',
3881       'unique'      => [],
3882       'index'       => [],
3883     },
3884
3885     'cdr_type' => {
3886       'columns' => [
3887         'cdrtypenum'  => 'serial',  '', '', '', '',
3888         'cdrtypename' => 'varchar', '', $char_d, '', '',
3889       ],
3890       'primary_key' => 'cdrtypenum',
3891       'unique'      => [],
3892       'index'       => [],
3893     },
3894
3895     'cdr_carrier' => {
3896       'columns' => [
3897         'carrierid'   =>  'serial',     '',      '', '', '',
3898         'carriername' => 'varchar',     '', $char_d, '', '',
3899         'disabled'    =>    'char', 'NULL',       1, '', '',
3900       ],
3901       'primary_key' => 'carrierid',
3902       'unique'      => [],
3903       'index'       => [],
3904     },
3905
3906     #'cdr_file' => {
3907     #  'columns' => [
3908     #    'filenum',    'serial',     '', '', '', '',
3909     #    'filename',  'varchar',     '', '', '', '',
3910     #    'status',    'varchar', 'NULL', '', '', '',
3911     #  ],
3912     #  'primary_key' => 'filenum',
3913     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
3914     #                                   # agent-virtualize or have a customer
3915     #                                   # with dup-filename needs or something
3916     #                                   # (only used by cdr.http_and_import for
3917     #                                   #  chrissakes)
3918     #  'index'  => [],
3919     #},
3920
3921     'inventory_item' => {
3922       'columns' => [
3923         'itemnum',   'serial',      '',      '', '', '',
3924         'classnum',  'int',         '',      '', '', '',
3925         'agentnum',  'int',     'NULL',      '', '', '',
3926         'item',      'varchar',     '', $char_d, '', '',
3927         'svcnum',    'int',     'NULL',      '', '', '',
3928         'svc_field', 'varchar', 'NULL', $char_d, '', '',
3929       ],
3930       'primary_key' => 'itemnum',
3931       'unique' => [ [ 'classnum', 'item' ] ],
3932       'index'  => [ [ 'classnum' ], [ 'agentnum' ], [ 'svcnum' ] ],
3933     },
3934
3935     'inventory_class' => {
3936       'columns' => [
3937         'classnum',  'serial',       '',      '', '', '',
3938         'classname', 'varchar',      '', $char_d, '', '',
3939       ],
3940       'primary_key' => 'classnum',
3941       'unique' => [],
3942       'index'  => [],
3943     },
3944
3945     'access_user' => {
3946       'columns' => [
3947         'usernum',            'serial',      '',      '', '', '',
3948         'username',           'varchar',     '', $char_d, '', '',
3949         '_password',          'varchar',     '', $char_d, '', '',
3950         'last',               'varchar',     '', $char_d, '', '',
3951         'first',              'varchar',     '', $char_d, '', '',
3952         'user_custnum',           'int', 'NULL',      '', '', '',
3953         'report_salesnum',        'int', 'NULL',      '', '', '',
3954         'disabled',              'char', 'NULL',       1, '', '',
3955       ],
3956       'primary_key' => 'usernum',
3957       'unique' => [ [ 'username' ] ],
3958       'index'  => [ [ 'user_custnum' ] ],
3959     },
3960
3961     'access_user_pref' => {
3962       'columns' => [
3963         'prefnum',    'serial',       '', '', '', '',
3964         'usernum',     'int',       '', '', '', '',
3965         'prefname', 'varchar', '', $char_d, '', '',
3966         'prefvalue', 'text', 'NULL', '', '', '',
3967         'expiration', @date_type, '', '',
3968       ],
3969       'primary_key' => 'prefnum',
3970       'unique' => [],
3971       'index'  => [ [ 'usernum' ] ],
3972     },
3973
3974     'access_group' => {
3975       'columns' => [
3976         'groupnum',   'serial', '',      '', '', '',
3977         'groupname', 'varchar', '', $char_d, '', '',
3978       ],
3979       'primary_key' => 'groupnum',
3980       'unique' => [ [ 'groupname' ] ],
3981       'index'  => [],
3982     },
3983
3984     'access_usergroup' => {
3985       'columns' => [
3986         'usergroupnum', 'serial', '', '', '', '',
3987         'usernum',         'int', '', '', '', '',
3988         'groupnum',        'int', '', '', '', '',
3989       ],
3990       'primary_key' => 'usergroupnum',
3991       'unique' => [ [ 'usernum', 'groupnum' ] ],
3992       'index'  => [ [ 'usernum' ] ],
3993     },
3994
3995     'access_groupagent' => {
3996       'columns' => [
3997         'groupagentnum', 'serial', '', '', '', '',
3998         'groupnum',         'int', '', '', '', '',
3999         'agentnum',         'int', '', '', '', '',
4000       ],
4001       'primary_key' => 'groupagentnum',
4002       'unique' => [ [ 'groupnum', 'agentnum' ] ],
4003       'index'  => [ [ 'groupnum' ] ],
4004     },
4005
4006     'access_right' => {
4007       'columns' => [
4008         'rightnum',   'serial', '',      '', '', '',
4009         'righttype', 'varchar', '', $char_d, '', '',
4010         'rightobjnum',   'int', '',      '', '', '',
4011         'rightname', 'varchar', '', $char_d, '', '',
4012       ],
4013       'primary_key' => 'rightnum',
4014       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
4015       'index'  => [],
4016     },
4017
4018     'sched_item' => {
4019       'columns' => [
4020         'itemnum',   'serial',      '', '', '', '',
4021         'usernum',      'int',  'NULL', '', '', '',
4022         #'itemname', 'varchar', $char_d, '', '', '',
4023         'disabled',    'char',  'NULL',  1, '', '',
4024       ],
4025       'primary_key'  => 'itemnum',
4026       'unique'       => [ [ 'usernum' ] ],
4027       'index'        => [],
4028     },
4029
4030     #'sched_item_class'
4031
4032     'sched_avail' => {
4033       'columns' => [
4034         'availnum',      'serial', '', '', '', '',
4035         'itemnum',          'int', '', '', '', '',
4036         'wday',             'int', '', '', '', '',
4037         'stime',            'int', '', '', '', '',
4038         'etime',            'int', '', '', '', '',
4039         'override_date',    @date_type,    '', '',
4040       ],
4041       'primary_key'  => 'availnum',
4042       'unique'       => [],
4043       'index'        => [],
4044     },
4045
4046     'svc_phone' => {
4047       'columns' => [
4048         'svcnum',                         'int',     '',      '', '', '',
4049         'countrycode',                'varchar',     '',       3, '', '',
4050         'phonenum',                   'varchar',     '',      25, '', '', #12 ?
4051         'sim_imsi',                   'varchar', 'NULL',      15, '', '',
4052         'pin',                        'varchar', 'NULL', $char_d, '', '',
4053         'sip_password',               'varchar', 'NULL', $char_d, '', '',
4054         'phone_name',                 'varchar', 'NULL', $char_d, '', '',
4055         'pbxsvc',                         'int', 'NULL',      '', '', '',
4056         'domsvc',                         'int', 'NULL',      '', '', '',
4057         'locationnum',                    'int', 'NULL',      '', '', '',
4058         'forwarddst',                 'varchar', 'NULL',      15, '', '',
4059         'email',                      'varchar', 'NULL',     255, '', '',
4060         'lnp_status',                 'varchar', 'NULL', $char_d, '', '',
4061         'portable',                      'char', 'NULL',       1, '', '',
4062         'lrn',                           'char', 'NULL',      10, '', '',
4063         'lnp_desired_due_date',           'int', 'NULL',      '', '', '',
4064         'lnp_due_date',                   'int', 'NULL',      '', '', '',
4065         'lnp_other_provider',         'varchar', 'NULL', $char_d, '', '',
4066         'lnp_other_provider_account', 'varchar', 'NULL', $char_d, '', '',
4067         'lnp_reject_reason',          'varchar', 'NULL', $char_d, '', '',
4068         'sms_carrierid',                  'int', 'NULL',      '', '', '',
4069         'sms_account',                'varchar', 'NULL', $char_d, '', '',
4070         'max_simultaneous',               'int', 'NULL',      '', '', '',
4071         'e911_class',                    'char', 'NULL',       1, '', '',
4072         'e911_type',                     'char', 'NULL',       1, '', '',
4073         'circuit_svcnum',                 'int', 'NULL',      '', '', '',
4074         'sip_server',                 'varchar', 'NULL', $char_d, '', '',
4075       ],
4076       'primary_key' => 'svcnum',
4077       'unique' => [ [ 'sms_carrierid', 'sms_account'] ],
4078       'index'  => [ ['countrycode', 'phonenum'], ['pbxsvc'], ['domsvc'],
4079                     ['locationnum'], ['sms_carrierid'],
4080                   ],
4081     },
4082
4083     'phone_device' => {
4084       'columns' => [
4085         'devicenum', 'serial',     '', '', '', '',
4086         'devicepart',   'int',     '', '', '', '',
4087         'svcnum',       'int',     '', '', '', '',
4088         'mac_addr', 'varchar', 'NULL', 12, '', '',
4089       ],
4090       'primary_key' => 'devicenum',
4091       'unique' => [ [ 'mac_addr' ], ],
4092       'index'  => [ [ 'devicepart' ], [ 'svcnum' ], ],
4093     },
4094
4095     'part_device' => {
4096       'columns' => [
4097         'devicepart', 'serial',  '',      '', '', '',
4098         'devicename', 'varchar', '', $char_d, '', '',
4099         'inventory_classnum', 'int', 'NULL', '', '', '',
4100       ],
4101       'primary_key' => 'devicepart',
4102       'unique' => [ [ 'devicename' ] ], #?
4103       'index'  => [],
4104     },
4105
4106     'phone_avail' => {
4107       'columns' => [
4108         'availnum',    'serial',      '',      '', '', '',
4109         'exportnum',   'int',         '',      '', '', '',
4110         'countrycode', 'varchar',     '',       3, '', '',
4111         'state',       'char',    'NULL',       2, '', '',
4112         'npa',         'char',        '',       3, '', '',
4113         'nxx',         'char',    'NULL',       3, '', '',
4114         'station',     'char',    'NULL',       4, '', '',
4115         'name',        'varchar', 'NULL', $char_d, '', '',
4116         'rate_center_abbrev', 'varchar', 'NULL', $char_d, '', '',
4117         'latanum',      'int',     'NULL',      '', '', '',
4118         'msanum',       'int', 'NULL', '', '', '',
4119         'ordernum',      'int',     'NULL',      '', '', '',
4120         'svcnum',      'int',     'NULL',      '', '', '',
4121         'availbatch', 'varchar',  'NULL', $char_d, '', '',
4122       ],
4123       'primary_key' => 'availnum',
4124       'unique' => [],
4125       'index'  => [ [ 'exportnum', 'countrycode', 'state' ],     #npa search
4126                     [ 'exportnum', 'countrycode', 'npa' ],       #nxx search
4127                     [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
4128                     [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
4129                     [ 'svcnum' ],
4130                     [ 'availbatch' ],
4131                     [ 'latanum' ],
4132                   ],
4133     },
4134
4135     'lata' => {
4136       'columns' => [
4137         'latanum',    'int',      '',      '', '', '',
4138         'description',   'varchar',    '',      $char_d, '', '',
4139         'have_usage',   'int',    'NULL',      '', '', '',
4140       ],
4141       'primary_key' => 'latanum',
4142       'unique' => [],
4143       'index'  => [],
4144     },
4145
4146     'msa' => {
4147       'columns' => [
4148         'msanum',    'int',      '',      '', '', '',
4149         'description',   'varchar',    '',      $char_d, '', '',
4150       ],
4151       'primary_key' => 'msanum',
4152       'unique' => [],
4153       'index'  => [],
4154     },
4155
4156     'rate_center' => {
4157       'columns' => [
4158         'ratecenternum',    'serial',      '',      '', '', '',
4159         'description',   'varchar',    '',      $char_d, '', '',
4160       ],
4161       'primary_key' => 'ratecenternum',
4162       'unique' => [],
4163       'index'  => [],
4164     },
4165
4166     'did_vendor' => {
4167       'columns' => [
4168         'vendornum',    'serial',      '',      '', '', '',
4169         'vendorname',   'varchar',        '',     $char_d, '', '',
4170       ],
4171       'primary_key' => 'vendornum',
4172       'unique' => [],
4173       'index'  => [],
4174     },
4175
4176     'did_order_item' => {
4177       'columns' => [
4178         'orderitemnum',    'serial',      '',      '', '', '',
4179         'ordernum',    'int',      '',      '', '', '',
4180         'msanum',      'int',     'NULL',      '', '', '',
4181         'npa',      'int',     'NULL',      '', '', '',
4182         'latanum',      'int',     'NULL',      '', '', '',
4183         'ratecenternum',      'int',     'NULL',      '', '', '',
4184         'state',       'char',    'NULL',       2, '', '',
4185         'quantity',      'int',     '',      '', '', '',
4186         'custnum',   'int', 'NULL', '', '', '',
4187       ],
4188       'primary_key' => 'orderitemnum',
4189       'unique' => [],
4190       'index'  => [],
4191     },
4192
4193     'did_order' => {
4194       'columns' => [
4195         'ordernum',    'serial',      '',      '', '', '',
4196         'vendornum',   'int',       '',      '', '', '',
4197         'vendor_order_id',   'varchar',  'NULL',   $char_d, '', '',
4198         'custnum',   'int', 'NULL', '', '', '',
4199         'submitted',      'int',     '',      '', '', '',
4200         'confirmed',      'int',     'NULL',      '', '', '',
4201         'received',      'int',     'NULL',      '', '', '',
4202       ],
4203       'primary_key' => 'ordernum',
4204       'unique' => [ [ 'vendornum', 'vendor_order_id' ] ],
4205       'index'  => [],
4206     },
4207
4208     'reason_type' => {
4209       'columns' => [
4210         'typenum',   'serial',  '', '', '', '',
4211         'class',     'char', '', 1, '', '',
4212         'type',     'varchar', '', $char_d, '', '',
4213       ],
4214       'primary_key' => 'typenum',
4215       'unique' => [],
4216       'index' => [],
4217     },
4218
4219     'reason' => {
4220       'columns' => [
4221         'reasonnum',     'serial',  '', '', '', '',
4222         'reason_type',   'int',  '', '', '', '',
4223         'reason',        'text', '', '', '', '',
4224         'disabled',      'char',    'NULL', 1, '', '',
4225         'unsuspend_pkgpart', 'int',  'NULL', '', '', '',
4226         'unsuspend_hold','char',    'NULL', 1, '', '',
4227         'unused_credit', 'char',    'NULL', 1, '', '',
4228         'feepart',        'int', 'NULL', '', '', '',
4229         'fee_on_unsuspend','char',  'NULL', 1, '', '',
4230         'fee_hold',      'char',    'NULL', 1, '', '',
4231       ],
4232       'primary_key' => 'reasonnum',
4233       'unique' => [],
4234       'index' => [],
4235     },
4236
4237     'conf' => {
4238       'columns' => [
4239         'confnum',  'serial',     '',      '', '', '',
4240         'agentnum', 'int',    'NULL',      '', '', '',
4241         'locale',   'varchar','NULL',      16, '', '',
4242         'name',     'varchar',    '', $char_d, '', '',
4243         'value',    'text',   'NULL',      '', '', '',
4244       ],
4245       'primary_key' => 'confnum',
4246       'unique' => [ [ 'agentnum', 'locale', 'name' ] ],
4247       'index' => [],
4248     },
4249
4250     'pkg_referral' => {
4251       'columns' => [
4252         'pkgrefnum',     'serial', '', '', '', '',
4253         'pkgnum',        'int',    '', '', '', '',
4254         'refnum',        'int',    '', '', '', '',
4255       ],
4256       'primary_key' => 'pkgrefnum',
4257       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
4258       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
4259     },
4260
4261     'svc_pbx' => {
4262       'columns' => [
4263         'svcnum',           'int',     '',      '', '', '',
4264         'id',               'int', 'NULL',      '', '', '',
4265         'uuid',            'char', 'NULL',      36, '', '',
4266         'title',        'varchar', 'NULL', $char_d, '', '',
4267         'max_extensions',   'int', 'NULL',      '', '', '',
4268         'max_simultaneous', 'int', 'NULL',      '', '', '',
4269         'ip_addr',      'varchar', 'NULL',      40, '', '',
4270       ],
4271       'primary_key' => 'svcnum',
4272       'unique' => [],
4273       'index'  => [ [ 'id' ], [ 'uuid' ] ],
4274     },
4275
4276     'pbx_extension' => {
4277       'columns' => [
4278         'extensionnum',  'serial',     '',      '', '', '',
4279         'svcnum',           'int',     '',      '', '', '',
4280         'extension',    'varchar',     '', $char_d, '', '',
4281         'pin',          'varchar', 'NULL', $char_d, '', '',
4282         'sip_password', 'varchar', 'NULL', $char_d, '', '',
4283         'phone_name',   'varchar', 'NULL', $char_d, '', '',
4284       ],
4285       'primary_key'  => 'extensionnum',
4286       'unique'       => [ [ 'svcnum', 'extension' ] ],
4287       'index'        => [ [ 'svcnum' ] ],
4288     },
4289
4290     'svc_mailinglist' => { #svc_group?
4291       'columns' => [
4292         'svcnum',            'int',     '',            '', '', '',
4293         'username',      'varchar',     '', $username_len, '', '',
4294         'domsvc',            'int',     '',            '', '', '',
4295         'listnum',           'int',     '',            '', '', '',
4296         'reply_to',         'char', 'NULL',             1, '', '',#SetReplyTo
4297         'remove_from',      'char', 'NULL',             1, '', '',#RemoveAuthor
4298         'reject_auto',      'char', 'NULL',             1, '', '',#RejectAuto
4299         'remove_to_and_cc', 'char', 'NULL',             1, '', '',#RemoveToAndCc
4300       ],
4301       'primary_key' => 'svcnum',
4302       'unique' => [],
4303       'index'  => [ ['username'], ['domsvc'], ['listnum'] ],
4304     },
4305
4306     'mailinglist' => {
4307       'columns' => [
4308         'listnum',   'serial', '',      '', '', '',
4309         'listname', 'varchar', '', $char_d, '', '',
4310       ],
4311       'primary_key' => 'listnum',
4312       'unique' => [],
4313       'index'  => [],
4314     },
4315
4316     'mailinglistmember' => {
4317       'columns' => [
4318         'membernum',        'serial',     '',   '', '', '',
4319         'listnum',             'int',     '',   '', '', '',
4320         'svcnum',              'int', 'NULL',   '', '', '',
4321         'contactemailnum',     'int', 'NULL',   '', '', '',
4322         'email',           'varchar', 'NULL',  255, '', '',
4323       ],
4324       'primary_key' => 'membernum',
4325       'unique'      => [],
4326       'index'       => [['listnum'],['svcnum'],['contactemailnum'],['email']],
4327     },
4328
4329     'bill_batch' => {
4330       'columns' => [
4331         'batchnum',         'serial',     '',  '', '', '',
4332         'agentnum',            'int', 'NULL',  '', '', '',
4333         'status',             'char', 'NULL', '1', '', '',
4334         'pdf',                'blob', 'NULL',  '', '', '',
4335       ],
4336       'primary_key' => 'batchnum',
4337       'unique'      => [],
4338       'index'       => [ ['agentnum'] ],
4339     },
4340
4341     'cust_bill_batch' => {
4342       'columns' => [
4343         'billbatchnum',     'serial',     '', '', '', '',
4344         'batchnum',            'int',     '', '', '', '',
4345         'invnum',              'int',     '', '', '', '',
4346       ],
4347       'primary_key' => 'billbatchnum',
4348       'unique'      => [],
4349       'index'       => [ [ 'batchnum' ], [ 'invnum' ] ],
4350     },
4351
4352     'cust_bill_batch_option' => {
4353       'columns' => [
4354         'optionnum', 'serial', '', '', '', '',
4355         'billbatchnum', 'int', '', '', '', '',
4356         'optionname', 'varchar', '', $char_d, '', '',
4357         'optionvalue', 'text', 'NULL', '', '', '',
4358       ],
4359       'primary_key' => 'optionnum',
4360       'unique'      => [],
4361       'index'       => [ [ 'billbatchnum' ], [ 'optionname' ] ],
4362     },
4363
4364     'msg_template' => {
4365       'columns' => [
4366         'msgnum',     'serial',     '',      '', '', '',
4367         'msgname',   'varchar',     '', $char_d, '', '',
4368         'agentnum',      'int', 'NULL',      '', '', '',
4369         'subject',   'varchar', 'NULL',     512, '', '',
4370         'mime_type', 'varchar',     '', $char_d, '', '',
4371         'body',         'blob', 'NULL',      '', '', '',
4372         'disabled',     'char', 'NULL',       1, '', '',
4373         'from_addr', 'varchar', 'NULL',     255, '', '',
4374         'bcc_addr',  'varchar', 'NULL',     255, '', '',
4375       ],
4376       'primary_key' => 'msgnum',
4377       'unique'      => [ ],
4378       'index'       => [ ['agentnum'], ],
4379     },
4380
4381     'template_content' => {
4382       'columns' => [
4383         'contentnum', 'serial',     '',      '', '', '',
4384         'msgnum',        'int',     '',      '', '', '',
4385         'locale',    'varchar', 'NULL',      16, '', '',
4386         'subject',   'varchar', 'NULL',     512, '', '',
4387         'body',         'text', 'NULL',      '', '', '',
4388       ],
4389       'primary_key' => 'contentnum',
4390       'unique'      => [ ['msgnum', 'locale'] ],
4391       'index'       => [ ],
4392     },
4393
4394     'cust_msg' => {
4395       'columns' => [
4396         'custmsgnum', 'serial',     '',     '', '', '',
4397         'custnum',       'int', 'NULL',     '', '', '',
4398         'msgnum',        'int', 'NULL',     '', '', '',
4399         '_date',    @date_type,                 '', '',
4400         'env_from',  'varchar', 'NULL',    255, '', '',
4401         'env_to',    'varchar', 'NULL',    255, '', '',
4402         'header',       'blob', 'NULL',     '', '', '',
4403         'body',         'blob', 'NULL',     '', '', '',
4404         'error',     'varchar', 'NULL',    255, '', '',
4405         'status',    'varchar',     '',$char_d, '', '',
4406         'msgtype',   'varchar', 'NULL',     16, '', '',
4407       ],
4408       'primary_key' => 'custmsgnum',
4409       'unique'      => [ ],
4410       'index'       => [ ['custnum'], ],
4411     },
4412
4413     'svc_cert' => {
4414       'columns' => [
4415         'svcnum',                'int',     '',      '', '', '',
4416         'recnum',                'int', 'NULL',      '', '', '',
4417         'privatekey',           'text', 'NULL',      '', '', '',
4418         'csr',                  'text', 'NULL',      '', '', '',
4419         'certificate',          'text', 'NULL',      '', '', '',
4420         'cacert',               'text', 'NULL',      '', '', '',
4421         'common_name',       'varchar', 'NULL', $char_d, '', '',
4422         'organization',      'varchar', 'NULL', $char_d, '', '',
4423         'organization_unit', 'varchar', 'NULL', $char_d, '', '',
4424         'city',              'varchar', 'NULL', $char_d, '', '',
4425         'state',             'varchar', 'NULL', $char_d, '', '',
4426         'country',              'char', 'NULL',       2, '', '',
4427         'cert_contact',      'varchar', 'NULL', $char_d, '', '',
4428       ],
4429       'primary_key' => 'svcnum',
4430       'unique' => [],
4431       'index'  => [], #recnum
4432     },
4433
4434     'svc_port' => {
4435       'columns' => [
4436         'svcnum',                'int',     '',      '', '', '',
4437         'serviceid', 'varchar', '', 64, '', '', #srvexport / reportfields
4438       ],
4439       'primary_key' => 'svcnum',
4440       'unique' => [],
4441       'index'  => [], #recnum
4442     },
4443
4444     'areacode'  => {
4445       'columns' => [
4446         'areanum',   'serial',        '',      '', '', '',
4447         'code',        'char',        '',       3, '', '',
4448         'country',     'char',    'NULL',       2, '', '',
4449         'state',       'char',    'NULL',       2, '', '',
4450         'description','varchar',  'NULL',     255, '', '',
4451       ],
4452       'primary_key' => 'areanum',
4453       'unique' => [ [ 'areanum' ] ],
4454       'index'  => [],
4455     },
4456
4457     'upgrade_journal' => {
4458       'columns' => [
4459         'upgradenum', 'serial', '', '', '', '',
4460         '_date', 'int', '', '', '', '',
4461         'upgrade', 'varchar', '', $char_d, '', '',
4462         'status', 'varchar', '', $char_d, '', '',
4463         'statustext', 'varchar', 'NULL', $char_d, '', '',
4464       ],
4465       'primary_key' => 'upgradenum',
4466       'unique' => [],
4467       'index' => [ [ 'upgrade' ] ],
4468     },
4469
4470     'upload_target' => {
4471       'columns' => [
4472         'targetnum', 'serial', '', '', '', '',
4473         'agentnum', 'int', 'NULL', '', '', '',
4474         'protocol', 'varchar', '', 10, '', '',
4475         'hostname', 'varchar', '', $char_d, '', '',
4476         'port', 'int', 'NULL', '', '', '',
4477         'username', 'varchar', '', $char_d, '', '',
4478         'password', 'varchar', 'NULL', $char_d, '', '',
4479         'path', 'varchar', 'NULL', $char_d, '', '',
4480         'subject', 'varchar', 'NULL', '255', '', '',
4481         'handling', 'varchar', 'NULL', $char_d, '', '',
4482       ],
4483       'primary_key' => 'targetnum',
4484       'unique' => [ [ 'targetnum' ] ],
4485       'index' => [],
4486     },
4487
4488     'log' => {
4489       'columns' => [
4490         'lognum',     'serial', '', '', '', '',
4491         '_date',      'int', '', '', '', '',
4492         'agentnum',   'int', 'NULL', '', '', '',
4493         'tablename',  'varchar', 'NULL', $char_d, '', '',
4494         'tablenum',   'int',  'NULL', '', '', '',
4495         'level',      'int',  '', '', '', '',
4496         'message',    'text', '', '', '', '',
4497       ],
4498       'primary_key' => 'lognum',
4499       'unique'      => [],
4500       'index'       => [ ['_date'], ['level'] ],
4501     },
4502
4503     'log_context' => {
4504       'columns' => [
4505         'logcontextnum', 'serial', '', '', '', '',
4506         'lognum', 'int', '', '', '', '',
4507         'context', 'varchar', '', $char_d, '', '',
4508       ],
4509       'primary_key' => 'logcontextnum',
4510       'unique' => [ [ 'lognum', 'context' ] ],
4511       'index' => [],
4512     },
4513
4514     'svc_alarm' => {
4515       'columns' => [
4516 #       name               type        null   length   default local
4517         'svcnum',          'int',      '',    '',      '',     '',
4518         'alarmsystemnum',  'int',      '',    '',      '',     '',
4519         'alarmtypenum',    'int',      '',    '',      '',     '',
4520         'alarmstationnum', 'int',      '',    '',      '',     '',
4521         'acctnum',         'varchar',  '',    $char_d, '',     '',
4522         '_password',       'varchar',  '',    $char_d, '',     '',
4523         'location',        'varchar', 'NULL', $char_d, '',     '',
4524         'cs_receiver',     'int',     'NULL', '',      '',     '',
4525         'cs_phonenum',     'varchar', 'NULL', $char_d, '',     '',
4526         'serialnum',       'varchar', 'NULL', $char_d, '',     '',
4527         #installer (rep)
4528       ],
4529       'primary_key' => 'svcnum',
4530       'unique' => [],
4531       'index'  => [],
4532     },
4533
4534     'alarm_system' => { #vendors
4535       'columns' => [
4536         'alarmsystemnum',  'serial',     '',      '', '', '',
4537         'agentnum',           'int', 'NULL',      '', '', '',
4538         'systemname',     'varchar',     '', $char_d, '', '',
4539         'disabled',          'char', 'NULL',       1, '', '',
4540       ],
4541       'primary_key' => 'alarmsystemnum',
4542       'unique'      => [ ['agentnum', 'systemname'] ],
4543       'index'       => [ ['agentnum'], ['disabled'] ],
4544     },
4545
4546     'alarm_type' => { #inputs and outputs
4547       'columns' => [
4548         'alarmtypenum', 'serial',     '',      '', '', '',
4549         'agentnum',        'int', 'NULL',      '', '', '',
4550         'inputs',          'int',     '', '', '', '',
4551         'outputs',         'int',     '', '', '', '',
4552         'disabled',       'char', 'NULL',       1, '', '',
4553       ],
4554       'primary_key' => 'alarmtypenum',
4555       'unique'      => [ ['agentnum', 'inputs', 'outputs'] ],
4556       'index'       => [ ['agentnum'], ['disabled'] ],
4557     },
4558
4559     'alarm_station' => { #central station (where the alarm reports to)
4560       'columns' => [
4561         'alarmstationnum', 'serial',     '',      '', '', '',
4562         'agentnum',           'int', 'NULL',      '', '', '',
4563         'stationname',    'varchar',     '', $char_d, '', '',
4564         'disabled',          'char', 'NULL',       1, '', '',
4565       ],
4566       'primary_key' => 'alarmstationnum',
4567       'unique'      => [ ['agentnum', 'stationname'], ],
4568       'index'       => [ ['agentnum'], ['disabled'] ],
4569     },
4570
4571     'svc_cable' => {
4572       'columns' => [
4573         'svcnum',        'int',     '',      '', '', '',
4574         'providernum',   'int', 'NULL',      '', '', '',
4575         'ordernum',  'varchar', 'NULL', $char_d, '', '',
4576         'modelnum',      'int', 'NULL',      '', '', '',
4577         'serialnum', 'varchar', 'NULL', $char_d, '', '',
4578         'mac_addr',  'varchar', 'NULL',      12, '', '',
4579       ],
4580       'primary_key' => 'svcnum',
4581       'unique'       => [ ['serialnum'] , ['mac_addr'] ],
4582       'index'  => [],
4583     },
4584
4585     'cable_model' => {
4586       'columns' => [
4587         'modelnum',    'serial',     '',      '', '', '',
4588         'model_name', 'varchar',     '', $char_d, '', '',
4589         'disabled',      'char', 'NULL',       1, '', '',
4590       ],
4591       'primary_key' => 'modelnum',
4592       'unique' => [ [ 'model_name' ], ],
4593       'index'  => [],
4594     },
4595
4596     'cable_provider' => {
4597       'columns' => [
4598         'providernum', 'serial',     '',      '', '', '',
4599         'provider',   'varchar',     '', $char_d, '', '',
4600         'disabled',      'char', 'NULL',       1, '', '',
4601       ],
4602       'primary_key' => 'providernum',
4603       'unique' => [ [ 'provider' ], ],
4604       'index'  => [],
4605     },
4606
4607     'circuit_type' => {
4608       'columns' => [
4609         'typenum',     'serial',     '',      '', '', '',
4610         'typename',   'varchar',     '', $char_d, '', '',
4611         'disabled',      'char', 'NULL',       1, '', '',
4612         # speed? number of voice lines? anything else?
4613       ],
4614       'primary_key' => 'typenum',
4615       'unique' => [ [ 'typename' ] ],
4616       'index'  => [],
4617     },
4618
4619     'circuit_provider' => {
4620       'columns' => [
4621         'providernum', 'serial',     '',      '', '', '',
4622         'provider',   'varchar',     '', $char_d, '', '',
4623         'disabled',      'char', 'NULL',       1, '', '',
4624       ],
4625       'primary_key' => 'providernum',
4626       'unique' => [ [ 'provider' ], ],
4627       'index'  => [],
4628     },
4629
4630     'circuit_termination' => {
4631       'columns' => [
4632         'termnum',     'serial',     '',      '', '', '',
4633         'termination','varchar',     '', $char_d, '', '',
4634         'disabled',      'char', 'NULL',       1, '', '',
4635       ],
4636       'primary_key' => 'termnum',
4637       'unique' => [ [ 'termination' ] ],
4638       'index' => [],
4639     },
4640
4641     'svc_circuit' => {
4642       'columns' => [
4643         'svcnum',                   'int',     '', '', '', '',
4644         'typenum',                  'int',     '', '', '', '',
4645         'providernum',              'int',     '', '', '', '',
4646         'termnum',                  'int',     '', '', '', '',
4647         'circuit_id',           'varchar',     '', 64, '', '',
4648         'desired_due_date',         'int', 'NULL', '', '', '',
4649         'due_date',                 'int', 'NULL', '', '', '',
4650         'vendor_order_id',      'varchar', 'NULL', $char_d,  '', '',
4651         'vendor_qual_id',       'varchar', 'NULL', $char_d,  '', '',
4652         'vendor_order_type',    'varchar', 'NULL', $char_d,  '', '',
4653         'vendor_order_status',  'varchar', 'NULL', $char_d,  '', '',
4654         'endpoint_ip_addr',     'varchar', 'NULL', 40, '', '',
4655         'endpoint_mac_addr',    'varchar', 'NULL', 12, '', '',
4656       ],
4657       'primary_key' => 'svcnum',
4658       'unique'      => [],
4659       'index'       => [ [ 'providernum' ], [ 'typenum' ] ],
4660     },
4661     %{ tables_hashref_torrus() },
4662
4663     # tables of ours for doing torrus virtual port combining
4664     'torrus_srvderive' => {
4665       'columns' => [
4666         'derivenum',     'serial',     '', '', '', '',
4667         'serviceid',    'varchar',     '', 64, '', '', #srvexport / reportfields
4668         'last_srv_date',   'date', 'NULL', '', '', '',
4669       ],
4670       'primary_key' => 'derivenum',
4671       'unique' => [ ['serviceid'] ],
4672       'index'  => [],
4673     },
4674
4675     'torrus_srvderive_component' => {
4676       'columns' => [
4677         'componentnum', 'serial', '', '', '', '',
4678         'derivenum',       'int', '', '', '', '',
4679         'serviceid',   'varchar', '', 64, '', '', #srvexport / reportfields
4680       ],
4681       'primary_key' => 'componentnum',
4682       'unique'      => [ [ 'derivenum', 'serviceid' ], ],
4683       'index'       => [ [ 'derivenum', ], ],
4684     },
4685
4686     'invoice_mode' => {
4687       'columns' => [
4688         'modenum',      'serial', '', '', '', '',
4689         'agentnum',        'int', 'NULL', '', '', '',
4690         'modename',    'varchar', '', 32, '', '',
4691       ],
4692       'primary_key' => 'modenum',
4693       'unique'      => [ ],
4694       'index'       => [ ],
4695     },
4696
4697     'invoice_conf' => {
4698       'columns' => [
4699         'confnum',              'serial',   '', '', '', '',
4700         'modenum',              'int',      '', '', '', '',
4701         'locale',               'varchar',  'NULL', 16, '', '',
4702         'notice_name',          'varchar',  'NULL', 64, '', '',
4703         'subject',              'varchar',  'NULL', 64, '', '',
4704         'htmlnotes',            'text',     'NULL', '', '', '',
4705         'htmlfooter',           'text',     'NULL', '', '', '',
4706         'htmlsummary',          'text',     'NULL', '', '', '',
4707         'htmlreturnaddress',    'text',     'NULL', '', '', '',
4708         'latexnotes',           'text',     'NULL', '', '', '',
4709         'latexfooter',          'text',     'NULL', '', '', '',
4710         'latexsummary',         'text',     'NULL', '', '', '',
4711         'latexsmallfooter',     'text',     'NULL', '', '', '',
4712         'latexreturnaddress',   'text',     'NULL', '', '', '',
4713         'with_latexcoupon',     'char',     'NULL', '1', '', '',
4714         'lpr',                  'varchar',  'NULL', $char_d, '', '',
4715       ],
4716       'primary_key' => 'confnum',
4717       'unique' => [ [ 'modenum', 'locale' ] ],
4718       'index'  => [ ],
4719     },
4720
4721     'export_batch' => {
4722       'columns' => [
4723         'batchnum',    'serial',     '',      '', '', '',
4724         'exportnum',      'int',     '',      '', '', '',
4725         '_date',          'int',     '',      '', '', '',
4726         'status',     'varchar', 'NULL',      32, '', '',
4727         'statustext',    'text', 'NULL',      '', '', '',
4728       ],
4729       'primary_key'  => 'batchnum',
4730       'unique'       => [],
4731       'index'        => [ [ 'exportnum' ], [ 'status' ] ],
4732     },
4733
4734     'export_batch_item' => {
4735       'columns' => [
4736         'itemnum',     'serial',     '',      '', '', '',
4737         'batchnum',       'int',     '',      '', '', '',
4738         'svcnum',         'int',     '',      '', '', '',
4739         'action',     'varchar',     '',      32, '', '',
4740         'data',          'text', 'NULL',      '', '', '',
4741         'frozen',        'char', 'NULL',       1, '', '',
4742       ],
4743       'primary_key'  => 'itemnum',
4744       'unique'       => [],
4745       'index'        => [ [ 'batchnum' ], [ 'svcnum' ] ],
4746     },
4747
4748     # lookup table for states, similar to msa and lata
4749     'state' => {
4750       'columns' => [
4751         'statenum', 'int',  '', '', '', '',
4752         'country',  'char', '',  2, '', '',
4753         'state',    'char', '', $char_d, '', '',
4754         'fips',     'char', '',  3, '', '',
4755       ],
4756       'primary_key' => 'statenum',
4757       'unique' => [ [ 'country', 'state' ], ],
4758       'index' => [],
4759     },
4760
4761     # eventually link to tower/sector?
4762     'deploy_zone' => {
4763       'columns' => [
4764         'zonenum',        'serial',  '',     '',      '', '',
4765         'description',    'char',    'NULL', $char_d, '', '',
4766         'agentnum',       'int',     '',     '',      '', '',
4767         'dbaname',        'char',    'NULL', $char_d, '', '',
4768         'zonetype',       'char',    '',     1,       '', '',
4769         'technology',     'int',     '',     '',      '', '',
4770         'spectrum',       'int',     'NULL', '',      '', '',
4771         'adv_speed_up',   'decimal', '',     '10,3', '0', '',
4772         'adv_speed_down', 'decimal', '',     '10,3', '0', '',
4773         'cir_speed_up',   'decimal', '',     '10,3', '0', '',
4774         'cir_speed_down', 'decimal', '',     '10,3', '0', '',
4775         'is_broadband',   'char',    'NULL', 1,       '', '',
4776         'is_voice',       'char',    'NULL', 1,       '', '',
4777         'is_consumer',    'char',    'NULL', 1,       '', '',
4778         'is_business',    'char',    'NULL', 1,       '', '',
4779         'active_date',    @date_type,                 '', '',
4780         'expire_date',    @date_type,                 '', '',
4781       ],
4782       'primary_key' => 'zonenum',
4783       'unique' => [],
4784       'index'  => [ [ 'agentnum' ] ],
4785     },
4786
4787     'deploy_zone_block' => {
4788       'columns' => [
4789         'blocknum',       'serial',  '',     '',      '', '',
4790         'zonenum',        'int',     '',     '',      '', '',
4791         'censusblock',    'char',    '',     15,      '', '',
4792         'censusyear',     'char',    '',      4,      '', '',
4793       ],
4794       'primary_key' => 'blocknum',
4795       'unique' => [],
4796       'index'  => [ [ 'zonenum' ] ],
4797     },
4798
4799     'deploy_zone_vertex' => {
4800       'columns' => [
4801         'vertexnum',      'serial',  '',     '',      '', '',
4802         'zonenum',        'int',     '',     '',      '', '',
4803         'latitude',       'decimal', '',     '10,7',  '', '',
4804         'longitude',      'decimal', '',     '10,7',  '', '',
4805       ],
4806       'primary_key' => 'vertexnum',
4807       'unique' => [ ],
4808       'index'  => [ ],
4809     },
4810
4811     'cacti_page' => {
4812       'columns' => [
4813         'cacti_pagenum',  'serial',   '',     '', '', '',
4814         'exportnum',      'int',      'NULL', '', '', '',
4815         'svcnum',         'int',      'NULL', '', '', '',
4816         'graphnum',       'int',      'NULL', '', '', '',
4817         'imported',       @date_type,             '', '',
4818         'content',        'text',     'NULL', '', '', '',
4819       ],
4820       'primary_key' => 'cacti_pagenum',
4821       'unique'  => [ ],
4822       'index'   => [ ['svcnum'], ['imported'] ],
4823     },
4824
4825     # name type nullability length default local
4826
4827     #'new_table' => {
4828     #  'columns' => [
4829     #    'num', 'serial',       '', '', '', '',
4830     #  ],
4831     #  'primary_key' => 'num',
4832     #  'unique' => [],
4833     #  'index'  => [],
4834     #},
4835
4836   };
4837
4838 }
4839
4840 =back
4841
4842 =head1 BUGS
4843
4844 =head1 SEE ALSO
4845
4846 L<DBIx::DBSchema>
4847
4848 =cut
4849
4850 1;
4851