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.44; #for foreign keys with MATCH / ON DELETE/UPDATE
   7 use DBIx::DBSchema::Table;
   8 use DBIx::DBSchema::Column;
   9 use DBIx::DBSchema::Index;
  10 use DBIx::DBSchema::ForeignKey;
  11 #can't use this yet, dependency bs #use FS::Conf;
  12
  13 @ISA = qw(Exporter);
  14 @EXPORT_OK = qw( dbdef dbdef_dist reload_dbdef );
  15
  16 $DEBUG = 0;
  17 $me = '[FS::Schema]';
  18
  19 =head1 NAME
  20
  21 FS::Schema - Freeside database schema
  22
  23 =head1 SYNOPSYS
  24
  25     use FS::Schema qw(dbdef dbdef_dist reload_dbdef);
  26
  27     $dbdef = reload_dbdef;
  28     $dbdef = reload_dbdef "/non/standard/filename";
  29     $dbdef = dbdef;
  30     $dbdef_dist = dbdef_dist;
  31
  32 =head1 DESCRIPTION
  33
  34 This class represents the database schema.
  35
  36 =head1 METHODS
  37
  38 =over 4
  39
  40 =item reload_dbdef([FILENAME])
  41
  42 Load a database definition (see L<DBIx::DBSchema>), optionally from a
  43 non-default filename.  This command is executed at startup unless
  44 I<$FS::Schema::setup_hack> is true.  Returns a DBIx::DBSchema object.
  45
  46 =cut
  47
  48 sub reload_dbdef {
  49   my $file = shift;
  50
  51   unless ( exists $dbdef_cache{$file} ) {
  52     warn "[debug]$me loading dbdef for $file\n" if $DEBUG;
  53     $dbdef_cache{$file} = DBIx::DBSchema->load( $file )
  54       or die "can't load database schema from $file: $DBIx::DBSchema::errstr\n";
  55   } else {
  56     warn "[debug]$me re-using cached dbdef for $file\n" if $DEBUG;
  57   }
  58   $dbdef = $dbdef_cache{$file};
  59   FS::Record::fk_methods_init();
  60 }
  61
  62 =item dbdef
  63
  64 Returns the current database definition (represents the current database,
  65 assuming it is up-to-date).  See L<DBIx::DBSchema>.
  66
  67 =cut
  68
  69 sub dbdef { $dbdef; }
  70
  71 =item dbdef_dist [ DATASRC ]
  72
  73 Returns the current canoical database definition as defined in this file.
  74
  75 Optionally, pass a DBI data source to enable syntax specific to that database.
  76 Currently, this enables "ENGINE=InnoDB" for MySQL databases.
  77
  78 =cut
  79
  80 sub dbdef_dist {
  81   my $datasrc = @_ && !ref($_[0]) ? shift : '';
  82   my $opt = @_ ? shift : {};
  83
  84   my $local_options = '';
  85   if ( $datasrc =~ /^dbi:mysql/i ) {
  86     $local_options = 'ENGINE=InnoDB';
  87   }
  88
  89   ###
  90   # create a dbdef object from the old data structure
  91   ###
  92
  93   my $tables_hashref = tables_hashref();
  94
  95   #turn it into objects
  96   my $dbdef = new DBIx::DBSchema map {
  97
  98     my $tablename = $_;
  99     my $indexnum = 1;
 100
 101     my @columns;
 102     while (@{$tables_hashref->{$tablename}{'columns'}}) {
 103       #my($name, $type, $null, $length, $default, $local) =
 104       my @coldef =
 105         splice @{$tables_hashref->{$tablename}{'columns'}}, 0, 6;
 106       my %hash = map { $_ => shift @coldef }
 107                      qw( name type null length default local );
 108
 109       #can be removed once we depend on DBIx::DBSchema 0.39;
 110       $hash{'type'} = 'LONGTEXT'
 111         if $hash{'type'} =~ /^TEXT$/i && $datasrc =~ /^dbi:mysql/i;
 112
 113       unless ( defined $hash{'default'} ) {
 114         warn "$tablename:\n".
 115              join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
 116       }
 117
 118       push @columns, new DBIx::DBSchema::Column ( \%hash );
 119     }
 120
 121     #false laziness w/sub indices in DBIx::DBSchema::DBD (well, sorta)
 122     #and sub sql_create_table in DBIx::DBSchema::Table (slighty more?)
 123     my $unique = $tables_hashref->{$tablename}{'unique'};
 124     warn "missing index for $tablename\n" unless defined $tables_hashref->{$tablename}{'index'};
 125     my @index  = @{ $tables_hashref->{$tablename}{'index'} };
 126
 127     # kludge to avoid avoid "BLOB/TEXT column 'statustext' used in key
 128     #  specification without a key length".
 129     # better solution: teach DBIx::DBSchema to specify a default length for
 130     #  MySQL indices on text columns, or just to support an index length at all
 131     #  so we can pass something in.
 132     # best solution: eliminate need for this index in cust_main::retry_realtime
 133     @index = grep { @{$_}[0] ne 'statustext' } @index
 134       if $datasrc =~ /^dbi:mysql/i;
 135
 136     my @indices = ();
 137     push @indices, map {
 138                          DBIx::DBSchema::Index->new({
 139                            'name'    => $tablename. $indexnum++,
 140                            'unique'  => 1,
 141                            'columns' => $_,
 142                          });
 143                        }
 144                        @$unique;
 145     push @indices, map {
 146                          DBIx::DBSchema::Index->new({
 147                            'name'    => $tablename. $indexnum++,
 148                            'unique'  => 0,
 149                            'columns' => $_,
 150                          });
 151                        }
 152                        @index;
 153
 154     my @foreign_keys =
 155       map DBIx::DBSchema::ForeignKey->new($_),
 156         @{ $tables_hashref->{$tablename}{'foreign_keys'} || [] };
 157
 158     DBIx::DBSchema::Table->new({
 159       name          => $tablename,
 160       primary_key   => $tables_hashref->{$tablename}{'primary_key'},
 161       columns       => \@columns,
 162       indices       => \@indices,
 163       foreign_keys  => \@foreign_keys,
 164       local_options => $local_options,
 165     });
 166
 167   } keys %$tables_hashref;
 168
 169   if ( $DEBUG ) {
 170     warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
 171     warn "[debug]$me   $_\n" foreach $dbdef->tables;
 172   }
 173
 174   #add radius attributes to svc_acct
 175   #
 176   #my($svc_acct)=$dbdef->table('svc_acct');
 177   #
 178   #my($attribute);
 179   #foreach $attribute (@attributes) {
 180   #  $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
 181   #    'radius_'. $attribute,
 182   #    'varchar',
 183   #    'NULL',
 184   #    $char_d,
 185   #  ));
 186   #}
 187   #
 188   #foreach $attribute (@check_attributes) {
 189   #  $svc_acct->addcolumn( new DBIx::DBSchema::Column (
 190   #    'rc_'. $attribute,
 191   #    'varchar',
 192   #    'NULL',
 193   #    $char_d,
 194   #  ));
 195   #}
 196
 197   my $tables_hashref_torrus = tables_hashref_torrus();
 198
 199   #create history tables
 200   foreach my $table (
 201     grep {    ! /^(clientapi|access_user)_session/
 202            && ! /^h_/
 203            && ! /^log(_context)?$/
 204            && ! /^(legacy_cust_history|cacti_page|template_image|access_user_log)$/
 205            && ( ! /^queue(_arg|_depend|_stat)?$/ || ! $opt->{'queue-no_history'} )
 206            && ! /^addr_status$/
 207            && ! $tables_hashref_torrus->{$_}
 208          }
 209       $dbdef->tables
 210   ) {
 211     my $tableobj = $dbdef->table($table)
 212       or die "unknown table $table";
 213
 214     my %h_indices = ();
 215
 216     unless ( $table eq 'cust_event' || $table eq 'cdr' ) { #others?
 217
 218       my %indices = $tableobj->indices;
 219
 220       %h_indices = map {
 221                          ( "h_$_" =>
 222                              DBIx::DBSchema::Index->new({
 223                                'name'    => 'h_'. $indices{$_}->name,
 224                                'unique'  => 0,
 225                                'columns' => [ @{$indices{$_}->columns} ],
 226                              })
 227                          );
 228                        }
 229                        keys %indices;
 230
 231       $h_indices{"h_${table}_srckey"} =
 232         DBIx::DBSchema::Index->new({
 233           'name'    => "h_${table}_srckey",
 234           'unique'  => 0,
 235           'columns' => [ 'history_action', #right?
 236                          $tableobj->primary_key,
 237                        ],
 238         });
 239
 240       $h_indices{"h_${table}_srckey2"} =
 241          DBIx::DBSchema::Index->new({
 242            'name'    => "h_${table}_srckey2",
 243            'unique'  => 0,
 244            'columns' => [ 'history_date',
 245                           $tableobj->primary_key,
 246                         ],
 247          });
 248
 249         #necessary for queries that want to look at *who* made changes
 250       $h_indices{"h_${table}_usernum"} =
 251          DBIx::DBSchema::Index->new({
 252            'name'    => "h_${table}_usernum",
 253            'unique'  => 0,
 254            'columns' => [ 'history_usernum'],
 255          });
 256
 257         # necessary because of the evil OR username for older data, be really nice if everything was just migrated to usernum and we could drop username
 258         # This will not be helpful to mysql, but postgres smartly does a bitmap across both indexes, mysql will just use one
 259
 260       $h_indices{"h_${table}_user"} =
 261          DBIx::DBSchema::Index->new({
 262            'name'    => "h_${table}_user",
 263            'unique'  => 0,
 264            'columns' => [ 'history_user'],
 265          });
 266     }
 267
 268     my $primary_key_col = $tableobj->column($tableobj->primary_key)
 269       or die "$table: primary key declared as ". $tableobj->primary_key.
 270              ", but no column of that name\n";
 271
 272     my $historynum_type = ( $tableobj->column($tableobj->primary_key)->type
 273                               =~ /^(bigserial|bigint|int8)$/i
 274                                 ? 'bigserial'
 275                                 : 'serial'
 276                           );
 277
 278     my $h_tableobj = DBIx::DBSchema::Table->new( {
 279       'name'          => "h_$table",
 280       'primary_key'   => 'historynum',
 281       'indices'       => \%h_indices,
 282       'local_options' => $local_options,
 283       'columns'       => [
 284           DBIx::DBSchema::Column->new( {
 285             'name'    => 'historynum',
 286             'type'    => $historynum_type,
 287             'null'    => 'NOT NULL',
 288             'length'  => '',
 289             'default' => '',
 290             'local'   => '',
 291           } ),
 292           DBIx::DBSchema::Column->new( {
 293             'name'    => 'history_date',
 294             'type'    => 'int',
 295             'null'    => 'NULL',
 296             'length'  => '',
 297             'default' => '',
 298             'local'   => '',
 299           } ),
 300           DBIx::DBSchema::Column->new( {
 301             'name'    => 'history_user',
 302             'type'    => 'varchar',
 303             'null'    => 'NULL',
 304             'length'  => '80',
 305             'default' => '',
 306             'local'   => '',
 307           } ),
 308           DBIx::DBSchema::Column->new( {
 309             'name'    => 'history_usernum',
 310             'type'    => 'int',
 311             'null'    => 'NULL',
 312             'length'  => '',
 313             'default' => '',
 314             'local'   => '',
 315           } ),
 316           DBIx::DBSchema::Column->new( {
 317             'name'    => 'history_action',
 318             'type'    => 'varchar',
 319             'null'    => 'NOT NULL',
 320             'length'  => '80',
 321             'default' => '',
 322             'local'   => '',
 323           } ),
 324           map {
 325             my $column = $tableobj->column($_);
 326
 327             #clone so as to not disturb the original
 328             $column = DBIx::DBSchema::Column->new( {
 329               map { $_ => $column->$_() }
 330                 qw( name type null length default local )
 331             } );
 332
 333             if ( $column->type =~ /^(\w*)SERIAL$/i ) {
 334               $column->type(uc($1).'INT');
 335               $column->null('NULL');
 336             }
 337             #$column->default('')
 338             #  if $column->default =~ /^nextval\(/i;
 339             #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
 340             #$column->local($local);
 341             $column;
 342           } $tableobj->columns
 343       ],
 344     } );
 345     $dbdef->addtable($h_tableobj);
 346   }
 347
 348   if ( $datasrc =~ /^dbi:mysql/i ) {
 349
 350     my $dup_lock_table = DBIx::DBSchema::Table->new( {
 351       'name'          => 'duplicate_lock',
 352       'primary_key'   => 'duplocknum',
 353       'local_options' => $local_options,
 354       'columns'       => [
 355         DBIx::DBSchema::Column->new( {
 356           'name'    => 'duplocknum',
 357           'type'    => 'serial',
 358           'null'    => 'NOT NULL',
 359           'length'  => '',
 360           'default' => '',
 361           'local'   => '',
 362         } ),
 363         DBIx::DBSchema::Column->new( {
 364           'name'    => 'lockname',
 365           'type'    => 'varchar',
 366           'null'    => 'NOT NULL',
 367           'length'  => '80',
 368           'default' => '',
 369           'local'   => '',
 370         } ),
 371       ],
 372       'indices' => { 'duplicate_lock1' =>
 373                        DBIx::DBSchema::Index->new({
 374                          'name'    => 'duplicate_lock1',
 375                          'unique'  => 1,
 376                          'columns' => [ 'lockname' ],
 377                        })
 378                    },
 379     } );
 380
 381     $dbdef->addtable($dup_lock_table);
 382
 383   }
 384
 385   $dbdef;
 386
 387 }
 388
 389 #torrus tables http://torrus.org/reporting_setup.pod.html#create_sql_tables
 390 sub tables_hashref_torrus {
 391
 392   return {
 393
 394     # Collector export table. It usually grows at several megabytes
 395     # per month, and is updated every 5 minutes
 396     'srvexport' => {
 397       'columns' => [
 398         'id',         'serial', '', '', '', '',
 399         'srv_date',     'date', '', '', '', '',#date and time of the data sample
 400         'srv_time',     'time', '', '', '', '',
 401         'serviceid', 'varchar', '', 64, '', '',#unique service ID per counter
 402         'value',     'double precision', '', '', '', '',#collected rate or gauge value
 403         'intvl', 'int', '', '', '', '', # collection interval - for counter volume calculation
 404       ],
 405       'primary_key' => 'id',
 406       'unique' => [],
 407       'index'  => [ ['srv_date'], ['srv_date', 'srv_time'], ['serviceid'], ],
 408     },
 409
 410     #Tables for (currently monthly only) report contents.
 411     #These are updated usually once per month, and read at the moment of
 412     #rendering the report output (HTML now, PDF or XML or Excel or whatever
 413     #in the future)
 414
 415     #DBIx::Sequence backend, theplatform-independent inplementation
 416     #of sequences
 417     'dbix_sequence_state' => {
 418       'columns' => [
 419         'id',       'serial', '', '', '', '',
 420         'dataset', 'varchar', '', 50, '', '',
 421         'state_id',    'int', '', '', '', '',
 422       ],
 423       'primary_key' => 'id',
 424       #CONSTRAINT pk_dbix_sequence PRIMARY KEY (dataset, state_id)
 425       'unique' => [ [ 'dataset', 'state_id' ], ],
 426       'index'  => [],
 427     },
 428
 429     'dbix_sequence_release' => {
 430       'columns' => [
 431         'id',       'serial', '', '', '', '',
 432         'dataset', 'varchar', '', 50, '', '',
 433         'released_id', 'int', '', '', '', '',
 434       ],
 435       'primary_key' => 'id',
 436       #CONSTRAINT pk_dbi_release PRIMARY KEY (dataset, released_id)
 437       'unique' => [ [ 'dataset', 'released_id', ] ],
 438       'index'  => [],
 439     },
 440
 441     #Each report is characterized by name, date and time.
 442     #Monthly reports are automatically assigned 00:00 of the 1st day
 443     #in the month. The report contains fields for every service ID
 444     #defined across all datasource trees.
 445     'reports' => {
 446       'columns' => [
 447         'id',          'serial', '', '', '', '',
 448         'rep_date',      'date', '', '', '', '',#Start date of the report
 449         'rep_time',      'time', '', '', '', '',#Start time of the report
 450         'reportname', 'varchar', '', 64, '', '',#Report name, such as
 451                                                 # MonthlyUsage
 452         'iscomplete',     'int', '', '', '', '',#0 when the report is in
 453                                                 # progress, 1 when it is ready
 454       ],
 455       'primary_key' => 'id',
 456       'unique' => [ [ qw(rep_date rep_time reportname) ] ],
 457       'index'  => [ [ 'rep_date' ] ],
 458     },
 459
 460     #Each report contains fields. For each service ID,
 461     #the report may contain several fields for various statistics.
 462     #Each field contains information about the units of the value it
 463     #contains
 464     'reportfields' => {
 465       'columns' => [
 466         'id',              'serial',     '', '',    '', '',
 467         'rep_id',             'int', 'NULL', '',    '', '',
 468         'name',           'varchar',     '', 64,    '', '',#name of the field,
 469                                                            # such as AVG or MAX
 470         'serviceid',      'varchar',     '', 64,    '', '',#service ID
 471         'value', 'double precision',     '', '',    '', '',#Numeric value
 472         'units',          'varchar',     '', 64, \"''", '',#Units, such as bytes
 473                                                            # or Mbps
 474       ],
 475       'primary_key', => 'id',
 476       'unique' => [ [ qw(rep_id name serviceid) ] ],
 477       'index'  => [],
 478     },
 479
 480   };
 481
 482 }
 483
 484 sub tables_hashref {
 485
 486   my $char_d = 80; #default maxlength for text fields
 487
 488   #my(@date_type)  = ( 'timestamp', '', ''     );
 489   my @date_type = ( 'int', 'NULL', ''     );
 490   my @perl_type = ( 'text', 'NULL', ''  );
 491   my @money_type = ( 'decimal',   '', '10,2' );
 492   my @money_typen = ( 'decimal',   'NULL', '10,2' );
 493   my @taxrate_type  = ( 'decimal',   '',     '14,8' ); # requires pg 8 for
 494   my @taxrate_typen = ( 'decimal',   'NULL', '14,8' ); # fs-upgrade to work
 495
 496   my $username_len = 64; #usernamemax config file
 497
 498     # name type nullability length default local
 499
 500   return {
 501
 502     'agent' => {
 503       'columns' => [
 504         'agentnum',          'serial',    '',       '', '', '',
 505         'agent',            'varchar',    '',  $char_d, '', '',
 506         'typenum',              'int',    '',       '', '', '',
 507         'ticketing_queueid',    'int', 'NULL',      '', '', '',
 508         'invoice_template', 'varchar', 'NULL', $char_d, '', '',
 509         'agent_custnum',        'int', 'NULL',      '', '', '',
 510         'disabled',            'char', 'NULL',       1, '', '',
 511         'username',         'varchar', 'NULL', $char_d, '', '',
 512         '_password',        'varchar', 'NULL', $char_d, '', '',
 513         'freq',              'int', 'NULL', '', '', '', #deprecated (never used)
 514         'prog',                     @perl_type, '', '', #deprecated (never used)
 515       ],
 516       'primary_key'  => 'agentnum',
 517       #'unique' => [ [ 'agent_custnum' ] ], #one agent per customer?
 518                                             #insert is giving it a value, tho..
 519       #'index' => [ ['typenum'], ['disabled'] ],
 520       'unique'       => [],
 521       'index'        => [ ['typenum'], ['disabled'], ['agent_custnum'] ],
 522       'foreign_keys' => [
 523                           { columns    => [ 'typenum' ],
 524                             table      => 'agent_type',
 525                           },
 526                           # 1. RT tables aren't part of our data structure, so
 527                           #     we can't make sure Queue is created already
 528                           # 2. Future ability to plug in other ticketing systems
 529                           #{ columns    => [ 'ticketing_queueid' ],
 530                           #  table      => 'Queue',
 531                           #  references => [ 'id' ],
 532                           #},
 533                           { columns    => [ 'agent_custnum' ],
 534                             table      => 'cust_main',
 535                             references => [ 'custnum' ],
 536                           },
 537                         ],
 538     },
 539
 540     'agent_pkg_class' => {
 541       'columns' => [
 542         'agentpkgclassnum',    'serial',     '',    '', '', '',
 543         'agentnum',               'int',     '',    '', '', '',
 544         'classnum',               'int', 'NULL',    '', '', '',
 545         'commission_percent', 'decimal',     '', '7,4', '', '',
 546       ],
 547       'primary_key'  => 'agentpkgclassnum',
 548       'unique'       => [ [ 'agentnum', 'classnum' ], ],
 549       'index'        => [],
 550       'foreign_keys' => [
 551                           { columns    => [ 'agentnum' ],
 552                             table      => 'agent',
 553                           },
 554                           { columns    => [ 'classnum' ],
 555                             table      => 'pkg_class',
 556                           },
 557                         ],
 558     },
 559
 560     'agent_type' => {
 561       'columns' => [
 562         'typenum',  'serial',      '',      '', '', '',
 563         'atype',    'varchar',     '', $char_d, '', '',
 564         'disabled',    'char', 'NULL',       1, '', '',
 565       ],
 566       'primary_key' => 'typenum',
 567       'unique' => [],
 568       'index' => [ ['disabled'] ],
 569     },
 570
 571     'type_pkgs' => {
 572       'columns' => [
 573         'typepkgnum', 'serial', '', '', '', '',
 574         'typenum',   'int',  '', '', '', '',
 575         'pkgpart',   'int',  '', '', '', '',
 576       ],
 577       'primary_key'  => 'typepkgnum',
 578       'unique'       => [ ['typenum', 'pkgpart'] ],
 579       'index'        => [ ['typenum'] ],
 580       'foreign_keys' => [
 581                           { columns    => [ 'typenum' ],
 582                             table      => 'agent_type',
 583                           },
 584                           { columns    => [ 'pkgpart' ],
 585                             table      => 'part_pkg',
 586                           },
 587                         ],
 588     },
 589
 590     'agent_currency' => {
 591       'columns' => [
 592         'agentcurrencynum', 'serial', '', '', '', '',
 593         'agentnum',            'int', '', '', '', '',
 594         'currency',           'char', '',  3, '', '',
 595       ],
 596       'primary_key'  => 'agentcurrencynum',
 597       'unique'       => [],
 598       'index'        => [ ['agentnum'] ],
 599       'foreign_keys' => [
 600                           { columns    => [ 'agentnum' ],
 601                             table      => 'agent',
 602                           },
 603                         ],
 604     },
 605
 606     'sales' => {
 607       'columns' => [
 608         'salesnum',          'serial',    '',       '', '', '',
 609         'salesperson',      'varchar',    '',  $char_d, '', '',
 610         'agentnum',             'int', 'NULL',      '', '', '',
 611         'sales_custnum',        'int', 'NULL',      '', '', '',
 612         'disabled',            'char', 'NULL',       1, '', '',
 613       ],
 614       'primary_key'  => 'salesnum',
 615       'unique'       => [],
 616       'index'        => [ ['salesnum'], ['disabled'] ],
 617       'foreign_keys' => [
 618                           { columns    => [ 'agentnum' ],
 619                             table      => 'agent',
 620                           },
 621                           { columns    => [ 'sales_custnum' ],
 622                             table      => 'cust_main',
 623                             references => [ 'custnum' ],
 624                           },
 625                         ],
 626     },
 627
 628     'sales_pkg_class' => {
 629       'columns' => [
 630         'salespkgclassnum',    'serial',     '',    '', '', '',
 631         'salesnum',               'int',     '',    '', '', '',
 632         'classnum',               'int', 'NULL',    '', '', '',
 633         'commission_percent', 'decimal',     '', '7,4', '', '',
 634         'commission_duration',    'int', 'NULL',    '', '', '',
 635       ],
 636       'primary_key'  => 'salespkgclassnum',
 637       'unique'       => [ [ 'salesnum', 'classnum' ], ],
 638       'index'        => [],
 639       'foreign_keys' => [
 640                           { columns    => [ 'salesnum' ],
 641                             table      => 'sales',
 642                           },
 643                           { columns    => [ 'classnum' ],
 644                             table      => 'pkg_class',
 645                           },
 646                         ],
 647     },
 648
 649     'cust_attachment' => {
 650       'columns' => [
 651         'attachnum', 'serial', '', '', '', '',
 652         'custnum',   'int', '', '', '', '',
 653         '_date',     @date_type, '', '',
 654         'otaker',    'varchar', 'NULL', 32, '', '',
 655         'usernum',   'int', 'NULL', '', '', '',
 656         'filename',  'varchar', '', 255, '', '',
 657         'mime_type', 'varchar', '', $char_d, '', '',
 658         'title',     'varchar', 'NULL', $char_d, '', '',
 659         'body',      'blob', 'NULL', '', '', '',
 660         'disabled',  @date_type, '', '',
 661       ],
 662       'primary_key'  => 'attachnum',
 663       'unique'       => [],
 664       'index'        => [ ['custnum'], ['usernum'], ],
 665       'foreign_keys' => [
 666                           { columns    => [ 'custnum' ],
 667                             table      => 'cust_main',
 668                           },
 669                           { columns    => [ 'usernum' ],
 670                             table      => 'access_user',
 671                           },
 672                         ],
 673    },
 674
 675     'cust_bill' => {
 676       'columns' => [
 677         #regular fields
 678         'invnum',         'serial',     '',      '', '', '',
 679         'custnum',           'int',     '',      '', '', '',
 680         '_date',        @date_type,                  '', '',
 681         'charged',     @money_type,                  '', '',
 682         'currency',         'char', 'NULL',       3, '', '',
 683         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 684
 685         #customer balance info at invoice generation time
 686         #(deprecated)
 687         'previous_balance',   @money_typen, '', '',  #eventually not nullable
 688         'billing_balance',    @money_typen, '', '',  #eventually not nullable
 689
 690         #deprecated (unused by now, right?)
 691         'printed',      'int',     '', '', '', '',
 692
 693         #specific use cases
 694         'closed',      'char', 'NULL',  1, '', '', #not yet used much
 695         'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
 696         'agent_invid',  'int', 'NULL', '', '', '', #(varchar?) importing legacy
 697         'promised_date', @date_type,       '', '',
 698
 699         'pending',     'char', 'NULL',  1, '', '',
 700       ],
 701       'primary_key'  => 'invnum',
 702       'unique'       => [ [ 'custnum', 'agent_invid' ] ], #agentnum?  huh
 703       'index'        => [ ['custnum'], ['_date'], ['statementnum'],
 704                           ['agent_invid'],
 705                         ],
 706       'foreign_keys' => [
 707                           { columns    => [ 'custnum' ],
 708                             table      => 'cust_main',
 709                           },
 710                           { columns    => [ 'statementnum' ],
 711                             table      => 'cust_statement',
 712                           },
 713                         ],
 714     },
 715
 716     'cust_bill_void' => {
 717       'columns' => [
 718         #regular fields
 719         'invnum',            'int',     '',      '', '', '',
 720         'custnum',           'int',     '',      '', '', '',
 721         '_date',        @date_type,                  '', '',
 722         'charged',     @money_type,                  '', '',
 723         'currency',         'char', 'NULL',       3, '', '',
 724         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 725
 726         #customer balance info at invoice generation time
 727         'previous_balance',   @money_typen, '', '',  #eventually not nullable
 728         'billing_balance',    @money_typen, '', '',  #eventually not nullable
 729
 730         #specific use cases
 731         'closed',      'char', 'NULL',  1, '', '', #not yet used much
 732         'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
 733         'agent_invid',  'int', 'NULL', '', '', '', #(varchar?) importing legacy
 734         'promised_date', @date_type,       '', '',
 735
 736         #void fields
 737         'void_date', @date_type, '', '',
 738         'reason',     'varchar', 'NULL', $char_d, '', '',
 739         'reasonnum',      'int', 'NULL',      '', '', '',
 740         'void_usernum',   'int', 'NULL',      '', '', '',
 741       ],
 742       'primary_key'  => 'invnum',
 743       'unique'       => [ [ 'custnum', 'agent_invid' ] ], #agentnum?  huh
 744       'index'        => [ ['custnum'], ['_date'], ['statementnum'],
 745                           ['agent_invid'], [ 'void_usernum' ],
 746                         ],
 747       'foreign_keys' => [
 748                           { columns    => [ 'custnum' ],
 749                             table      => 'cust_main',
 750                           },
 751                           { columns    => [ 'statementnum' ],
 752                             table      => 'cust_statement', #_void? both?
 753                           },
 754                           { columns    => [ 'reasonnum' ],
 755                             table      => 'reason',
 756                           },
 757                           { columns    => [ 'void_usernum' ],
 758                             table      => 'access_user',
 759                             references => [ 'usernum' ],
 760                           },
 761                         ],
 762     },
 763
 764     #for importing invoices from a legacy system for display purposes only
 765     # no effect upon balance
 766     'legacy_cust_bill' => {
 767       'columns' => [
 768         'legacyinvnum',  'serial',     '',      '', '', '',
 769         'legacyid',     'varchar', 'NULL', $char_d, '', '',
 770         'custnum',          'int',     '',      '', '', '',
 771         '_date',       @date_type,                  '', '',
 772         'charged',    @money_type,                  '', '',
 773         'currency',        'char', 'NULL',       3, '', '',
 774         'content_pdf',     'blob', 'NULL',      '', '', '',
 775         'content_html',    'text', 'NULL',      '', '', '',
 776         'locale',       'varchar', 'NULL',      16, '', '',
 777       ],
 778       'primary_key'  => 'legacyinvnum',
 779       'unique'       => [],
 780       'index'        => [ ['legacyid', 'custnum', 'locale' ], ],
 781       'foreign_keys' => [
 782                           { columns    => [ 'custnum' ],
 783                             table      => 'cust_main',
 784                           },
 785                         ],
 786     },
 787
 788     'legacy_cust_history' => {
 789       'columns' => [
 790         'legacyhistorynum', 'serial',     '',        '', '', '',
 791         'custnum',             'int',     '',        '', '', '',
 792         'history_action',  'varchar',     '',   $char_d, '', '',
 793         'history_date',           @date_type,            '', '',
 794         'history_usernum',     'int', 'NULL',        '', '', '',
 795         'item',            'varchar', 'NULL',   $char_d, '', '',
 796         'description',     'varchar', 'NULL', 2*$char_d, '', '',
 797         'change_data',        'text', 'NULL',        '', '', '',
 798       ],
 799       'primary_key'  => 'legacyhistorynum',
 800       'unique'       => [],
 801       'index'        => [ ['custnum'], ['history_date'], ],
 802       'foreign_keys' => [
 803                           { columns    => [ 'custnum' ],
 804                             table      => 'cust_main',
 805                           },
 806                           { columns    => [ 'history_usernum' ],
 807                             table      => 'access_user',
 808                             references => [ 'usernum' ],
 809                           },
 810                         ],
 811     },
 812
 813     'cust_statement' => {
 814       'columns' => [
 815         'statementnum', 'serial', '', '', '', '',
 816         'custnum',         'int', '', '', '', '',
 817         '_date',           @date_type,    '', '',
 818       ],
 819       'primary_key'  => 'statementnum',
 820       'unique'       => [],
 821       'index'        => [ ['custnum'], ['_date'], ],
 822       'foreign_keys' => [
 823                           { columns    => [ 'custnum' ],
 824                             table      => 'cust_main',
 825                           },
 826                         ],
 827     },
 828
 829     'part_event' => {
 830       'columns' => [
 831         'eventpart',   'serial',      '',      '', '', '',
 832         'agentnum',    'int',     'NULL',      '', '', '',
 833         'event',       'varchar',     '', $char_d, '', '',
 834         'eventtable',  'varchar',     '', $char_d, '', '',
 835         'check_freq',  'varchar', 'NULL', $char_d, '', '',
 836         'weight',      'int',         '',      '', '', '',
 837         'action',      'varchar',     '', $char_d, '', '',
 838         'disabled',     'char',   'NULL',       1, '', '',
 839       ],
 840       'primary_key'  => 'eventpart',
 841       'unique'       => [],
 842       'index'        => [ ['agentnum'], ['eventtable'], ['check_freq'],
 843                           ['disabled'],
 844                         ],
 845       'foreign_keys' => [
 846                           { columns    => [ 'agentnum' ],
 847                             table      => 'agent',
 848                           },
 849                         ],
 850     },
 851
 852     'part_event_option' => {
 853       'columns' => [
 854         'optionnum', 'serial', '', '', '', '',
 855         'eventpart', 'int', '', '', '', '',
 856         'optionname', 'varchar', '', $char_d, '', '',
 857         'optionvalue', 'text', 'NULL', '', '', '',
 858       ],
 859       'primary_key'  => 'optionnum',
 860       'unique'       => [],
 861       'index'        => [ [ 'eventpart' ], [ 'optionname' ] ],
 862       'foreign_keys' => [
 863                           { columns    => [ 'eventpart' ],
 864                             table      => 'part_event',
 865                           },
 866                         ],
 867     },
 868
 869     'part_event_condition' => {
 870       'columns' => [
 871         'eventconditionnum', 'serial', '', '', '', '',
 872         'eventpart', 'int', '', '', '', '',
 873         'conditionname', 'varchar', '', $char_d, '', '',
 874       ],
 875       'primary_key'  => 'eventconditionnum',
 876       'unique'       => [],
 877       'index'        => [ [ 'eventpart' ], [ 'conditionname' ] ],
 878       'foreign_keys' => [
 879                           { columns    => [ 'eventpart' ],
 880                             table      => 'part_event',
 881                           },
 882                         ],
 883     },
 884
 885     'part_event_condition_option' => {
 886       'columns' => [
 887         'optionnum', 'serial', '', '', '', '',
 888         'eventconditionnum', 'int', '', '', '', '',
 889         'optionname', 'varchar', '', $char_d, '', '',
 890         'optionvalue', 'text', 'NULL', '', '', '',
 891       ],
 892       'primary_key'  => 'optionnum',
 893       'unique'       => [],
 894       'index'        => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
 895       'foreign_keys' => [
 896                           { columns    => [ 'eventconditionnum' ],
 897                             table      => 'part_event_condition',
 898                           },
 899                         ],
 900     },
 901
 902     'part_event_condition_option_option' => {
 903       'columns' => [
 904         'optionoptionnum', 'serial', '', '', '', '',
 905         'optionnum', 'int', '', '', '', '',
 906         'optionname', 'varchar', '', $char_d, '', '',
 907         'optionvalue', 'text', 'NULL', '', '', '',
 908       ],
 909       'primary_key'  => 'optionoptionnum',
 910       'unique'       => [],
 911       'index'        => [ [ 'optionnum' ], [ 'optionname' ] ],
 912       'foreign_keys' => [
 913                           { columns    => [ 'optionnum' ],
 914                             table      => 'part_event_condition_option',
 915                           },
 916                         ],
 917     },
 918
 919     'cust_event' => {
 920       'columns' => [
 921         'eventnum',    'serial',  '', '', '', '',
 922         'eventpart',   'int',  '', '', '', '',
 923         'tablenum',   'int',  '', '', '', '',
 924         '_date',     @date_type, '', '',
 925         'status', 'varchar', '', $char_d, '', '',
 926         'statustext', 'text', 'NULL', '', '', '',
 927         'no_action',  'char', 'NULL',  1, '', '',
 928       ],
 929       'primary_key'  => 'eventnum',
 930       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 931       'unique'       => [],
 932       'index'        => [ ['eventpart'], ['tablenum'], ['status'],
 933                           ['statustext'], ['_date'], ['no_action'],
 934                         ],
 935       'foreign_keys' => [
 936                           { columns    => [ 'eventpart' ],
 937                             table      => 'part_event',
 938                           },
 939                         ],
 940     },
 941
 942     'cust_event_fee' => {
 943       'columns' => [
 944         'eventfeenum', 'serial', '', '', '', '',
 945         'eventnum',       'int', '', '', '', '',
 946         'billpkgnum',     'int', 'NULL', '', '', '',
 947         'feepart',        'int', '', '', '', '',
 948         'nextbill',      'char', 'NULL',  1, '', '',
 949       ],
 950       'primary_key'  => 'eventfeenum', # I'd rather just use eventnum
 951       'unique' => [ [ 'billpkgnum' ], [ 'eventnum' ] ], # one-to-one link
 952       'index'  => [ [ 'feepart' ] ],
 953       'foreign_keys' => [
 954                           { columns => [ 'eventnum' ],
 955                             table   => 'cust_event',
 956                           },
 957                           #{ columns => [ 'billpkgnum' ],
 958                           #  table   => 'cust_bill_pkg',
 959                           #},
 960                           { columns => [ 'feepart' ],
 961                             table   => 'part_fee',
 962                           },
 963                         ],
 964     },
 965
 966     'cust_bill_pkg' => {
 967       'columns' => [
 968         'billpkgnum',          'serial',     '',      '', '', '',
 969         'invnum',                 'int',     '',      '', '', '',
 970         'pkgnum',                 'int',     '',      '', '', '',
 971         'pkgpart_override',       'int', 'NULL',      '', '', '',
 972         'setup',                 @money_type,             '', '',
 973         'unitsetup',             @money_typen,            '', '',
 974         'setup_billed_currency', 'char', 'NULL',       3, '', '',
 975         'setup_billed_amount',   @money_typen,            '', '',
 976         'recur',                 @money_type,             '', '',
 977         'unitrecur',             @money_typen,            '', '',
 978         'recur_billed_currency', 'char', 'NULL',       3, '', '',
 979         'recur_billed_amount',   @money_typen,            '', '',
 980         'sdate',                 @date_type,              '', '',
 981         'edate',                 @date_type,              '', '',
 982         'itemdesc',           'varchar', 'NULL', $char_d, '', '',
 983         'itemcomment',        'varchar', 'NULL', $char_d, '', '',
 984         'section',            'varchar', 'NULL', $char_d, '', '',
 985         'freq',               'varchar', 'NULL', $char_d, '', '',
 986         'quantity',               'int', 'NULL',      '', '', '',
 987         'hidden',                'char', 'NULL',       1, '', '',
 988         'feepart',                'int', 'NULL',      '', '', '',
 989       ],
 990       'primary_key'  => 'billpkgnum',
 991       'unique'       => [],
 992       'index'        => [ ['invnum'], [ 'pkgnum' ], [ 'itemdesc' ], ],
 993       'foreign_keys' => [
 994                           { columns    => [ 'invnum' ],
 995                             table      => 'cust_bill',
 996                           },
 997                           #pkgnum 0 and -1 are used for special things
 998                           #{ columns    => [ 'pkgnum' ],
 999                           #  table      => 'cust_pkg',
1000                           #},
1001                           { columns    => [ 'pkgpart_override' ],
1002                             table      => 'part_pkg',
1003                             references => [ 'pkgpart' ],
1004                           },
1005                           { columns    => [ 'feepart' ],
1006                             table      => 'part_fee',
1007                           },
1008                         ],
1009     },
1010
1011     'cust_bill_pkg_detail' => {
1012       'columns' => [
1013         'detailnum', 'serial', '', '', '', '',
1014           # bigserial? this table will eventually be as big as cdr...
1015         'billpkgnum', 'int', 'NULL', '', '', '',        # should not be nullable
1016         'pkgnum',  'int', 'NULL', '', '', '',           # deprecated
1017         'invnum',  'int', 'NULL', '', '', '',           # deprecated
1018         'amount',  'decimal', 'NULL', '10,4', '', '',
1019         'format',  'char', 'NULL', 1, '', '',
1020         'classnum', 'int', 'NULL', '', '', '',
1021         'duration', 'int', 'NULL', '',  0, '',
1022         'phonenum', 'varchar', 'NULL', 255, '', '', # has to hold a service label
1023         'accountcode', 'varchar',  'NULL',      32, '', '',
1024         'startdate',  @date_type, '', '',
1025         'regionname', 'varchar', 'NULL', $char_d, '', '',
1026         'detail',  'varchar', '', 255, '', '',
1027       ],
1028       'primary_key'  => 'detailnum',
1029       'unique'       => [],
1030       'index'        => [ [ 'billpkgnum' ], [ 'classnum' ],
1031                           [ 'pkgnum', 'invnum' ],
1032                         ],
1033       'foreign_keys' => [
1034                           { columns    => [ 'billpkgnum' ],
1035                             table      => 'cust_bill_pkg',
1036                           },
1037                           #{ columns    => [ 'pkgnum' ],
1038                           #  table      => 'cust_pkg',
1039                           #},
1040                           #{ columns    => [ 'invnum' ],
1041                           #  table      => 'cust_bill',
1042                           #},
1043                           { columns    => [ 'classnum' ],
1044                             table      => 'usage_class',
1045                           },
1046                         ],
1047     },
1048
1049     'cust_bill_pkg_display' => {
1050       'columns' => [
1051         'billpkgdisplaynum', 'serial', '', '', '', '',
1052         'billpkgnum', 'int', '', '', '', '',
1053         'section',  'varchar', 'NULL', $char_d, '', '',
1054         #'unitsetup', @money_typen, '', '',     #override the linked real one?
1055         #'unitrecur', @money_typen, '', '',     #this too?
1056         'post_total', 'char', 'NULL', 1, '', '',
1057         'type',       'char', 'NULL', 1, '', '',
1058         'summary',    'char', 'NULL', 1, '', '',
1059       ],
1060       'primary_key'  => 'billpkgdisplaynum',
1061       'unique'       => [],
1062       'index'        => [ ['billpkgnum'], ],
1063       'foreign_keys' => [
1064                           { columns    => [ 'billpkgnum' ],
1065                             table      => 'cust_bill_pkg',
1066                           },
1067                         ],
1068     },
1069
1070     'cust_bill_pkg_fee' => {
1071       'columns' => [
1072         'billpkgfeenum',    'serial', '', '', '', '',
1073         'billpkgnum',          'int', '', '', '', '',
1074         'base_invnum',       'int', '', '', '', '',
1075         'base_billpkgnum',   'int', 'NULL', '', '', '',
1076         'amount',        @money_type,         '', '',
1077       ],
1078       'primary_key' => 'billpkgfeenum',
1079       'unique'      => [],
1080       'index'       => [ ['billpkgnum'],
1081                          ['base_invnum'],
1082                          ['base_billpkgnum'],
1083                        ],
1084       'foreign_keys' => [
1085                           { columns     => [ 'billpkgnum' ],
1086                             table       => 'cust_bill_pkg',
1087                           },
1088                         ],
1089     },
1090
1091     'cust_bill_pkg_fee_void' => {
1092       'columns' => [
1093         'billpkgfeenum',    'serial', '', '', '', '',
1094         'billpkgnum',          'int', '', '', '', '',
1095         'base_invnum',       'int', '', '', '', '',
1096         'base_billpkgnum',   'int', 'NULL', '', '', '',
1097         'amount',        @money_type,         '', '',
1098       ],
1099       'primary_key' => 'billpkgfeenum',
1100       'unique'      => [],
1101       'index'       => [ ['billpkgnum'],
1102                          ['base_invnum'],
1103                          ['base_billpkgnum'],
1104                        ],
1105       'foreign_keys' => [
1106                           { columns     => [ 'billpkgnum' ],
1107                             table       => 'cust_bill_pkg_void',
1108                           },
1109                         ],
1110     },
1111
1112
1113     'cust_bill_pkg_tax_location' => {
1114       'columns' => [
1115         'billpkgtaxlocationnum', 'serial',     '',      '', '', '',
1116         'billpkgnum',               'int',     '',      '', '', '',
1117         'taxnum',                   'int',     '',      '', '', '',
1118         'taxtype',              'varchar',     '', $char_d, '', '',
1119         'pkgnum',                   'int',     '',      '', '', '', #redundant
1120         'locationnum',              'int',     '',      '', '', '', #redundant
1121         'amount',             @money_type,                  '', '',
1122         'currency',                'char', 'NULL',       3, '', '',
1123         'taxable_billpkgnum',       'int', 'NULL',      '', '', '',
1124       ],
1125       'primary_key'  => 'billpkgtaxlocationnum',
1126       'unique'       => [],
1127       'index'        => [ [ 'billpkgnum' ],
1128                           [ 'taxnum' ],
1129                           [ 'pkgnum' ],
1130                           [ 'locationnum' ],
1131                           [ 'taxable_billpkgnum' ],
1132                         ],
1133       'foreign_keys' => [
1134                           { columns    => [ 'billpkgnum' ],
1135                             table      => 'cust_bill_pkg',
1136                           },
1137                           #{ columns    => [ 'pkgnum' ],
1138                           #  table      => 'cust_pkg',
1139                           #}, # taxes can apply to fees
1140                           { columns    => [ 'locationnum' ],
1141                             table      => 'cust_location',
1142                           },
1143                           #{ columns    => [ 'taxable_billpkgnum' ],
1144                           #  table      => 'cust_bill_pkg',
1145                           #  references => [ 'billpkgnum' ],
1146                           #},
1147                         ],
1148     },
1149
1150     'cust_bill_pkg_tax_rate_location' => {
1151       'columns' => [
1152         'billpkgtaxratelocationnum', 'serial',      '',      '', '', '',
1153         'billpkgnum',                   'int',      '',      '', '', '',
1154         'taxnum',                       'int',      '',      '', '', '',
1155         'taxtype',                  'varchar',      '', $char_d, '', '',
1156         'locationtaxid',            'varchar',  'NULL', $char_d, '', '',
1157         'taxratelocationnum',           'int',      '',      '', '', '',
1158         'amount',                 @money_type,                   '', '',
1159         'currency',                    'char', 'NULL',        3, '', '',
1160         'taxable_billpkgnum',           'int', 'NULL',       '', '', '',
1161         'taxclass',                 'varchar', 'NULL',       10, '', '',
1162       ],
1163       'primary_key'  => 'billpkgtaxratelocationnum',
1164       'unique'       => [],
1165       'index'        => [ ['billpkgnum'], ['taxnum'], ['taxratelocationnum'],
1166                           ['taxable_billpkgnum'],
1167                         ],
1168       'foreign_keys' => [
1169                           { columns    => [ 'billpkgnum' ],
1170                             table      => 'cust_bill_pkg',
1171                           },
1172                           { columns    => [ 'taxratelocationnum' ],
1173                             table      => 'tax_rate_location',
1174                           },
1175                           #{ columns    => [ 'taxable_billpkgnum' ],
1176                           #  table      => 'cust_bill_pkg',
1177                           #  references => [ 'billpkgnum' ],
1178                           #},
1179                         ],
1180     },
1181
1182     'cust_bill_pkg_void' => {
1183       'columns' => [
1184         'billpkgnum',           'int',     '',      '', '', '',
1185         'invnum',               'int',     '',      '', '', '',
1186         'pkgnum',               'int',     '',      '', '', '',
1187         'pkgpart_override',     'int', 'NULL',      '', '', '',
1188         'setup',               @money_type,             '', '',
1189         'recur',               @money_type,             '', '',
1190         #XXX a currency for a line item?  or just one for the entire invoice
1191         #'currency',            'char', 'NULL',       3, '', '',
1192         'sdate',               @date_type,              '', '',
1193         'edate',               @date_type,              '', '',
1194         'itemdesc',         'varchar', 'NULL', $char_d, '', '',
1195         'itemcomment',      'varchar', 'NULL', $char_d, '', '',
1196         'section',          'varchar', 'NULL', $char_d, '', '',
1197         'freq',             'varchar', 'NULL', $char_d, '', '',
1198         'quantity',             'int', 'NULL',      '', '', '',
1199         'unitsetup',           @money_typen,            '', '',
1200         'unitrecur',           @money_typen,            '', '',
1201         'hidden',              'char', 'NULL',       1, '', '',
1202         'feepart',              'int', 'NULL',      '', '', '',
1203         #void fields
1204         'void_date', @date_type, '', '',
1205         'reason',     'varchar', 'NULL', $char_d, '', '',
1206         'reasonnum',      'int', 'NULL',      '', '', '',
1207         'void_usernum',   'int', 'NULL',      '', '', '',
1208       ],
1209       'primary_key'  => 'billpkgnum',
1210       'unique'       => [],
1211       'index'        => [ ['invnum'], ['pkgnum'], ['itemdesc'],
1212                           ['void_usernum'],
1213                         ],
1214       'foreign_keys' => [
1215                           { columns    => [ 'invnum' ],
1216                             table      => 'cust_bill_void',
1217                           },
1218                           { columns    => [ 'reasonnum' ],
1219                             table      => 'reason',
1220                           },
1221                           #pkgnum 0 and -1 are used for special things
1222                           #{ columns    => [ 'pkgnum' ],
1223                           #  table      => 'cust_pkg',
1224                           #},
1225                           { columns    => [ 'pkgpart_override' ],
1226                             table      => 'part_pkg',
1227                             references => [ 'pkgpart' ],
1228                           },
1229                           { columns    => [ 'void_usernum' ],
1230                             table      => 'access_user',
1231                             references => [ 'usernum' ],
1232                           },
1233                         ],
1234     },
1235
1236     'cust_bill_pkg_detail_void' => {
1237       'columns' => [
1238         'detailnum',  'int', '', '', '', '',
1239         'billpkgnum', 'int', 'NULL', '', '', '',        # should not be nullable
1240         'pkgnum',  'int', 'NULL', '', '', '',           # deprecated
1241         'invnum',  'int', 'NULL', '', '', '',           # deprecated
1242         'amount',  'decimal', 'NULL', '10,4', '', '',
1243         'format',  'char', 'NULL', 1, '', '',
1244         'classnum', 'int', 'NULL', '', '', '',
1245         'duration', 'int', 'NULL', '',  0, '',
1246         'phonenum', 'varchar', 'NULL', 255, '', '',
1247         'accountcode', 'varchar',  'NULL',      32, '', '',
1248         'startdate',  @date_type, '', '',
1249         'regionname', 'varchar', 'NULL', $char_d, '', '',
1250         'detail',  'varchar', '', 255, '', '',
1251       ],
1252       'primary_key'  => 'detailnum',
1253       'unique'       => [],
1254       'index'        => [ ['billpkgnum'], ['classnum'], ['pkgnum', 'invnum'] ],
1255       'foreign_keys' => [
1256                           { columns    => [ 'billpkgnum' ],
1257                             table      => 'cust_bill_pkg_void',
1258                           },
1259                           #{ columns    => [ 'pkgnum' ],
1260                           #  table      => 'cust_pkg',
1261                           #},
1262                           #{ columns    => [ 'invnum' ],
1263                           #  table      => 'cust_bill',
1264                           #},
1265                           { columns    => [ 'classnum' ],
1266                             table      => 'usage_class',
1267                           },
1268                         ],
1269     },
1270
1271     'cust_bill_pkg_display_void' => {
1272       'columns' => [
1273         'billpkgdisplaynum',    'int', '', '', '', '',
1274         'billpkgnum', 'int', '', '', '', '',
1275         'section',  'varchar', 'NULL', $char_d, '', '',
1276         #'unitsetup', @money_typen, '', '',     #override the linked real one?
1277         #'unitrecur', @money_typen, '', '',     #this too?
1278         'post_total', 'char', 'NULL', 1, '', '',
1279         'type',       'char', 'NULL', 1, '', '',
1280         'summary',    'char', 'NULL', 1, '', '',
1281       ],
1282       'primary_key'  => 'billpkgdisplaynum',
1283       'unique'       => [],
1284       'index'        => [ ['billpkgnum'], ],
1285       'foreign_keys' => [
1286                           { columns    => [ 'billpkgnum' ],
1287                             table      => 'cust_bill_pkg_void',
1288                           },
1289                         ],
1290     },
1291
1292     'cust_bill_pkg_tax_location_void' => {
1293       'columns' => [
1294         'billpkgtaxlocationnum',    'int',     '',      '', '', '',
1295         'billpkgnum',               'int',     '',      '', '', '',
1296         'taxnum',                   'int',     '',      '', '', '',
1297         'taxtype',              'varchar',     '', $char_d, '', '',
1298         'pkgnum',                   'int',     '',      '', '', '',
1299         'locationnum',              'int',     '',      '', '', '', #redundant?
1300         'amount',             @money_type,                  '', '',
1301         'currency',                'char', 'NULL',       3, '', '',
1302         'taxable_billpkgnum',       'int', 'NULL',      '', '', '',
1303       ],
1304       'primary_key'  => 'billpkgtaxlocationnum',
1305       'unique'       => [],
1306       'index'        => [ ['billpkgnum'], ['taxnum'], ['pkgnum'],
1307                           ['locationnum'],
1308                         ],
1309       'foreign_keys' => [
1310                           { columns    => [ 'billpkgnum' ],
1311                             table      => 'cust_bill_pkg_void',
1312                           },
1313                           { columns    => [ 'locationnum' ],
1314                             table      => 'cust_location',
1315                           },
1316                           #{ columns    => [ 'taxable_billpkgnum' ],
1317                           #  table      => 'cust_bill_pkg_void',
1318                           #  references => [ 'billpkgnum' ],
1319                           #},
1320                         ],
1321     },
1322
1323     'cust_bill_pkg_tax_rate_location_void' => {
1324       'columns' => [
1325         'billpkgtaxratelocationnum',    'int',     '',      '', '', '',
1326         'billpkgnum',                   'int',     '',      '', '', '',
1327         'taxnum',                       'int',     '',      '', '', '',
1328         'taxtype',                  'varchar',     '', $char_d, '', '',
1329         'locationtaxid',            'varchar', 'NULL', $char_d, '', '',
1330         'taxratelocationnum',           'int',     '',      '', '', '',
1331         'amount',                 @money_type,                  '', '',
1332         'currency',                    'char', 'NULL',       3, '', '',
1333       ],
1334       'primary_key'  => 'billpkgtaxratelocationnum',
1335       'unique'       => [],
1336       'index'        => [ ['billpkgnum'], ['taxnum'], ['taxratelocationnum'] ],
1337       'foreign_keys' => [
1338                           { columns    => [ 'billpkgnum' ],
1339                             table      => 'cust_bill_pkg_void',
1340                           },
1341                           { columns    => [ 'taxratelocationnum' ],
1342                             table      => 'tax_rate_location',
1343                           },
1344                         ],
1345     },
1346
1347     'cust_credit' => {
1348       'columns' => [
1349         'crednum',  'serial',     '', '', '', '',
1350         'custnum',     'int',     '', '', '', '',
1351         '_date',  @date_type,             '', '',
1352         'amount',@money_type,             '', '',
1353         'currency',   'char', 'NULL',  3, '', '',
1354         'otaker',  'varchar', 'NULL', 32, '', '',
1355         'usernum',     'int', 'NULL', '', '', '',
1356         'reason',     'text', 'NULL', '', '', '',
1357         'reasonnum',   'int', 'NULL', '', '', '',
1358         'addlinfo',   'text', 'NULL', '', '', '',
1359         'closed',     'char', 'NULL',  1, '', '',
1360         'pkgnum',      'int', 'NULL', '', '','',#desired pkgnum for pkg-balances
1361         'eventnum',    'int', 'NULL', '', '','',#triggering event for commission
1362         'commission_agentnum', 'int', 'NULL', '', '', '', #
1363         'commission_salesnum', 'int', 'NULL', '', '', '', #
1364         'commission_pkgnum',   'int', 'NULL', '', '', '', #
1365         'commission_invnum',   'int', 'NULL', '', '', '',
1366         'credbatch',    'varchar', 'NULL', $char_d, '', '',
1367       ],
1368       'primary_key'  => 'crednum',
1369       'unique'       => [],
1370       'index'        => [ ['custnum'], ['_date'], ['usernum'], ['eventnum'],
1371                           ['commission_salesnum'], ['credbatch'],
1372                         ],
1373       'foreign_keys' => [
1374                           { columns    => [ 'custnum' ],
1375                             table      => 'cust_main',
1376                           },
1377                           { columns    => [ 'usernum' ],
1378                             table      => 'access_user',
1379                           },
1380                           { columns    => [ 'reasonnum' ],
1381                             table      => 'reason',
1382                           },
1383                           { columns    => [ 'pkgnum' ],
1384                             table      => 'cust_pkg',
1385                           },
1386                           { columns    => [ 'eventnum' ],
1387                             table      => 'cust_event',
1388                           },
1389                           { columns    => [ 'commission_agentnum' ],
1390                             table      => 'agent',
1391                             references => [ 'agentnum' ],
1392                           },
1393                           { columns    => [ 'commission_salesnum' ],
1394                             table      => 'sales',
1395                             references => [ 'salesnum' ],
1396                           },
1397                           { columns    => [ 'commission_pkgnum' ],
1398                             table      => 'cust_pkg',
1399                             references => [ 'pkgnum' ],
1400                           },
1401                           { columns    => [ 'commission_invnum' ],
1402                             table      => 'cust_bill',
1403                             references => [ 'invnum' ],
1404                           },
1405                         ],
1406     },
1407
1408     'cust_credit_void' => {
1409       'columns' => [
1410         'crednum',  'serial',     '', '', '', '',
1411         'custnum',     'int',     '', '', '', '',
1412         '_date',  @date_type,             '', '',
1413         'amount',@money_type,             '', '',
1414         'currency',   'char', 'NULL',  3, '', '',
1415         'otaker',  'varchar', 'NULL', 32, '', '',
1416         'usernum',     'int', 'NULL', '', '', '',
1417         'reason',     'text', 'NULL', '', '', '',
1418         'reasonnum',   'int', 'NULL', '', '', '',
1419         'addlinfo',   'text', 'NULL', '', '', '',
1420         'closed',     'char', 'NULL',  1, '', '',
1421         'pkgnum',      'int', 'NULL', '', '','',
1422         'eventnum',    'int', 'NULL', '', '','',
1423         'commission_agentnum', 'int', 'NULL', '', '', '',
1424         'commission_salesnum', 'int', 'NULL', '', '', '',
1425         'commission_pkgnum',   'int', 'NULL', '', '', '',
1426         'commission_invnum',   'int', 'NULL', '', '', '',
1427         #void fields
1428         'void_date',  @date_type,                  '', '',
1429         'void_reason', 'varchar', 'NULL', $char_d, '', '',
1430         'void_reasonnum', 'int', 'NULL', '', '', '',
1431         'void_usernum',    'int', 'NULL',      '', '', '',
1432       ],
1433       'primary_key'  => 'crednum',
1434       'unique'       => [],
1435       'index'        => [ ['custnum'], ['_date'], ['usernum'], ['eventnum'],
1436                           ['commission_salesnum'],
1437                         ],
1438       'foreign_keys' => [
1439                           { columns    => [ 'custnum' ],
1440                             table      => 'cust_main',
1441                           },
1442                           { columns    => [ 'usernum' ],
1443                             table      => 'access_user',
1444                           },
1445                           { columns    => [ 'reasonnum' ],
1446                             table      => 'reason',
1447                           },
1448                           { columns    => [ 'pkgnum' ],
1449                             table      => 'cust_pkg',
1450                           },
1451                           { columns    => [ 'eventnum' ],
1452                             table      => 'cust_event',
1453                           },
1454                           { columns    => [ 'commission_agentnum' ],
1455                             table      => 'agent',
1456                             references => [ 'agentnum' ],
1457                           },
1458                           { columns    => [ 'commission_salesnum' ],
1459                             table      => 'sales',
1460                             references => [ 'salesnum' ],
1461                           },
1462                           { columns    => [ 'commission_pkgnum' ],
1463                             table      => 'cust_pkg',
1464                             references => [ 'pkgnum' ],
1465                           },
1466                           { columns    => [ 'commission_invnum' ],
1467                             table      => 'cust_bill',
1468                             references => [ 'invnum' ],
1469                           },
1470                           { columns    => [ 'void_reasonnum' ],
1471                             table      => 'reason',
1472                             references => [ 'reasonnum' ],
1473                           },
1474                           { columns    => [ 'void_usernum' ],
1475                             table      => 'access_user',
1476                             references => [ 'usernum' ],
1477                           },
1478                         ],
1479     },
1480
1481
1482     'cust_credit_bill' => {
1483       'columns' => [
1484         'creditbillnum', 'serial', '', '', '', '',
1485         'crednum',  'int', '', '', '', '',
1486         'invnum',  'int', '', '', '', '',
1487         '_date',    @date_type, '', '',
1488         'amount',   @money_type, '', '',
1489         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1490       ],
1491       'primary_key'  => 'creditbillnum',
1492       'unique'       => [],
1493       'index'        => [ ['crednum'], ['invnum'] ],
1494       'foreign_keys' => [
1495                           { columns    => [ 'crednum' ],
1496                             table      => 'cust_credit',
1497                           },
1498                           { columns    => [ 'invnum' ],
1499                             table      => 'cust_bill',
1500                           },
1501                           { columns    => [ 'pkgnum' ],
1502                             table      => 'cust_pkg',
1503                           },
1504                         ],
1505     },
1506
1507     'cust_credit_bill_pkg' => {
1508       'columns' => [
1509         'creditbillpkgnum', 'serial', '',      '', '', '',
1510         'creditbillnum',       'int', '',      '', '', '',
1511         'billpkgnum',          'int', '',      '', '', '',
1512         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
1513         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
1514         'amount',            @money_type,          '', '',
1515         'setuprecur',      'varchar', '', $char_d, '', '',
1516         'sdate',   @date_type, '', '',
1517         'edate',   @date_type, '', '',
1518       ],
1519       'primary_key'  => 'creditbillpkgnum',
1520       'unique'       => [],
1521       'index'        => [ [ 'creditbillnum' ],
1522                           [ 'billpkgnum' ],
1523                           [ 'billpkgtaxlocationnum' ],
1524                           [ 'billpkgtaxratelocationnum' ],
1525                         ],
1526       'foreign_keys' => [
1527                           { columns    => [ 'creditbillnum' ],
1528                             table      => 'cust_credit_bill',
1529                           },
1530                           { columns    => [ 'billpkgnum' ],
1531                             table      => 'cust_bill_pkg',
1532                           },
1533                           { columns    => [ 'billpkgtaxlocationnum' ],
1534                             table      => 'cust_bill_pkg_tax_location',
1535                           },
1536                           { columns    => [ 'billpkgtaxratelocationnum' ],
1537                             table      => 'cust_bill_pkg_tax_rate_location',
1538                           },
1539                         ],
1540     },
1541
1542     'cust_credit_source_bill_pkg' => {
1543       'columns' => [
1544         'creditsourcebillpkgnum', 'serial',     '', '', '', '',
1545         'crednum',                   'int',     '', '', '', '',
1546         'billpkgnum',                'int',     '', '', '', '',
1547         'amount',              @money_type,             '', '',
1548         'currency',                 'char', 'NULL',  3, '', '',
1549       ],
1550       'primary_key'  => 'creditsourcebillpkgnum',
1551       'unique'       => [],
1552       'index'        => [ ['crednum'], ['billpkgnum'] ],
1553       'foreign_keys' => [
1554                           { columns => ['billpkgnum'],
1555                             table   => 'cust_bill_pkg',
1556                           },
1557                           { columns => ['crednum'],
1558                             table   => 'cust_credit',
1559                           },
1560                         ],
1561     },
1562
1563     'cust_main' => {
1564       'columns' => [
1565         'custnum',  'serial',  '',     '', '', '',
1566         'agentnum', 'int',  '',     '', '', '',
1567         'salesnum', 'int',  'NULL', '', '', '',
1568         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
1569         'classnum', 'int', 'NULL', '', '', '',
1570         'custbatch', 'varchar', 'NULL', $char_d, '', '',
1571 #        'titlenum', 'int',  'NULL',   '', '', '',
1572         'last',     'varchar', '',   2*$char_d, '', '',
1573 #        'middle',   'varchar', 'NULL', $char_d, '', '',
1574         'first',    'varchar', '',     $char_d, '', '',
1575         'ss',       'varchar', 'NULL', 11, '', '',
1576         'stateid', 'varchar', 'NULL', $char_d, '', '',
1577         'stateid_state', 'varchar', 'NULL', $char_d, '', '',
1578         'national_id', 'varchar', 'NULL', $char_d, '', '',
1579         'birthdate' ,@date_type, '', '',
1580         'spouse_last',  'varchar', 'NULL', 2*$char_d, '', '',
1581         'spouse_first', 'varchar', 'NULL', $char_d, '', '',
1582         'spouse_birthdate', @date_type, '', '',
1583         'anniversary_date', @date_type, '', '',
1584         'signupdate',@date_type, '', '',
1585         'dundate',   @date_type, '', '',
1586         'company',  'varchar', 'NULL', $char_d, '', '',
1587         'address1', 'varchar', 'NULL', $char_d, '', '',
1588         'address2', 'varchar', 'NULL', $char_d, '', '',
1589         'city',     'varchar', 'NULL', $char_d, '', '',
1590         'county',   'varchar', 'NULL', $char_d, '', '',
1591         'state',    'varchar', 'NULL', $char_d, '', '',
1592         'zip',      'varchar', 'NULL', 10, '', '',
1593         'country',  'char',    'NULL',  2, '', '',
1594         'latitude', 'decimal', 'NULL', '10,7', '', '',
1595         'longitude','decimal', 'NULL', '10,7', '', '',
1596         'coord_auto',  'char', 'NULL',  1, '', '',
1597         'addr_clean',  'char', 'NULL',  1, '', '',
1598         'daytime',  'varchar', 'NULL', 20, '', '',
1599         'night',    'varchar', 'NULL', 20, '', '',
1600         'fax',      'varchar', 'NULL', 12, '', '',
1601         'mobile',   'varchar', 'NULL', 12, '', '',
1602         'ship_last',     'varchar', 'NULL', 2*$char_d, '', '',
1603 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '',
1604         'ship_first',    'varchar', 'NULL', $char_d, '', '',
1605         'ship_company',  'varchar', 'NULL', $char_d, '', '',
1606         'ship_address1', 'varchar', 'NULL', $char_d, '', '',
1607         'ship_address2', 'varchar', 'NULL', $char_d, '', '',
1608         'ship_city',     'varchar', 'NULL', $char_d, '', '',
1609         'ship_county',   'varchar', 'NULL', $char_d, '', '',
1610         'ship_state',    'varchar', 'NULL', $char_d, '', '',
1611         'ship_zip',      'varchar', 'NULL', 10, '', '',
1612         'ship_country',  'char', 'NULL', 2, '', '',
1613         'ship_latitude', 'decimal', 'NULL', '10,7', '', '',
1614         'ship_longitude','decimal', 'NULL', '10,7', '', '',
1615         'ship_coord_auto',  'char', 'NULL',  1, '', '',
1616         'ship_addr_clean',  'char', 'NULL',  1, '', '',
1617         'ship_daytime',  'varchar', 'NULL', 20, '', '',
1618         'ship_night',    'varchar', 'NULL', 20, '', '',
1619         'ship_fax',      'varchar', 'NULL', 12, '', '',
1620         'ship_mobile',   'varchar', 'NULL', 12, '', '',
1621         'currency',         'char', 'NULL',  3, '', '',
1622
1623         'geocode',  'varchar', 'NULL', 20,  '', '',
1624         'censustract', 'varchar', 'NULL', 20,  '', '', # 7 to save space?
1625         'censusyear', 'char', 'NULL', 4, '', '',
1626         'district', 'varchar', 'NULL', 20, '', '',
1627         'tax',      'char', 'NULL', 1, '', '',
1628         'otaker',   'varchar', 'NULL',    32, '', '',
1629         'usernum',   'int', 'NULL', '', '', '',
1630         'refnum',   'int',  '',     '', '', '',
1631         'referral_custnum', 'int',  'NULL', '', '', '',
1632         'comments', 'text', 'NULL', '', '', '',
1633         'spool_cdr','char', 'NULL', 1, '', '',
1634         'squelch_cdr','char', 'NULL', 1, '', '',
1635         'cdr_termination_percentage', 'decimal', 'NULL', '7,4', '', '',
1636         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
1637         'credit_limit', @money_typen, '', '',
1638         'credit_limit_currency', 'char', 'NULL',  3, '', '',
1639         'archived', 'char', 'NULL', 1, '', '',
1640         'email_csv_cdr', 'char', 'NULL', 1, '', '',
1641         'accountcode_cdr', 'char', 'NULL', 1, '', '',
1642         'billday',   'int', 'NULL', '', '', '',
1643         'prorate_day',   'int', 'NULL', '', '', '',
1644         'edit_subject', 'char', 'NULL', 1, '', '',
1645         'locale', 'varchar', 'NULL', 16, '', '',
1646         'calling_list_exempt', 'char', 'NULL', 1, '', '',
1647         'invoice_noemail', 'char', 'NULL', 1, '', '',
1648         'message_noemail', 'char', 'NULL', 1, '', '',
1649         'bill_locationnum', 'int', 'NULL', '', '', '',
1650         'ship_locationnum', 'int', 'NULL', '', '', '',
1651         'taxstatusnum',   'int', 'NULL', '', '', '',
1652         'complimentary', 'char', 'NULL', 1, '', '',
1653         'po_number', 'varchar', 'NULL', $char_d, '', '',
1654         'invoice_attn', 'varchar', 'NULL', $char_d, '', '',
1655         'invoice_ship_address', 'char', 'NULL', 1, '', '',
1656         'postal_invoice', 'char', 'NULL', 1, '', '',
1657       ],
1658       'primary_key'  => 'custnum',
1659       'unique'       => [ [ 'agentnum', 'agent_custid' ] ],
1660       #'index'        => [ ['last'], ['company'] ],
1661       'index'        => [
1662                           ['agentnum'], ['refnum'], ['classnum'], ['usernum'],
1663                           [ 'custbatch' ],
1664                           [ 'referral_custnum' ],
1665                           [ 'archived' ],
1666                           [ 'ship_locationnum' ],
1667                           [ 'bill_locationnum' ],
1668                         ],
1669       'foreign_keys' => [
1670                           { columns    => [ 'agentnum' ],
1671                             table      => 'agent',
1672                           },
1673                           { columns    => [ 'salesnum' ],
1674                             table      => 'sales',
1675                           },
1676                           { columns    => [ 'refnum' ],
1677                             table      => 'part_referral',
1678                           },
1679                           { columns    => [ 'classnum' ],
1680                             table      => 'cust_class',
1681                           },
1682                           { columns    => [ 'usernum' ],
1683                             table      => 'access_user',
1684                           },
1685                           { columns    => [ 'referral_custnum' ],
1686                             table      => 'cust_main',
1687                             references => [ 'custnum' ],
1688                           },
1689                           { columns    => [ 'bill_locationnum' ],
1690                             table      => 'cust_location',
1691                             references => [ 'locationnum' ],
1692                           },
1693                           { columns    => [ 'ship_locationnum' ],
1694                             table      => 'cust_location',
1695                             references => [ 'locationnum' ],
1696                           },
1697                         ],
1698     },
1699
1700     'cust_payby' => {
1701       'columns' => [
1702         'custpaybynum', 'serial',     '',        '', '', '',
1703         'custnum',         'int',     '',        '', '', '',
1704         'weight',          'int', 'NULL',        '', '', '',
1705         'payby',          'char',     '',         4, '', '',
1706         'payinfo',     'varchar', 'NULL',       512, '', '',
1707         'paycardtype', 'varchar', 'NULL',   $char_d, '', '',
1708         'paycvv',      'varchar', 'NULL',       512, '', '',
1709         'paymask',     'varchar', 'NULL',   $char_d, '', '',
1710         #'paydate',   @date_type, '', '',
1711         'paydate',     'varchar', 'NULL',        10, '', '',
1712         'paystart_month',  'int', 'NULL',        '', '', '',
1713         'paystart_year',   'int', 'NULL',        '', '', '',
1714         'payissue',    'varchar', 'NULL',         2, '', '',
1715         'payname',     'varchar', 'NULL', 2*$char_d, '', '',
1716         'paystate',    'varchar', 'NULL',   $char_d, '', '',
1717         'paytype',     'varchar', 'NULL',   $char_d, '', '',
1718         'payip',       'varchar', 'NULL',        15, '', '',
1719         'locationnum',     'int', 'NULL',        '', '', '',
1720       ],
1721       'primary_key'  => 'custpaybynum',
1722       'unique'       => [],
1723       'index'        => [ [ 'custnum' ] ],
1724       'foreign_keys' => [
1725                           { columns    => [ 'custnum' ],
1726                             table      => 'cust_main',
1727                           },
1728                           { columns    => [ 'locationnum' ],
1729                             table      => 'cust_location',
1730                           },
1731                         ],
1732     },
1733
1734     'contact_class' => {
1735       'columns' => [
1736         'classnum',    'serial',   '',      '', '', '',
1737         'classname',   'varchar',  '', $char_d, '', '',
1738         'disabled',    'char', 'NULL',       1, '', '',
1739       ],
1740       'primary_key' => 'classnum',
1741       'unique' => [],
1742       'index' => [ ['disabled'] ],
1743     },
1744
1745     'cust_contact' => {
1746       'columns' => [
1747         'custcontactnum',     'serial',     '',  '', '', '',
1748         'custnum',               'int',     '',  '', '', '',
1749         'contactnum',            'int',     '',  '', '', '',
1750         'classnum',              'int', 'NULL',  '', '', '',
1751         'comment',           'varchar', 'NULL', 255, '', '',
1752         'selfservice_access',   'char', 'NULL',   1, '', '',
1753         'invoice_dest',         'char', 'NULL',       1, '', '',
1754       ],
1755       'primary_key'  => 'custcontactnum',
1756       'unique'       => [ [ 'custnum', 'contactnum' ], ],
1757       'index'        => [ [ 'custnum' ], [ 'contactnum' ], ],
1758       'foreign_keys' => [
1759                           { columns    => [ 'custnum' ],
1760                             table      => 'cust_main',
1761                           },
1762                           { columns    => [ 'contactnum' ],
1763                             table      => 'contact',
1764                           },
1765                           { columns    => [ 'classnum' ],
1766                             table      => 'contact_class',
1767                           },
1768                         ],
1769     },
1770
1771     'prospect_contact' => {
1772       'columns' => [
1773         'prospectcontactnum', 'serial',     '',  '', '', '',
1774         'prospectnum',       'int',     '',  '', '', '',
1775         'contactnum',        'int',     '',  '', '', '',
1776         'classnum',          'int', 'NULL',  '', '', '',
1777         'comment',       'varchar', 'NULL', 255, '', '',
1778       ],
1779       'primary_key'  => 'prospectcontactnum',
1780       'unique'       => [ [ 'prospectnum', 'contactnum' ], ],
1781       'index'        => [ [ 'prospectnum' ], [ 'contactnum' ], ],
1782       'foreign_keys' => [
1783                           { columns    => [ 'prospectnum' ],
1784                             table      => 'prospect_main',
1785                           },
1786                           { columns    => [ 'contactnum' ],
1787                             table      => 'contact',
1788                           },
1789                           { columns    => [ 'classnum' ],
1790                             table      => 'contact_class',
1791                           },
1792                         ],
1793     },
1794
1795     'contact' => {
1796       'columns' => [
1797         'contactnum', 'serial',     '',      '', '', '',
1798         'prospectnum',   'int', 'NULL',      '', '', '', #deprecated, now prospect_contact table
1799         'custnum',       'int', 'NULL',      '', '', '', #deprecated, now cust_contact table
1800         'locationnum',   'int', 'NULL',      '', '', '', #not yet
1801         'classnum',      'int', 'NULL',      '', '', '', #deprecated, now prospect_contact or cust_contact
1802 #        'titlenum',      'int', 'NULL',      '', '', '', #eg Mr. Mrs. Dr. Rev.
1803         'last',      'varchar',     '', $char_d, '', '',
1804 #        'middle',    'varchar', 'NULL', $char_d, '', '',
1805         'first',     'varchar',     '', $char_d, '', '',
1806         'title',     'varchar', 'NULL', $char_d, '', '', #eg Head Bottle Washer
1807         'comment',   'varchar', 'NULL',     255, '', '',  #depredated, now prospect_contact or cust_contact
1808         'selfservice_access',    'char', 'NULL',       1, '', '', #deprecated, now cust_contact
1809         '_password',          'varchar', 'NULL', $char_d, '', '',
1810         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1811         'disabled',              'char', 'NULL',       1, '', '',
1812         'invoice_dest',          'char', 'NULL',       1, '', '',
1813       ],
1814       'primary_key'  => 'contactnum',
1815       'unique'       => [],
1816       'index'        => [ [ 'prospectnum' ], [ 'custnum' ], [ 'locationnum' ],
1817                           [ 'last' ], [ 'first' ],
1818                         ],
1819       'foreign_keys' => [
1820                           { columns    => [ 'prospectnum' ],
1821                             table      => 'prospect_main',
1822                           },
1823                           { columns    => [ 'custnum' ],
1824                             table      => 'cust_main',
1825                           },
1826                           { columns    => [ 'locationnum' ],
1827                             table      => 'cust_location',
1828                           },
1829                           { columns    => [ 'classnum' ],
1830                             table      => 'contact_class',
1831                           },
1832                         ],
1833     },
1834
1835     'contact_phone' => {
1836       'columns' => [
1837         'contactphonenum', 'serial',     '', '', '', '',
1838         'contactnum',         'int',     '', '', '', '',
1839         'phonetypenum',       'int',     '', '', '', '',
1840         'countrycode',    'varchar',     '',  3, '', '',
1841         'phonenum',       'varchar',     '', 14, '', '',
1842         'extension',      'varchar', 'NULL',  7, '', '',
1843         #?#'comment',        'varchar',     '', $char_d, '', '',
1844       ],
1845       'primary_key'  => 'contactphonenum',
1846       'unique'       => [],
1847       'index'        => [],
1848       'foreign_keys' => [
1849                           { columns    => [ 'contactnum' ],
1850                             table      => 'contact',
1851                           },
1852                           { columns    => [ 'phonetypenum' ],
1853                             table      => 'phone_type',
1854                           },
1855                         ],
1856     },
1857
1858     'phone_type' => {
1859       'columns' => [
1860         'phonetypenum',  'serial', '',      '', '', '',
1861         'typename',     'varchar', '', $char_d, '', '',
1862         'weight',           'int', '',      '', '', '',
1863       ],
1864       'primary_key' => 'phonetypenum',
1865       'unique'      => [ [ 'typename' ], ],
1866       'index'       => [],
1867     },
1868
1869     'contact_email' => {
1870       'columns' => [
1871         'contactemailnum', 'serial', '',      '', '', '',
1872         'contactnum',         'int', '',      '', '', '',
1873         'emailaddress',   'varchar', '', $char_d, '', '',
1874       ],
1875       'primary_key'  => 'contactemailnum',
1876       #'unique'       => [ [ 'contactnum', 'emailaddress' ], ],
1877       'unique'       => [ [ 'emailaddress' ], ],
1878       'index'        => [],
1879       'foreign_keys' => [
1880                           { columns    => [ 'contactnum' ],
1881                             table      => 'contact',
1882                           },
1883                         ],
1884     },
1885
1886     'prospect_main' => {
1887       'columns' => [
1888         'prospectnum',  'serial',     '',      '', '', '',
1889         'agentnum',        'int',     '',      '', '', '',
1890         'company',     'varchar', 'NULL', $char_d, '', '',
1891         'add_date',   @date_type,                  '', '',
1892         'disabled',       'char', 'NULL',       1, '', '',
1893         'custnum',         'int', 'NULL',      '', '', '',
1894         'refnum',          'int', 'NULL',      '', '', '',
1895         'taxstatusnum',    'int', 'NULL',      '', '', '',
1896       ],
1897       'primary_key'  => 'prospectnum',
1898       'unique'       => [],
1899       'index'        => [ ['company'], ['agentnum'], ['disabled'], ['refnum'] ],
1900       'foreign_keys' => [
1901                           { columns    => [ 'agentnum' ],
1902                             table      => 'agent',
1903                           },
1904                           { columns    => [ 'custnum' ],
1905                             table      => 'cust_main',
1906                           },
1907                           { columns    => [ 'refnum' ],
1908                             table      => 'part_referral',
1909                           },
1910                         ],
1911     },
1912
1913     'quotation' => {
1914       'columns' => [
1915         #regular fields
1916         'quotationnum',   'serial',     '', '', '', '',
1917         'prospectnum',       'int', 'NULL', '', '', '',
1918         'custnum',           'int', 'NULL', '', '', '',
1919         '_date',        @date_type,             '', '',
1920         'disabled',         'char', 'NULL',  1, '', '',
1921         'usernum',           'int', 'NULL', '', '', '',
1922         'close_date',   @date_type,             '', '',
1923         'confidence',        'int', 'NULL', '', '', '',
1924         #'total',      @money_type,       '', '',
1925         #'quotation_term', 'varchar', 'NULL', $char_d, '', '',
1926       ],
1927       'primary_key'  => 'quotationnum',
1928       'unique'       => [],
1929       'index'        => [ [ 'prospectnum' ], ['custnum'], ['disabled'], ],
1930       'foreign_keys' => [
1931                           { columns    => [ 'prospectnum' ],
1932                             table      => 'prospect_main',
1933                           },
1934                           { columns    => [ 'custnum' ],
1935                             table      => 'cust_main',
1936                           },
1937                           { columns    => [ 'usernum' ],
1938                             table      => 'access_user',
1939                           },
1940                         ],
1941     },
1942
1943     'quotation_pkg' => {
1944       'columns' => [
1945         'quotationpkgnum',   'serial',     '', '', '', '',
1946         'quotationnum',         'int', 'NULL', '', '', '', #shouldn't be null,
1947                                                            # but history...
1948         'pkgpart',              'int',     '', '', '', '',
1949         'locationnum',          'int', 'NULL', '', '', '',
1950         'start_date',      @date_type,             '', '',
1951         'contract_end',    @date_type,             '', '',
1952         'quantity',             'int', 'NULL', '', '', '',
1953         'waive_setup',         'char', 'NULL',  1, '', '',
1954         'unitsetup',     @money_typen,             '', '',
1955         'unitrecur',     @money_typen,             '', '',
1956       ],
1957       'primary_key'  => 'quotationpkgnum',
1958       'unique'       => [],
1959       'index'        => [ ['pkgpart'], ],
1960       'foreign_keys' => [
1961                           { columns    => [ 'quotationnum' ],
1962                             table      => 'quotation',
1963                           },
1964                           { columns    => [ 'pkgpart' ],
1965                             table      => 'part_pkg',
1966                           },
1967                           { columns    => [ 'locationnum' ],
1968                             table      => 'cust_location',
1969                           },
1970                         ],
1971     },
1972
1973     'quotation_pkg_detail' => {
1974       'columns' => [
1975         'detailnum', 'serial', '', '', '', '',
1976         'quotationpkgnum', 'int', '', '', '', '',
1977         'format',  'char', 'NULL', 1, '', '',       # not used for anything
1978         'detail',  'varchar', '', 255, '', '',
1979         'copy_on_order',        'char', 'NULL',  1, '', '', # 'Y' to copy when ordering
1980       ],
1981       'primary_key'  => 'detailnum',
1982       'unique'       => [],
1983       'index'        => [ [ 'quotationpkgnum' ] ],
1984       'foreign_keys' => [
1985                           { columns    => [ 'quotationpkgnum' ],
1986                             table      => 'quotation_pkg',
1987                             references => [ 'quotationpkgnum' ],
1988                           },
1989                         ],
1990     },
1991
1992     'quotation_pkg_discount' => {
1993       'columns' => [
1994         'quotationpkgdiscountnum', 'serial', '', '', '', '',
1995         'quotationpkgnum',            'int', '', '', '', '',
1996         'discountnum',                'int', '', '', '', '',
1997         'setuprecur',             'varchar', 'NULL', $char_d, '', '',
1998         'amount',              @money_typen, '', '',
1999         #'end_date',              @date_type,         '', '',
2000       ],
2001       'primary_key'  => 'quotationpkgdiscountnum',
2002       'unique'       => [],
2003       'index'        => [ [ 'quotationpkgnum' ], ], #[ 'discountnum' ] ],
2004       'foreign_keys' => [
2005                           { columns    => [ 'quotationpkgnum' ],
2006                             table      => 'quotation_pkg',
2007                           },
2008                           { columns    => [ 'discountnum' ],
2009                             table      => 'discount',
2010                           },
2011                         ],
2012     },
2013
2014     'quotation_pkg_tax' => {
2015       'columns' => [
2016         'quotationtaxnum',  'serial',     '',      '', '', '',
2017         'quotationpkgnum',     'int',     '',      '', '', '',
2018         'itemdesc',        'varchar',     '', $char_d, '', '',
2019         'setup_amount',    @money_type,                '', '',
2020         'recur_amount',    @money_type,                '', '',
2021       ],
2022       'primary_key' => 'quotationtaxnum',
2023       'unique' => [],
2024       'index'  => [ [ 'quotationpkgnum' ] ],
2025       'foreign_keys' => [
2026                           { columns    => [ 'quotationpkgnum' ],
2027                             table      => 'quotation_pkg',
2028                           },
2029                         ],
2030     },
2031
2032     'cust_location' => { #'location' now that its prospects too, but...
2033       'columns' => [
2034         'locationnum',      'serial',     '',      '', '', '',
2035         'prospectnum',         'int', 'NULL',      '', '', '',
2036         'custnum',             'int', 'NULL',      '', '', '',
2037         'locationname',    'varchar', 'NULL', $char_d, '', '',
2038         'address1',        'varchar',     '', $char_d, '', '',
2039         'address2',        'varchar', 'NULL', $char_d, '', '',
2040         'city',            'varchar', 'NULL', $char_d, '', '',
2041         'county',          'varchar', 'NULL', $char_d, '', '',
2042         'state',           'varchar', 'NULL', $char_d, '', '',
2043         'zip',             'varchar', 'NULL',      10, '', '',
2044         'latitude',        'decimal', 'NULL',  '10,7', '', '',
2045         'longitude',       'decimal', 'NULL',  '10,7', '', '',
2046         'coord_auto',         'char', 'NULL',       1, '', '',
2047         'addr_clean',         'char', 'NULL',       1, '', '',
2048         'country',            'char',     '',       2, '', '',
2049         'geocode',         'varchar', 'NULL',      20, '', '',
2050         'district',        'varchar', 'NULL',      20, '', '',
2051         'censustract',     'varchar', 'NULL',      20, '', '',
2052         'censusyear',         'char', 'NULL',       4, '', '',
2053
2054         #used only in... DSL qualification?  .CA DSL qualification?
2055         'location_type',   'varchar', 'NULL',      20, '', '',
2056         'location_number', 'varchar', 'NULL',      20, '', '',
2057         'location_kind',      'char', 'NULL',       1, '', '',
2058
2059         'incorporated',       'char', 'NULL',       1, '', '',
2060         'disabled',           'char', 'NULL',       1, '', '',
2061       ],
2062       'primary_key'  => 'locationnum',
2063       'unique'       => [],
2064       'index'        => [ [ 'prospectnum' ], [ 'custnum' ],
2065                           [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
2066                           [ 'city' ], [ 'district' ]
2067                         ],
2068       'foreign_keys' => [
2069                           { columns    => [ 'prospectnum' ],
2070                             table      => 'prospect_main',
2071                           },
2072                           { columns    => [ 'custnum' ],
2073                             table      => 'cust_main',
2074                           },
2075                         ],
2076     },
2077
2078     'cust_main_invoice' => {
2079       'columns' => [
2080         'destnum',  'serial',  '',     '', '', '',
2081         'custnum',  'int',  '',     '', '', '',
2082         'dest',     'varchar', '',  $char_d, '', '',
2083       ],
2084       'primary_key'  => 'destnum',
2085       'unique'       => [],
2086       'index'        => [ ['custnum'], ],
2087       'foreign_keys' => [
2088                           { columns    => [ 'custnum' ],
2089                             table      => 'cust_main',
2090                           },
2091                         ],
2092     },
2093
2094     'cust_main_credit_limit' => {
2095       'columns' => [
2096         'creditlimitnum',   'serial', '', '', '', '',
2097         'custnum',             'int', '', '', '', '',
2098         '_date',          @date_type,         '', '',
2099         'amount',       @money_typen,         '', '',
2100         #'amount_currency', 'char', 'NULL',  3, '', '',
2101         'credit_limit', @money_typen,         '', '',
2102         #'credit_limit_currency', 'char', 'NULL',  3, '', '',
2103       ],
2104       'primary_key'  => 'creditlimitnum',
2105       'unique'       => [],
2106       'index'        => [ ['custnum'], ],
2107       'foreign_keys' => [
2108                           { columns    => [ 'custnum' ],
2109                             table      => 'cust_main',
2110                           },
2111                         ],
2112     },
2113
2114     'cust_main_note' => {
2115       'columns' => [
2116         'notenum',   'serial',    '',  '', '', '',
2117         'custnum',      'int',    '',  '', '', '',
2118         'classnum',     'int', 'NULL', '', '', '',
2119         '_date',          @date_type,      '', '',
2120         'otaker',   'varchar', 'NULL', 32, '', '',
2121         'usernum',      'int', 'NULL', '', '', '',
2122         'comments',    'text', 'NULL', '', '', '',
2123         'sticky',       'int',     '', '',  0, '',
2124       ],
2125       'primary_key'  => 'notenum',
2126       'unique'       => [],
2127       'index'        => [ [ 'custnum' ], [ '_date' ], [ 'usernum' ], ],
2128       'foreign_keys' => [
2129                           { columns    => [ 'custnum' ],
2130                             table      => 'cust_main',
2131                           },
2132                           { columns    => [ 'classnum' ],
2133                             table      => 'cust_note_class',
2134                           },
2135                           { columns    => [ 'usernum' ],
2136                             table      => 'access_user',
2137                           },
2138                         ],
2139     },
2140
2141     'cust_note_class' => {
2142       'columns' => [
2143         'classnum',    'serial',   '',      '', '', '',
2144         'classname',   'varchar',  '', $char_d, '', '',
2145         'disabled',    'char', 'NULL',       1, '', '',
2146       ],
2147       'primary_key' => 'classnum',
2148       'unique' => [],
2149       'index' => [ ['disabled'] ],
2150     },
2151
2152     'cust_category' => {
2153       'columns' => [
2154         'categorynum',   'serial',  '', '', '', '',
2155         'categoryname',  'varchar', '', $char_d, '', '',
2156         'weight',         'int', 'NULL',  '', '', '',
2157         'disabled',      'char', 'NULL',   1, '', '',
2158       ],
2159       'primary_key' => 'categorynum',
2160       'unique' => [],
2161       'index' => [ ['disabled'] ],
2162     },
2163
2164     'cust_class' => {
2165       'columns' => [
2166         'classnum',     'serial',     '',      '', '', '',
2167         'classname',   'varchar',     '', $char_d, '', '',
2168         'categorynum',     'int', 'NULL',      '', '', '',
2169         'tax',            'char', 'NULL',       1, '', '',
2170         'disabled',       'char', 'NULL',       1, '', '',
2171       ],
2172       'primary_key'  => 'classnum',
2173       'unique'       => [],
2174       'index'        => [ ['disabled'] ],
2175       'foreign_keys' => [
2176                           { columns    => [ 'categorynum' ],
2177                             table      => 'cust_category',
2178                           },
2179                         ],
2180     },
2181
2182     'cust_tag' => {
2183       'columns' => [
2184         'custtagnum', 'serial', '', '', '', '',
2185         'custnum',       'int', '', '', '', '',
2186         'tagnum',        'int', '', '', '', '',
2187       ],
2188       'primary_key'  => 'custtagnum',
2189       'unique'       => [ [ 'custnum', 'tagnum' ] ],
2190       'index'        => [ [ 'custnum' ] ],
2191       'foreign_keys' => [
2192                           { columns    => [ 'custnum' ],
2193                             table      => 'cust_main',
2194                           },
2195                           { columns    => [ 'tagnum' ],
2196                             table      => 'part_tag',
2197                           },
2198                         ],
2199     },
2200
2201     'part_tag' => {
2202       'columns' => [
2203         'tagnum',    'serial',     '',      '', '', '',
2204         'tagname',  'varchar',     '', $char_d, '', '',
2205         'tagdesc',  'varchar', 'NULL', $char_d, '', '',
2206         'tagcolor', 'varchar', 'NULL',       6, '', '',
2207         'by_default',  'char', 'NULL',       1, '', '',
2208         'disabled',    'char', 'NULL',       1, '', '',
2209       ],
2210       'primary_key' => 'tagnum',
2211       'unique'      => [], #[ [ 'tagname' ] ], #?
2212       'index'       => [ [ 'disabled' ] ],
2213     },
2214
2215     'cust_main_exemption' => {
2216       'columns' => [
2217         'exemptionnum',   'serial',     '',      '', '', '',
2218         'custnum',           'int',     '',      '', '', '',
2219         'taxname',       'varchar',     '', $char_d, '', '',
2220         'exempt_number', 'varchar', 'NULL', $char_d, '', '',
2221         #start/end dates?  for reporting?
2222       ],
2223       'primary_key'  => 'exemptionnum',
2224       'unique'       => [],
2225       'index'        => [ [ 'custnum' ] ],
2226       'foreign_keys' => [
2227                           { columns    => [ 'custnum' ],
2228                             table      => 'cust_main',
2229                           },
2230                         ],
2231     },
2232
2233     'cust_tax_adjustment' => {
2234       'columns' => [
2235         'adjustmentnum', 'serial',     '',      '', '', '',
2236         'custnum',          'int',     '',      '', '', '',
2237         'taxname',      'varchar',     '', $char_d, '', '',
2238         'amount',     @money_type,                  '', '',
2239         'currency',        'char', 'NULL',       3, '', '',
2240         'comment',      'varchar', 'NULL', $char_d, '', '',
2241         'billpkgnum',       'int', 'NULL',      '', '', '',
2242         #more?  no cust_bill_pkg_tax_location?
2243       ],
2244       'primary_key'  => 'adjustmentnum',
2245       'unique'       => [],
2246       'index'        => [ [ 'custnum' ], [ 'billpkgnum' ] ],
2247       'foreign_keys' => [
2248                           { columns    => [ 'custnum' ],
2249                             table      => 'cust_main',
2250                           },
2251                           { columns    => [ 'billpkgnum' ],
2252                             table      => 'cust_bill_pkg',
2253                           },
2254                         ],
2255     },
2256
2257     'cust_main_county' => { #district+city+county+state+country are checked
2258                             #off the cust_main_county for validation and to
2259                             #provide a tax rate.
2260       'columns' => [
2261         'taxnum',    'serial',     '',      '', '', '',
2262         'district', 'varchar', 'NULL',      20, '', '',
2263         'city',     'varchar', 'NULL', $char_d, '', '',
2264         'county',   'varchar', 'NULL', $char_d, '', '',
2265         'state',    'varchar', 'NULL', $char_d, '', '',
2266         'country',     'char',     '',       2, '', '',
2267         'taxclass', 'varchar', 'NULL', $char_d, '', '',
2268         'exempt_amount', @money_type,            '', '',
2269         'exempt_amount_currency', 'char', 'NULL', 3, '', '',
2270         'tax',         'real',     '',      '', '', '', #tax %
2271         'taxname',  'varchar', 'NULL', $char_d, '', '',
2272         'setuptax',    'char', 'NULL',       1, '', '', # Y = setup tax exempt
2273         'recurtax',    'char', 'NULL',       1, '', '', # Y = recur tax exempt
2274         'source',   'varchar', 'NULL', $char_d, '', '',
2275       ],
2276       'primary_key' => 'taxnum',
2277       'unique' => [],
2278   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
2279       'index' => [ [ 'district' ], [ 'city' ], [ 'county' ], [ 'state' ],
2280                    [ 'country' ],
2281                    [ 'taxclass' ],
2282                  ],
2283     },
2284
2285     'tax_rate'    => {
2286       'columns' => [
2287         'taxnum',       'serial',     '',      '', '', '',
2288         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
2289         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
2290         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
2291         'taxclassnum', 'int',     'NULL',      '', '', '',
2292         'effective_date', @date_type, '', '',
2293         'tax',        @taxrate_type,      '', '',        # tax %
2294         'excessrate', @taxrate_typen,     '', '',        # second tax %
2295         'taxbase',    @money_typen, '', '',              # amount at first tax rate
2296         'taxmax',     @money_typen, '', '',              # maximum about at both rates
2297         'usetax',        @taxrate_typen,     '', '',     # tax % when non-local
2298         'useexcessrate', @taxrate_typen,     '', '',     # second tax % when non-local
2299         'unittype',    'int',  'NULL', '', '', '',      # for fee
2300         'fee',         @taxrate_typen,     '', '',      # amount tax per unit
2301         'excessfee',   @taxrate_typen,     '', '',      # second amount tax per unit
2302         'feebase',     @taxrate_typen,     '', '',      # units taxed at first rate
2303         'feemax',      @taxrate_typen,     '', '',      # maximum number of unit taxed
2304         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
2305         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
2306         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
2307         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
2308         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
2309         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
2310         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
2311         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
2312         'inoutcity',   'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
2313         'inoutlocal',  'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
2314         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
2315         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
2316       ],
2317       'primary_key'  => 'taxnum',
2318       'unique'       => [],
2319       'index'        => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
2320       'foreign_keys' => [
2321                           { columns    => [ 'taxclassnum' ],
2322                             table      => 'tax_class',
2323                           },
2324                         ],
2325     },
2326
2327     'tax_rate_location' => {
2328       'columns' => [
2329         'taxratelocationnum', 'serial',  '',     '', '', '',
2330         'data_vendor',        'varchar', 'NULL', $char_d, '', '',
2331         'geocode',            'varchar', '',     20,      '', '',
2332         'city',               'varchar', 'NULL', $char_d, '', '',
2333         'county',             'varchar', 'NULL', $char_d, '', '',
2334         'state',              'char',    'NULL',       2, '', '',
2335         'country',            'char',    'NULL',       2, '', '',
2336         'disabled',           'char',    'NULL', 1, '', '',
2337       ],
2338       'primary_key' => 'taxratelocationnum',
2339       'unique' => [],
2340       'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
2341     },
2342
2343     'cust_tax_location' => {
2344       'columns' => [
2345         'custlocationnum', 'serial',  '',     '', '', '',
2346         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
2347         'city',            'varchar', 'NULL', $char_d, '', '',
2348         'postalcity',      'varchar', 'NULL', $char_d, '', '',
2349         'county',          'varchar', 'NULL', $char_d, '', '',
2350         'zip',             'char',    'NULL', 5,  '', '',
2351         'state',           'char',    '',     2,  '', '',
2352         'country',         'char',    'NULL', 2,  '', '', # should not actually be NULL, but cch...
2353         'ziphi',           'char',    'NULL', 10, '', '',
2354         'ziplo',           'char',    'NULL', 10, '', '',
2355         'plus4hi',         'char',    'NULL', 4,  '', '',
2356         'plus4lo',         'char',    'NULL', 4,  '', '',
2357         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
2358         'cityflag',        'char',    'NULL', 1,  '', '', # I(n)/O(out)/B(oth)/NULL
2359         'geocode',         'varchar', '',    20,  '', '',
2360       ],
2361       'primary_key' => 'custlocationnum',
2362       'unique' => [],
2363       'index' => [ [ 'zip', 'plus4lo', 'plus4hi', 'ziphi', 'ziplo' ] ],
2364     },
2365
2366     'tax_class' => {
2367       'columns' => [
2368         'taxclassnum',  'serial',  '',            '', '', '',
2369         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
2370         'taxclass',     'varchar', '',       $char_d, '', '',
2371         'description',  'varchar', '',     2*$char_d, '', '',
2372       ],
2373       'primary_key' => 'taxclassnum',
2374       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
2375       'index' => [],
2376     },
2377
2378     'tax_status' => {
2379       'columns' => [
2380         'taxstatusnum', 'serial', '',             '', '', '',
2381         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
2382         'taxstatus',    'varchar', '',       $char_d, '', '',
2383         'description',  'varchar', '',       $char_d, '', '',
2384       ],
2385       'primary_key' => 'taxstatusnum',
2386       'unique'      => [ [ 'data_vendor', 'taxstatus' ] ],
2387       'index' => [],
2388     },
2389
2390     'cust_pay_pending' => {
2391       'columns' => [
2392         'paypendingnum',      'serial',     '',      '', '', '',
2393         'custnum',               'int', 'NULL',      '', '', '',
2394         'paid',            @money_type,                  '', '',
2395         'currency',             'char', 'NULL',       3, '', '',
2396         '_date',            @date_type,                  '', '',
2397         'payby',                'char',     '',       4, '', '',
2398         'payinfo',           'varchar', 'NULL',     512, '', '',
2399         'paymask',           'varchar', 'NULL', $char_d, '', '',
2400         'paydate',           'varchar', 'NULL',     10, '', '',
2401         'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
2402         'payunique',         'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
2403
2404         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
2405         'status',       'varchar',     '', $char_d, '', '',
2406         'session_id',   'varchar', 'NULL', 1024, '', '', # SHA-512-hex
2407         'statustext',   'text',    'NULL',  '', '', '',
2408         'gatewaynum',   'int',     'NULL',  '', '', '',
2409         #'cust_balance', @money_type,            '', '',
2410         'paynum',       'int',     'NULL',  '', '', '',
2411         'void_paynum',  'int',     'NULL',  '', '', '',
2412         'jobnum',    'bigint',     'NULL',  '', '', '',
2413         'invnum',       'int',     'NULL',  '', '', '',
2414         'manual',       'char',    'NULL',   1, '', '',
2415         'discount_term','int',     'NULL',  '', '', '',
2416         'failure_status','varchar','NULL',  16, '', '',
2417       ],
2418       'primary_key'  => 'paypendingnum',
2419       'unique'       => [ [ 'payunique' ] ],
2420       'index'        => [ [ 'custnum' ], [ 'status' ],
2421                           ['paynum'], ['void_paynum'], ['jobnum'], ['invnum'],
2422                         ],
2423       'foreign_keys' => [
2424                           { columns    => [ 'custnum' ],
2425                             table      => 'cust_main',
2426                           },
2427                           { columns    => [ 'pkgnum' ],
2428                             table      => 'cust_pkg',
2429                           },
2430                           { columns    => [ 'gatewaynum' ],
2431                             table      => 'payment_gateway',
2432                           },
2433                           { columns    => [ 'paynum' ],
2434                             table      => 'cust_pay',
2435                           },
2436                           { columns    => [ 'void_paynum' ],
2437                             table      => 'cust_pay_void',
2438                             references => [ 'paynum' ],
2439                           },
2440                           { columns    => [ 'jobnum' ],
2441                             table      => 'queue',
2442                           },
2443                           { columns    => [ 'invnum' ],
2444                             table      => 'cust_bill',
2445                           },
2446                         ],
2447     },
2448
2449     'cust_pay' => {
2450       'columns' => [
2451         'paynum',       'serial',    '',       '', '', '',
2452         'custnum',         'int',    '',       '', '', '',
2453         '_date',     @date_type,                   '', '',
2454         'paid',      @money_type,                  '', '',
2455         'currency',       'char', 'NULL',       3, '', '',
2456         'otaker',      'varchar', 'NULL',      32, '', '',
2457         'usernum',         'int', 'NULL',      '', '', '',
2458         'payby',          'char',     '',       4, '', '',
2459         'payinfo',     'varchar', 'NULL',     512, '', '',
2460         'paycardtype', 'varchar', 'NULL',   $char_d, '', '',
2461         'paymask',     'varchar', 'NULL', $char_d, '', '',
2462         'paydate',     'varchar', 'NULL',      10, '', '',
2463         'paybatch',    'varchar', 'NULL', $char_d, '', '',#for auditing purposes
2464         'payunique',   'varchar', 'NULL', $char_d, '', '',#separate paybatch "unique" functions from current usage
2465         'closed',         'char', 'NULL',       1, '', '',
2466         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
2467         'no_auto_apply',  'char', 'NULL',       1, '', '',
2468
2469         # cash/check deposit info fields
2470         'bank',        'varchar', 'NULL', $char_d, '', '',
2471         'depositor',   'varchar', 'NULL', $char_d, '', '',
2472         'account',     'varchar', 'NULL',      20, '', '',
2473         'teller',      'varchar', 'NULL',      20, '', '',
2474
2475         'batchnum',        'int', 'NULL',      '', '', '',#pay_batch foreign key
2476
2477         # credit card/EFT fields (formerly in paybatch)
2478         'gatewaynum',      'int', 'NULL',      '', '', '', # payment_gateway FK
2479         'processor',   'varchar', 'NULL', $char_d, '', '', # module name
2480         'auth',        'varchar', 'NULL',      16, '', '', # CC auth number
2481         'order_number','varchar', 'NULL', 256, '', '', # transaction number
2482       ],
2483       'primary_key'  => 'paynum',
2484       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
2485       'index'        => [ ['custnum'], ['paybatch'], ['payby'], ['_date'],
2486                           ['usernum'],
2487                         ],
2488       'foreign_keys' => [
2489                           { columns    => [ 'custnum' ],
2490                             table      => 'cust_main',
2491                           },
2492                           { columns    => [ 'usernum' ],
2493                             table      => 'access_user',
2494                           },
2495                           { columns    => [ 'pkgnum' ],
2496                             table      => 'cust_pkg',
2497                           },
2498                           { columns    => [ 'batchnum' ],
2499                             table      => 'pay_batch',
2500                           },
2501                           { columns    => [ 'gatewaynum' ],
2502                             table      => 'payment_gateway',
2503                           },
2504                         ],
2505     },
2506
2507     'cust_pay_void' => {
2508       'columns' => [
2509         'paynum',          'int',    '',       '', '', '',
2510         'custnum',         'int',    '',       '', '', '',
2511         '_date',      @date_type,                  '', '',
2512         'paid',      @money_type,                  '', '',
2513         'currency',       'char', 'NULL',       3, '', '',
2514         'otaker',      'varchar', 'NULL',      32, '', '',
2515         'usernum',         'int', 'NULL',      '', '', '',
2516         'payby',          'char',     '',       4, '', '',
2517         'payinfo',     'varchar', 'NULL',     512, '', '',
2518         'paycardtype', 'varchar', 'NULL',   $char_d, '', '',
2519         'paymask',     'varchar', 'NULL', $char_d, '', '',
2520         #'paydate' ?
2521         'paybatch',    'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
2522         'closed',        'char',  'NULL',       1, '', '',
2523         'pkgnum', 'int',   'NULL', '', '', '', #desired pkgnum for pkg-balances
2524
2525         # cash/check deposit info fields
2526         'bank',       'varchar', 'NULL', $char_d, '', '',
2527         'depositor',  'varchar', 'NULL', $char_d, '', '',
2528         'account',    'varchar', 'NULL',      20, '', '',
2529         'teller',     'varchar', 'NULL',      20, '', '',
2530         'batchnum',       'int', 'NULL',      '', '', '', #pay_batch foreign key
2531
2532         # credit card/EFT fields (formerly in paybatch)
2533         'gatewaynum',      'int', 'NULL',      '', '', '', # payment_gateway FK
2534         'processor',   'varchar', 'NULL', $char_d, '', '', # module name
2535         'auth',        'varchar', 'NULL',      16, '', '', # CC auth number
2536         'order_number','varchar', 'NULL', 256, '', '', # transaction number
2537
2538         #void fields
2539         'void_date',  @date_type,                  '', '',
2540         'reason',      'varchar', 'NULL', $char_d, '', '',
2541         'reasonnum',       'int', 'NULL',      '', '', '',
2542         'void_usernum',    'int', 'NULL',      '', '', '',
2543       ],
2544       'primary_key'  => 'paynum',
2545       'unique'       => [],
2546       'index'        => [ ['custnum'], ['usernum'], ['void_usernum'] ],
2547       'foreign_keys' => [
2548                           { columns    => [ 'custnum' ],
2549                             table      => 'cust_main',
2550                           },
2551                           { columns    => [ 'usernum' ],
2552                             table      => 'access_user',
2553                           },
2554                           { columns    => [ 'pkgnum' ],
2555                             table      => 'cust_pkg',
2556                           },
2557                           { columns    => [ 'batchnum' ],
2558                             table      => 'pay_batch',
2559                           },
2560                           { columns    => [ 'gatewaynum' ],
2561                             table      => 'payment_gateway',
2562                           },
2563                           { columns    => [ 'reasonnum' ],
2564                             table      => 'reason',
2565                           },
2566                           { columns    => [ 'void_usernum' ],
2567                             table      => 'access_user',
2568                             references => [ 'usernum' ],
2569                           },
2570                         ],
2571     },
2572
2573     'cust_bill_pay' => {
2574       'columns' => [
2575         'billpaynum', 'serial',     '',   '', '', '',
2576         'invnum',  'int',     '',   '', '', '',
2577         'paynum',  'int',     '',   '', '', '',
2578         'amount',  @money_type, '', '',
2579         '_date',   @date_type, '', '',
2580         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
2581       ],
2582       'primary_key'  => 'billpaynum',
2583       'unique'       => [],
2584       'index'        => [ [ 'paynum' ], [ 'invnum' ] ],
2585       'foreign_keys' => [
2586                           { columns    => [ 'invnum' ],
2587                             table      => 'cust_bill',
2588                           },
2589                           { columns    => [ 'paynum' ],
2590                             table      => 'cust_pay',
2591                           },
2592                           { columns    => [ 'pkgnum' ],
2593                             table      => 'cust_pkg',
2594                           },
2595                         ],
2596     },
2597
2598     'cust_bill_pay_batch' => {
2599       'columns' => [
2600         'billpaynum', 'serial',     '',   '', '', '',
2601         'invnum',  'int',     '',   '', '', '',
2602         'paybatchnum',  'int',     '',   '', '', '',
2603         'amount',  @money_type, '', '',
2604         '_date',   @date_type, '', '',
2605       ],
2606       'primary_key'  => 'billpaynum',
2607       'unique'       => [],
2608       'index'        => [ [ 'paybatchnum' ], [ 'invnum' ] ],
2609       'foreign_keys' => [
2610                           { columns    => [ 'invnum' ],
2611                             table      => 'cust_bill',
2612                           },
2613                           { columns    => [ 'paybatchnum' ],
2614                             table      => 'cust_pay_batch',
2615                           },
2616                         ],
2617     },
2618
2619     'cust_bill_pay_pkg' => {
2620       'columns' => [
2621         'billpaypkgnum', 'serial', '', '', '', '',
2622         'billpaynum',       'int', '', '', '', '',
2623         'billpkgnum',       'int', '', '', '', '',
2624         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
2625         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
2626         'amount',         @money_type,     '', '',
2627         'setuprecur',      'varchar', '', $char_d, '', '',
2628         'sdate',   @date_type, '', '',
2629         'edate',   @date_type, '', '',
2630       ],
2631       'primary_key'  => 'billpaypkgnum',
2632       'unique'       => [],
2633       'index'        => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
2634       'foreign_keys' => [
2635                           { columns    => [ 'billpaynum' ],
2636                             table      => 'cust_bill_pay',
2637                           },
2638                           { columns    => [ 'billpkgnum' ],
2639                             table      => 'cust_bill_pkg',
2640                           },
2641                           { columns    => [ 'billpkgtaxlocationnum' ],
2642                             table      => 'cust_bill_pkg_tax_location',
2643                           },
2644                           { columns    => [ 'billpkgtaxratelocationnum' ],
2645                             table      => 'cust_bill_pkg_tax_rate_location',
2646                           },
2647                         ],
2648     },
2649
2650     'pay_batch' => { #batches of payments to an external processor
2651       'columns' => [
2652         'batchnum', 'serial',     '', '', '', '',
2653         'agentnum',    'int', 'NULL', '', '', '',
2654         'payby',      'char',     '',  4, '', '', # CARD/CHEK
2655         'status',     'char', 'NULL',  1, '', '',
2656         'download',       @date_type,     '', '',
2657         'upload',         @date_type,     '', '',
2658         'title',   'varchar', 'NULL',255, '', '',
2659         'processor_id',   'varchar', 'NULL',255, '', '',
2660       ],
2661       'primary_key'  => 'batchnum',
2662       'unique'       => [],
2663       'index'        => [],
2664       'foreign_keys' => [
2665                           { columns    => [ 'agentnum' ],
2666                             table      => 'agent',
2667                           },
2668                         ],
2669     },
2670
2671     'cust_pay_batch' => { #list of customers in current CARD/CHEK batch
2672       'columns' => [
2673         'paybatchnum',    'serial',     '',      '', '', '',
2674         'batchnum',          'int',     '',      '', '', '',
2675         'invnum',            'int',     '',      '', '', '',
2676         'custnum',           'int',     '',      '', '', '',
2677         'last',          'varchar',     '', $char_d, '', '',
2678         'first',         'varchar',     '', $char_d, '', '',
2679         'address1',      'varchar',     '', $char_d, '', '',
2680         'address2',      'varchar', 'NULL', $char_d, '', '',
2681         'city',          'varchar', 'NULL', $char_d, '', '',
2682         'state',         'varchar', 'NULL', $char_d, '', '',
2683         'zip',           'varchar', 'NULL',      10, '', '',
2684         'country',          'char',     '',       2, '', '',
2685         'payby',            'char',     '',       4, '', '',
2686         'payinfo',       'varchar', 'NULL',     512, '', '',
2687         #'exp',          @date_type,                  '', '',
2688         'exp',           'varchar', 'NULL',      11, '', '',
2689         'payname',       'varchar', 'NULL', $char_d, '', '',
2690         'paytype',       'varchar', 'NULL', $char_d, '', '',
2691         'amount',      @money_type,                  '', '',
2692         'currency',         'char', 'NULL',       3, '', '',
2693         'status',        'varchar', 'NULL', $char_d, '', '',
2694         'failure_status','varchar', 'NULL',      16, '', '',
2695         'error_message', 'varchar', 'NULL', $char_d, '', '',
2696       ],
2697       'primary_key'  => 'paybatchnum',
2698       'unique'       => [],
2699       'index'        => [ ['batchnum'], ['invnum'], ['custnum'] ],
2700       'foreign_keys' => [
2701                           { columns    => [ 'batchnum' ],
2702                             table      => 'pay_batch',
2703                           },
2704                           #{ columns    => [ 'invnum' ],
2705                           #  table      => 'cust_bill',
2706                           #},
2707                           { columns    => [ 'custnum' ],
2708                             table      => 'cust_main',
2709                           },
2710                         ],
2711     },
2712
2713     'fcc477map' => {
2714       'columns' => [
2715         'formkey',   'varchar',     '', 255, '', '',
2716         'formvalue',    'text', 'NULL',  '', '', '',
2717       ],
2718       'primary_key' => 'formkey',
2719       'unique'      => [],
2720       'index'       => [],
2721     },
2722
2723     'cust_pkg' => {
2724       'columns' => [
2725         'pkgnum',           'serial',     '', '', '', '',
2726         'custnum',             'int',     '', '', '', '',
2727         'pkgpart',             'int',     '', '', '', '',
2728         'pkgbatch',        'varchar', 'NULL', $char_d, '', '',
2729         'contactnum',          'int', 'NULL', '', '', '',
2730         'locationnum',         'int', 'NULL', '', '', '',
2731         'otaker',          'varchar', 'NULL', 32, '', '',
2732         'usernum',             'int', 'NULL', '', '', '',
2733         'salesnum',            'int', 'NULL', '', '', '',
2734         'order_date',     @date_type,             '', '',
2735         'start_date',     @date_type,             '', '',
2736         'setup',          @date_type,             '', '',
2737         'bill',           @date_type,             '', '',
2738         'last_bill',      @date_type,             '', '',
2739         'susp',           @date_type,             '', '',
2740         'adjourn',        @date_type,             '', '',
2741         'resume',         @date_type,             '', '',
2742         'cancel',         @date_type,             '', '',
2743         'uncancel',       @date_type,             '', '',
2744         'uncancel_pkgnum',     'int', 'NULL', '', '', '',
2745         'expire',         @date_type,             '', '',
2746         'contract_end',   @date_type,             '', '',
2747         'dundate',        @date_type,             '', '',
2748         'change_date',    @date_type,             '', '',
2749         'change_pkgnum',       'int', 'NULL', '', '', '',
2750         'change_pkgpart',      'int', 'NULL', '', '', '',
2751         'change_locationnum',  'int', 'NULL', '', '', '',
2752         'change_custnum',      'int', 'NULL', '', '', '',
2753         'main_pkgnum',         'int', 'NULL', '', '', '',
2754         'pkglinknum',          'int', 'NULL', '', '', '',
2755         'no_auto',            'char', 'NULL',  1, '', '',
2756         'quantity',            'int', 'NULL', '', '', '',
2757         'agent_pkgid',     'varchar', 'NULL', $char_d, '', '',
2758         'waive_setup',        'char', 'NULL',  1, '', '',
2759         'recur_show_zero',    'char', 'NULL',  1, '', '',
2760         'setup_show_zero',    'char', 'NULL',  1, '', '',
2761         'change_to_pkgnum',    'int', 'NULL', '', '', '',
2762         'separate_bill',      'char', 'NULL',  1, '', '',
2763       ],
2764       'primary_key'  => 'pkgnum',
2765       'unique'       => [],
2766       'index'        => [ ['custnum'], ['pkgpart'], ['pkgbatch'],
2767                           ['locationnum'], ['usernum'], ['agent_pkgid'],
2768                           ['order_date'], [ 'start_date' ], ['setup'], ['bill'],
2769                           ['last_bill'], ['susp'], ['adjourn'], ['resume'],
2770                           ['cancel'], ['expire'], ['contract_end'],
2771                           ['change_date'],
2772                           ['no_auto'],
2773                           #['contactnum'],
2774                           ['salesnum'],
2775                           #['uncancel_pkgnum'],
2776                           #['change_pkgnum'], ['change_locationnum'],
2777                           #['change_custnum'],
2778                           ['main_pkgnum'],
2779                           #['pkglinknum'], ['change_to_pkgnum'],
2780                         ],
2781       'foreign_keys' => [
2782                           { columns    => [ 'custnum' ],
2783                             table      => 'cust_main',
2784                           },
2785                           { columns    => [ 'pkgpart' ],
2786                             table      => 'part_pkg',
2787                           },
2788                           { columns    => [ 'contactnum' ],
2789                             table      => 'contact',
2790                           },
2791                           { columns    => [ 'locationnum' ],
2792                             table      => 'cust_location',
2793                           },
2794                           { columns    => [ 'usernum' ],
2795                             table      => 'access_user',
2796                           },
2797                           { columns    => [ 'salesnum' ],
2798                             table      => 'sales',
2799                           },
2800                           { columns    => [ 'uncancel_pkgnum' ],
2801                             table      => 'cust_pkg',
2802                             references => [ 'pkgnum' ],
2803                           },
2804                           { columns    => [ 'change_pkgnum' ],
2805                             table      => 'cust_pkg',
2806                             references => [ 'pkgnum' ],
2807                           },
2808                           { columns    => [ 'change_pkgpart' ],
2809                             table      => 'part_pkg',
2810                             references => [ 'pkgpart' ],
2811                           },
2812                           { columns    => [ 'change_locationnum' ],
2813                             table      => 'cust_location',
2814                             references => [ 'locationnum' ],
2815                           },
2816                           { columns    => [ 'change_custnum' ],
2817                             table      => 'cust_main',
2818                             references => [ 'custnum' ],
2819                           },
2820                           { columns    => [ 'main_pkgnum' ],
2821                             table      => 'cust_pkg',
2822                             references => [ 'pkgnum' ],
2823                           },
2824                           { columns    => [ 'pkglinknum' ],
2825                             table      => 'part_pkg_link',
2826                           },
2827                           { columns    => [ 'change_to_pkgnum' ],
2828                             table      => 'cust_pkg',
2829                             references => [ 'pkgnum' ],
2830                           },
2831                         ],
2832    },
2833
2834     'cust_pkg_option' => {
2835       'columns' => [
2836         'optionnum', 'serial', '', '', '', '',
2837         'pkgnum', 'int', '', '', '', '',
2838         'optionname', 'varchar', '', $char_d, '', '',
2839         'optionvalue', 'text', 'NULL', '', '', '',
2840       ],
2841       'primary_key'  => 'optionnum',
2842       'unique'       => [],
2843       'index'        => [ [ 'pkgnum' ], [ 'optionname' ] ],
2844       'foreign_keys' => [
2845                           { columns    => [ 'pkgnum' ],
2846                             table      => 'cust_pkg',
2847                           },
2848                         ],
2849     },
2850
2851     'cust_pkg_detail' => {
2852       'columns' => [
2853         'pkgdetailnum', 'serial', '',        '', '', '',
2854         'pkgnum',          'int', '',        '', '', '',
2855         'detail',      'varchar', '', 2*$char_d, '', '',
2856         'detailtype',     'char', '',         1, '', '', #"I"nvoice or "C"omment
2857         'weight',          'int', '',        '', '', '',
2858       ],
2859       'primary_key'  => 'pkgdetailnum',
2860       'unique'       => [],
2861       'index'        => [ [ 'pkgnum', 'detailtype' ] ],
2862       'foreign_keys' => [
2863                           { columns    => [ 'pkgnum' ],
2864                             table      => 'cust_pkg',
2865                           },
2866                         ],
2867     },
2868
2869     'cust_pkg_reason' => {
2870       'columns' => [
2871         'num',      'serial',    '',   '', '', '',
2872         'pkgnum',   'int',    '',   '', '', '',
2873         'reasonnum','int',    '',   '', '', '',
2874         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
2875         'otaker',   'varchar', 'NULL', 32, '', '',
2876         'usernum',   'int', 'NULL', '', '', '',
2877         'date',     @date_type, '', '',
2878       ],
2879       'primary_key'  => 'num',
2880       'unique'       => [],
2881       'index'        => [ ['pkgnum'], ['reasonnum'], ['action'], ['usernum'], ],
2882       'foreign_keys' => [
2883                           { columns    => [ 'pkgnum' ],
2884                             table      => 'cust_pkg',
2885                           },
2886                           { columns    => [ 'reasonnum' ],
2887                             table      => 'reason',
2888                           },
2889                           { columns    => [ 'usernum' ],
2890                             table      => 'access_user',
2891                           },
2892                         ],
2893     },
2894
2895     'cust_pkg_reason_fee' => {
2896       'columns' => [
2897         'pkgreasonfeenum', 'serial', '', '', '', '',
2898         'pkgreasonnum',       'int', '', '', '', '',
2899         'billpkgnum',         'int', 'NULL', '', '', '',
2900         'feepart',            'int', '', '', '', '',
2901         'nextbill',          'char', 'NULL',  1, '', '',
2902       ],
2903       'primary_key'  => 'pkgreasonfeenum',
2904       'unique' => [ [ 'billpkgnum' ], [ 'pkgreasonnum' ] ], # one-to-one link
2905       'index'  => [ [ 'feepart' ] ],
2906       'foreign_keys' => [
2907                           { columns     => [ 'pkgreasonnum' ],
2908                             table       => 'cust_pkg_reason',
2909                             references  => [ 'num' ],
2910                           },
2911                           { columns     => [ 'feepart' ],
2912                             table       => 'part_fee',
2913                           },
2914                           # can't link billpkgnum, because of voids
2915       ],
2916     },
2917
2918     'cust_pkg_discount' => {
2919       'columns' => [
2920         'pkgdiscountnum', 'serial', '',        '', '', '',
2921         'pkgnum',            'int', '',        '', '', '',
2922         'discountnum',       'int', '',        '', '', '',
2923         'months_used',   'decimal', 'NULL', '7,4', '', '',
2924         'end_date',     @date_type,                '', '',
2925         'otaker',        'varchar', 'NULL',    32, '', '',
2926         'usernum',           'int', 'NULL',    '', '', '',
2927         'disabled',         'char', 'NULL',     1, '', '',
2928         'setuprecur',       'char', 'NULL',     5, '', '',
2929       ],
2930       'primary_key'  => 'pkgdiscountnum',
2931       'unique'       => [],
2932       'index'        => [ [ 'pkgnum' ], [ 'discountnum' ], [ 'usernum' ], ],
2933       'foreign_keys' => [
2934                           { columns    => [ 'pkgnum' ],
2935                             table      => 'cust_pkg',
2936                           },
2937                           { columns    => [ 'discountnum' ],
2938                             table      => 'discount',
2939                           },
2940                           { columns    => [ 'usernum' ],
2941                             table      => 'access_user',
2942                           },
2943                         ],
2944     },
2945
2946     'cust_pkg_usage' => {
2947       'columns' => [
2948         'pkgusagenum', 'serial', '', '', '', '',
2949         'pkgnum',         'int', '', '', '', '',
2950         'minutes',        'double precision', '', '', '', '',
2951         'pkgusagepart',   'int', '', '', '', '',
2952       ],
2953       'primary_key'  => 'pkgusagenum',
2954       'unique'       => [],
2955       'index'        => [ [ 'pkgnum' ], [ 'pkgusagepart' ] ],
2956       'foreign_keys' => [
2957                           { columns    => [ 'pkgnum' ],
2958                             table      => 'cust_pkg',
2959                           },
2960                           { columns    => [ 'pkgusagepart' ],
2961                             table      => 'part_pkg_usage',
2962                           },
2963                         ],
2964     },
2965
2966     'cdr_cust_pkg_usage' => {
2967       'columns' => [
2968         'cdrusagenum', 'bigserial', '', '', '', '',
2969         'acctid',      'bigint',    '', '', '', '',
2970         'pkgusagenum', 'int',       '', '', '', '',
2971         'minutes',     'double precision',       '', '', '', '',
2972       ],
2973       'primary_key'  => 'cdrusagenum',
2974       'unique'       => [],
2975       'index'        => [ [ 'pkgusagenum' ], [ 'acctid' ] ],
2976       'foreign_keys' => [
2977                           { columns    => [ 'acctid' ],
2978                             table      => 'cdr',
2979                           },
2980                           { columns    => [ 'pkgusagenum' ],
2981                             table      => 'cust_pkg_usage',
2982                           },
2983                         ],
2984     },
2985
2986     'cust_bill_pkg_discount' => {
2987       'columns' => [
2988         'billpkgdiscountnum', 'serial',        '', '', '', '',
2989         'billpkgnum',            'int',        '', '', '', '',
2990         'pkgdiscountnum',        'int',        '', '', '', '',
2991         'amount',          @money_type,                '', '',
2992         'months',            'decimal', 'NULL', '7,4', '', '',
2993       ],
2994       'primary_key'  => 'billpkgdiscountnum',
2995       'unique'       => [],
2996       'index'        => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
2997       'foreign_keys' => [
2998                           { columns    => [ 'billpkgnum' ],
2999                             table      => 'cust_bill_pkg',
3000                           },
3001                           { columns    => [ 'pkgdiscountnum' ],
3002                             table      => 'cust_pkg_discount',
3003                           },
3004                         ],
3005     },
3006
3007     'cust_bill_pkg_discount_void' => {
3008       'columns' => [
3009         'billpkgdiscountnum',    'int',        '', '', '', '',
3010         'billpkgnum',            'int',        '', '', '', '',
3011         'pkgdiscountnum',        'int',        '', '', '', '',
3012         'amount',          @money_type,                '', '',
3013         'months',            'decimal', 'NULL', '7,4', '', '',
3014       ],
3015       'primary_key'  => 'billpkgdiscountnum',
3016       'unique'       => [],
3017       'index'        => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
3018       'foreign_keys' => [
3019                           { columns    => [ 'billpkgnum' ],
3020                             table      => 'cust_bill_pkg_void',
3021                           },
3022                           { columns    => [ 'pkgdiscountnum' ],
3023                             table      => 'cust_pkg_discount',
3024                           },
3025                         ],
3026     },
3027
3028     'discount' => {
3029       'columns' => [
3030         'discountnum', 'serial',     '',      '', '', '',
3031         #'agentnum',       'int', 'NULL',      '', '', '',
3032         'classnum',       'int', 'NULL',      '', '', '',
3033         'name',       'varchar', 'NULL', $char_d, '', '',
3034         'amount',   @money_type,                  '', '',
3035         'percent',    'decimal',     '',   '7,4', '', '',
3036         'months',     'decimal', 'NULL',   '7,4', '', '',
3037         'disabled',      'char', 'NULL',       1, '', '',
3038         'setup',         'char', 'NULL',       1, '', '',
3039         #'linked',        'char', 'NULL',       1, '', '',
3040       ],
3041       'primary_key'  => 'discountnum',
3042       'unique'       => [],
3043       'index'        => [], # [ 'agentnum' ], ],
3044       'foreign_keys' => [
3045                           { columns    => [ 'classnum' ],
3046                             table      => 'discount_class',
3047                           },
3048                         ],
3049     },
3050
3051     'discount_class' => {
3052       'columns' => [
3053         'classnum',    'serial',   '',      '', '', '',
3054         'classname',   'varchar',  '', $char_d, '', '',
3055         #'categorynum', 'int',  'NULL',      '', '', '',
3056         'disabled',    'char', 'NULL',       1, '', '',
3057       ],
3058       'primary_key' => 'classnum',
3059       'unique' => [],
3060       'index' => [ ['disabled'] ],
3061     },
3062
3063     'cust_refund' => {
3064       'columns' => [
3065         'refundnum',    'serial',    '',   '', '', '',
3066         'custnum',  'int',    '',   '', '', '',
3067         '_date',        @date_type, '', '',
3068         'refund',       @money_type, '', '',
3069         'currency',       'char', 'NULL',       3, '', '',
3070         'otaker',       'varchar',   'NULL',   32, '', '',
3071         'usernum',   'int', 'NULL', '', '', '',
3072         'reason',       'varchar',   'NULL',   $char_d, '', '',
3073         'reasonnum',   'int', 'NULL', '', '', '',
3074         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
3075                                                      # be index into payby
3076                                                      # table eventually
3077         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
3078         'paycardtype',  'varchar', 'NULL',   $char_d, '', '',
3079         'paymask', 'varchar', 'NULL', $char_d, '', '',
3080         'paybatch',     'varchar',   'NULL', $char_d, '', '',
3081         'closed',    'char', 'NULL', 1, '', '',
3082         'source_paynum', 'int', 'NULL', '', '', '', # link to cust_payby, to prevent unapply of gateway-generated refunds
3083         # credit card/EFT fields (formerly in paybatch)
3084         'gatewaynum',     'int', 'NULL', '', '', '', # payment_gateway FK
3085         'processor',  'varchar', 'NULL', $char_d, '', '', # module name
3086         'auth',       'varchar','NULL',16, '', '', # CC auth number
3087         'order_number', 'varchar','NULL',$char_d, '', '', # transaction number
3088       ],
3089       'primary_key'  => 'refundnum',
3090       'unique'       => [],
3091       'index'        => [ ['custnum'], ['_date'], [ 'usernum' ], ],
3092       'foreign_keys' => [
3093                           { columns    => [ 'custnum' ],
3094                             table      => 'cust_main',
3095                           },
3096                           { columns    => [ 'usernum' ],
3097                             table      => 'access_user',
3098                           },
3099                           { columns    => [ 'reasonnum' ],
3100                             table      => 'reason',
3101                           },
3102                           { columns    => [ 'gatewaynum' ],
3103                             table      => 'payment_gateway',
3104                           },
3105                           { columns    => [ 'source_paynum' ],
3106                             table      => 'cust_pay',
3107                             references => [ 'paynum' ],
3108                           },
3109                         ],
3110     },
3111
3112     'cust_credit_refund' => {
3113       'columns' => [
3114         'creditrefundnum', 'serial',     '',   '', '', '',
3115         'crednum',  'int',     '',   '', '', '',
3116         'refundnum',  'int',     '',   '', '', '',
3117         'amount',  @money_type, '', '',
3118         '_date',   @date_type, '', '',
3119       ],
3120       'primary_key'  => 'creditrefundnum',
3121       'unique'       => [],
3122       'index'        => [ ['crednum'], ['refundnum'] ],
3123       'foreign_keys' => [
3124                           { columns    => [ 'crednum' ],
3125                             table      => 'cust_credit',
3126                           },
3127                           { columns    => [ 'refundnum' ],
3128                             table      => 'cust_refund',
3129                           },
3130                         ],
3131     },
3132
3133
3134     'cust_svc' => {
3135       'columns' => [
3136         'svcnum',      'serial',     '', '', '', '',
3137         'pkgnum',         'int', 'NULL', '', '', '',
3138         'svcpart',        'int',     '', '', '', '',
3139         'agent_svcid',    'int', 'NULL', '', '', '',
3140         'overlimit',           @date_type,   '', '',
3141       ],
3142       'primary_key'  => 'svcnum',
3143       'unique'       => [],
3144       'index'        => [ ['svcnum'], ['pkgnum'], ['svcpart'],
3145                           ['agent_svcid'],
3146                         ],
3147       'foreign_keys' => [
3148                           { columns    => [ 'pkgnum' ],
3149                             table      => 'cust_pkg',
3150                           },
3151                           { columns    => [ 'svcpart' ],
3152                             table      => 'part_svc',
3153                           },
3154                         ],
3155     },
3156
3157     'cust_svc_option' => {
3158       'columns' => [
3159         'optionnum',   'serial', '', '', '', '',
3160         'svcnum',      'int', '', '', '', '',
3161         'optionname',  'varchar', '', $char_d, '', '',
3162         'optionvalue', 'text', 'NULL', '', '', '',
3163       ],
3164       'primary_key'  => 'optionnum',
3165       'unique'       => [],
3166       'index'        => [ [ 'svcnum' ], [ 'optionname' ] ],
3167       'foreign_keys' => [
3168                           { columns    => [ 'svcnum' ],
3169                             table      => 'cust_svc',
3170                           },
3171                         ],
3172     },
3173
3174     'svc_export_machine' => {
3175       'columns' => [
3176         'svcexportmachinenum', 'serial', '', '', '', '',
3177         'svcnum',                 'int', '', '', '', '',
3178         'exportnum',              'int', '', '', '', '',
3179         'machinenum',             'int', '', '', '', '',
3180       ],
3181       'primary_key'  => 'svcexportmachinenum',
3182       'unique'       => [ ['svcnum', 'exportnum'] ],
3183       'index'        => [],
3184       'foreign_keys' => [
3185                           { columns    => [ 'svcnum' ],
3186                             table      => 'cust_svc',
3187                           },
3188                           { columns    => [ 'exportnum' ],
3189                             table      => 'part_export',
3190                           },
3191                           { columns    => [ 'machinenum' ],
3192                             table      => 'part_export_machine',
3193                           },
3194                         ],
3195     },
3196
3197     'part_export_machine' => {
3198       'columns' => [
3199         'machinenum', 'serial', '', '', '', '',
3200         'exportnum',     'int', '', '', '', '',
3201         'machine',    'varchar', 'NULL', $char_d, '', '',
3202         'disabled',      'char', 'NULL',       1, '', '',
3203       ],
3204       'primary_key'  => 'machinenum',
3205       'unique'       => [ [ 'exportnum', 'machine' ] ],
3206       'index'        => [ [ 'exportnum' ] ],
3207       'foreign_keys' => [
3208                           { columns    => [ 'exportnum' ],
3209                             table      => 'part_export',
3210                           },
3211                         ],
3212     },
3213
3214     'part_pkg' => {
3215       'columns' => [
3216         'pkgpart',       'serial',    '',   '', '', '',
3217         'pkgpartbatch',  'varchar', 'NULL', $char_d, '', '',
3218         'pkg',           'varchar',   '',   $char_d, '', '',
3219         'comment',       'varchar', 'NULL', 2*$char_d, '', '',
3220         'promo_code',    'varchar', 'NULL', $char_d, '', '',
3221         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
3222         'setuptax',      'char', 'NULL', 1, '', '',
3223         'recurtax',      'char', 'NULL', 1, '', '',
3224         'plan',          'varchar', 'NULL', $char_d, '', '',
3225         'disabled',      'char', 'NULL', 1, '', '',
3226         'custom',        'char', 'NULL', 1, '', '',
3227         'taxclass',      'varchar', 'NULL', $char_d, '', '',
3228         'classnum',      'int',     'NULL', '', '', '',
3229         'addon_classnum','int',     'NULL', '', '', '',
3230         'taxproductnum', 'int',     'NULL', '', '', '',
3231         'setup_cost',    @money_typen,          '', '',
3232         'recur_cost',    @money_typen,          '', '',
3233         'pay_weight',    'real',    'NULL', '', '', '',
3234         'credit_weight', 'real',    'NULL', '', '', '',
3235         'agentnum',      'int',     'NULL', '', '', '',
3236         'fcc_ds0s',      'int',     'NULL', '', '', '',
3237         'fcc_voip_class','char',    'NULL',  1, '', '',
3238         'no_auto',          'char', 'NULL',  1, '', '',
3239         'recur_show_zero',  'char', 'NULL',  1, '', '',
3240         'setup_show_zero',  'char', 'NULL',  1, '', '',
3241         'successor',     'int',     'NULL', '', '', '',
3242         'family_pkgpart','int',     'NULL', '', '', '',
3243         'delay_start',   'int',     'NULL', '', '', '',
3244         'start_on_hold', 'char',    'NULL',  1, '', '',
3245         'agent_pkgpartid', 'varchar', 'NULL', 20, '', '',
3246         'expire_months', 'int',     'NULL', '', '', '',
3247         'adjourn_months', 'int',    'NULL', '', '', '',
3248         'contract_end_months','int','NULL', '', '', '',
3249         'change_to_pkgpart', 'int', 'NULL', '', '', '',
3250       ],
3251       'primary_key'  => 'pkgpart',
3252       'unique'       => [],
3253       'index'        => [ [ 'promo_code' ], [ 'disabled' ], [ 'classnum' ],
3254                           [ 'agentnum' ], ['no_auto'], ['agent_pkgpartid'],
3255                         ],
3256       'foreign_keys' => [
3257                           { columns    => [ 'classnum' ],
3258                             table      => 'pkg_class',
3259                           },
3260                           { columns    => [ 'addon_classnum' ],
3261                             table      => 'pkg_class',
3262                             references => [ 'classnum' ],
3263                           },
3264                           { columns    => [ 'taxproductnum' ],
3265                             table      => 'part_pkg_taxproduct',
3266                           },
3267                           { columns    => [ 'agentnum' ],
3268                             table      => 'agent',
3269                           },
3270                           { columns    => [ 'successor' ],
3271                             table      => 'part_pkg',
3272                             references => [ 'pkgpart' ],
3273                           },
3274                           { columns    => [ 'family_pkgpart' ],
3275                             table      => 'part_pkg',
3276                             references => [ 'pkgpart' ],
3277                           },
3278                           { columns    => [ 'change_to_pkgpart' ],
3279                             table      => 'part_pkg',
3280                             references => [ 'pkgpart' ],
3281                           },
3282                         ],
3283     },
3284
3285     'part_pkg_msgcat' => {
3286       'columns' => [
3287         'pkgpartmsgnum',  'serial',     '',        '', '', '',
3288         'pkgpart',           'int',     '',        '', '', '',
3289         'locale',        'varchar',     '',        16, '', '',
3290         'pkg',           'varchar',     '',   $char_d, '', '', #longer/no limit?
3291         'comment',       'varchar', 'NULL', 2*$char_d, '', '', #longer/no limit?
3292       ],
3293       'primary_key'  => 'pkgpartmsgnum',
3294       'unique'       => [ [ 'pkgpart', 'locale' ] ],
3295       'index'        => [],
3296       'foreign_keys' => [
3297                           { columns    => [ 'pkgpart' ],
3298                             table      => 'part_pkg',
3299                           },
3300                         ],
3301     },
3302
3303     'part_pkg_currency' => {
3304       'columns' => [
3305         'pkgcurrencynum', 'serial', '',      '', '', '',
3306         'pkgpart',           'int', '',      '', '', '',
3307         'currency',         'char', '',       3, '', '',
3308         'optionname',    'varchar', '', $char_d, '', '',
3309         'optionvalue',      'text', '',      '', '', '',
3310       ],
3311       'primary_key'  => 'pkgcurrencynum',
3312       'unique'       => [ [ 'pkgpart', 'currency', 'optionname' ] ],
3313       'index'        => [ ['pkgpart'] ],
3314       'foreign_keys' => [
3315                           { columns    => [ 'pkgpart' ],
3316                             table      => 'part_pkg',
3317                           },
3318                         ],
3319     },
3320
3321     'currency_exchange' => {
3322       'columns' => [
3323         'currencyratenum', 'serial', '',    '', '', '',
3324         'from_currency',     'char', '',     3, '', '',
3325         'to_currency',       'char', '',     3, '', '',
3326         'rate',           'decimal', '', '7,6', '', '',
3327       ],
3328       'primary_key' => 'currencyratenum',
3329       'unique'      => [ [ 'from_currency', 'to_currency' ] ],
3330       'index'       => [],
3331     },
3332
3333     'part_pkg_usageprice' => {
3334       'columns' => [
3335         'usagepricepart', 'serial',      '',      '', '', '',
3336         'pkgpart',           'int',      '',      '', '', '',
3337         'price',          @money_type,                '', '',
3338         'currency',         'char',  'NULL',       3, '', '',
3339         'action',        'varchar',      '', $char_d, '', '',
3340         'target',        'varchar',      '', $char_d, '', '',
3341         'amount',        'varchar',      '', $char_d, '', '',
3342       ],
3343       'primary_key'  => 'usagepricepart',
3344       'unique'       => [ [ 'pkgpart', 'currency', 'target' ] ],
3345       'index'        => [ [ 'pkgpart' ] ],
3346       'foreign_keys' => [
3347                           { columns    => [ 'pkgpart' ],
3348                             table      => 'part_pkg',
3349                           },
3350                         ],
3351     },
3352
3353     'cust_pkg_usageprice' => {
3354       'columns' => [
3355         'usagepricenum', 'serial',      '',      '', '', '',
3356         'pkgnum',           'int',      '',      '', '', '',
3357         'usagepricepart',   'int',      '',      '', '', '',
3358         'quantity',         'int',      '',      '', '', '',
3359       ],
3360       'primary_key'  => 'usagepricenum',
3361       'unique'       => [ [ 'pkgnum', 'usagepricepart' ] ],
3362       'index'        => [ [ 'pkgnum' ] ],
3363       'foreign_keys' => [
3364                           { columns    => [ 'pkgnum' ],
3365                             table      => 'cust_pkg',
3366                           },
3367                           { columns    => [ 'usagepricepart' ],
3368                             table      => 'part_pkg_usageprice',
3369                           },
3370                         ],
3371     },
3372
3373     'part_fee' => {
3374       'columns' => [
3375         'feepart',       'serial',    '',   '', '', '',
3376         'itemdesc',      'varchar',   '',   $char_d,   '', '',
3377         'comment',       'varchar', 'NULL', 2*$char_d, '', '',
3378         'disabled',      'char',    'NULL',  1, '', '',
3379         'classnum',      'int',     'NULL', '', '', '',
3380         'taxclass',      'varchar', 'NULL', $char_d, '', '',
3381         'taxproductnum', 'int',     'NULL', '', '', '',
3382         'pay_weight',    'real',    'NULL', '', '', '',
3383         'credit_weight', 'real',    'NULL', '', '', '',
3384         'agentnum',      'int',     'NULL', '', '', '',
3385         'amount',   @money_type,                '', '',
3386         'percent',     'decimal',    '', '7,4', '', '',
3387         'basis',         'varchar',  '',    16, '', '',
3388         'minimum',    @money_typen,             '', '',
3389         'maximum',    @money_typen,             '', '',
3390         'limit_credit',  'char',    'NULL',  1, '', '',
3391         'setuprecur',    'char',     '',     5, '', '',
3392         'taxable',       'char',    'NULL',  1, '', '',
3393       ],
3394       'primary_key'  => 'feepart',
3395       'unique'       => [],
3396       'index'        => [ [ 'disabled' ], [ 'classnum' ], [ 'agentnum' ]
3397                         ],
3398       'foreign_keys' => [
3399                           { columns    => [ 'classnum' ],
3400                             table      => 'pkg_class',
3401                           },
3402                           { columns    => [ 'taxproductnum' ],
3403                             table      => 'part_pkg_taxproduct',
3404                           },
3405                           { columns    => [ 'agentnum' ],
3406                             table      => 'agent',
3407                           },
3408                         ],
3409     },
3410
3411     'part_fee_msgcat' => {
3412       'columns' => [
3413         'feepartmsgnum',  'serial',     '',        '', '', '',
3414         'feepart',           'int',     '',        '', '', '',
3415         'locale',        'varchar',     '',        16, '', '',
3416         'itemdesc',      'varchar',     '',   $char_d, '', '', #longer/no limit?
3417         'comment',       'varchar', 'NULL', 2*$char_d, '', '', #longer/no limit?
3418       ],
3419       'primary_key'  => 'feepartmsgnum',
3420       'unique'       => [ [ 'feepart', 'locale' ] ],
3421       'index'        => [],
3422       'foreign_keys' => [
3423                           { columns    => [ 'feepart' ],
3424                             table      => 'part_fee',
3425                           },
3426                         ],
3427     },
3428
3429     'part_fee_usage' => {
3430       'columns' => [
3431         'feepartusagenum','serial',     '',        '', '', '',
3432         'feepart',           'int',     '',        '', '', '',
3433         'classnum',          'int',     '',        '', '', '',
3434         'amount',   @money_type,                '', '',
3435         'percent',     'decimal',    '', '7,4', '', '',
3436       ],
3437       'primary_key'  => 'feepartusagenum',
3438       'unique'       => [ [ 'feepart', 'classnum' ] ],
3439       'index'        => [],
3440       'foreign_keys' => [
3441                           { columns    => [ 'feepart' ],
3442                             table      => 'part_fee',
3443                           },
3444                           { columns    => [ 'classnum' ],
3445                             table      => 'usage_class',
3446                           },
3447                         ],
3448     },
3449
3450     'part_pkg_link' => {
3451       'columns' => [
3452         'pkglinknum',  'serial',   '',      '', '', '',
3453         'src_pkgpart', 'int',      '',      '', '', '',
3454         'dst_pkgpart', 'int',      '',      '', '', '',
3455         'link_type',   'varchar',  '', $char_d, '', '',
3456         'hidden',      'char', 'NULL',       1, '', '',
3457       ],
3458       'primary_key'  => 'pkglinknum',
3459       'unique'       => [ ['src_pkgpart','dst_pkgpart','link_type','hidden'] ],
3460       'index'        => [ [ 'src_pkgpart' ] ],
3461       'foreign_keys' => [
3462                           { columns    => [ 'src_pkgpart' ],
3463                             table      => 'part_pkg',
3464                             references => [ 'pkgpart' ]
3465                           },
3466                           { columns    => [ 'dst_pkgpart' ],
3467                             table      => 'part_pkg',
3468                             references => [ 'pkgpart' ]
3469                           },
3470                         ],
3471     },
3472     # XXX somewhat borked unique: we don't really want a hidden and unhidden
3473     # it turns out we'd prefer to use svc, bill, and invisibill (or something)
3474
3475     'part_pkg_discount' => {
3476       'columns' => [
3477         'pkgdiscountnum', 'serial',   '',      '', '', '',
3478         'pkgpart',        'int',      '',      '', '', '',
3479         'discountnum',    'int',      '',      '', '', '',
3480       ],
3481       'primary_key'  => 'pkgdiscountnum',
3482       'unique'       => [ [ 'pkgpart', 'discountnum' ] ],
3483       'index'        => [],
3484       'foreign_keys' => [
3485                           { columns    => [ 'pkgpart' ],
3486                             table      => 'part_pkg',
3487                           },
3488                           { columns    => [ 'discountnum' ],
3489                             table      => 'discount',
3490                           },
3491                         ],
3492     },
3493
3494     'part_pkg_taxclass' => {
3495       'columns' => [
3496         'taxclassnum',  'serial', '',       '', '', '',
3497         'taxclass',     'varchar', '', $char_d, '', '',
3498         'disabled', 'char',   'NULL',         1, '', '',
3499       ],
3500       'primary_key' => 'taxclassnum',
3501       'unique'      => [ [ 'taxclass' ] ],
3502       'index'       => [ [ 'disabled' ] ],
3503     },
3504
3505     'part_pkg_taxproduct' => {
3506       'columns' => [
3507         'taxproductnum', 'serial',      '',        '', '', '',
3508         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
3509         'taxproduct',    'varchar',     '',   $char_d, '', '',
3510         'description',   'varchar',     '', 3*$char_d, '', '',
3511         'note',             'text', 'NULL',        '', '', '',
3512       ],
3513       'primary_key' => 'taxproductnum',
3514       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
3515       'index'       => [],
3516     },
3517
3518     'part_pkg_taxrate' => {
3519       'columns' => [
3520         'pkgtaxratenum', 'serial',  '',     '',      '', '',
3521         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
3522         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
3523         'taxproductnum', 'int',  '',     '',       '', '',
3524         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
3525         'county',           'varchar', 'NULL', $char_d, '', '',
3526         'state',            'varchar', 'NULL', $char_d, '', '',
3527         'local',            'varchar', 'NULL', $char_d, '', '',
3528         'country',          'char',    'NULL', 2,       '', '',
3529         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
3530         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
3531         'taxclassnum',      'int',     'NULL', '',      '', '',
3532         'effdate',          @date_type, '', '',
3533         'taxable',          'char',    'NULL', 1,       '', '',
3534       ],
3535       'primary_key'  => 'pkgtaxratenum',
3536       'unique'       => [],
3537       'index'        => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
3538       'foreign_keys' => [
3539                           { columns    => [ 'taxproductnum' ],
3540                             table      => 'part_pkg_taxproduct',
3541                           },
3542                           { columns    => [ 'taxclassnumtaxed' ],
3543                             table      => 'tax_class',
3544                             references => [ 'taxclassnum' ],
3545                           },
3546                           { columns    => [ 'taxclassnum' ],
3547                             table      => 'tax_class',
3548                           },
3549                         ],
3550     },
3551
3552     'part_pkg_taxoverride' => {
3553       'columns' => [
3554         'taxoverridenum', 'serial', '', '', '', '',
3555         'pkgpart',           'int', '', '', '', '',
3556         'taxclassnum',       'int', '', '', '', '',
3557         'usage_class',    'varchar', 'NULL', $char_d, '', '',
3558       ],
3559       'primary_key'  => 'taxoverridenum',
3560       'unique'       => [],
3561       'index'        => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
3562       'foreign_keys' => [
3563                           { columns    => [ 'pkgpart' ],
3564                             table      => 'part_pkg',
3565                           },
3566                           { columns    => [ 'taxclassnum' ],
3567                             table      => 'tax_class',
3568                           },
3569                         ],
3570     },
3571
3572 #    'part_title' => {
3573 #      'columns' => [
3574 #        'titlenum',   'int',    '',   '',
3575 #        'title',      'varchar',   '',   $char_d,
3576 #      ],
3577 #      'primary_key' => 'titlenum',
3578 #      'unique' => [ [] ],
3579 #      'index' => [ [] ],
3580 #    },
3581
3582     'pkg_svc' => {
3583       'columns' => [
3584         'pkgsvcnum',   'serial',    '', '', '', '',
3585         'pkgpart',        'int',    '', '', '', '',
3586         'svcpart',        'int',    '', '', '', '',
3587         'quantity',       'int',    '', '', '', '',
3588         'primary_svc',   'char', 'NULL', 1, '', '',
3589         'hidden',        'char', 'NULL', 1, '', '',
3590         'bulk_skip',     'char', 'NULL', 1, '', '',
3591         'provision_hold', 'char', 'NULL', 1, '', '',
3592       ],
3593       'primary_key'  => 'pkgsvcnum',
3594       'unique'       => [ ['pkgpart', 'svcpart'] ],
3595       'index'        => [ ['pkgpart'], ['quantity'] ],
3596       'foreign_keys' => [
3597                           { columns    => [ 'pkgpart' ],
3598                             table      => 'part_pkg',
3599                           },
3600                           { columns    => [ 'svcpart' ],
3601                             table      => 'part_svc',
3602                           },
3603                         ],
3604     },
3605
3606     'part_referral' => {
3607       'columns' => [
3608         'refnum',   'serial',     '',        '', '', '',
3609         'referral', 'varchar',    '',   $char_d, '', '',
3610         'disabled', 'char',   'NULL',         1, '', '',
3611         'agentnum', 'int',    'NULL',        '', '', '',
3612         'title',   'varchar', 'NULL',   $char_d, '', '',
3613       ],
3614       'primary_key'  => 'refnum',
3615       'unique'       => [ ['agentnum', 'title'] ],
3616       'index'        => [ ['disabled'], ['agentnum'], ],
3617       'foreign_keys' => [
3618                           { columns    => [ 'agentnum' ],
3619                             table      => 'agent',
3620                           },
3621                         ],
3622     },
3623
3624     'part_svc' => {
3625       'columns' => [
3626         'svcpart',             'serial',     '',        '', '', '',
3627         'svc',                'varchar',     '',   $char_d, '', '',
3628         'svcdb',              'varchar',     '',   $char_d, '', '',
3629         'disabled',              'char', 'NULL',         1, '', '',
3630         'preserve',              'char', 'NULL',         1, '', '',
3631         'selfservice_access', 'varchar', 'NULL',   $char_d, '', '',
3632         'classnum',               'int', 'NULL',        '', '', '',
3633         'restrict_edit_password','char', 'NULL',         1, '', '',
3634         'has_router',            'char', 'NULL',         1, '', '',
3635 ],
3636       'primary_key'  => 'svcpart',
3637       'unique'       => [],
3638       'index'        => [ [ 'disabled' ] ],
3639       'foreign_keys' => [
3640                           { columns    => [ 'classnum' ],
3641                             table      => 'part_svc_class',
3642                           },
3643                         ],
3644     },
3645
3646     'part_svc_column' => {
3647       'columns' => [
3648         'columnnum',   'serial',      '',      '', '', '',
3649         'svcpart',     'int',         '',      '', '', '',
3650         'columnname',  'varchar',     '',      64, '', '',
3651         'columnlabel', 'varchar', 'NULL', $char_d, '', '',
3652         'columnvalue', 'varchar', 'NULL',     512, '', '',
3653         'columnflag',  'char',    'NULL',       1, '', '',
3654         'required',    'char',    'NULL',       1, '', '',
3655       ],
3656       'primary_key'  => 'columnnum',
3657       'unique'       => [ [ 'svcpart', 'columnname' ] ],
3658       'index'        => [ [ 'svcpart' ] ],
3659       'foreign_keys' => [
3660                           { columns    => [ 'svcpart' ],
3661                             table      => 'part_svc',
3662                           },
3663                         ],
3664     },
3665
3666     'part_svc_class' => {
3667       'columns' => [
3668         'classnum',    'serial',   '',      '', '', '',
3669         'classname',   'varchar',  '', $char_d, '', '',
3670         'disabled',    'char', 'NULL',       1, '', '',
3671       ],
3672       'primary_key' => 'classnum',
3673       'unique' => [],
3674       'index' => [ ['disabled'] ],
3675     },
3676
3677     'part_svc_link' => {
3678       'columns' => [
3679         'svclinknum',  'serial',   '',      '', '', '',
3680         #'linkname',    'varchar', 'NULL', $char_d, '', '',
3681         'agentnum',    'int',     'NULL', '', '', '',
3682         'src_svcpart', 'int',      '',      '', '', '',
3683         'dst_svcpart', 'int',      '',      '', '', '',
3684         'link_type',   'varchar',  '', $char_d, '', '',
3685         'disabled',    'char', 'NULL',   1, '', '',
3686       ],
3687       'primary_key'  => 'svclinknum',
3688       'unique'       => [ ['agentnum','src_svcpart','dst_svcpart','link_type'] ],
3689       'index'        => [ [ 'src_svcpart' ], [ 'src_svcpart', 'link_type' ], [ 'disabled' ] ],
3690       'foreign_keys' => [
3691                           { columns    => [ 'src_svcpart' ],
3692                             table      => 'part_svc',
3693                             references => [ 'svcpart' ]
3694                           },
3695                           { columns    => [ 'dst_svcpart' ],
3696                             table      => 'part_svc',
3697                             references => [ 'svcpart' ]
3698                           },
3699                         ],
3700     },
3701
3702     'part_svc_msgcat' => {
3703       'columns' => [
3704         'svcpartmsgnum',  'serial',     '',        '', '', '',
3705         'svcpart',           'int',     '',        '', '', '',
3706         'locale',        'varchar',     '',        16, '', '',
3707         'svc',           'varchar',     '',   $char_d, '', '',
3708       ],
3709       'primary_key'  => 'svcpartmsgnum',
3710       'unique'       => [ [ 'svcpart', 'locale' ] ],
3711       'index'        => [],
3712       'foreign_keys' => [
3713                           { columns    => [ 'svcpart' ],
3714                             table      => 'part_svc',
3715                           },
3716                         ],
3717     },
3718
3719
3720     #(this should be renamed to part_pop)
3721     'svc_acct_pop' => {
3722       'columns' => [
3723         'popnum',    'serial',    '',   '', '', '',
3724         'city',      'varchar',   '',   $char_d, '', '',
3725         'state',     'varchar',   '',   $char_d, '', '',
3726         'ac',        'char',   '',   3, '', '',
3727         'exch',      'char',   '',   3, '', '',
3728         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
3729       ],
3730       'primary_key' => 'popnum',
3731       'unique' => [],
3732       'index' => [ [ 'state' ] ],
3733     },
3734
3735     'part_pop_local' => {
3736       'columns' => [
3737         'localnum',  'serial',     '',     '', '', '',
3738         'popnum',    'int',     '',     '', '', '',
3739         'city',      'varchar', 'NULL', $char_d, '', '',
3740         'state',     'char',    'NULL', 2, '', '',
3741         'npa',       'char',    '',     3, '', '',
3742         'nxx',       'char',    '',     3, '', '',
3743       ],
3744       'primary_key'  => 'localnum',
3745       'unique'       => [],
3746       'index'        => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
3747       'foreign_keys' => [
3748                          { columns    => [ 'popnum' ],
3749                            table      => 'svc_acct_pop',
3750                          },
3751                        ],
3752     },
3753
3754     'qual' => {
3755       'columns' => [
3756         'qualnum',  'serial',     '',     '', '', '',
3757         'custnum',    'int',     'NULL',     '', '', '',
3758         'prospectnum',    'int',     'NULL',     '', '', '',
3759         'locationnum',    'int',     'NULL',     '', '', '',
3760         'phonenum',     'varchar', 'NULL',       24, '', '',
3761         'exportnum',      'int', 'NULL', '', '', '',
3762         'vendor_qual_id',      'varchar', 'NULL', $char_d, '', '',
3763         'status',      'char', '', 1, '', '',
3764       ],
3765       'primary_key'  => 'qualnum',
3766       'unique'       => [],
3767       'index'        => [ ['locationnum'], ['custnum'], ['prospectnum'],
3768                           ['phonenum'], ['vendor_qual_id'],
3769                         ],
3770       'foreign_keys' => [
3771                           { columns    => [ 'custnum' ],
3772                             table      => 'cust_main',
3773                           },
3774                           { columns    => [ 'prospectnum' ],
3775                             table      => 'prospect_main',
3776                           },
3777                           { columns    => [ 'locationnum' ],
3778                             table      => 'cust_location',
3779                           },
3780                           { columns    => [ 'exportnum' ],
3781                             table      => 'part_export',
3782                           },
3783                         ],
3784     },
3785
3786     'qual_option' => {
3787       'columns' => [
3788         'optionnum', 'serial', '', '', '', '',
3789         'qualnum',  'int',     '',     '', '', '',
3790         'optionname', 'varchar', '', $char_d, '', '',
3791         'optionvalue', 'text', 'NULL', '', '', '',
3792       ],
3793       'primary_key'  => 'optionnum',
3794       'unique'       => [],
3795       'index'        => [],
3796       'foreign_keys' => [
3797                           { columns    => [ 'qualnum' ],
3798                             table      => 'qual',
3799                           },
3800                         ],
3801     },
3802
3803     'svc_acct' => {
3804       'columns' => [
3805         'svcnum',    'int',    '',   '', '', '',
3806         'username',  'varchar',   '',   $username_len, '', '',
3807         '_password', 'varchar',   'NULL',  512, '', '',
3808         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
3809         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
3810         'popnum',    'int',    'NULL',   '', '', '',
3811         'sectornum', 'int', 'NULL',      '', '', '',
3812         'uid',       'int', 'NULL',   '', '', '',
3813         'gid',       'int', 'NULL',   '', '', '',
3814         'finger',    'varchar',   'NULL',   2*$char_d, '', '',
3815         'dir',       'varchar',   'NULL',   $char_d, '', '',
3816         'shell',     'varchar',   'NULL',   $char_d, '', '',
3817         'quota',     'varchar',   'NULL',   $char_d, '', '',
3818         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
3819         # IP address mgmt
3820         'routernum', 'int', 'NULL',      '', '', '',
3821         'blocknum',  'int', 'NULL',      '', '', '',
3822         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
3823         'seconds_threshold',   'int', 'NULL',   '', '', '',
3824         'upbytes',   'bigint', 'NULL',   '', '', '',
3825         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
3826         'downbytes', 'bigint', 'NULL',   '', '', '',
3827         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
3828         'totalbytes','bigint', 'NULL',   '', '', '',
3829         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
3830         'domsvc',    'int',     '', '', '', '',
3831         'pbxsvc',    'int', 'NULL', '', '', '',
3832         'last_login',  @date_type, '', '',
3833         'last_logout', @date_type, '', '',
3834         #cardfortress field(s)
3835         'cf_privatekey',      'text', 'NULL',      '', '', '',
3836         #communigate pro fields (quota = MaxAccountSize)
3837         'cgp_aliases',     'varchar', 'NULL',     255, '', '',
3838         #settings
3839         'cgp_type',        'varchar', 'NULL', $char_d, '', '', #AccountType
3840         'file_quota',      'varchar', 'NULL', $char_d, '', '', #MaxWebSize
3841         'file_maxnum',     'varchar', 'NULL', $char_d, '', '', #MaxWebFiles
3842         'file_maxsize',    'varchar', 'NULL', $char_d, '', '', #MaxFileSize
3843         'cgp_accessmodes', 'varchar', 'NULL',     255, '', '', #AccessModes
3844         'password_selfchange','char', 'NULL',       1, '', '', #PWDAllowed
3845         'password_recover',   'char', 'NULL',       1, 'Y','', #PasswordRecovery
3846         'cgp_rulesallowed','varchar', 'NULL', $char_d, '', '', #RulesAllowed
3847         'cgp_rpopallowed',    'char', 'NULL',       1, '', '', #RPOPAllowed
3848         'cgp_mailtoall',      'char', 'NULL',       1, '', '', #MailToAll
3849         'cgp_addmailtrailer', 'char', 'NULL',       1, '', '', #AddMailTrailer
3850         'cgp_archiveafter',    'int', 'NULL',      '', '', '', #ArchiveMessagesAfter
3851         #XXX mailing lists
3852         #preferences
3853         'cgp_deletemode',     'varchar', 'NULL', $char_d, '', '',#DeleteMode
3854         'cgp_emptytrash',     'varchar', 'NULL', $char_d, '', '',#EmptyTrash
3855         'cgp_language',       'varchar', 'NULL', $char_d, '', '',#Language
3856         'cgp_timezone',       'varchar', 'NULL', $char_d, '', '',#TimeZone
3857         'cgp_skinname',       'varchar', 'NULL', $char_d, '', '',#SkinName
3858         'cgp_prontoskinname', 'varchar', 'NULL', $char_d, '', '',#ProntoSkinName
3859         'cgp_sendmdnmode',    'varchar', 'NULL', $char_d, '', '',#SendMDNMode
3860         #mail
3861         #XXX RPOP settings
3862         #
3863       ],
3864       'primary_key'  => 'svcnum',
3865       #'unique'       => [ [ 'username', 'domsvc' ] ],
3866       'unique'       => [],
3867       'index'        => [ ['username'], ['domsvc'], ['pbxsvc'] ],
3868       'foreign_keys' => [
3869                           { columns    => [ 'svcnum' ],
3870                             table      => 'cust_svc',
3871                           },
3872                           { columns    => [ 'popnum' ],
3873                             table      => 'svc_acct_pop',
3874                           },
3875                           { columns    => [ 'sectornum' ],
3876                             table      => 'tower_sector',
3877                           },
3878                           { columns    => [ 'routernum' ],
3879                             table      => 'router',
3880                           },
3881                           { columns    => [ 'blocknum' ],
3882                             table      => 'addr_block',
3883                           },
3884                           { columns    => [ 'domsvc' ],
3885                             table      => 'svc_domain', #'cust_svc',
3886                             references => [ 'svcnum' ],
3887                           },
3888                           { columns    => [ 'pbxsvc' ],
3889                             table      => 'svc_pbx', #'cust_svc',
3890                             references => [ 'svcnum' ],
3891                           },
3892                         ],
3893     },
3894
3895     'acct_rt_transaction' => {
3896       'columns' => [
3897         'svcrtid',   'int',    '',   '', '', '', #why am i not a serial
3898         'svcnum',    'int',    '',   '', '', '',
3899         'transaction_id',       'int', '',   '', '', '',
3900         '_date',   @date_type, '', '',
3901         'seconds',   'int', '',   '', '', '', #uhhhh
3902         'support',   'int', '',   '', '', '',
3903       ],
3904       'primary_key'  => 'svcrtid',
3905       'unique'       => [],
3906       'index'        => [ ['svcnum', 'transaction_id'] ],
3907       'foreign_keys' => [
3908                           # problems w/deleted services, and as per below, this
3909                           # is our internal hack, not a customer-facing feature
3910                           #{ columns    => [ 'svcnum' ],
3911                           #  table      => 'svc_acct', #'cust_svc',
3912                           #},
3913
3914                           # 1. RT tables aren't part of our data structure, so
3915                           #     we can't make sure Queue is created already
3916                           # 2. This is our internal hack for time tracking, not
3917                           #     a user-facing feature
3918                           #{ columns    => [ 'transaction_id' ],
3919                           #  table      => 'Transaction',
3920                           #  references => [ 'id' ],
3921                           #},
3922                         ],
3923     },
3924
3925     #'svc_charge' => {
3926     #  'columns' => [
3927     #    'svcnum',    'int',    '',   '',
3928     #    'amount',    @money_type,
3929     #  ],
3930     #  'primary_key' => 'svcnum',
3931     #  'unique' => [ [] ],
3932     #  'index' => [ [] ],
3933     #},
3934
3935     'svc_domain' => {
3936       'columns' => [
3937         'svcnum',           'int',    '',        '', '', '',
3938         'domain',       'varchar',    '',   $char_d, '', '',
3939         'suffix',       'varchar', 'NULL',  $char_d, '', '',
3940         'catchall',         'int', 'NULL',       '', '', '',
3941         'parent_svcnum',    'int', 'NULL',       '', '', '',
3942         'quota',        'varchar', 'NULL',  $char_d, '', '',
3943
3944         #registration info
3945         'registrarnum',     'int', 'NULL',       '', '', '',
3946         'registrarkey', 'varchar', 'NULL',      512, '', '',
3947         'setup_date',      @date_type, '', '',
3948         'renewal_interval', 'int', 'NULL',       '', '', '',
3949         'expiration_date', @date_type, '', '',
3950
3951         #some weird shit australia-specific shit?  yuck.. seems totally unused
3952         'au_registrant_name',       'varchar', 'NULL',  $char_d, '', '',
3953         'au_eligibility_type',      'varchar', 'NULL',  $char_d, '', '',
3954
3955         #communigate pro fields (quota = MaxAccountSize)
3956         'max_accounts',     'int', 'NULL',       '', '', '',
3957         'trailer',         'text', 'NULL',       '', '', '',
3958         'cgp_aliases',  'varchar', 'NULL',      255, '', '',
3959         'cgp_accessmodes','varchar','NULL',     255, '', '', #DomainAccessModes
3960         'cgp_certificatetype','varchar','NULL', $char_d, '', '',
3961
3962         #(account default) settings
3963         'acct_def_password_selfchange',   'char', 'NULL',       1,  '', '',
3964         'acct_def_password_recover',      'char', 'NULL',       1, 'Y', '',
3965         'acct_def_cgp_accessmodes',    'varchar', 'NULL',     255,  '', '',
3966         'acct_def_quota',              'varchar', 'NULL', $char_d,  '', '',
3967         'acct_def_file_quota',         'varchar', 'NULL', $char_d,  '', '',
3968         'acct_def_file_maxnum',        'varchar', 'NULL', $char_d,  '', '',
3969         'acct_def_file_maxsize',       'varchar', 'NULL', $char_d,  '', '',
3970         'acct_def_cgp_rulesallowed',   'varchar', 'NULL', $char_d,  '', '',
3971         'acct_def_cgp_rpopallowed',       'char', 'NULL',       1,  '', '',
3972         'acct_def_cgp_mailtoall',         'char', 'NULL',       1,  '', '',
3973         'acct_def_cgp_addmailtrailer',    'char', 'NULL',       1,  '', '',
3974         'acct_def_cgp_archiveafter',       'int', 'NULL',      '',  '', '',
3975
3976         #(account default) preferences
3977         'acct_def_cgp_deletemode',     'varchar', 'NULL', $char_d,  '', '',
3978         'acct_def_cgp_emptytrash',     'varchar', 'NULL', $char_d,  '', '',
3979         'acct_def_cgp_language',       'varchar', 'NULL', $char_d,  '', '',
3980         'acct_def_cgp_timezone',       'varchar', 'NULL', $char_d,  '', '',
3981         'acct_def_cgp_skinname',       'varchar', 'NULL', $char_d,  '', '',
3982         'acct_def_cgp_prontoskinname', 'varchar', 'NULL', $char_d,  '', '',
3983         'acct_def_cgp_sendmdnmode',    'varchar', 'NULL', $char_d,  '', '',
3984       ],
3985       'primary_key'  => 'svcnum',
3986       'unique'       => [],
3987       'index'        => [ ['domain'] ],
3988       'foreign_keys' => [
3989                           { columns    => [ 'svcnum' ],
3990                             table      => 'cust_svc',
3991                           },
3992                           { columns    => [ 'catchall' ],
3993                             table      => 'svc_acct',
3994                             references => [ 'svcnum' ],
3995                           },
3996                           { columns    => [ 'parent_svcnum' ],
3997                             table      => 'cust_svc',
3998                             references => [ 'svcnum' ],
3999                           },
4000                           { columns    => [ 'registrarnum' ],
4001                             table      => 'registrar',
4002                           },
4003                         ],
4004     },
4005
4006     'svc_dsl' => {
4007       'columns' => [
4008         'svcnum',                    'int',    '',        '', '', '',
4009         'pushed',                    'int', 'NULL',       '', '', '',
4010         'desired_due_date',          'int', 'NULL',       '', '', '',
4011         'due_date',                  'int', 'NULL',       '', '', '',
4012         'vendor_order_id',       'varchar', 'NULL', $char_d,  '', '',
4013         'vendor_qual_id',        'varchar', 'NULL', $char_d,  '', '',
4014         'vendor_order_type',     'varchar', 'NULL', $char_d,  '', '',
4015         'vendor_order_status',   'varchar', 'NULL', $char_d,  '', '',
4016         'first',                 'varchar', 'NULL', $char_d,  '', '',
4017         'last',                  'varchar', 'NULL', $char_d,  '', '',
4018         'company',               'varchar', 'NULL', $char_d,  '', '',
4019         'phonenum',              'varchar', 'NULL',      24, '', '',
4020         'gateway_access_number', 'varchar', 'NULL',      24, '', '',
4021         'loop_type',                'char', 'NULL',       1, '', '',
4022         'local_voice_provider',  'varchar', 'NULL', $char_d, '', '',
4023         'circuitnum',            'varchar', 'NULL', $char_d, '', '',
4024         'rate_band',             'varchar', 'NULL', $char_d, '', '',
4025         'vpi',                       'int', 'NULL',      '', '', '',
4026         'vci',                       'int', 'NULL',      '', '', '',
4027         'isp_chg',                  'char', 'NULL',       1, '', '',
4028         'isp_prev',              'varchar', 'NULL', $char_d, '', '',
4029         'username',              'varchar', 'NULL', $char_d, '', '',
4030         'password',              'varchar', 'NULL', $char_d, '', '',
4031         'staticips',                'text', 'NULL',      '', '', '',
4032         'monitored',                'char', 'NULL',       1, '', '',
4033         'last_pull',                 'int', 'NULL',      '', '', '',
4034       ],
4035       'primary_key'  => 'svcnum',
4036       'unique'       => [ ],
4037       'index'        => [ ['phonenum'], ['vendor_order_id'] ],
4038       'foreign_keys' => [
4039                           { columns    => [ 'svcnum' ],
4040                             table      => 'cust_svc',
4041                           },
4042                         ],
4043     },
4044
4045     'dsl_device' => {
4046       'columns' => [
4047         'devicenum', 'serial',     '', '', '', '',
4048         #part_device?  or our own part_dsl_device?
4049         #'devicepart',   'int',     '', '', '', '',
4050         'svcnum',       'int',     '', '', '', '',
4051         'mac_addr', 'varchar',     '', 12, '', '',
4052       ],
4053       'primary_key'  => 'devicenum',
4054       'unique'       => [ [ 'mac_addr' ], ],
4055       'index'        => [ [ 'svcnum' ], ], # [ 'devicepart' ] ],
4056       'foreign_keys' => [
4057                           { columns    => [ 'svcnum' ],
4058                             table      => 'svc_dsl',
4059                           },
4060                         ],
4061     },
4062
4063     'dsl_note' => {
4064       'columns' => [
4065         'notenum',           'serial',    '',        '', '', '',
4066         'svcnum',     'int', '',       '', '', '',
4067         'author',     'varchar', 'NULL', $char_d,  '', '',
4068         'priority',   'char', 'NULL',       1,  '', '',
4069         '_date',     'int', 'NULL',       '', '', '',
4070         'note',     'text', '',       '', '', '',
4071       ],
4072       'primary_key'  => 'notenum',
4073       'unique'       => [],
4074       'index'        => [ ['svcnum'] ],
4075       'foreign_keys' => [
4076                           { columns    => [ 'svcnum' ],
4077                             table      => 'svc_dsl',
4078                           },
4079                         ],
4080     },
4081
4082     'svc_dish' => {
4083       'columns' => [
4084         'svcnum',   'int',     '',     '', '', '',
4085         'acctnum',  'varchar', '',     16, '', '',
4086         'installdate', @date_type,         '', '',
4087         'note',     'text',    'NULL', '', '', '',
4088       ],
4089       'primary_key'  => 'svcnum',
4090       'unique'       => [],
4091       'index'        => [],
4092       'foreign_keys' => [
4093                           { columns    => [ 'svcnum' ],
4094                             table      => 'cust_svc',
4095                           },
4096                         ],
4097     },
4098
4099     'svc_hardware' => {
4100       'columns' => [
4101         'svcnum',   'int',     '',          '', '', '',
4102         'typenum',  'int',     '',          '', '', '',
4103         'serial',   'varchar', 'NULL', $char_d, '', '',
4104         'ip_addr',  'varchar', 'NULL',      40, '', '',
4105         'hw_addr',  'varchar', 'NULL',      12, '', '',
4106         'smartcard','varchar', 'NULL',      30, '', '',
4107         'statusnum','int',     'NULL',      '', '', '',
4108         'note',     'text',    'NULL',      '', '', '',
4109       ],
4110       'primary_key'  => 'svcnum',
4111       'unique'       => [],
4112       'index'        => [],
4113       'foreign_keys' => [
4114                           { columns    => [ 'svcnum' ],
4115                             table      => 'cust_svc',
4116                           },
4117                           { columns    => [ 'typenum' ],
4118                             table      => 'hardware_type',
4119                           },
4120                           { columns    => [ 'statusnum' ],
4121                             table      => 'hardware_status',
4122                           },
4123                         ],
4124     },
4125
4126     'hardware_class' => {
4127       'columns' => [
4128         'classnum',   'serial', '',      '', '', '',
4129         'classname', 'varchar', '', $char_d, '', '',
4130       ],
4131       'primary_key' => 'classnum',
4132       'unique' => [],
4133       'index'  => [],
4134     },
4135
4136     'hardware_type' => {
4137       'columns' => [
4138         'typenum',  'serial',     '',      '', '', '',
4139         'classnum',    'int',     '',      '', '', '',
4140         'model',   'varchar',     '', $char_d, '', '',
4141         'revision','varchar', 'NULL', $char_d, '', '',
4142       ],
4143       'primary_key'  => 'typenum',
4144       'unique'       => [ [ 'classnum', 'model', 'revision' ] ],
4145       'index'        => [],
4146       'foreign_keys' => [
4147                           { columns    => [ 'classnum' ],
4148                             table      => 'hardware_class',
4149                           },
4150                         ],
4151     },
4152
4153     'hardware_status' => {
4154       'columns' => [
4155         'statusnum', 'serial', '',      '', '', '',
4156         'label'    ,'varchar', '', $char_d, '', '',
4157         'disabled',    'char', 'NULL',   1, '', '',
4158       ],
4159       'primary_key' => 'statusnum',
4160       'unique' => [],
4161       'index'  => [],
4162     },
4163
4164     'domain_record' => {
4165       'columns' => [
4166         'recnum',    'serial',     '',  '', '', '',
4167         'svcnum',    'int',     '',  '', '', '',
4168         'reczone',   'varchar', '',  255, '', '',
4169         'recaf',     'char',    '',  2, '', '',
4170         'rectype',   'varchar',    '',  5, '', '',
4171         'recdata',   'varchar', '',  255, '', '',
4172         'ttl',       'int',     'NULL', '', '', '',
4173       ],
4174       'primary_key'  => 'recnum',
4175       'unique'       => [],
4176       'index'        => [ ['svcnum'] ],
4177       'foreign_keys' => [
4178                           { columns    => [ 'svcnum' ],
4179                             table      => 'svc_domain',
4180                           },
4181                         ],
4182     },
4183
4184     'registrar' => {
4185       'columns' => [
4186         'registrarnum',   'serial', '',      '', '', '',
4187         'registrarname', 'varchar', '', $char_d, '', '',
4188       ],
4189       'primary_key' => 'registrarnum',
4190       'unique'      => [],
4191       'index'       => [],
4192     },
4193
4194     'cgp_rule' => {
4195       'columns' => [
4196         'rulenum',  'serial',     '',      '', '', '',
4197         'name',    'varchar',     '', $char_d, '', '',
4198         'comment', 'varchar', 'NULL', $char_d, '', '',
4199         'svcnum',      'int',     '',      '', '', '',
4200         'priority',    'int',     '',      '', '', '',
4201       ],
4202       'primary_key' => 'rulenum',
4203       'unique'      => [ [ 'svcnum', 'name' ] ],
4204       'index'       => [ [ 'svcnum' ] ],
4205       'foreign_keys' => [
4206                           { columns    => [ 'svcnum' ],
4207                             table      => 'cust_svc', #svc_acct / svc_domain
4208                           },
4209                         ],
4210     },
4211
4212     'cgp_rule_condition' => {
4213       'columns' => [
4214         'ruleconditionnum',  'serial',     '',      '', '', '',
4215         'conditionname',    'varchar',     '', $char_d, '', '',
4216         'op',               'varchar', 'NULL', $char_d, '', '',
4217         'params',           'varchar', 'NULL',     255, '', '',
4218         'rulenum',              'int',     '',      '', '', '',
4219       ],
4220       'primary_key'  => 'ruleconditionnum',
4221       'unique'       => [],
4222       'index'        => [ [ 'rulenum' ] ],
4223       'foreign_keys' => [
4224                           { columns    => [ 'rulenum' ],
4225                             table      => 'cgp_rule',
4226                           },
4227                         ],
4228     },
4229
4230     'cgp_rule_action' => {
4231        'columns' => [
4232         'ruleactionnum',  'serial',     '',      '', '', '',
4233         'action',        'varchar',     '', $char_d, '', '',
4234         'params',        'varchar', 'NULL',     255, '', '',
4235         'rulenum',           'int',     '',      '', '', '',
4236       ],
4237       'primary_key'  => 'ruleactionnum',
4238       'unique'       => [],
4239       'index'        => [ [ 'rulenum' ] ],
4240       'foreign_keys' => [
4241                           { columns    => [ 'rulenum' ],
4242                             table      => 'cgp_rule',
4243                           },
4244                         ],
4245    },
4246
4247     'svc_forward' => {
4248       'columns' => [
4249         'svcnum',   'int',            '',   '', '', '',
4250         'srcsvc',   'int',        'NULL',   '', '', '',
4251         'src',      'varchar',    'NULL',  255, '', '',
4252         'dstsvc',   'int',        'NULL',   '', '', '',
4253         'dst',      'varchar',    'NULL',  255, '', '',
4254       ],
4255       'primary_key'  => 'svcnum',
4256       'unique'       => [],
4257       'index'        => [ ['srcsvc'], ['dstsvc'] ],
4258       'foreign_keys' => [
4259                           { columns    => [ 'svcnum' ],
4260                             table      => 'cust_svc',
4261                           },
4262                           { columns    => [ 'srcsvc' ],
4263                             table      => 'svc_acct',
4264                             references => [ 'svcnum' ]
4265                           },
4266                           { columns    => [ 'dstsvc' ],
4267                             table      => 'svc_acct',
4268                             references => [ 'svcnum' ]
4269                           },
4270                         ],
4271     },
4272
4273     'svc_www' => {
4274       'columns' => [
4275         'svcnum',   'int',      '',  '', '', '',
4276         'recnum',   'int',      '',  '', '', '',
4277         'usersvc',  'int',  'NULL',  '', '', '',
4278         'config',   'text', 'NULL',  '', '', '',
4279       ],
4280       'primary_key' => 'svcnum',
4281       'unique'      => [],
4282       'index'       => [],
4283       'foreign_keys' => [
4284                           { columns    => [ 'svcnum' ],
4285                             table      => 'cust_svc',
4286                           },
4287                           { columns    => [ 'recnum' ],
4288                             table      => 'domain_record',
4289                           },
4290                           { columns    => [ 'usersvc' ],
4291                             table      => 'svc_acct',
4292                             references => [ 'svcnum' ]
4293                           },
4294                         ],
4295     },
4296
4297     #'svc_wo' => {
4298     #  'columns' => [
4299     #    'svcnum',    'int',    '',   '',
4300     #    'svcnum',    'int',    '',   '',
4301     #    'svcnum',    'int',    '',   '',
4302     #    'worker',    'varchar',   '',   $char_d,
4303     #    '_date',     @date_type,
4304     #  ],
4305     #  'primary_key' => 'svcnum',
4306     #  'unique' => [ [] ],
4307     #  'index' => [ [] ],
4308     #},
4309
4310     'prepay_credit' => {
4311       'columns' => [
4312         'prepaynum',   'serial',     '',   '', '', '',
4313         'identifier',  'varchar', '', $char_d, '', '',
4314         'amount',      @money_type, '', '',
4315         'seconds',     'int',     'NULL', '', '', '',
4316         'upbytes',     'bigint',     'NULL', '', '', '',
4317         'downbytes',   'bigint',     'NULL', '', '', '',
4318         'totalbytes',  'bigint',     'NULL', '', '', '',
4319         'agentnum',    'int',     'NULL', '', '', '',
4320       ],
4321       'primary_key'  => 'prepaynum',
4322       'unique'       => [ ['identifier'] ],
4323       'index'        => [ ['agentnum'] ],
4324       'foreign_keys' => [
4325                           { columns    => [ 'agentnum' ],
4326                             table      => 'agent',
4327                           },
4328                         ],
4329     },
4330
4331     'port' => {
4332       'columns' => [
4333         'portnum',  'serial',     '',   '', '', '',
4334         'ip',       'varchar', 'NULL', 15, '', '',
4335         'nasport',  'int',     'NULL', '', '', '',
4336         'nasnum',   'int',     '',   '', '', '',
4337       ],
4338       'primary_key'  => 'portnum',
4339       'unique'       => [],
4340       'index'        => [],
4341       'foreign_keys' => [
4342                           { columns    => [ 'nasnum' ],
4343                             table      => 'nas',
4344                           },
4345                         ],
4346     },
4347
4348     'nas' => {
4349       'columns' => [
4350         'nasnum',       'serial',     '',  '',              '', '',
4351         'nasname',     'varchar',     '', 128,              '', '',
4352         'shortname',   'varchar', 'NULL',  32,              '', '',
4353         'type',        'varchar',     '',  30,         'other', '',
4354         'ports',           'int', 'NULL',  '',              '', '',
4355         'secret',      'varchar',     '',  60,        'secret', '',
4356         'server',      'varchar', 'NULL',  64,              '', '',
4357         'community',   'varchar', 'NULL',  50,              '', '',
4358         'description', 'varchar',     '', 200, 'RADIUS Client', '',
4359         'svcnum',          'int', 'NULL',  '',              '', '',
4360       ],
4361       'primary_key'  => 'nasnum',
4362       'unique'       => [ [ 'nasname' ], ],
4363       'index'        => [],
4364       'foreign_keys' => [
4365                           { columns    => [ 'svcnum' ],
4366                             table      => 'svc_broadband',#no? could be _acct?
4367                                                           #remove or cust_svc?
4368                           },
4369                         ],
4370     },
4371
4372     'export_nas' => {
4373       'columns' => [
4374         'exportnasnum', 'serial', '', '', '', '',
4375         'exportnum',       'int', '', '', '', '',
4376         'nasnum',          'int', '', '', '', '',
4377       ],
4378       'primary_key'  => 'exportnasnum',
4379       'unique'       => [ [ 'exportnum', 'nasnum' ] ],
4380       'index'        => [ [ 'exportnum' ], [ 'nasnum' ] ],
4381       'foreign_keys' => [
4382                           { columns    => [ 'exportnum' ],
4383                             table      => 'part_export',
4384                           },
4385                           { columns    => [ 'nasnum' ],
4386                             table      => 'nas',
4387                           },
4388                         ],
4389     },
4390
4391     'queue' => {
4392       'columns' => [
4393         'jobnum',   'bigserial',     '',      '', '', '',
4394         'job',        'varchar',     '',     512, '', '',
4395         '_date',          'int',     '',      '', '', '',
4396         'status',     'varchar',     '', $char_d, '', '',
4397         'statustext',    'text', 'NULL',      '', '', '',
4398         'svcnum',         'int', 'NULL',      '', '', '',
4399         'custnum',        'int', 'NULL',      '', '', '',
4400         'secure',        'char', 'NULL',       1, '', '',
4401         'priority',       'int', 'NULL',      '', '', '',
4402         'usernum',        'int', 'NULL',      '', '', '',
4403       ],
4404       'primary_key'  => 'jobnum',
4405       'unique'       => [],
4406       'index'        => [ [ 'secure' ], [ 'priority' ],
4407                           [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
4408                         ],
4409       'foreign_keys' => [
4410 #                          { columns    => [ 'svcnum' ],
4411 #                            table      => 'cust_svc',
4412 #                          },
4413                           { columns    => [ 'custnum' ],
4414                             table      => 'cust_main',
4415                           },
4416                           { columns    => [ 'usernum' ],
4417                             table      => 'access_user',
4418                           },
4419                         ],
4420     },
4421
4422     'queue_arg' => {
4423       'columns' => [
4424         'argnum', 'bigserial',     '', '', '', '',
4425         'jobnum',    'bigint',     '', '', '', '',
4426         'frozen',      'char', 'NULL',  1, '', '',
4427         'arg',         'text', 'NULL', '', '', '',
4428       ],
4429       'primary_key'  => 'argnum',
4430       'unique'       => [],
4431       'index'        => [ [ 'jobnum' ] ],
4432       'foreign_keys' => [
4433                           { columns    => [ 'jobnum' ],
4434                             table      => 'queue',
4435                             on_delete  => 'CASCADE',
4436                           },
4437                         ],
4438     },
4439
4440     'queue_depend' => {
4441       'columns' => [
4442         'dependnum',  'bigserial', '', '', '', '',
4443         'jobnum',        'bigint', '', '', '', '',
4444         'depend_jobnum', 'bigint', '', '', '', '',
4445       ],
4446       'primary_key'  => 'dependnum',
4447       'unique'       => [],
4448       'index'        => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
4449       'foreign_keys' => [
4450                           { columns    => [ 'jobnum' ],
4451                             table      => 'queue',
4452                           },
4453                           { columns    => [ 'depend_jobnum' ],
4454                             table      => 'queue',
4455                             references => [ 'jobnum' ],
4456                             on_delete  => 'CASCADE',
4457                           },
4458                         ],
4459     },
4460
4461     'queue_stat' => {
4462       'columns' => [
4463         'statnum', 'bigserial',     '',  '', '', '',
4464         'jobnum',     'bigint',     '',  '', '', '',
4465         'job',       'varchar',     '', 512, '', '',
4466         'custnum',       'int', 'NULL',  '', '', '',
4467         'insert_date', @date_type, '', '',
4468         'start_date',  @date_type, '', '',
4469         'end_date',    @date_type, '', '',
4470       ],
4471       'primary_key'  => 'statnum',
4472       'unique'       => [], #[ ['jobnum'] ],
4473       'index'        => [],
4474     },
4475
4476     'export_svc' => {
4477       'columns' => [
4478         'exportsvcnum' => 'serial', '', '', '', '',
4479         'exportnum'    => 'int', '', '', '', '',
4480         'svcpart'      => 'int', '', '', '', '',
4481         'role'         => 'varchar', 'NULL', 16, '', '',
4482       ],
4483       'primary_key'  => 'exportsvcnum',
4484       'unique'       => [ [ 'exportnum', 'svcpart' ] ],
4485       'index'        => [ [ 'exportnum' ], [ 'svcpart' ] ],
4486       'foreign_keys' => [
4487                           { columns    => [ 'exportnum' ],
4488                             table      => 'part_export',
4489                           },
4490                           { columns    => [ 'svcpart' ],
4491                             table      => 'part_svc',
4492                           },
4493                         ],
4494     },
4495
4496     'export_cust_svc' => {
4497       'columns' => [
4498         'exportcustsvcnum', 'serial', '', '', '', '',
4499         'exportnum', 'int', '', '', '', '',
4500         'svcnum', 'int', '', '', '', '',
4501         'remoteid', 'varchar', '', 512, '', '',
4502       ],
4503       'primary_key'  => 'exportcustsvcnum',
4504       'unique'       => [ [ 'exportnum', 'svcnum' ] ],
4505       'index'        => [ [ 'exportnum', 'svcnum' ] ],
4506       'foreign_keys' => [
4507                           { columns    => [ 'exportnum' ],
4508                             table      => 'part_export',
4509                           },
4510                           { columns    => [ 'svcnum' ],
4511                             table      => 'cust_svc',
4512                           },
4513                         ],
4514     },
4515
4516     'export_device' => {
4517       'columns' => [
4518         'exportdevicenum' => 'serial', '', '', '', '',
4519         'exportnum'       => 'int', '', '', '', '',
4520         'devicepart'      => 'int', '', '', '', '',
4521       ],
4522       'primary_key'  => 'exportdevicenum',
4523       'unique'       => [ [ 'exportnum', 'devicepart' ] ],
4524       'index'        => [ [ 'exportnum' ], [ 'devicepart' ] ],
4525       'foreign_keys' => [
4526                           { columns    => [ 'exportnum' ],
4527                             table      => 'part_export',
4528                           },
4529                           { columns    => [ 'devicepart' ],
4530                             table      => 'part_device',
4531                           },
4532                         ],
4533     },
4534
4535     'part_export' => {
4536       'columns' => [
4537         'exportnum',   'serial',     '',      '', '', '',
4538         'exportname', 'varchar', 'NULL', $char_d, '', '',
4539         'machine',    'varchar', 'NULL', $char_d, '', '',
4540         'exporttype', 'varchar',     '', $char_d, '', '',
4541         'nodomain',      'char', 'NULL',       1, '', '',
4542         'default_machine','int', 'NULL',      '', '', '',
4543         'no_suspend',    'char', 'NULL',       1, '', '',
4544         # could also have 'no_insert', 'no_replace', etc.
4545       ],
4546       'primary_key'  => 'exportnum',
4547       'unique'       => [],
4548       'index'        => [ [ 'machine' ], [ 'exporttype' ] ],
4549       'foreign_keys' => [
4550                           { columns    => [ 'default_machine' ],
4551                             table      => 'part_export_machine',
4552                             references => [ 'machinenum' ]
4553                           },
4554                         ],
4555     },
4556
4557     'part_export_option' => {
4558       'columns' => [
4559         'optionnum', 'serial', '', '', '', '',
4560         'exportnum', 'int', '', '', '', '',
4561         'optionname', 'varchar', '', $char_d, '', '',
4562         'optionvalue', 'text', 'NULL', '', '', '',
4563       ],
4564       'primary_key'  => 'optionnum',
4565       'unique'       => [],
4566       'index'        => [ [ 'exportnum' ], [ 'optionname' ] ],
4567       'foreign_keys' => [
4568                           { columns    => [ 'exportnum' ],
4569                             table      => 'part_export',
4570                           },
4571                         ],
4572     },
4573
4574     'radius_usergroup' => {
4575       'columns' => [
4576         'usergroupnum', 'serial', '', '', '', '',
4577         'svcnum',       'int', '', '', '', '',
4578         'groupname',    'varchar', 'NULL', $char_d, '', '', #deprecated
4579         'groupnum',     'int', 'NULL', '', '', '',
4580       ],
4581       'primary_key'  => 'usergroupnum',
4582       'unique'       => [],
4583       'index'        => [ [ 'svcnum' ], [ 'groupname' ] ],
4584       'foreign_keys' => [
4585                           { columns    => [ 'svcnum' ],
4586                             table      => 'cust_svc', #svc_acct / svc_broadband
4587                           },
4588                           { columns    => [ 'groupnum' ],
4589                             table      => 'radius_group',
4590                           },
4591                         ],
4592     },
4593
4594     'radius_group' => {
4595       'columns' => [
4596         'groupnum', 'serial', '', '', '', '',
4597         'groupname',    'varchar', '', $char_d, '', '',
4598         'description',  'varchar', 'NULL', $char_d, '', '',
4599         'priority', 'int', '', '', '1', '',
4600         'speed_up', 'int', 'NULL', '', '', '',
4601         'speed_down', 'int', 'NULL', '', '', '',
4602       ],
4603       'primary_key' => 'groupnum',
4604       'unique'      => [ ['groupname'] ],
4605       'index'       => [],
4606     },
4607
4608     'radius_attr' => {
4609       'columns' => [
4610         'attrnum',   'serial', '',      '', '', '',
4611         'groupnum',     'int', '',      '', '', '',
4612         'attrname', 'varchar', '', $char_d, '', '',
4613         'value',    'varchar', '',     255, '', '',
4614         'attrtype',    'char', '',       1, '', '',
4615         'op',          'char', '',       2, '', '',
4616       ],
4617       'primary_key'  => 'attrnum',
4618       'unique'       => [],
4619       'index'        => [ ['groupnum'], ],
4620       'foreign_keys' => [
4621                           { columns    => [ 'groupnum' ],
4622                             table      => 'radius_group',
4623                           },
4624                         ],
4625     },
4626
4627     'msgcat' => {
4628       'columns' => [
4629         'msgnum', 'serial', '', '', '', '',
4630         'msgcode', 'varchar', '', 255, '', '',
4631         'locale', 'varchar', '', 16, '', '',
4632         'msg', 'text', '', '', '', '',
4633       ],
4634       'primary_key' => 'msgnum',
4635       'unique'      => [ [ 'msgcode', 'locale' ] ],
4636       'index'       => [],
4637     },
4638
4639     'cust_tax_exempt' => {
4640       'columns' => [
4641         'exemptnum', 'serial', '', '', '', '',
4642         'custnum',   'int', '', '', '', '',
4643         'taxnum',    'int', '', '', '', '',
4644         'year',      'int', '', '', '', '',
4645         'month',     'int', '', '', '', '',
4646         'amount',   @money_type, '', '',
4647       ],
4648       'primary_key'  => 'exemptnum',
4649       'unique'       => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
4650       'index'        => [],
4651       'foreign_keys' => [
4652                           { columns    => [ 'custnum' ],
4653                             table      => 'cust_main',
4654                           },
4655                           { columns    => [ 'taxnum' ],
4656                             table      => 'cust_main_county',
4657                           },
4658                         ],
4659     },
4660
4661     'cust_tax_exempt_pkg' => {
4662       'columns' => [
4663         'exemptpkgnum',  'serial', '', '', '', '',
4664         #'custnum',      'int', '', '', '', ''
4665         'billpkgnum',   'int', '', '', '', '',
4666         'taxnum',       'int', '', '', '', '',
4667         'taxtype',  'varchar', 'NULL', $char_d, '', '',
4668         'year',         'int', 'NULL', '', '', '',
4669         'month',        'int', 'NULL', '', '', '',
4670         'creditbillpkgnum', 'int', 'NULL', '', '', '',
4671         'amount',       @money_type, '', '',
4672         # exemption type flags
4673         'exempt_cust',          'char', 'NULL', 1, '', '',
4674         'exempt_setup',         'char', 'NULL', 1, '', '',
4675         'exempt_recur',         'char', 'NULL', 1, '', '',
4676         'exempt_cust_taxname',  'char', 'NULL', 1, '', '',
4677         'exempt_monthly',       'char', 'NULL', 1, '', '',
4678       ],
4679       'primary_key'  => 'exemptpkgnum',
4680       'unique'       => [],
4681       'index'        => [ [ 'taxnum', 'year', 'month' ],
4682                           [ 'billpkgnum' ],
4683                           [ 'taxnum', 'taxtype' ],
4684                           [ 'creditbillpkgnum' ],
4685                         ],
4686       'foreign_keys' => [
4687                           { columns    => [ 'billpkgnum' ],
4688                             table      => 'cust_bill_pkg',
4689                           },
4690                           { columns    => [ 'creditbillpkgnum' ],
4691                             table      => 'cust_credit_bill_pkg',
4692                           },
4693                         ],
4694     },
4695
4696     'cust_tax_exempt_pkg_void' => {
4697       'columns' => [
4698         'exemptpkgnum',  'int', '', '', '', '',
4699         #'custnum',      'int', '', '', '', ''
4700         'billpkgnum',   'int', '', '', '', '',
4701         'taxnum',       'int', '', '', '', '',
4702         'taxtype',  'varchar', 'NULL', $char_d, '', '',
4703         'year',         'int', 'NULL', '', '', '',
4704         'month',        'int', 'NULL', '', '', '',
4705         'creditbillpkgnum', 'int', 'NULL', '', '', '',
4706         'amount',       @money_type, '', '',
4707         # exemption type flags
4708         'exempt_cust',          'char', 'NULL', 1, '', '',
4709         'exempt_setup',         'char', 'NULL', 1, '', '',
4710         'exempt_recur',         'char', 'NULL', 1, '', '',
4711         'exempt_cust_taxname',  'char', 'NULL', 1, '', '',
4712         'exempt_monthly',       'char', 'NULL', 1, '', '',
4713       ],
4714       'primary_key'  => 'exemptpkgnum',
4715       'unique'       => [],
4716       'index'        => [ [ 'taxnum', 'year', 'month' ],
4717                           [ 'billpkgnum' ],
4718                           [ 'taxnum', 'taxtype' ],
4719                           [ 'creditbillpkgnum' ],
4720                         ],
4721       'foreign_keys' => [
4722                           { columns    => [ 'billpkgnum' ],
4723                             table      => 'cust_bill_pkg_void',
4724                           },
4725                           { columns    => [ 'taxnum' ],
4726                             table      => 'cust_main_county',
4727                           },
4728                           { columns    => [ 'creditbillpkgnum' ],
4729                             table      => 'cust_credit_bill_pkg',
4730                           },
4731                         ],
4732     },
4733
4734     'router' => {
4735       'columns' => [
4736         'routernum', 'serial', '', '', '', '',
4737         'routername', 'varchar', '', $char_d, '', '',
4738         'svcnum', 'int', 'NULL', '', '', '',
4739         'agentnum',   'int', 'NULL', '', '', '',
4740         'manual_addr', 'char', 'NULL', 1, '', '',
4741       ],
4742       'primary_key'  => 'routernum',
4743       'unique'       => [],
4744       'index'        => [],
4745       'foreign_keys' => [
4746                           { columns    => [ 'svcnum' ],
4747                             table      => 'cust_svc', #svc_acct / svc_broadband
4748                           },
4749                           { columns    => [ 'agentnum' ],
4750                             table      => 'agent',
4751                           },
4752                         ],
4753     },
4754
4755     'part_svc_router' => {
4756       'columns' => [
4757         'svcrouternum', 'serial', '', '', '', '',
4758         'svcpart', 'int', '', '', '', '',
4759         'routernum', 'int', '', '', '', '',
4760       ],
4761       'primary_key'  => 'svcrouternum',
4762       'unique'       => [],
4763       'index'        => [],
4764       'foreign_keys' => [
4765                           { columns    => [ 'svcpart' ],
4766                             table      => 'part_svc',
4767                           },
4768                           { columns    => [ 'routernum' ],
4769                             table      => 'router',
4770                           },
4771                         ],
4772     },
4773
4774     'addr_block' => {
4775       'columns' => [
4776         'blocknum', 'serial', '', '', '', '',
4777         'routernum', 'int', '', '', '', '',
4778         'ip_gateway', 'varchar', '', 15, '', '',
4779         'ip_netmask', 'int', '', '', '', '',
4780         'agentnum',   'int', 'NULL', '', '', '',
4781         'manual_flag', 'char', 'NULL', 1, '', '',
4782       ],
4783       'primary_key'  => 'blocknum',
4784       'unique'       => [ [ 'blocknum', 'routernum' ] ],
4785       'index'        => [],
4786       'foreign_keys' => [
4787                           #{ columns    => [ 'routernum' ],
4788                           #   table      => 'router',
4789                           #},
4790                           { columns    => [ 'agentnum' ],
4791                             table      => 'agent',
4792                           },
4793                         ],
4794     },
4795
4796     'addr_range' => {
4797       'columns' => [
4798         'rangenum', 'serial', '', '', '', '',
4799         'start',    'varchar', '', 15, '', '',
4800         'length',   'int', '', '', '', '',
4801         'status',   'varchar', 'NULL', 32, '', '',
4802       ],
4803       'primary_key' => 'rangenum',
4804       'unique'      => [],
4805       'index'       => [],
4806     },
4807
4808     'svc_broadband' => {
4809       'columns' => [
4810         'svcnum',                  'int',     '',        '', '', '',
4811         'description',         'varchar', 'NULL',   $char_d, '', '',
4812         'routernum',               'int', 'NULL',        '', '', '',
4813         'blocknum',                'int', 'NULL',        '', '', '',
4814         'sectornum',               'int', 'NULL',        '', '', '',
4815         'speed_up',                'int', 'NULL',        '', '', '',
4816         'speed_down',              'int', 'NULL',        '', '', '',
4817         'ip_addr',             'varchar', 'NULL',        15, '', '',
4818         'mac_addr',            'varchar', 'NULL',        12, '', '',
4819         'authkey',             'varchar', 'NULL',        32, '', '',
4820         'latitude',            'decimal', 'NULL',    '10,7', '', '',
4821         'longitude',           'decimal', 'NULL',    '10,7', '', '',
4822         'altitude',            'decimal', 'NULL',        '', '', '',
4823         'vlan_profile',        'varchar', 'NULL',   $char_d, '', '',
4824         'performance_profile', 'varchar', 'NULL',   $char_d, '', '',
4825         'plan_id',             'varchar', 'NULL',   $char_d, '', '',
4826         'radio_serialnum',     'varchar', 'NULL',   $char_d, '', '',
4827         'radio_location',      'varchar', 'NULL', 2*$char_d, '', '',
4828         'poe_location',        'varchar', 'NULL', 2*$char_d, '', '',
4829         'rssi',                    'int', 'NULL',        '', '', '',
4830         'suid',                    'int', 'NULL',        '', '', '',
4831         'shared_svcnum',           'int', 'NULL',        '', '', '',
4832         'serviceid',           'varchar', 'NULL',        64, '', '',#srvexport/reportfields
4833       ],
4834       'primary_key'  => 'svcnum',
4835       'unique'       => [ [ 'ip_addr' ], [ 'mac_addr' ] ],
4836       'index'        => [],
4837       'foreign_keys' => [
4838                           { columns    => [ 'svcnum' ],
4839                             table      => 'cust_svc',
4840                           },
4841                           { columns    => [ 'routernum' ],
4842                             table      => 'router',
4843                           },
4844                           { columns    => [ 'blocknum' ],
4845                             table      => 'addr_block',
4846                           },
4847                           { columns    => [ 'sectornum' ],
4848                             table      => 'tower_sector',
4849                           },
4850                           { columns    => [ 'shared_svcnum' ],
4851                             table      => 'svc_broadband',
4852                             references => [ 'svcnum' ],
4853                           },
4854                         ],
4855     },
4856
4857     'tower' => {
4858       'columns' => [
4859         'towernum',    'serial',     '',      '', '', '',
4860         #'agentnum',       'int', 'NULL',      '', '', '',
4861         'towername',  'varchar',     '', $char_d, '', '',
4862         'disabled',      'char', 'NULL',       1, '', '',
4863         'latitude',   'decimal', 'NULL',  '10,7', '', '',
4864         'longitude',  'decimal', 'NULL',  '10,7', '', '',
4865         'coord_auto',    'char', 'NULL',       1, '', '',
4866         'altitude',   'decimal', 'NULL',      '', '', '',
4867         'height',     'decimal', 'NULL',      '', '', '',
4868         'veg_height', 'decimal', 'NULL',      '', '', '',
4869         'color',      'varchar', 'NULL',       6, '', '',
4870       ],
4871       'primary_key' => 'towernum',
4872       'unique'      => [ [ 'towername' ] ], # , 'agentnum' ] ],
4873       'index'       => [],
4874     },
4875
4876     'tower_sector' => {
4877       'columns' => [
4878         'sectornum',     'serial',     '',      '', '', '',
4879         'towernum',         'int',     '',      '', '', '',
4880         'sectorname',   'varchar',     '', $char_d, '', '',
4881         'ip_addr',      'varchar', 'NULL',      15, '', '',
4882         'height',       'decimal', 'NULL',      '', '', '',
4883         'freq_mhz',         'int', 'NULL',      '', '', '',
4884         'direction',        'int', 'NULL',      '', '', '',
4885         'width',            'int', 'NULL',      '', '', '',
4886         'sector_range', 'decimal', 'NULL',      '', '', '',  #?
4887         'downtilt',     'decimal', 'NULL',      '', '', '',
4888         'v_width',          'int', 'NULL',      '', '', '',
4889         'db_high',          'int', 'NULL',     '', '', '',
4890         'db_low',           'int', 'NULL',     '', '', '',
4891         'image',           'blob', 'NULL',     '', '', '',
4892         'west',         'decimal', 'NULL', '10,7', '', '',
4893         'east',         'decimal', 'NULL', '10,7', '', '',
4894         'south',        'decimal', 'NULL', '10,7', '', '',
4895         'north',        'decimal', 'NULL', '10,7', '', '',
4896      ],
4897       'primary_key'  => 'sectornum',
4898       'unique'       => [ [ 'towernum', 'sectorname' ], [ 'ip_addr' ], ],
4899       'index'        => [ [ 'towernum' ] ],
4900       'foreign_keys' => [
4901                           { columns    => [ 'towernum' ],
4902                             table      => 'tower',
4903                           },
4904                         ],
4905     },
4906
4907     'sector_coverage' => {
4908       'columns' => [
4909         'coveragenum', 'serial', '', '', '', '',
4910         'sectornum',     'int', '', '', '', '',
4911         'db_loss',       'int', '', '', '', '',
4912         'geometry',     'text', 'NULL', '', '', '',
4913       ],
4914       'primary_key' => 'coveragenum',
4915       'unique' => [],
4916       'index'  => [],
4917       'foreign_keys' => [
4918                           { columns => [ 'sectornum' ],
4919                             table   => 'tower_sector'
4920                           },
4921                         ],
4922     },
4923
4924     'part_virtual_field' => {
4925       'columns' => [
4926         'vfieldpart', 'serial', '', '', '', '',
4927         'dbtable', 'varchar', '', 32, '', '',
4928         'name', 'varchar', '', 32, '', '',
4929         'length', 'int', 'NULL', '', '', '',
4930         'label', 'varchar', 'NULL', 80, '', '',
4931       ],
4932       'primary_key' => 'vfieldpart',
4933       'unique' => [],
4934       'index' => [],
4935     },
4936
4937     'virtual_field' => {
4938       'columns' => [
4939         'vfieldnum', 'serial', '', '', '', '',
4940         'recnum', 'int', '', '', '', '',
4941         'vfieldpart', 'int', '', '', '', '',
4942         'value', 'varchar', '', 128, '', '',
4943       ],
4944       'primary_key'  => 'vfieldnum',
4945       'unique'       => [ [ 'vfieldpart', 'recnum' ] ],
4946       'index'        => [],
4947       'foreign_keys' => [
4948                           { columns    => [ 'vfieldpart' ],
4949                             table      => 'part_virtual_field',
4950                           },
4951                         ],
4952     },
4953
4954     'acct_snarf' => {
4955       'columns' => [
4956         'snarfnum',    'serial',     '',      '', '', '',
4957         'snarfname',  'varchar', 'NULL', $char_d, '', '',
4958         'svcnum',         'int',     '',      '', '', '',
4959         'machine',    'varchar',     '',     255, '', '',
4960         'protocol',   'varchar',     '', $char_d, '', '',
4961         'username',   'varchar',     '', $char_d, '', '',
4962         '_password',  'varchar',     '', $char_d, '', '',
4963         'check_freq',     'int', 'NULL',      '', '', '',
4964         'leavemail',     'char', 'NULL',       1, '', '',
4965         'apop',          'char', 'NULL',       1, '', '',
4966         'tls',           'char', 'NULL',       1, '', '',
4967         'mailbox',    'varchar', 'NULL', $char_d, '', '',
4968       ],
4969       'primary_key'  => 'snarfnum',
4970       'unique'       => [],
4971       'index'        => [ [ 'svcnum' ] ],
4972       'foreign_keys' => [
4973                           { columns    => [ 'svcnum' ],
4974                             table      => 'svc_acct',
4975                           },
4976                         ],
4977     },
4978
4979     'svc_external' => {
4980       'columns' => [
4981         'svcnum',     'int',     '',      '', '', '',
4982         'id',      'bigint', 'NULL',      '', '', '',
4983         'title',  'varchar', 'NULL', $char_d, '', '',
4984       ],
4985       'primary_key'  => 'svcnum',
4986       'unique'       => [],
4987       'index'        => [],
4988       'foreign_keys' => [
4989                           { columns    => [ 'svcnum' ],
4990                             table      => 'cust_svc',
4991                           },
4992                         ],
4993     },
4994
4995     'cust_pay_refund' => {
4996       'columns' => [
4997         'payrefundnum', 'serial', '', '', '', '',
4998         'paynum',  'int', '', '', '', '',
4999         'refundnum',  'int', '', '', '', '',
5000         '_date',    @date_type, '', '',
5001         'amount',   @money_type, '', '',
5002       ],
5003       'primary_key'  => 'payrefundnum',
5004       'unique'       => [],
5005       'index'        => [ ['paynum'], ['refundnum'] ],
5006       'foreign_keys' => [
5007                           { columns    => [ 'paynum' ],
5008                             table      => 'cust_pay',
5009                           },
5010                           { columns    => [ 'refundnum' ],
5011                             table      => 'cust_refund',
5012                           },
5013                         ],
5014     },
5015
5016     'part_pkg_option' => {
5017       'columns' => [
5018         'optionnum', 'serial', '', '', '', '',
5019         'pkgpart', 'int', '', '', '', '',
5020         'optionname', 'varchar', '', $char_d, '', '',
5021         'optionvalue', 'text', 'NULL', '', '', '',
5022       ],
5023       'primary_key'  => 'optionnum',
5024       'unique'       => [],
5025       'index'        => [ [ 'pkgpart' ], [ 'optionname' ] ],
5026       'foreign_keys' => [
5027                           { columns    => [ 'pkgpart' ],
5028                             table      => 'part_pkg',
5029                           },
5030                         ],
5031     },
5032
5033     'part_pkg_vendor' => {
5034       'columns' => [
5035         'num', 'serial', '', '', '', '',
5036         'pkgpart', 'int', '', '', '', '',
5037         'exportnum', 'int', '', '', '', '',
5038         'vendor_pkg_id', 'varchar', '', $char_d, '', '',
5039       ],
5040       'primary_key'  => 'num',
5041       'unique'       => [ [ 'pkgpart', 'exportnum' ] ],
5042       'index'        => [ [ 'pkgpart' ] ],
5043       'foreign_keys' => [
5044                           { columns    => [ 'pkgpart' ],
5045                             table      => 'part_pkg',
5046                           },
5047                           { columns    => [ 'exportnum' ],
5048                             table      => 'part_export',
5049                           },
5050                         ],
5051     },
5052
5053     'part_pkg_report_option' => {
5054       'columns' => [
5055         'num',      'serial',   '',      '', '', '',
5056         'name',     'varchar',  '', $char_d, '', '',
5057         'disabled', 'char', 'NULL',       1, '', '',
5058       ],
5059       'primary_key' => 'num',
5060       'unique' => [ [ 'name' ] ],
5061       'index' => [ [ 'disabled' ] ],
5062     },
5063
5064     'part_pkg_usage' => {
5065       'columns' => [
5066         'pkgusagepart', 'serial',   '', '', '', '',
5067         'pkgpart',  'int',      '', '', '', '',
5068         'minutes',  'double precision',      '', '', '', '',
5069         'priority', 'int',  'NULL', '', '', '',
5070         'shared',   'char', 'NULL',  1, '', '',
5071         'rollover', 'char', 'NULL',  1, '', '',
5072         'description',  'varchar', 'NULL', $char_d, '', '',
5073       ],
5074       'primary_key'  => 'pkgusagepart',
5075       'unique'       => [],
5076       'index'        => [ [ 'pkgpart' ] ],
5077       'foreign_keys' => [
5078                           { columns    => [ 'pkgpart' ],
5079                             table      => 'part_pkg',
5080                           },
5081                         ],
5082     },
5083
5084     'part_pkg_usage_class' => {
5085       'columns' => [
5086         'num',       'serial',  '', '', '', '',
5087         'pkgusagepart', 'int',  '', '', '', '',
5088         'classnum',     'int','NULL', '', '', '',
5089       ],
5090       'primary_key'  => 'num',
5091       'unique'       => [ [ 'pkgusagepart', 'classnum' ] ],
5092       'index'        => [],
5093       'foreign_keys' => [
5094                           { columns    => [ 'pkgusagepart' ],
5095                             table      => 'part_pkg_usage',
5096                           },
5097                           { columns    => [ 'classnum' ],
5098                             table      => 'usage_class',
5099                           },
5100                         ],
5101     },
5102
5103     'part_pkg_fcc_option' => {
5104       'columns' => [
5105         'num',        'serial', '', '', '', '',
5106         'fccoptionname', 'varchar', '', $char_d, '', '',
5107         'pkgpart',       'int', '', '', '', '',
5108         'optionvalue',   'varchar', 'NULL', $char_d, '', '',
5109       ],
5110       'primary_key' => 'num',
5111       'unique'      => [ [ 'fccoptionname', 'pkgpart' ] ],
5112       'index'       => [],
5113     },
5114
5115     'rate' => {
5116       'columns' => [
5117         'ratenum',          'serial',     '', '', '', '',
5118         'ratename',        'varchar', '',$char_d, '', '',
5119         'agentnum',            'int', 'NULL', '', '', '',
5120         'default_detailnum',   'int', 'NULL', '', '', '',
5121       ],
5122       'primary_key' => 'ratenum',
5123       'unique'      => [],
5124       'index'       => [],
5125       'foreign_keys' => [
5126                           { columns    => [ 'agentnum' ],
5127                             table      => 'agent',
5128                           },
5129                         ],
5130     },
5131
5132     'rate_detail' => {
5133       'columns' => [
5134         'ratedetailnum',   'serial',  '',     '',      '', '',
5135         'ratenum',         'int',     '',     '',      '', '',
5136         'orig_regionnum',  'int', 'NULL',     '',      '', '',
5137         'dest_regionnum',  'int', 'NULL',     '',      '', '',
5138         'min_included',    'int',     '',     '',      '', '',
5139         'conn_charge',     'decimal', '', '10,4', '0.0000', '',
5140         'conn_cost',       'decimal', '', '10,4', '0.0000', '',
5141         'conn_sec',        'int',     '',     '',      '0', '',
5142         'min_charge',      'decimal', '', '10,5',       '', '',
5143         'min_cost',        'decimal', '', '10,5','0.00000', '',
5144         'sec_granularity', 'int',     '',     '',       '', '',
5145         'ratetimenum',     'int', 'NULL',     '',       '', '',
5146         'classnum',        'int', 'NULL',     '',       '', '',
5147         'cdrtypenum',      'int', 'NULL',     '',       '', '',
5148         'region_group',   'char', 'NULL',      1,       '', '',
5149         'upstream_mult_charge',  'decimal',  '', '10,4', '0.0000', '',
5150         'upstream_mult_cost',    'decimal',  '', '10,4', '0.0000', '',
5151       ],
5152       'primary_key'  => 'ratedetailnum',
5153       'unique'       => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
5154       'index'        => [ [ 'ratenum', 'dest_regionnum' ],
5155                           [ 'ratenum', 'ratetimenum' ]
5156                         ],
5157       'foreign_keys' => [
5158                           { columns    => [ 'ratenum' ],
5159                             table      => 'rate',
5160                           },
5161                           { columns    => [ 'orig_regionnum' ],
5162                             table      => 'rate_region',
5163                             references => [ 'regionnum' ],
5164                           },
5165                           { columns    => [ 'dest_regionnum' ],
5166                             table      => 'rate_region',
5167                             references => [ 'regionnum' ],
5168                           },
5169                           { columns    => [ 'ratetimenum' ],
5170                             table      => 'rate_time',
5171                           },
5172                           { columns    => [ 'classnum' ],
5173                             table      => 'usage_class',
5174                           },
5175                           { columns    => [ 'cdrtypenum' ],
5176                             table      => 'cdr_type',
5177                           },
5178                         ],
5179     },
5180
5181     'rate_region' => {
5182       'columns' => [
5183         'regionnum',   'serial',      '', '', '', '',
5184         'regionname',  'varchar',     '', $char_d, '', '',
5185         'exact_match', 'char',    'NULL',  1, '', '',
5186       ],
5187       'primary_key' => 'regionnum',
5188       'unique'      => [],
5189       'index'       => [],
5190     },
5191
5192     'rate_prefix' => {
5193       'columns' => [
5194         'prefixnum',   'serial',      '', '', '', '',
5195         'regionnum',   'int',         '', '', '', '',
5196         'countrycode', 'varchar',     '',  3, '', '',
5197         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
5198         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
5199         'latanum',     'int',     'NULL',      '', '', '',
5200         'state',       'char',    'NULL',       2, '', '',
5201         'ocn',         'char',    'NULL',       4, '', '',
5202       ],
5203       'primary_key'  => 'prefixnum',
5204       'unique'       => [],
5205       'index'        => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
5206       'foreign_keys' => [
5207                           { columns    => [ 'regionnum' ],
5208                             table      => 'rate_region',
5209                           },
5210                           { columns    => [ 'latanum' ],
5211                             table      => 'lata',
5212                           },
5213                         ],
5214     },
5215
5216     'rate_time' => {
5217       'columns' => [
5218         'ratetimenum', 'serial',      '',      '', '', '',
5219         'ratetimename',   'varchar',      '', $char_d, '', '',
5220       ],
5221       'primary_key' => 'ratetimenum',
5222       'unique'      => [],
5223       'index'       => [],
5224     },
5225
5226     'rate_time_interval' => {
5227       'columns' => [
5228         'intervalnum', 'serial', '', '', '', '',
5229         'stime',          'int', '', '', '', '',
5230         'etime',          'int', '', '', '', '',
5231         'ratetimenum',    'int', '', '', '', '',
5232       ],
5233       'primary_key'  => 'intervalnum',
5234       'unique'       => [],
5235       'index'        => [],
5236       'foreign_keys' => [
5237                           { columns    => [ 'ratetimenum' ],
5238                             table      => 'rate_time',
5239                           },
5240                         ],
5241      },
5242
5243     #not really part of the above rate_ stuff (used with flat rate rather than
5244     # rated billing), but could be eventually, and its a rate
5245     'rate_tier' => {
5246       'columns' => [
5247         'tiernum',   'serial', '',      '', '', '',
5248         'tiername', 'varchar', '', $char_d, '', '',
5249       ],
5250       'primary_key' => 'tiernum',
5251       'unique'      => [ [ 'tiername'], ],
5252       'index'       => [],
5253     },
5254
5255     'rate_tier_detail' => {
5256       'columns' => [
5257         'tierdetailnum', 'serial', '',     '', '', '',
5258         'tiernum',          'int', '',     '', '', '',
5259         'min_quan',         'int', '',     '', '', '',
5260         'min_charge',   'decimal', '', '10,4', '', '',
5261       ],
5262       'primary_key'  => 'tierdetailnum',
5263       'unique'       => [],
5264       'index'        => [ ['tiernum'], ],
5265       'foreign_keys' => [
5266                           { columns    => [ 'tiernum' ],
5267                             table      => 'rate_tier',
5268                           },
5269                         ],
5270     },
5271
5272     'usage_class' => {
5273       'columns' => [
5274         'classnum',    'serial',      '',      '', '', '',
5275         'weight',      'int',     'NULL',      '', '', '',
5276         'classname',   'varchar',     '', $char_d, '', '',
5277         'format',      'varchar', 'NULL', $char_d, '', '',
5278         'disabled',    'char',    'NULL',       1, '', '',
5279       ],
5280       'primary_key' => 'classnum',
5281       'unique' => [],
5282       'index' => [ ['disabled'] ],
5283     },
5284
5285     'reg_code' => {
5286       'columns' => [
5287         'codenum',   'serial',    '', '', '', '',
5288         'code',      'varchar',   '', $char_d, '', '',
5289         'agentnum',  'int',       '', '', '', '',
5290       ],
5291       'primary_key'  => 'codenum',
5292       'unique'       => [ [ 'agentnum', 'code' ] ],
5293       'index'        => [ [ 'agentnum' ] ],
5294       'foreign_keys' => [
5295                           { columns    => [ 'agentnum' ],
5296                             table      => 'agent',
5297                           },
5298                         ],
5299      },
5300
5301     'reg_code_pkg' => {
5302       'columns' => [
5303         'codepkgnum', 'serial', '', '', '', '',
5304         'codenum',   'int',    '', '', '', '',
5305         'pkgpart',   'int',    '', '', '', '',
5306       ],
5307       'primary_key'  => 'codepkgnum',
5308       'unique'       => [ [ 'codenum', 'pkgpart' ] ],
5309       'index'        => [ [ 'codenum' ] ],
5310       'foreign_keys' => [
5311                           { columns    => [ 'codenum' ],
5312                             table      => 'reg_code',
5313                           },
5314                           { columns    => [ 'pkgpart' ],
5315                             table      => 'part_pkg',
5316                           },
5317                         ],
5318     },
5319
5320     'clientapi_session' => {
5321       'columns' => [
5322         'sessionnum',  'serial',  '', '', '', '',
5323         'sessionid',  'varchar',  '', $char_d, '', '',
5324         'namespace',  'varchar',  '', $char_d, '', '',
5325       ],
5326       'primary_key' => 'sessionnum',
5327       'unique'      => [ [ 'sessionid', 'namespace' ] ],
5328       'index'       => [],
5329     },
5330
5331     'clientapi_session_field' => {
5332       'columns' => [
5333         'fieldnum',    'serial',     '', '', '', '',
5334         'sessionnum',     'int',     '', '', '', '',
5335         'fieldname',  'varchar',     '', $char_d, '', '',
5336         'fieldvalue',    'text', 'NULL', '', '', '',
5337       ],
5338       'primary_key'  => 'fieldnum',
5339       'unique'       => [ [ 'sessionnum', 'fieldname' ] ],
5340       'index'        => [],
5341       'foreign_keys' => [
5342                           { columns    => [ 'sessionnum' ],
5343                             table      => 'clientapi_session',
5344                           },
5345                         ],
5346     },
5347
5348     'payment_gateway' => {
5349       'columns' => [
5350         'gatewaynum',       'serial',   '',     '', '', '',
5351         'gateway_namespace','varchar',  'NULL', $char_d, '', '',
5352         'gateway_module',   'varchar',  '',     $char_d, '', '',
5353         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
5354         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
5355         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
5356         'gateway_callback_url', 'varchar',  'NULL', 255, '', '',
5357         'gateway_cancel_url',   'varchar',  'NULL', 255, '', '',
5358         'disabled',   'char',  'NULL',   1, '', '',
5359       ],
5360       'primary_key' => 'gatewaynum',
5361       'unique' => [],
5362       'index'  => [ [ 'disabled' ] ],
5363     },
5364
5365     'payment_gateway_option' => {
5366       'columns' => [
5367         'optionnum',   'serial',  '',     '', '', '',
5368         'gatewaynum',  'int',     '',     '', '', '',
5369         'optionname',  'varchar', '',     $char_d, '', '',
5370         'optionvalue', 'text',    'NULL', '', '', '',
5371       ],
5372       'primary_key'  => 'optionnum',
5373       'unique'       => [],
5374       'index'        => [ [ 'gatewaynum' ], [ 'optionname' ] ],
5375       'foreign_keys' => [
5376                           { columns    => [ 'gatewaynum' ],
5377                             table      => 'payment_gateway',
5378                           },
5379                         ],
5380     },
5381
5382     'agent_payment_gateway' => {
5383       'columns' => [
5384         'agentgatewaynum', 'serial', '', '', '', '',
5385         'agentnum',        'int', '', '', '', '',
5386         'gatewaynum',      'int', '', '', '', '',
5387         'cardtype',        'varchar', 'NULL', $char_d, '', '',
5388         'taxclass',        'varchar', 'NULL', $char_d, '', '',
5389       ],
5390       'primary_key'  => 'agentgatewaynum',
5391       'unique'       => [],
5392       'index'        => [ [ 'agentnum', 'cardtype' ], ],
5393
5394       'foreign_keys' => [
5395
5396                           { columns    => [ 'agentnum' ],
5397                             table      => 'agent',
5398                           },
5399                           { columns    => [ 'gatewaynum' ],
5400                             table      => 'payment_gateway',
5401                           },
5402                         ],
5403     },
5404
5405     'banned_pay' => {
5406       'columns' => [
5407         'bannum',        'serial',     '',      '', '', '',
5408         'payby',           'char',     '',       4, '', '',
5409         'payinfo',      'varchar',     '',     128, '', '', #say, a 512-big digest _hex encoded
5410         'payinfo_hash', 'varchar', 'NULL',      32, '', '',
5411         #'paymask',      'varchar',  'NULL', $char_d, '', ''
5412         '_date',                @date_type,         '', '',
5413         'end_date',             @date_type,         '', '',
5414         'otaker',       'varchar', 'NULL',      32, '', '',
5415         'usernum',          'int', 'NULL',      '', '', '',
5416         'bantype',      'varchar', 'NULL', $char_d, '', '',
5417         'reason',       'varchar', 'NULL', $char_d, '', '',
5418       ],
5419       'primary_key'  => 'bannum',
5420       'unique'       => [],
5421       'index'        => [ [ 'payby', 'payinfo' ], [ 'usernum' ], ],
5422       'foreign_keys' => [
5423                           { columns    => [ 'usernum' ],
5424                             table      => 'access_user',
5425                           },
5426                         ],
5427     },
5428
5429     'pkg_category' => {
5430       'columns' => [
5431         'categorynum',        'serial',     '',      '', '', '',
5432         'categoryname',      'varchar',     '', $char_d, '', '',
5433         'weight',                'int', 'NULL',      '', '', '',
5434         'ticketing_queueid',     'int', 'NULL',      '', '', '',
5435         'condense',             'char', 'NULL',       1, '', '',
5436         'disabled',             'char', 'NULL',       1, '', '',
5437       ],
5438       'primary_key' => 'categorynum',
5439       'unique' => [],
5440       'index' => [ ['disabled'] ],
5441     },
5442
5443     'pkg_class' => {
5444       'columns' => [
5445         'classnum',    'serial',   '',      '', '', '',
5446         'classname',   'varchar',  '', $char_d, '', '',
5447         'categorynum', 'int',  'NULL',      '', '', '',
5448         'disabled',    'char', 'NULL',       1, '', '',
5449         'fcc_ds0s',      'int',     'NULL', '', '', '',
5450       ],
5451       'primary_key'  => 'classnum',
5452       'unique'       => [],
5453       'index'        => [ ['disabled'] ],
5454       'foreign_keys' => [
5455                           { columns    => [ 'categorynum' ],
5456                             table      => 'pkg_category',
5457                           },
5458                         ],
5459     },
5460
5461     'cdr' => {
5462       'columns' => [
5463         # qw( name type null length default local );
5464
5465         ###
5466         #asterisk fields
5467         ###
5468
5469         'acctid',   'bigserial',  '', '', '', '',
5470         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
5471         'calldate', 'timestamp',   '',      '', \'now()', '',
5472         'clid',        'varchar',  '', $char_d, \"''", '',
5473         'src',         'varchar',  '', $char_d, \"''", '',
5474         'dst',         'varchar',  '', $char_d, \"''", '',
5475         'dcontext',    'varchar',  '', $char_d, \"''", '',
5476         'channel',     'varchar',  '', $char_d, \"''", '',
5477         'dstchannel',  'varchar',  '', $char_d, \"''", '',
5478         'lastapp',     'varchar',  '', $char_d, \"''", '',
5479         'lastdata',    'varchar',  '',     255, \"''", '',
5480
5481         #currently only opensips & voipswitch
5482         'src_ip_addr', 'varchar',  'NULL',  15,    '', '',
5483
5484         #currently only opensips
5485         'dst_ip_addr', 'varchar',  'NULL',  15,    '', '',
5486
5487         #currently only u4:
5488         # terminating number (as opposed to dialed destination)
5489         'dst_term',    'varchar',  'NULL', $char_d, '', '',
5490
5491         #these don't seem to be logged by most of the SQL cdr_* modules
5492         #except tds under sql-illegal names, so;
5493         # ... don't rely on them for rating?
5494         # and, what they hey, i went ahead and changed the names and data types
5495         # to freeside-style dates...
5496           #'start',  'timestamp', 'NULL',  '',    '', '',
5497           #'answer', 'timestamp', 'NULL',  '',    '', '',
5498           #'end',    'timestamp', 'NULL',  '',    '', '',
5499         'startdate',  @date_type, '', '',
5500         'answerdate', @date_type, '', '',
5501         'enddate',    @date_type, '', '',
5502         #
5503
5504         'duration',    'int',      '',      '',     0, '',
5505         'billsec',     'int',      '',      '',     0, '',
5506         'disposition', 'varchar',  '',      45, \"''", '',
5507         'amaflags',    'int',      '',      '',     0, '',
5508         'accountcode', 'varchar',  '',      32, \"''", '',
5509         'uniqueid',    'varchar',  '', $char_d, \"''", '',
5510         'userfield',   'varchar',  '',     512, \"''", '',
5511
5512         'max_callers', 'int',  'NULL',      '',    '', '',
5513
5514         ###
5515         # old fields for unitel/RSLCOM/convergent that don't map to asterisk
5516         # ones we adoped moved to "own fields" section below
5517         # charged_party, upstream_price, rated_price, carrierid, cdrtypenum
5518         ###
5519
5520         'upstream_currency',      'char', 'NULL',       3, '', '',
5521         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
5522
5523         # how it was rated internally...
5524         'ratedetailnum',           'int', 'NULL',      '', '', '',
5525
5526         'distance',            'decimal', 'NULL',      '', '', '',
5527         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
5528
5529         #cdr_calltype: the big list in appendix 2
5530         'calltypenum',             'int', 'NULL',      '', '', '',
5531
5532         'description',         'varchar', 'NULL', $char_d, '', '',
5533         'quantity',                'int', 'NULL',      '', '', '',
5534
5535         'upstream_rateid',         'int', 'NULL',      '', '', '',
5536
5537         ###
5538         # more fields, for GSM imports
5539         ###
5540         'servicecode',             'int', 'NULL',      '', '', '',
5541         'quantity_able',           'int', 'NULL',      '', '', '',
5542
5543         ###
5544         #and now for our own fields
5545         ###
5546
5547         'cdrtypenum',              'int', 'NULL',      '', '', '',
5548
5549         'charged_party',       'varchar', 'NULL', $char_d, '', '',
5550         'charged_party_imsi',  'varchar', 'NULL', $char_d, '', '',
5551
5552         'upstream_price',      'decimal', 'NULL',  '10,5', '', '',
5553
5554         #currently only voipswitch
5555         #'upstream_rate',      'decimal', 'NULL',  '10,5', '', '',
5556
5557         'upstream_src_regionname', 'varchar', 'NULL', $char_d, '', '',
5558         'upstream_dst_regionname', 'varchar', 'NULL', $char_d, '', '',
5559
5560         # how it was rated internally...
5561         'rated_pretty_dst',       'varchar', 'NULL', $char_d, '', '',
5562         'rated_regionname',       'varchar', 'NULL', $char_d, '', '',
5563         'rated_price',            'decimal', 'NULL',  '10,4', '', '',
5564         'rated_seconds',              'int', 'NULL',      '', '', '',
5565         'rated_minutes', 'double precision', 'NULL',      '', '', '',
5566         'rated_granularity',          'int', 'NULL',      '', '', '',
5567         'rated_ratedetailnum',        'int', 'NULL',      '', '', '',
5568         'rated_classnum',             'int', 'NULL',      '', '', '',
5569         'rated_ratename',         'varchar', 'NULL', $char_d, '', '',
5570         'rated_cost',            'decimal', 'NULL',  '10,4', '', '',
5571
5572         # real endpoints of the call
5573         'src_lrn',             'varchar', 'NULL',     '15', '', '',
5574         'dst_lrn',             'varchar', 'NULL',     '15', '', '',
5575
5576         'carrierid',               'bigint', 'NULL',      '', '', '',
5577
5578         # service it was matched to
5579         'svcnum',             'int',   'NULL',     '',   '', '',
5580
5581         #NULL, done (or something)
5582         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
5583
5584         #NULL, done (or something)
5585         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '',
5586
5587         #an indexed place to put big numbers
5588         'cdrid',         'bigint',     'NULL',     '',  '', '',
5589
5590         #for taqua accountcode rewriting, for starters
5591         'sessionnum',       'int',    'NULL',      '', '', '',
5592         'subscriber',   'varchar',    'NULL', $char_d, '', '',
5593
5594         #old
5595         'cdrbatch',     'varchar',    'NULL',     255, '', '',
5596         #new
5597         'cdrbatchnum',      'int',    'NULL',      '', '', '',
5598
5599         # FK to cust_bill_pkg_detail; having a value here absolutely means
5600         # that the CDR appears on an invoice
5601         'detailnum',     'bigint',    'NULL',      '', '', '',
5602       ],
5603       'primary_key' => 'acctid',
5604       'unique' => [],
5605       'index' => [ [ 'calldate' ],
5606                    [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
5607                    [ 'lastapp' ],
5608                    ['accountcode'], ['uniqueid'], ['carrierid'], ['cdrid'],
5609                    [ 'sessionnum' ], [ 'subscriber' ],
5610                    [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
5611                    [ 'cdrbatch' ], [ 'cdrbatchnum' ],
5612                    [ 'src_ip_addr' ], [ 'dst_ip_addr' ], [ 'dst_term' ],
5613                    [ 'detailnum' ],
5614                  ],
5615       #no FKs on cdr table... choosing not to throw errors no matter what's
5616       # thrown in here.  better to have the data.
5617     },
5618
5619     'cdr_batch' => {
5620       'columns' => [
5621         'cdrbatchnum',   'serial',    '',   '', '', '',
5622         'cdrbatch', 'varchar', 'NULL', 255, '', '',
5623         '_date',     @date_type, '', '',
5624       ],
5625       'primary_key' => 'cdrbatchnum',
5626       'unique' => [ [ 'cdrbatch' ] ],
5627       'index' => [],
5628     },
5629
5630     'cdr_termination' => {
5631       'columns' => [
5632         'cdrtermnum', 'bigserial',     '',      '', '', '',
5633         'acctid',        'bigint',     '',      '', '', '',
5634         'termpart',         'int',     '',      '', '', '',#future use see below
5635         'rated_price',  'decimal', 'NULL',  '10,4', '', '',
5636         'rated_seconds',    'int', 'NULL',      '', '', '',
5637         'rated_minutes', 'double precision', 'NULL',   '', '', '',
5638         'rated_granularity','int', 'NULL',      '', '', '',
5639         'status',       'varchar', 'NULL',      32, '', '',
5640         'svcnum',           'int', 'NULL',      '', '', '',
5641       ],
5642       'primary_key'  => 'cdrtermnum',
5643       'unique'       => [ [ 'acctid', 'termpart' ] ],
5644       'index'        => [ [ 'acctid' ], [ 'status' ], ],
5645       'foreign_keys' => [
5646                           { columns    => [ 'acctid' ],
5647                             table      => 'cdr',
5648                           },
5649                           { columns    => [ 'svcnum' ],
5650                             table      => 'cust_svc',
5651                           },
5652                         ],
5653     },
5654
5655     #to handle multiple termination/settlement passes...
5656    # 'part_termination' => {
5657    #   'columns' => [
5658    #     'termpart',       'int', '',      '', '', '',
5659    #     'termname',   'varchar', '', $char_d, '', '',
5660    #     'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
5661    #   ],
5662    #   'primary_key' => 'termpart',
5663    #   'unique' => [],
5664    #   'index'  => [],
5665    # },
5666
5667     #the remaining cdr_ tables are not really used
5668     'cdr_calltype' => {
5669       'columns' => [
5670         'calltypenum',   'serial',  '', '', '', '',
5671         'calltypename',  'varchar', '', $char_d, '', '',
5672       ],
5673       'primary_key' => 'calltypenum',
5674       'unique'      => [],
5675       'index'       => [],
5676     },
5677
5678     'cdr_type' => {
5679       'columns' => [
5680         'cdrtypenum'  => 'serial',  '', '', '', '',
5681         'cdrtypename' => 'varchar', '', $char_d, '', '',
5682       ],
5683       'primary_key' => 'cdrtypenum',
5684       'unique'      => [],
5685       'index'       => [],
5686     },
5687
5688     'cdr_carrier' => {
5689       'columns' => [
5690         'carrierid'   =>  'serial',     '',      '', '', '',
5691         'carriername' => 'varchar',     '', $char_d, '', '',
5692         'disabled'    =>    'char', 'NULL',       1, '', '',
5693       ],
5694       'primary_key' => 'carrierid',
5695       'unique'      => [],
5696       'index'       => [],
5697     },
5698
5699     #'cdr_file' => {
5700     #  'columns' => [
5701     #    'filenum',    'serial',     '', '', '', '',
5702     #    'filename',  'varchar',     '', '', '', '',
5703     #    'status',    'varchar', 'NULL', '', '', '',
5704     #  ],
5705     #  'primary_key' => 'filenum',
5706     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
5707     #                                   # agent-virtualize or have a customer
5708     #                                   # with dup-filename needs or something
5709     #                                   # (only used by cdr.http_and_import for
5710     #                                   #  chrissakes)
5711     #  'index'  => [],
5712     #},
5713
5714     'inventory_item' => {
5715       'columns' => [
5716         'itemnum',   'serial',      '',      '', '', '',
5717         'classnum',  'int',         '',      '', '', '',
5718         'agentnum',  'int',     'NULL',      '', '', '',
5719         'item',      'varchar',     '', $char_d, '', '',
5720         'svcnum',    'int',     'NULL',      '', '', '',
5721         'svc_field', 'varchar', 'NULL', $char_d, '', '',
5722       ],
5723       'primary_key'  => 'itemnum',
5724       'unique'       => [ [ 'classnum', 'item' ] ],
5725       'index'        => [ [ 'classnum' ], [ 'agentnum' ], [ 'svcnum' ] ],
5726       'foreign_keys' => [
5727                           { columns    => [ 'classnum' ],
5728                             table      => 'inventory_class',
5729                           },
5730                           { columns    => [ 'agentnum' ],
5731                             table      => 'agent',
5732                           },
5733                           { columns    => [ 'svcnum' ],
5734                             table      => 'cust_svc',
5735                           },
5736                         ],
5737     },
5738
5739     'inventory_class' => {
5740       'columns' => [
5741         'classnum',  'serial',       '',      '', '', '',
5742         'classname', 'varchar',      '', $char_d, '', '',
5743       ],
5744       'primary_key' => 'classnum',
5745       'unique' => [],
5746       'index'  => [],
5747     },
5748
5749     'access_user_session' => {
5750       'columns' => [
5751         'sessionnum',   'serial',  '',      '', '', '',
5752         'sessionkey',  'varchar',  '', $char_d, '', '',
5753         'usernum',         'int',  '',      '', '', '',
5754         'start_date', @date_type,               '', '',
5755         'last_date',  @date_type,               '', '',
5756       ],
5757       'primary_key'  => 'sessionnum',
5758       'unique'       => [ [ 'sessionkey' ] ],
5759       'index'        => [],
5760       'foreign_keys' => [
5761                           { columns    => [ 'usernum' ],
5762                             table      => 'access_user',
5763                           },
5764                         ],
5765     },
5766
5767     'access_user' => {
5768       'columns' => [
5769         'usernum',             'serial',     '',      '', '', '',
5770         'username',           'varchar',     '', $char_d, '', '',
5771         '_password',          'varchar', 'NULL', $char_d, '', '',
5772         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
5773         'last',               'varchar', 'NULL', $char_d, '', '',
5774         'first',              'varchar', 'NULL', $char_d, '', '',
5775         'user_custnum',           'int', 'NULL',      '', '', '',
5776         'report_salesnum',        'int', 'NULL',      '', '', '',
5777         'disabled',              'char', 'NULL',       1, '', '',
5778       ],
5779       'primary_key'  => 'usernum',
5780       'unique'       => [ [ 'username' ] ],
5781       'index'        => [ [ 'user_custnum' ] ],
5782       'foreign_keys' => [
5783                           { columns    => [ 'user_custnum' ],
5784                             table      => 'cust_main',
5785                             references => [ 'custnum' ],
5786                           },
5787                           { columns    => [ 'report_salesnum' ],
5788                             table      => 'sales',
5789                             references => [ 'salesnum' ],
5790                           },
5791                         ],
5792     },
5793
5794     'access_user_pref' => {
5795       'columns' => [
5796         'prefnum',    'serial',       '', '', '', '',
5797         'usernum',     'int',       '', '', '', '',
5798         'prefname', 'varchar', '', $char_d, '', '',
5799         'prefvalue', 'text', 'NULL', '', '', '',
5800         'expiration', @date_type, '', '',
5801       ],
5802       'primary_key'  => 'prefnum',
5803       'unique'       => [],
5804       'index'        => [ [ 'usernum' ] ],
5805       'foreign_keys' => [
5806                           { columns    => [ 'usernum' ],
5807                             table      => 'access_user',
5808                           },
5809                         ],
5810     },
5811
5812     'access_group' => {
5813       'columns' => [
5814         'groupnum',   'serial', '',      '', '', '',
5815         'groupname', 'varchar', '', $char_d, '', '',
5816       ],
5817       'primary_key' => 'groupnum',
5818       'unique' => [ [ 'groupname' ] ],
5819       'index'  => [],
5820     },
5821
5822     'access_usergroup' => {
5823       'columns' => [
5824         'usergroupnum', 'serial', '', '', '', '',
5825         'usernum',         'int', '', '', '', '',
5826         'groupnum',        'int', '', '', '', '',
5827       ],
5828       'primary_key'  => 'usergroupnum',
5829       'unique'       => [ [ 'usernum', 'groupnum' ] ],
5830       'index'        => [ [ 'usernum' ] ],
5831       'foreign_keys' => [
5832                           { columns    => [ 'usernum' ],
5833                             table      => 'access_user',
5834                           },
5835                           { columns    => [ 'groupnum' ],
5836                             table      => 'access_group',
5837                           },
5838                         ],
5839      },
5840
5841     'access_groupagent' => {
5842       'columns' => [
5843         'groupagentnum', 'serial', '', '', '', '',
5844         'groupnum',         'int', '', '', '', '',
5845         'agentnum',         'int', '', '', '', '',
5846       ],
5847       'primary_key'  => 'groupagentnum',
5848       'unique'       => [ [ 'groupnum', 'agentnum' ] ],
5849       'index'        => [ [ 'groupnum' ] ],
5850       'foreign_keys' => [
5851                           { columns    => [ 'groupnum' ],
5852                             table      => 'access_group',
5853                           },
5854                           { columns    => [ 'agentnum' ],
5855                             table      => 'agent',
5856                           },
5857                         ],
5858     },
5859
5860     'access_right' => {
5861       'columns' => [
5862         'rightnum',   'serial', '',      '', '', '',
5863         'righttype', 'varchar', '', $char_d, '', '',
5864         'rightobjnum',   'int', '',      '', '', '',
5865         'rightname', 'varchar', '', $char_d, '', '',
5866       ],
5867       'primary_key' => 'rightnum',
5868       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
5869       'index'  => [],
5870     },
5871
5872     'access_user_log' => {
5873       'columns'      => [
5874         'lognum',          'serial',     '',        '', '', '',
5875         'usernum',            'int',     '',        '', '', '',
5876         'path',           'varchar',     '', 2*$char_d, '', '',
5877         '_date',                   @date_type,          '', '',
5878         'render_seconds',     'int', 'NULL',        '', '', '',
5879       ],
5880       'primary_key'  => 'lognum',
5881       'unique'       => [],
5882       'index'        => [ ['usernum'], ['path'], ['_date'] ],
5883     },
5884
5885     'access_user_page_pref' => {
5886       'columns'     => [
5887         'prefnum'     =>  'serial',     '',      '', '', '',
5888         'usernum'     =>     'int',     '',      '', '', '',
5889         'path'        =>    'text',     '',      '', '', '',
5890         'tablenum'    =>     'int', 'NULL',      '', '', '',
5891         '_date'       =>    @date_type,              '', '',
5892         'prefname'    =>    'varchar',  '', $char_d, '', '',
5893         'prefvalue'   =>    'text',     '',      '', '', '',
5894       ],
5895       'primary_key' => 'prefnum',
5896       'unique'      => [ [ 'usernum', 'path', 'tablenum', 'prefname' ] ],
5897       'index'       => [],
5898       'foreign_keys' => [
5899                           { columns   => [ 'usernum' ],
5900                             table     => 'access_user'
5901                           },
5902                         ],
5903     },
5904
5905     'sched_item' => {
5906       'columns' => [
5907         'itemnum',   'serial',      '', '', '', '',
5908         'usernum',      'int',  'NULL', '', '', '',
5909         #'itemname', 'varchar', $char_d, '', '', '',
5910         'disabled',    'char',  'NULL',  1, '', '',
5911       ],
5912       'primary_key'  => 'itemnum',
5913       'unique'       => [ [ 'usernum' ] ],
5914       'index'        => [],
5915       'foreign_keys' => [
5916                           { columns    => [ 'usernum' ],
5917                             table      => 'access_user',
5918                           },
5919                         ],
5920     },
5921
5922     #'sched_item_class'
5923
5924     'sched_avail' => {
5925       'columns' => [
5926         'availnum',      'serial', '', '', '', '',
5927         'itemnum',          'int', '', '', '', '',
5928         'wday',             'int', '', '', '', '',
5929         'stime',            'int', '', '', '', '',
5930         'etime',            'int', '', '', '', '',
5931         'override_date',    @date_type,    '', '',
5932       ],
5933       'primary_key'  => 'availnum',
5934       'unique'       => [],
5935       'index'        => [],
5936       'foreign_keys' => [
5937                           { columns    => [ 'itemnum' ],
5938                             table      => 'sched_item',
5939                           },
5940                         ],
5941     },
5942
5943     'svc_phone' => {
5944       'columns' => [
5945         'svcnum',                         'int',     '',      '', '', '',
5946         'countrycode',                'varchar',     '',       3, '', '',
5947         'phonenum',                   'varchar',     '',      25, '', '', #12 ?
5948         'sim_imsi',                   'varchar', 'NULL',      15, '', '',
5949         'pin',                        'varchar', 'NULL', $char_d, '', '',
5950         'sip_password',               'varchar', 'NULL', $char_d, '', '',
5951         'phone_name',                 'varchar', 'NULL', $char_d, '', '',
5952         'pbxsvc',                         'int', 'NULL',      '', '', '',
5953         'domsvc',                         'int', 'NULL',      '', '', '',
5954         'locationnum',                    'int', 'NULL',      '', '', '',
5955         'forward_svcnum',                 'int', 'NULL',      '', '', '',
5956         'forwarddst',                 'varchar', 'NULL',      15, '', '',
5957         'email',                      'varchar', 'NULL',     255, '', '',
5958         'lnp_status',                 'varchar', 'NULL', $char_d, '', '',
5959         'portable',                      'char', 'NULL',       1, '', '',
5960         'lrn',                           'char', 'NULL',      10, '', '',
5961         'lnp_desired_due_date',           'int', 'NULL',      '', '', '',
5962         'lnp_due_date',                   'int', 'NULL',      '', '', '',
5963         'lnp_other_provider',         'varchar', 'NULL', $char_d, '', '',
5964         'lnp_other_provider_account', 'varchar', 'NULL', $char_d, '', '',
5965         'lnp_reject_reason',          'varchar', 'NULL', $char_d, '', '',
5966         'sms_carrierid',                  'int', 'NULL',      '', '', '',
5967         'sms_account',                'varchar', 'NULL', $char_d, '', '',
5968         'max_simultaneous',               'int', 'NULL',      '', '', '',
5969         'e911_class',                    'char', 'NULL',       1, '', '',
5970         'e911_type',                     'char', 'NULL',       1, '', '',
5971         'circuit_svcnum',                 'int', 'NULL',      '', '', '',
5972         'sip_server',                 'varchar', 'NULL', $char_d, '', '',
5973       ],
5974       'primary_key'  => 'svcnum',
5975       'unique'       => [ [ 'sms_carrierid', 'sms_account'] ],
5976       'index'        => [ ['countrycode', 'phonenum'], ['pbxsvc'], ['domsvc'],
5977                           ['locationnum'], ['sms_carrierid'],
5978                         ],
5979       'foreign_keys' => [
5980                           { columns    => [ 'svcnum' ],
5981                             table      => 'cust_svc',
5982                           },
5983                           { columns    => [ 'pbxsvc' ],
5984                             table      => 'svc_pbx', #'cust_svc',
5985                             references => [ 'svcnum' ],
5986                           },
5987                           { columns    => [ 'domsvc' ],
5988                             table      => 'svc_domain', #'cust_svc',
5989                             references => [ 'svcnum' ],
5990                           },
5991                           { columns    => [ 'locationnum' ],
5992                             table      => 'cust_location',
5993                           },
5994                           { columns    => [ 'sms_carrierid' ],
5995                             table      => 'cdr_carrier',
5996                             references => [ 'carrierid' ],
5997                           },
5998                           { columns    => [ 'circuit_svcnum' ],
5999                             table      => 'svc_circuit',
6000                             references => [ 'svcnum' ],
6001                           },
6002                         ],
6003     },
6004
6005     'phone_device' => {
6006       'columns' => [
6007         'devicenum', 'serial',     '', '', '', '',
6008         'devicepart',   'int',     '', '', '', '',
6009         'svcnum',       'int',     '', '', '', '',
6010         'mac_addr', 'varchar', 'NULL', 12, '', '',
6011       ],
6012       'primary_key'  => 'devicenum',
6013       'unique'       => [ [ 'mac_addr' ], ],
6014       'index'        => [ [ 'devicepart' ], [ 'svcnum' ], ],
6015       'foreign_keys' => [
6016                           { columns    => [ 'devicepart' ],
6017                             table      => 'part_device',
6018                           },
6019                           { columns    => [ 'svcnum' ],
6020                             table      => 'svc_phone',
6021                           },
6022                         ],
6023     },
6024
6025     'part_device' => {
6026       'columns' => [
6027         'devicepart', 'serial',  '',      '', '', '',
6028         'devicename', 'varchar', '', $char_d, '', '',
6029         'inventory_classnum', 'int', 'NULL', '', '', '',
6030         'title',      'varchar', 'NULL', $char_d, '', '',
6031       ],
6032       'primary_key'  => 'devicepart',
6033       'unique'       => [ [ 'devicename' ] ], #?
6034       'index'        => [],
6035       'foreign_keys' => [
6036                           { columns    => [ 'inventory_classnum' ],
6037                             table      => 'inventory_class',
6038                             references => [ 'classnum' ],
6039                           },
6040                         ],
6041     },
6042
6043     'phone_avail' => {
6044       'columns' => [
6045         'availnum',    'serial',      '',      '', '', '',
6046         'exportnum',   'int',         '',      '', '', '',
6047         'countrycode', 'varchar',     '',       3, '', '',
6048         'state',       'char',    'NULL',       2, '', '',
6049         'npa',         'char',        '',       3, '', '',
6050         'nxx',         'char',    'NULL',       3, '', '',
6051         'station',     'char',    'NULL',       4, '', '',
6052         'name',        'varchar', 'NULL', $char_d, '', '',
6053         'rate_center_abbrev', 'varchar', 'NULL', $char_d, '', '',
6054         'latanum',      'int',     'NULL',      '', '', '',
6055         'msanum',       'int', 'NULL', '', '', '',
6056         'ordernum',      'int',     'NULL',      '', '', '',
6057         'svcnum',      'int',     'NULL',      '', '', '',
6058         'availbatch', 'varchar',  'NULL', $char_d, '', '',
6059       ],
6060       'primary_key'  => 'availnum',
6061       'unique'       => [],
6062       'index'        => [ ['exportnum','countrycode','state'],    #npa search
6063                           ['exportnum','countrycode','npa'],      #nxx search
6064                           ['exportnum','countrycode','npa','nxx'],#station srch
6065                           [ 'exportnum','countrycode','npa','nxx','station'], #
6066                           [ 'svcnum' ],
6067                           [ 'availbatch' ],
6068                           [ 'latanum' ],
6069                         ],
6070       'foreign_keys' => [
6071                           { columns    => [ 'exportnum' ],
6072                             table      => 'part_export',
6073                           },
6074                           { columns    => [ 'latanum' ],
6075                             table      => 'lata',
6076                           },
6077                           { columns    => [ 'msanum' ],
6078                             table      => 'msa',
6079                           },
6080                           { columns    => [ 'ordernum' ],
6081                             table      => 'did_order',
6082                           },
6083                           { columns    => [ 'svcnum' ],
6084                             table      => 'svc_phone',
6085                           },
6086                         ],
6087     },
6088
6089     'lata' => {
6090       'columns' => [
6091         'latanum',    'int',      '',      '', '', '',
6092         'description',   'varchar',    '',      $char_d, '', '',
6093         'have_usage',   'int',    'NULL',      '', '', '',
6094       ],
6095       'primary_key' => 'latanum',
6096       'unique' => [],
6097       'index'  => [],
6098     },
6099
6100     'msa' => {
6101       'columns' => [
6102         'msanum',    'int',      '',      '', '', '',
6103         'description',   'varchar',    '',      $char_d, '', '',
6104       ],
6105       'primary_key' => 'msanum',
6106       'unique' => [],
6107       'index'  => [],
6108     },
6109
6110     'rate_center' => {
6111       'columns' => [
6112         'ratecenternum',    'serial',      '',      '', '', '',
6113         'description',   'varchar',    '',      $char_d, '', '',
6114       ],
6115       'primary_key' => 'ratecenternum',
6116       'unique' => [],
6117       'index'  => [],
6118     },
6119
6120     'did_vendor' => {
6121       'columns' => [
6122         'vendornum',    'serial',      '',      '', '', '',
6123         'vendorname',   'varchar',        '',     $char_d, '', '',
6124       ],
6125       'primary_key' => 'vendornum',
6126       'unique' => [],
6127       'index'  => [],
6128     },
6129
6130     'did_order_item' => {
6131       'columns' => [
6132         'orderitemnum',    'serial',      '',      '', '', '',
6133         'ordernum',    'int',      '',      '', '', '',
6134         'msanum',      'int',     'NULL',      '', '', '',
6135         'npa',      'int',     'NULL',      '', '', '',
6136         'latanum',      'int',     'NULL',      '', '', '',
6137         'ratecenternum',      'int',     'NULL',      '', '', '',
6138         'state',       'char',    'NULL',       2, '', '',
6139         'quantity',      'int',     '',      '', '', '',
6140         'custnum',   'int', 'NULL', '', '', '',
6141       ],
6142       'primary_key'  => 'orderitemnum',
6143       'unique'       => [],
6144       'index'        => [],
6145       'foreign_keys' => [
6146                           { columns    => [ 'ordernum' ],
6147                             table      => 'did_order',
6148                           },
6149                           { columns    => [ 'msanum' ],
6150                             table      => 'msa',
6151                           },
6152                           { columns    => [ 'latanum' ],
6153                             table      => 'lata',
6154                           },
6155                           { columns    => [ 'ratecenternum' ],
6156                             table      => 'rate_center',
6157                           },
6158                           { columns    => [ 'custnum' ],
6159                             table      => 'cust_main',
6160                           },
6161                         ],
6162     },
6163
6164     'did_order' => {
6165       'columns' => [
6166         'ordernum',    'serial',      '',      '', '', '',
6167         'vendornum',   'int',       '',      '', '', '',
6168         'vendor_order_id',   'varchar',  'NULL',   $char_d, '', '',
6169         'custnum',   'int', 'NULL', '', '', '',
6170         'submitted',      'int',     '',      '', '', '',
6171         'confirmed',      'int',     'NULL',      '', '', '',
6172         'received',      'int',     'NULL',      '', '', '',
6173       ],
6174       'primary_key'  => 'ordernum',
6175       'unique'       => [ [ 'vendornum', 'vendor_order_id' ] ],
6176       'index'        => [],
6177       'foreign_keys' => [
6178                           { columns    => [ 'vendornum' ],
6179                             table      => 'did_vendor',
6180                           },
6181                           { columns    => [ 'custnum' ],
6182                             table      => 'cust_main',
6183                           },
6184                         ],
6185     },
6186
6187     'reason_type' => {
6188       'columns' => [
6189         'typenum',   'serial',  '', '', '', '',
6190         'class',     'char', '', 1, '', '',
6191         'type',     'varchar', '', $char_d, '', '',
6192       ],
6193       'primary_key' => 'typenum',
6194       'unique' => [],
6195       'index' => [],
6196     },
6197
6198     'reason' => {
6199       'columns' => [
6200         'reasonnum',     'serial',  '', '', '', '',
6201         'reason_type',   'int',  '', '', '', '',
6202         'reason',        'text', '', '', '', '',
6203         'disabled',      'char',    'NULL', 1, '', '',
6204         'unsuspend_pkgpart', 'int',  'NULL', '', '', '',
6205         'unsuspend_hold','char',    'NULL', 1, '', '',
6206         'unused_credit', 'char',    'NULL', 1, '', '',
6207         'feepart',        'int', 'NULL', '', '', '',
6208         'fee_on_unsuspend','char',  'NULL', 1, '', '',
6209         'fee_hold',      'char',    'NULL', 1, '', '',
6210       ],
6211       'primary_key'  => 'reasonnum',
6212       'unique'       => [],
6213       'index'        => [],
6214       'foreign_keys' => [
6215                           { columns    => [ 'reason_type' ],
6216                             table      => 'reason_type',
6217                             references => [ 'typenum' ],
6218                           },
6219                           { columns    => [ 'unsuspend_pkgpart' ],
6220                             table      => 'part_pkg',
6221                             references => [ 'pkgpart' ],
6222                           },
6223                         ],
6224     },
6225
6226     'conf' => {
6227       'columns' => [
6228         'confnum',  'serial',     '',      '', '', '',
6229         'agentnum', 'int',    'NULL',      '', '', '',
6230         'locale',   'varchar','NULL',      16, '', '',
6231         'name',     'varchar',    '', $char_d, '', '',
6232         'value',    'text',   'NULL',      '', '', '',
6233       ],
6234       'primary_key'  => 'confnum',
6235       'unique'       => [ [ 'agentnum', 'locale', 'name' ] ],
6236       'index'        => [],
6237       'foreign_keys' => [
6238                           { columns    => [ 'agentnum' ],
6239                             table      => 'agent',
6240                           },
6241                         ],
6242     },
6243
6244     'pkg_referral' => {
6245       'columns' => [
6246         'pkgrefnum',     'serial', '', '', '', '',
6247         'pkgnum',        'int',    '', '', '', '',
6248         'refnum',        'int',    '', '', '', '',
6249       ],
6250       'primary_key'  => 'pkgrefnum',
6251       'unique'       => [ [ 'pkgnum', 'refnum' ] ],
6252       'index'        => [ [ 'pkgnum' ], [ 'refnum' ] ],
6253       'foreign_keys' => [
6254                           { columns    => [ 'pkgnum' ],
6255                             table      => 'cust_pkg',
6256                           },
6257                           { columns    => [ 'refnum' ],
6258                             table      => 'part_referral',
6259                           },
6260                         ],
6261     },
6262
6263     'svc_pbx' => {
6264       'columns' => [
6265         'svcnum',           'int',     '',      '', '', '',
6266         'id',               'int', 'NULL',      '', '', '',
6267         'uuid',            'char', 'NULL',      36, '', '',
6268         'title',        'varchar', 'NULL', $char_d, '', '',
6269         'max_extensions',   'int', 'NULL',      '', '', '',
6270         'max_simultaneous', 'int', 'NULL',      '', '', '',
6271         'ip_addr',      'varchar', 'NULL',      40, '', '',
6272       ],
6273       'primary_key'  => 'svcnum',
6274       'unique'       => [],
6275       'index'        => [ [ 'id' ], [ 'uuid' ] ],
6276       'foreign_keys' => [
6277                           { columns    => [ 'svcnum' ],
6278                             table      => 'cust_svc',
6279                           },
6280                         ],
6281     },
6282
6283     'pbx_extension' => {
6284       'columns' => [
6285         'extensionnum',  'serial',     '',      '', '', '',
6286         'svcnum',           'int',     '',      '', '', '',
6287         'extension',    'varchar',     '', $char_d, '', '',
6288         'pin',          'varchar', 'NULL', $char_d, '', '',
6289         'sip_password', 'varchar', 'NULL', $char_d, '', '',
6290         'phone_name',   'varchar', 'NULL', $char_d, '', '',
6291       ],
6292       'primary_key'  => 'extensionnum',
6293       'unique'       => [ [ 'svcnum', 'extension' ] ],
6294       'index'        => [ [ 'svcnum' ] ],
6295       'foreign_keys' => [
6296                           { columns    => [ 'svcnum' ],
6297                             table      => 'svc_pbx',
6298                           },
6299                         ],
6300     },
6301
6302     'pbx_device' => {
6303       'columns' => [
6304         'devicenum', 'serial',     '', '', '', '',
6305         'devicepart',   'int',     '', '', '', '',
6306         'svcnum',       'int',     '', '', '', '',
6307         'mac_addr', 'varchar', 'NULL', 12, '', '',
6308       ],
6309       'primary_key'  => 'devicenum',
6310       'unique'       => [ [ 'mac_addr' ], ],
6311       'index'        => [ [ 'devicepart' ], [ 'svcnum' ], ],
6312       'foreign_keys' => [
6313                           { columns    => [ 'devicepart' ],
6314                             table      => 'part_device',
6315                           },
6316                           { columns    => [ 'svcnum' ],
6317                             table      => 'svc_pbx',
6318                           },
6319                         ],
6320     },
6321
6322     'extension_device' => {
6323       'columns' => [
6324         'extensiondevicenum', 'serial', '', '', '', '',
6325         'extensionnum',          'int', '', '', '', '',
6326         'devicenum',             'int', '', '', '', '',
6327       ],
6328       'primary_key'  => 'extensiondevicenum',
6329       'unique'       => [ [ 'extensionnum', 'devicenum' ] ],
6330       'index'        => [],#both?  which way do we need to query?
6331       'foreign_keys' => [
6332                           { columns  => [ 'extensionnum' ],
6333                             table    => 'pbx_extension',
6334                           },
6335                           { columns  => [ 'devicenum' ],
6336                             table    => 'pbx_device',
6337                           },
6338                         ],
6339     },
6340
6341     'svc_mailinglist' => { #svc_group?
6342       'columns' => [
6343         'svcnum',            'int',     '',            '', '', '',
6344         'username',      'varchar',     '', $username_len, '', '',
6345         'domsvc',            'int',     '',            '', '', '',
6346         'listnum',           'int',     '',            '', '', '',
6347         'reply_to',         'char', 'NULL',             1, '', '',#SetReplyTo
6348         'remove_from',      'char', 'NULL',             1, '', '',#RemoveAuthor
6349         'reject_auto',      'char', 'NULL',             1, '', '',#RejectAuto
6350         'remove_to_and_cc', 'char', 'NULL',             1, '', '',#RemoveToAndCc
6351       ],
6352       'primary_key'  => 'svcnum',
6353       'unique'       => [],
6354       'index'        => [ ['username'], ['domsvc'], ['listnum'] ],
6355       'foreign_keys' => [
6356                           { columns    => [ 'svcnum' ],
6357                             table      => 'cust_svc',
6358                           },
6359                           { columns    => [ 'domsvc' ],
6360                             table      => 'svc_domain', #'cust_svc',
6361                             references => [ 'svcnum' ],
6362                           },
6363                           { columns    => [ 'listnum' ],
6364                             table      => 'mailinglist',
6365                           },
6366                         ],
6367     },
6368
6369     'mailinglist' => {
6370       'columns' => [
6371         'listnum',   'serial', '',      '', '', '',
6372         'listname', 'varchar', '', $char_d, '', '',
6373       ],
6374       'primary_key' => 'listnum',
6375       'unique' => [],
6376       'index'  => [],
6377     },
6378
6379     'mailinglistmember' => {
6380       'columns' => [
6381         'membernum',        'serial',     '',   '', '', '',
6382         'listnum',             'int',     '',   '', '', '',
6383         'svcnum',              'int', 'NULL',   '', '', '',
6384         'contactemailnum',     'int', 'NULL',   '', '', '',
6385         'email',           'varchar', 'NULL',  255, '', '',
6386       ],
6387       'primary_key'  => 'membernum',
6388       'unique'       => [],
6389       'index'        => [['listnum'],['svcnum'],['contactemailnum'],['email']],
6390       'foreign_keys' => [
6391                           { columns    => [ 'listnum' ],
6392                             table      => 'mailinglist',
6393                           },
6394                           { columns    => [ 'svcnum' ],
6395                             table      => 'svc_acct',
6396                           },
6397                           { columns    => [ 'contactemailnum' ],
6398                             table      => 'contact_email',
6399                           },
6400                         ],
6401     },
6402
6403     'bill_batch' => {
6404       'columns' => [
6405         'batchnum',         'serial',     '',  '', '', '',
6406         'agentnum',            'int', 'NULL',  '', '', '',
6407         'status',             'char', 'NULL', '1', '', '',
6408         'pdf',                'blob', 'NULL',  '', '', '',
6409       ],
6410       'primary_key'  => 'batchnum',
6411       'unique'       => [],
6412       'index'        => [ ['agentnum'] ],
6413       'foreign_keys' => [
6414                           { columns    => [ 'agentnum' ],
6415                             table      => 'agent',
6416                           },
6417                         ],
6418     },
6419
6420     'cust_bill_batch' => {
6421       'columns' => [
6422         'billbatchnum',     'serial',     '', '', '', '',
6423         'batchnum',            'int',     '', '', '', '',
6424         'invnum',              'int',     '', '', '', '',
6425       ],
6426       'primary_key'  => 'billbatchnum',
6427       'unique'       => [],
6428       'index'        => [ [ 'batchnum' ], [ 'invnum' ] ],
6429       'foreign_keys' => [
6430                           { columns    => [ 'batchnum' ],
6431                             table      => 'bill_batch',
6432                           },
6433                           { columns    => [ 'invnum' ],
6434                             table      => 'cust_bill',
6435                           },
6436                         ],
6437     },
6438
6439     'cust_bill_batch_option' => {
6440       'columns' => [
6441         'optionnum', 'serial', '', '', '', '',
6442         'billbatchnum', 'int', '', '', '', '',
6443         'optionname', 'varchar', '', $char_d, '', '',
6444         'optionvalue', 'text', 'NULL', '', '', '',
6445       ],
6446       'primary_key'  => 'optionnum',
6447       'unique'       => [],
6448       'index'        => [ [ 'billbatchnum' ], [ 'optionname' ] ],
6449       'foreign_keys' => [
6450                           { columns    => [ 'billbatchnum' ],
6451                             table      => 'cust_bill_batch',
6452                           },
6453                         ],
6454      },
6455
6456     'msg_template' => {
6457       'columns' => [
6458         'msgnum',     'serial',     '',      '', '', '',
6459         'msgname',   'varchar',     '', $char_d, '', '',
6460         'agentnum',      'int', 'NULL',      '', '', '',
6461         'subject',   'varchar', 'NULL',     512, '', '',
6462         'mime_type', 'varchar',     '', $char_d, '', '',
6463         'body',         'blob', 'NULL',      '', '', '',
6464         'disabled',     'char', 'NULL',       1, '', '',
6465           # migrate these to msg_template_email
6466         'from_addr', 'varchar', 'NULL',     255, '', '',
6467         'bcc_addr',  'varchar', 'NULL',     255, '', '',
6468           # change to not null on v5
6469         'msgclass',  'varchar', 'NULL',      16, '', '',
6470       ],
6471       'primary_key'  => 'msgnum',
6472       'unique'       => [ ],
6473       'index'        => [ ['agentnum'], ],
6474       'foreign_keys' => [
6475                           { columns    => [ 'agentnum' ],
6476                             table      => 'agent',
6477                           },
6478                         ],
6479     },
6480
6481     'msg_template_http' => {
6482       'columns' => [
6483         'num',          'serial',     '',      '', '', '',
6484         'msgnum',          'int',     '',      '', '', '',
6485         'prepare_url', 'varchar', 'NULL',     255, '', '',
6486         'send_url',    'varchar', 'NULL',     255, '', '',
6487         'username',    'varchar', 'NULL', $char_d, '', '',
6488         'password',    'varchar', 'NULL', $char_d, '', '',
6489         'content',        'text', 'NULL',      '', '', '',
6490       ],
6491       'primary_key'  => 'num',
6492       'unique'       => [ [ 'msgnum' ], ],
6493       'index'        => [ ],
6494       'foreign_keys' => [
6495                           { columns    => [ 'msgnum' ],
6496                             table      => 'msg_template',
6497                           },
6498                         ],
6499     },
6500
6501     'template_content' => {
6502       'columns' => [
6503         'contentnum', 'serial',     '',      '', '', '',
6504         'msgnum',        'int',     '',      '', '', '',
6505         'locale',    'varchar', 'NULL',      16, '', '',
6506         'subject',   'varchar', 'NULL',     512, '', '',
6507         'body',         'text', 'NULL',      '', '', '',
6508       ],
6509       'primary_key'  => 'contentnum',
6510       'unique'       => [ ['msgnum', 'locale'] ],
6511       'index'        => [ ],
6512       'foreign_keys' => [
6513                           { columns    => [ 'msgnum' ],
6514                             table      => 'msg_template',
6515                           },
6516                         ],
6517     },
6518
6519     'template_image' => {
6520       'columns' => [
6521         'imgnum',     'serial',     '',      '', '', '',
6522         'name',      'varchar',     '', $char_d, '', '',
6523         'agentnum',      'int', 'NULL',      '', '', '',
6524         'mime_type', 'varchar',     '', $char_d, '', '',
6525         'base64',       'text',     '',      '', '', '',
6526       ],
6527       'primary_key'  => 'imgnum',
6528       'unique'       => [ ],
6529       'index'        => [ ['name'], ['agentnum'] ],
6530     },
6531
6532     'cust_msg' => {
6533       'columns' => [
6534         'custmsgnum', 'serial',     '',     '', '', '',
6535         'custnum',       'int', 'NULL',     '', '', '',
6536         'msgnum',        'int', 'NULL',     '', '', '',
6537         '_date',    @date_type,                 '', '',
6538         'env_from',  'varchar', 'NULL',    255, '', '',
6539         'env_to',    'varchar', 'NULL',    255, '', '',
6540         'header',       'blob', 'NULL',     '', '', '',
6541         'body',         'blob', 'NULL',     '', '', '',
6542         'error',     'varchar', 'NULL',    255, '', '',
6543         'status',    'varchar',     '',$char_d, '', '',
6544         'msgtype',   'varchar', 'NULL',     16, '', '',
6545         'preview',      'text', 'NULL',     '', '', '',
6546       ],
6547       'primary_key'  => 'custmsgnum',
6548       'unique'       => [ ],
6549       'index'        => [ ['custnum'], ],
6550       'foreign_keys' => [
6551                           { columns    => [ 'custnum' ],
6552                             table      => 'cust_main',
6553                           },
6554                           { columns    => [ 'msgnum' ],
6555                             table      => 'msg_template',
6556                           },
6557                         ],
6558     },
6559
6560     'svc_cert' => {
6561       'columns' => [
6562         'svcnum',                'int',     '',      '', '', '',
6563         'recnum',                'int', 'NULL',      '', '', '',
6564         'privatekey',           'text', 'NULL',      '', '', '',
6565         'csr',                  'text', 'NULL',      '', '', '',
6566         'certificate',          'text', 'NULL',      '', '', '',
6567         'cacert',               'text', 'NULL',      '', '', '',
6568         'common_name',       'varchar', 'NULL', $char_d, '', '',
6569         'organization',      'varchar', 'NULL', $char_d, '', '',
6570         'organization_unit', 'varchar', 'NULL', $char_d, '', '',
6571         'city',              'varchar', 'NULL', $char_d, '', '',
6572         'state',             'varchar', 'NULL', $char_d, '', '',
6573         'country',              'char', 'NULL',       2, '', '',
6574         'cert_contact',      'varchar', 'NULL', $char_d, '', '',
6575       ],
6576       'primary_key'  => 'svcnum',
6577       'unique'       => [],
6578       'index'        => [], #recnum
6579       'foreign_keys' => [
6580                           { columns    => [ 'svcnum' ],
6581                             table      => 'cust_svc',
6582                           },
6583                           { columns    => [ 'recnum' ],
6584                             table      => 'domain_record',
6585                           },
6586                         ],
6587     },
6588
6589     'svc_port' => {
6590       'columns' => [
6591         'svcnum',                'int',     '',      '', '', '',
6592         'serviceid', 'varchar', '', 64, '', '', #srvexport / reportfields
6593       ],
6594       'primary_key'  => 'svcnum',
6595       'unique'       => [],
6596       'index'        => [], #recnum
6597       'foreign_keys' => [
6598                           { columns    => [ 'svcnum' ],
6599                             table      => 'cust_svc',
6600                           },
6601                         ],
6602     },
6603
6604     'areacode'  => {
6605       'columns' => [
6606         'areanum',   'serial',        '',      '', '', '',
6607         'code',        'char',        '',       3, '', '',
6608         'country',     'char',    'NULL',       2, '', '',
6609         'state',       'char',    'NULL',       2, '', '',
6610         'description','varchar',  'NULL',     255, '', '',
6611       ],
6612       'primary_key' => 'areanum',
6613       'unique' => [ [ 'areanum' ] ],
6614       'index'  => [],
6615     },
6616
6617     'upgrade_journal' => {
6618       'columns' => [
6619         'upgradenum', 'serial', '', '', '', '',
6620         '_date', 'int', '', '', '', '',
6621         'upgrade', 'varchar', '', $char_d, '', '',
6622         'status', 'varchar', '', $char_d, '', '',
6623         'statustext', 'varchar', 'NULL', $char_d, '', '',
6624       ],
6625       'primary_key' => 'upgradenum',
6626       'unique' => [],
6627       'index' => [ [ 'upgrade' ] ],
6628     },
6629
6630     'upload_target' => {
6631       'columns' => [
6632         'targetnum', 'serial', '', '', '', '',
6633         'agentnum', 'int', 'NULL', '', '', '',
6634         'protocol', 'varchar', '', 10, '', '',
6635         'hostname', 'varchar', '', $char_d, '', '',
6636         'port', 'int', 'NULL', '', '', '',
6637         'username', 'varchar', '', $char_d, '', '',
6638         'password', 'varchar', 'NULL', $char_d, '', '',
6639         'path', 'varchar', 'NULL', $char_d, '', '',
6640         'subject', 'varchar', 'NULL', '255', '', '',
6641         'handling', 'varchar', 'NULL', $char_d, '', '',
6642       ],
6643       'primary_key'   => 'targetnum',
6644       'unique'        => [ [ 'targetnum' ] ],
6645       'index'         => [],
6646       'foreign_keys' => [
6647                           { columns    => [ 'agentnum' ],
6648                             table      => 'agent',
6649                           },
6650                         ],
6651     },
6652
6653     'log' => {
6654       'columns' => [
6655         'lognum',     'serial', '', '', '', '',
6656         '_date',      'int', '', '', '', '',
6657         'agentnum',   'int', 'NULL', '', '', '',
6658         'tablename',  'varchar', 'NULL', $char_d, '', '',
6659         'tablenum',   'int',  'NULL', '', '', '',
6660         'level',      'int',  '', '', '', '',
6661         'message',    'text', '', '', '', '',
6662       ],
6663       'primary_key'  => 'lognum',
6664       'unique'       => [],
6665       'index'        => [ ['_date'], ['level'] ],
6666       'foreign_keys' => [
6667                           { columns    => [ 'agentnum' ],
6668                             table      => 'agent',
6669                           },
6670                         ],
6671     },
6672
6673     'log_context' => {
6674       'columns' => [
6675         'logcontextnum', 'serial', '', '', '', '',
6676         'lognum', 'int', '', '', '', '',
6677         'context', 'varchar', '', $char_d, '', '',
6678       ],
6679       'primary_key'  => 'logcontextnum',
6680       'unique'       => [ [ 'lognum', 'context' ] ],
6681       'index'        => [],
6682       'foreign_keys' => [
6683                           { columns    => [ 'lognum' ],
6684                             table      => 'log',
6685                           },
6686                         ],
6687     },
6688
6689     'log_email' => {
6690       'columns' => [
6691         'logemailnum', 'serial', '', '', '', '',
6692         'context', 'varchar', 'NULL', $char_d, '', '',
6693         'min_level', 'int',  'NULL', '', '', '',
6694         'msgnum', 'int', '',  '', '', '',
6695         'to_addr', 'varchar', 'NULL',     255, '', '',
6696         'context_height',  'int', 'NULL', '', '', '',
6697       ],
6698       'primary_key'  => 'logemailnum',
6699       'unique'       => [],
6700       'index'        => [ ['context'], ['min_level'] ],
6701       'foreign_keys' => [
6702                           { columns    => [ 'msgnum' ],
6703                             table      => 'msg_template',
6704                             references => [ 'msgnum' ],
6705                           },
6706                         ],
6707     },
6708
6709     'svc_alarm' => {
6710       'columns' => [
6711 #       name               type        null   length   default local
6712         'svcnum',          'int',      '',    '',      '',     '',
6713         'alarmsystemnum',  'int',      '',    '',      '',     '',
6714         'alarmtypenum',    'int',      '',    '',      '',     '',
6715         'alarmstationnum', 'int',      '',    '',      '',     '',
6716         'acctnum',         'varchar',  '',    $char_d, '',     '',
6717         '_password',       'varchar',  '',    $char_d, '',     '',
6718         'location',        'varchar', 'NULL', $char_d, '',     '',
6719         'cs_receiver',     'int',     'NULL', '',      '',     '',
6720         'cs_phonenum',     'varchar', 'NULL', $char_d, '',     '',
6721         'serialnum',       'varchar', 'NULL', $char_d, '',     '',
6722         #installer (rep)
6723       ],
6724       'primary_key'  => 'svcnum',
6725       'unique'       => [],
6726       'index'        => [],
6727       'foreign_keys' => [
6728                           { columns    => [ 'svcnum' ],
6729                             table      => 'cust_svc',
6730                           },
6731                           { columns    => [ 'alarmsystemnum' ],
6732                             table      => 'alarm_system',
6733                           },
6734                           { columns    => [ 'alarmtypenum' ],
6735                             table      => 'alarm_type',
6736                           },
6737                           { columns    => [ 'alarmstationnum' ],
6738                             table      => 'alarm_station',
6739                           },
6740                         ],
6741     },
6742
6743     'alarm_system' => { #vendors
6744       'columns' => [
6745         'alarmsystemnum',  'serial',     '',      '', '', '',
6746         'agentnum',           'int', 'NULL',      '', '', '',
6747         'systemname',     'varchar',     '', $char_d, '', '',
6748         'disabled',          'char', 'NULL',       1, '', '',
6749       ],
6750       'primary_key' => 'alarmsystemnum',
6751       'unique'      => [ ['agentnum', 'systemname'] ],
6752       'index'       => [ ['agentnum'], ['disabled'] ],
6753       'foreign_keys' => [
6754                           { columns    => [ 'agentnum' ],
6755                             table      => 'agent',
6756                           },
6757                         ],
6758     },
6759
6760     'alarm_type' => { #inputs and outputs
6761       'columns' => [
6762         'alarmtypenum', 'serial',     '',      '', '', '',
6763         'agentnum',        'int', 'NULL',      '', '', '',
6764         'inputs',          'int',     '', '', '', '',
6765         'outputs',         'int',     '', '', '', '',
6766         'disabled',       'char', 'NULL',       1, '', '',
6767       ],
6768       'primary_key' => 'alarmtypenum',
6769       'unique'      => [ ['agentnum', 'inputs', 'outputs'] ],
6770       'index'       => [ ['agentnum'], ['disabled'] ],
6771       'foreign_keys' => [
6772                           { columns    => [ 'agentnum' ],
6773                             table      => 'agent',
6774                           },
6775                         ],
6776     },
6777
6778     'alarm_station' => { #central station (where the alarm reports to)
6779       'columns' => [
6780         'alarmstationnum', 'serial',     '',      '', '', '',
6781         'agentnum',           'int', 'NULL',      '', '', '',
6782         'stationname',    'varchar',     '', $char_d, '', '',
6783         'disabled',          'char', 'NULL',       1, '', '',
6784       ],
6785       'primary_key' => 'alarmstationnum',
6786       'unique'      => [ ['agentnum', 'stationname'], ],
6787       'index'       => [ ['agentnum'], ['disabled'] ],
6788       'foreign_keys' => [
6789                           { columns    => [ 'agentnum' ],
6790                             table      => 'agent',
6791                           },
6792                         ],
6793     },
6794
6795     'svc_cable' => {
6796       'columns' => [
6797         'svcnum',        'int',     '',      '', '', '',
6798         'providernum',   'int', 'NULL',      '', '', '',
6799         'ordernum',  'varchar', 'NULL', $char_d, '', '',
6800         'modelnum',      'int', 'NULL',      '', '', '',
6801         'serialnum', 'varchar', 'NULL', $char_d, '', '',
6802         'mac_addr',  'varchar', 'NULL',      12, '', '',
6803       ],
6804       'primary_key'  => 'svcnum',
6805       'unique'       => [ ['serialnum'] , ['mac_addr'] ],
6806       'index'        => [],
6807       'foreign_keys' => [
6808                           { columns    => [ 'svcnum' ],
6809                             table      => 'cust_svc',
6810                           },
6811                           { columns    => [ 'providernum' ],
6812                             table      => 'cable_provider',
6813                           },
6814                           { columns    => [ 'modelnum' ],
6815                             table      => 'cable_model',
6816                           },
6817                         ],
6818     },
6819
6820     'cable_model' => {
6821       'columns' => [
6822         'modelnum',    'serial',     '',      '', '', '',
6823         'model_name', 'varchar',     '', $char_d, '', '',
6824         'disabled',      'char', 'NULL',       1, '', '',
6825       ],
6826       'primary_key' => 'modelnum',
6827       'unique' => [ [ 'model_name' ], ],
6828       'index'  => [],
6829     },
6830
6831     'cable_provider' => {
6832       'columns' => [
6833         'providernum', 'serial',     '',      '', '', '',
6834         'provider',   'varchar',     '', $char_d, '', '',
6835         'disabled',      'char', 'NULL',       1, '', '',
6836       ],
6837       'primary_key' => 'providernum',
6838       'unique' => [ [ 'provider' ], ],
6839       'index'  => [],
6840     },
6841
6842     'svc_conferencing' => {
6843       'columns' => [
6844         'svcnum',            'int',     '',      '', '', '',
6845         'conf_id',           'int', 'NULL',      '', '', '', #"system assigned"
6846         'conf_name',     'varchar',     '', $char_d, '', '',
6847         'conf_password', 'varchar',     '', $char_d, '', '',
6848         'access_code',   'varchar',     '',      16, '', '',
6849         'duration',          'int',     '',      '', '', '',
6850         'participants',      'int',     '',      '', '', '',
6851         'conftypenum',       'int',     '',      '', '', '',
6852         'confqualitynum',    'int',     '',      '', '', '',
6853         'opt_recording',    'char', 'NULL',       1, '', '',
6854         'opt_sip',          'char', 'NULL',       1, '', '',
6855         'opt_phone',        'char', 'NULL',       1, '', '',
6856       ],
6857       'primary_key' => 'svcnum',
6858       'unique' => [],
6859       'index'  => [],
6860       'foreign_keys' => [
6861                           { columns => [ 'svcnum' ],
6862                             table   => 'cust_svc',
6863                           },
6864                           { columns => [ 'conftypenum' ],
6865                             table   => 'conferencing_type',
6866                           },
6867                           { columns => [ 'confqualitynum' ],
6868                             table   => 'conferencing_quality',
6869                           },
6870                         ],
6871     },
6872
6873     'conferencing_type' => {
6874       'columns' => [
6875         'conftypenum',  'int',     '',      '', '', '',
6876         'typeid'      , 'int',     '',      '', '', '',
6877         'typename', 'varchar',     '', $char_d, '', '',
6878         'disabled',    'char', 'NULL',       1, '', '',
6879       ],
6880       'primary_key' => 'conftypenum',
6881       'unique'      => [ [ 'typeid', 'disabled' ], [ 'typename', 'disabled' ] ],
6882       'index'       => [],
6883     },
6884
6885     'conferencing_quality' => {
6886       'columns' => [
6887         'confqualitynum',  'int',     '',      '', '', '',
6888         'qualityid'      , 'int',     '',      '', '', '',
6889         'qualityname', 'varchar',     '', $char_d, '', '',
6890         'disabled',       'char', 'NULL',       1, '', '',
6891       ],
6892       'primary_key' => 'confqualitynum',
6893       'unique'      => [ [ 'qualityid', 'disabled' ], [ 'qualityname', 'disabled' ] ],
6894       'index'       => [],
6895     },
6896
6897     'svc_video' => {
6898       'columns' => [
6899         'svcnum',            'int', '', '', '', '',
6900         'smartcard_num', 'varchar', '', 16, '', '',
6901         'mac_addr',      'varchar', '', 12, '', '',
6902         'duration',          'int', '', '', '', '',
6903       ],
6904       'primary_key' => 'svcnum',
6905       'unique' => [], # [ 'smartcard_num' ], [ 'mac_addr' ], ],
6906       'index'  => [],
6907       'foreign_keys' => [
6908                           { columns => [ 'svcnum' ],
6909                             table   => 'cust_svc',
6910                           },
6911                         ],
6912     },
6913
6914     'circuit_type' => {
6915       'columns' => [
6916         'typenum',     'serial',     '',      '', '', '',
6917         'typename',   'varchar',     '', $char_d, '', '',
6918         'disabled',      'char', 'NULL',       1, '', '',
6919         # speed? number of voice lines? anything else?
6920       ],
6921       'primary_key' => 'typenum',
6922       'unique' => [ [ 'typename' ] ],
6923       'index'  => [],
6924     },
6925
6926     'circuit_provider' => {
6927       'columns' => [
6928         'providernum', 'serial',     '',      '', '', '',
6929         'provider',   'varchar',     '', $char_d, '', '',
6930         'disabled',      'char', 'NULL',       1, '', '',
6931       ],
6932       'primary_key' => 'providernum',
6933       'unique' => [ [ 'provider' ], ],
6934       'index'  => [],
6935     },
6936
6937     'circuit_termination' => {
6938       'columns' => [
6939         'termnum',     'serial',     '',      '', '', '',
6940         'termination','varchar',     '', $char_d, '', '',
6941         'disabled',      'char', 'NULL',       1, '', '',
6942       ],
6943       'primary_key' => 'termnum',
6944       'unique' => [ [ 'termination' ] ],
6945       'index' => [],
6946     },
6947
6948     'svc_circuit' => {
6949       'columns' => [
6950         'svcnum',                   'int',     '', '', '', '',
6951         'typenum',                  'int',     '', '', '', '',
6952         'providernum',              'int',     '', '', '', '',
6953         'termnum',                  'int',     '', '', '', '',
6954         'circuit_id',           'varchar',     '', 64, '', '',
6955         'desired_due_date',         'int', 'NULL', '', '', '',
6956         'due_date',                 'int', 'NULL', '', '', '',
6957         'vendor_order_id',      'varchar', 'NULL', $char_d,  '', '',
6958         'vendor_qual_id',       'varchar', 'NULL', $char_d,  '', '',
6959         'vendor_order_type',    'varchar', 'NULL', $char_d,  '', '',
6960         'vendor_order_status',  'varchar', 'NULL', $char_d,  '', '',
6961         'endpoint_ip_addr',     'varchar', 'NULL', 40, '', '',
6962         'endpoint_mac_addr',    'varchar', 'NULL', 12, '', '',
6963       ],
6964       'primary_key' => 'svcnum',
6965       'unique'      => [],
6966       'index'       => [ [ 'providernum' ], [ 'typenum' ] ],
6967       'foreign_keys' => [
6968                           { columns => [ 'svcnum' ],
6969                             table   => 'cust_svc',
6970                           },
6971                           { columns => [ 'typenum' ],
6972                             table   => 'circuit_type',
6973                           },
6974                           { columns => [ 'providernum' ],
6975                             table   => 'circuit_provider',
6976                           },
6977                           { columns => [ 'termnum' ],
6978                             table   => 'circuit_termination',
6979                           },
6980       ],
6981     },
6982
6983     'svc_fiber' => {
6984       'columns' => [
6985         'svcnum',         'int',     '',      '', '', '',
6986         'oltnum',         'int', 'NULL',      '', '', '',
6987         'shelf',          'int', 'NULL',      '', '', '',
6988         'card',           'int', 'NULL',      '', '', '',
6989         'olt_port',       'int', 'NULL',      '', '', '',
6990         'ont_id',         'int', 'NULL',      '', '', '',
6991         'ont_typenum',    'int', 'NULL',      '', '', '',
6992         'ont_serial', 'varchar', 'NULL', $char_d, '', '',
6993         'ont_port',   'varchar', 'NULL',      16, '', '',
6994         'circuit_id', 'varchar', 'NULL', $char_d, '', '',
6995         'vlan',           'int', 'NULL',      '', '', '',
6996         'signal',     'decimal', 'NULL',  '10,2', '', '',
6997         'speed_up',       'int', 'NULL',      '', '', '',
6998         'speed_down',     'int', 'NULL',      '', '', '',
6999         'ont_install','varchar', 'NULL', $char_d, '', '',
7000       ],
7001       'primary_key' => 'svcnum',
7002       'unique'      => [ ],
7003       'index'       => [ [ 'ont_serial' ] ],
7004       'foreign_keys' => [
7005                           { columns => [ 'svcnum' ],
7006                             table   => 'cust_svc',
7007                           },
7008                           { columns => [ 'oltnum' ],
7009                             table   => 'fiber_olt',
7010                           },
7011                           { columns => [ 'ont_typenum' ],
7012                             table   => 'hardware_type',
7013                             references => [ 'typenum' ],
7014                           },
7015                         ],
7016     },
7017
7018     'fiber_olt' => {
7019       'columns' => [
7020         'oltnum',   'serial', '',       '', '', '',
7021         'oltname', 'varchar', '',  $char_d, '', '',
7022         'sitenum',     'int', 'NULL',   '', '', '',
7023         'serial',  'varchar', '',  $char_d, '', '',
7024         'disabled',   'char', 'NULL',    1, '', '',
7025       ],
7026       'primary_key' => 'oltnum',
7027       'unique' => [ ],
7028       'index'  => [ ],
7029       'foreign_keys' => [
7030                           { columns => [ 'sitenum' ],
7031                             table   => 'olt_site',
7032                           },
7033                         ],
7034     },
7035
7036     'olt_site' => {
7037       'columns' => [
7038         'sitenum',  'serial', '',      '', '', '',
7039         'market',  'varchar', '', $char_d, '', '',
7040         'site',    'varchar', '', $char_d, '', '',
7041       ],
7042       'primary_key' => 'sitenum',
7043       'unique' => [ [ 'market', 'site' ] ],
7044       'index' => [ ],
7045     },
7046
7047
7048
7049
7050
7051     'vend_main' => {
7052       'columns' => [
7053         'vendnum',   'serial',     '',      '', '', '',
7054         'vendname', 'varchar',     '', $char_d, '', '',
7055         'classnum',     'int',     '',      '', '', '',
7056         'disabled',    'char', 'NULL',       1, '', '',
7057       ],
7058       'primary_key'  => 'vendnum',
7059       'unique'       => [ ['vendname', 'disabled'] ],
7060       'index'        => [],
7061       'foreign_keys' => [
7062                           { columns    => [ 'classnum' ],
7063                             table      => 'vend_class',
7064                           },
7065                         ],
7066     },
7067
7068     'vend_class' => {
7069       'columns' => [
7070         'classnum',     'serial',     '',      '', '', '',
7071         'classname',   'varchar',     '', $char_d, '', '',
7072         'disabled',       'char', 'NULL',       1, '', '',
7073       ],
7074       'primary_key' => 'classnum',
7075       'unique'      => [],
7076       'index'       => [ ['disabled'] ],
7077     },
7078
7079     'vend_bill' => {
7080       'columns' => [
7081         'vendbillnum',    'serial',     '',      '', '', '',
7082         'vendnum',           'int',     '',      '', '', '',
7083         #'_date',        @date_type,                  '', '',
7084         '_date',     'int', '', '',                   '', '',
7085         'charged',     @money_type,                  '', '',
7086       ],
7087       'primary_key'  => 'vendbillnum',
7088       'unique'       => [],
7089       'index'        => [ ['vendnum'], ['_date'], ],
7090       'foreign_keys' => [
7091                           { columns    => [ 'vendnum' ],
7092                             table      => 'vend_main',
7093                           },
7094                         ],
7095     },
7096
7097     'vend_pay' => {
7098       'columns' => [
7099         'vendpaynum',   'serial',    '',       '', '', '',
7100         'vendnum',         'int',    '',       '', '', '',
7101         #'_date',     @date_type,                   '', '',
7102         '_date',     'int', '', '',                   '', '',
7103         'paid',      @money_type,                  '', '',
7104       ],
7105       'primary_key'  => 'vendpaynum',
7106       'unique'       => [],
7107       'index'        => [ [ 'vendnum' ], [ '_date' ], ],
7108       'foreign_keys' => [
7109                           { columns    => [ 'vendnum' ],
7110                             table      => 'vend_main',
7111                           },
7112                         ],
7113     },
7114
7115     'vend_bill_pay' => {
7116       'columns' => [
7117         'vendbillpaynum', 'serial',     '',   '', '', '',
7118         'vendbillnum',       'int',     '',   '', '', '',
7119         'vendpaynum',        'int',     '',   '', '', '',
7120         'amount',  @money_type, '', '',
7121         #? '_date',   @date_type, '', '',
7122       ],
7123       'primary_key'  => 'vendbillpaynum',
7124       'unique'       => [],
7125       'index'        => [ [ 'vendbillnum' ], [ 'vendpaynum' ] ],
7126       'foreign_keys' => [
7127                           { columns    => [ 'vendbillnum' ],
7128                             table      => 'vend_bill',
7129                           },
7130                           { columns    => [ 'vendpaynum' ],
7131                             table      => 'vend_pay',
7132                           },
7133                         ],
7134     },
7135
7136     %{ tables_hashref_torrus() },
7137
7138     # tables of ours for doing torrus virtual port combining
7139     'torrus_srvderive' => {
7140       'columns' => [
7141         'derivenum',     'serial',     '', '', '', '',
7142         'serviceid',    'varchar',     '', 64, '', '', #srvexport / reportfields
7143         'last_srv_date',   'date', 'NULL', '', '', '',
7144       ],
7145       'primary_key' => 'derivenum',
7146       'unique' => [ ['serviceid'] ],
7147       'index'  => [],
7148     },
7149
7150     'torrus_srvderive_component' => {
7151       'columns' => [
7152         'componentnum', 'serial', '', '', '', '',
7153         'derivenum',       'int', '', '', '', '',
7154         'serviceid',   'varchar', '', 64, '', '', #srvexport / reportfields
7155       ],
7156       'primary_key'  => 'componentnum',
7157       'unique'       => [ [ 'derivenum', 'serviceid' ], ],
7158       'index'        => [ [ 'derivenum', ], ],
7159       'foreign_keys' => [
7160                           { columns    => [ 'derivenum' ],
7161                             table      => 'torrus_srvderive',
7162                           },
7163                         ],
7164     },
7165
7166     'invoice_mode' => {
7167       'columns' => [
7168         'modenum',      'serial', '', '', '', '',
7169         'agentnum',        'int', 'NULL', '', '', '',
7170         'modename',    'varchar', '', 32, '', '',
7171       ],
7172       'primary_key' => 'modenum',
7173       'unique'      => [ ],
7174       'index'       => [ ],
7175       'foreign_keys' => [
7176                           { columns    => [ 'agentnum' ],
7177                             table      => 'agent',
7178                           },
7179                         ],
7180     },
7181
7182     'invoice_conf' => {
7183       'columns' => [
7184         'confnum',              'serial',   '', '', '', '',
7185         'modenum',              'int',      '', '', '', '',
7186         'locale',               'varchar',  'NULL', 16, '', '',
7187         'notice_name',          'varchar',  'NULL', 64, '', '',
7188         'subject',              'varchar',  'NULL', 64, '', '',
7189         'htmlnotes',            'text',     'NULL', '', '', '',
7190         'htmlfooter',           'text',     'NULL', '', '', '',
7191         'htmlsummary',          'text',     'NULL', '', '', '',
7192         'htmlreturnaddress',    'text',     'NULL', '', '', '',
7193         'latexnotes',           'text',     'NULL', '', '', '',
7194         'latexfooter',          'text',     'NULL', '', '', '',
7195         'latexsummary',         'text',     'NULL', '', '', '',
7196         'latexsmallfooter',     'text',     'NULL', '', '', '',
7197         'latexreturnaddress',   'text',     'NULL', '', '', '',
7198         'with_latexcoupon',     'char',     'NULL', '1', '', '',
7199         'htmlwatermark',        'text',     'NULL', '', '', '',
7200         'latexwatermark',       'text',     'NULL', '', '', '',
7201         'lpr',                  'varchar',  'NULL', $char_d, '', '',
7202       ],
7203       'primary_key'  => 'confnum',
7204       'unique'       => [ [ 'modenum', 'locale' ] ],
7205       'index'        => [ ],
7206       'foreign_keys' => [
7207                           { columns    => [ 'modenum' ],
7208                             table      => 'invoice_mode',
7209                           },
7210                         ],
7211     },
7212
7213     'export_batch' => {
7214       'columns' => [
7215         'batchnum',    'serial',     '',      '', '', '',
7216         'exportnum',      'int',     '',      '', '', '',
7217         '_date',          'int',     '',      '', '', '',
7218         'status',     'varchar', 'NULL',      32, '', '',
7219         'statustext',    'text', 'NULL',      '', '', '',
7220       ],
7221       'primary_key'  => 'batchnum',
7222       'unique'       => [],
7223       'index'        => [ [ 'exportnum' ], [ 'status' ] ],
7224       'foreign_keys' => [
7225                           { columns    => [ 'exportnum' ],
7226                             table      => 'part_export',
7227                             references => [ 'exportnum' ]
7228                           },
7229                         ],
7230     },
7231
7232     'export_batch_item' => {
7233       'columns' => [
7234         'itemnum',     'serial',     '',      '', '', '',
7235         'batchnum',       'int',     '',      '', '', '',
7236         'svcnum',         'int',     '',      '', '', '',
7237         'action',     'varchar',     '',      32, '', '',
7238         'data',          'text', 'NULL',      '', '', '',
7239         'frozen',        'char', 'NULL',       1, '', '',
7240       ],
7241       'primary_key'  => 'itemnum',
7242       'unique'       => [],
7243       'index'        => [ [ 'batchnum' ], [ 'svcnum' ] ],
7244       'foreign_keys' => [
7245                           { columns    => [ 'batchnum' ],
7246                             table      => 'export_batch',
7247                             references => [ 'batchnum' ]
7248                           },
7249                         ],
7250     },
7251
7252     # lookup table for states, similar to msa and lata
7253     'state' => {
7254       'columns' => [
7255         'statenum', 'int',  '', '', '', '',
7256         'country',  'char', '',  2, '', '',
7257         'state',    'char', '', $char_d, '', '',
7258         'fips',     'char', '',  3, '', '',
7259       ],
7260       'primary_key' => 'statenum',
7261       'unique' => [ [ 'country', 'state' ], ],
7262       'index' => [],
7263     },
7264
7265     # eventually link to tower/sector?
7266     'deploy_zone' => {
7267       'columns' => [
7268         'zonenum',        'serial',  '',     '',      '', '',
7269         'description',    'char',    'NULL', $char_d, '', '',
7270         'agentnum',       'int',     '',     '',      '', '',
7271         'censusyear',     'char',    'NULL', 4,      '', '',
7272         'dbaname',        'char',    'NULL', $char_d, '', '',
7273         'zonetype',       'char',    '',     1,       '', '',
7274         'technology',     'int',     '',     '',      '', '',
7275         'spectrum',       'int',     'NULL', '',      '', '',
7276         'adv_speed_up',   'decimal', '',     '10,3', '0', '',
7277         'adv_speed_down', 'decimal', '',     '10,3', '0', '',
7278         'cir_speed_up',   'decimal', '',     '10,3', '0', '',
7279         'cir_speed_down', 'decimal', '',     '10,3', '0', '',
7280         'is_broadband',   'char',    'NULL', 1,       '', '',
7281         'is_voice',       'char',    'NULL', 1,       '', '',
7282         'is_consumer',    'char',    'NULL', 1,       '', '',
7283         'is_business',    'char',    'NULL', 1,       '', '',
7284         'active_date',    @date_type,                 '', '',
7285         'expire_date',    @date_type,                 '', '',
7286       ],
7287       'primary_key' => 'zonenum',
7288       'unique' => [],
7289       'index'  => [ [ 'agentnum' ] ],
7290       'foreign_keys' => [
7291                           { columns     => [ 'agentnum' ],
7292                             table       => 'agent',
7293                             references  => [ 'agentnum' ],
7294                           },
7295                         ],
7296     },
7297
7298     'deploy_zone_block' => {
7299       'columns' => [
7300         'blocknum',       'serial',  '',     '',      '', '',
7301         'zonenum',        'int',     '',     '',      '', '',
7302         'censusblock',    'char',    '',     15,      '', '',
7303         'censusyear',     'char','NULL',      4,      '', '',
7304       ],
7305       'primary_key' => 'blocknum',
7306       'unique' => [],
7307       'index'  => [ [ 'zonenum' ] ],
7308       'foreign_keys' => [
7309                           { columns     => [ 'zonenum' ],
7310                             table       => 'deploy_zone',
7311                             references  => [ 'zonenum' ],
7312                           },
7313                         ],
7314     },
7315
7316     'deploy_zone_vertex' => {
7317       'columns' => [
7318         'vertexnum',      'serial',  '',     '',      '', '',
7319         'zonenum',        'int',     '',     '',      '', '',
7320         'latitude',       'decimal', '',     '10,7',  '', '',
7321         'longitude',      'decimal', '',     '10,7',  '', '',
7322       ],
7323       'primary_key' => 'vertexnum',
7324       'unique' => [ ],
7325       'index'  => [ ],
7326       'foreign_keys' => [
7327                           { columns     => [ 'zonenum' ],
7328                             table       => 'deploy_zone',
7329                             references  => [ 'zonenum' ],
7330                           },
7331                         ],
7332     },
7333
7334     'cacti_page' => {
7335       'columns' => [
7336         'cacti_pagenum',  'serial',   '',     '', '', '',
7337         'exportnum',      'int',      'NULL', '', '', '',
7338         'svcnum',         'int',      'NULL', '', '', '',
7339         'graphnum',       'int',      'NULL', '', '', '',
7340         'imported',       @date_type,             '', '',
7341         'content',        'text',     'NULL', '', '', '',
7342         'thumbnail',      'text',     'NULL', '', '', '',
7343       ],
7344       'primary_key' => 'cacti_pagenum',
7345       'unique'  => [ ],
7346       'index'   => [ ['svcnum'], ['imported'] ],
7347       'foreign_keys' => [
7348                           { columns    => [ 'svcnum' ],
7349                             table      => 'cust_svc',
7350                             references => [ 'svcnum' ],
7351                           },
7352                           { columns    => [ 'exportnum' ],
7353                             table      => 'part_export',
7354                             references => [ 'exportnum' ],
7355                           },
7356                         ],
7357     },
7358
7359     'report_batch' => {
7360       'columns' => [
7361         'reportbatchnum', 'serial',      '',  '', '', '',
7362         'reportname',     'varchar',     '', 255, '', '',
7363         'agentnum',           'int', 'NULL',  '', '', '',
7364         'send_date',     @date_type,              '', '',
7365         'sdate',         @date_type,              '', '',
7366         'edate',         @date_type,              '', '',
7367         'usernum',            'int', 'NULL',  '', '', '',
7368         'msgnum',             'int', 'NULL',  '', '', '',
7369         # add report params here as necessary
7370       ],
7371       'primary_key' => 'reportbatchnum',
7372       'unique' => [],
7373       'index'  => [],
7374       'foreign_keys' => [
7375                           { columns    => [ 'agentnum' ],
7376                             table      => 'agent',
7377                             references => [ 'agentnum' ],
7378                           },
7379                           { columns    => [ 'usernum' ],
7380                             table      => 'access_user',
7381                             references => [ 'usernum' ],
7382                           },
7383                           { columns    => [ 'msgnum' ],
7384                             table      => 'msg_template',
7385                             references => [ 'msgnum' ],
7386                           },
7387                         ],
7388     },
7389
7390     'password_history' => {
7391       'columns' => [
7392         'passwordnum',        'serial',  '',          '', '', '',
7393         '_password',          'varchar', 'NULL', $char_d, '', '',
7394         'encryption_method',  'varchar', 'NULL', $char_d, '', '',
7395         'created',   @date_type,   '', '',
7396         # each table that needs password history gets a column here, and
7397         # an entry in foreign_keys.
7398         'svc_acct__svcnum',     'int', 'NULL', '', '', '',
7399         'svc_dsl__svcnum',      'int', 'NULL', '', '', '',
7400         'svc_alarm__svcnum',    'int', 'NULL', '', '', '',
7401         'agent__agentnum',      'int', 'NULL', '', '', '',
7402         'contact__contactnum',  'int', 'NULL', '', '', '',
7403         'access_user__usernum', 'int', 'NULL', '', '', '',
7404       ],
7405       'primary_key' => 'passwordnum',
7406       'unique' => [],
7407       'index'  => [],
7408       'foreign_keys' => [
7409                           { columns     => [ 'svc_acct__svcnum' ],
7410                             table       => 'svc_acct',
7411                             references  => [ 'svcnum' ],
7412                           },
7413                           { columns     => [ 'svc_dsl__svcnum' ],
7414                             table       => 'svc_dsl',
7415                             references  => [ 'svcnum' ],
7416                           },
7417                           { columns     => [ 'svc_alarm__svcnum' ],
7418                             table       => 'svc_alarm',
7419                             references  => [ 'svcnum' ],
7420                           },
7421                           { columns    => [ 'agent__agentnum' ],
7422                             table      => 'agent',
7423                             references => [ 'agentnum' ],
7424                           },
7425                           { columns    => [ 'contact__contactnum' ],
7426                             table      => 'contact',
7427                             references => [ 'contactnum' ],
7428                           },
7429                           { columns    => [ 'access_user__usernum' ],
7430                             table      => 'access_user',
7431                             references => [ 'usernum' ],
7432                           },
7433                         ],
7434     },
7435
7436     'webservice_log' => {
7437       'columns' => [
7438         'webservicelognum',    'serial',      '',      '', '', '', #big? hubrus
7439         'svcnum',                 'int',  'NULL',      '', '', '', #just in case
7440         'custnum',                'int',      '',      '', '', '',
7441         'method',             'varchar',      '', $char_d, '', '',
7442         'quantity',               'int',      '',      '', '', '', #i.e. pages
7443         '_date',             @date_type,                   '', '',
7444         'status',             'varchar',  'NULL', $char_d, '', '',
7445         'rated_price',        'decimal',  'NULL',  '10,2', '', '',
7446       ],
7447       'primary_key'  => 'webservicelognum',
7448       'unique'       => [],
7449       'index'        => [ ['custnum'], ['status'] ],
7450       'foreign_keys' => [
7451                           { columns => [ 'custnum' ],
7452                             table   => 'cust_main',
7453                           },
7454                           #no FK on svcnum... we don't want to purge these on
7455                           # service deletion
7456                         ],
7457     },
7458
7459     'rt_field_charge' => {
7460       'columns' => [
7461         'rtfieldchargenum',    'serial',      '',      '', '', '',
7462         'pkgnum',                 'int',      '',      '', '', '',
7463         'ticketid',               'int',      '',      '', '', '',
7464         'rate',             @money_type,                   '', '',
7465         'units',              'decimal',      '',  '10,4', '', '',
7466         'charge',           @money_type,                   '', '',
7467         '_date',             @date_type,                   '', '',
7468       ],
7469       'primary_key'  => 'rtfieldchargenum',
7470       'unique'       => [],
7471       'index'        => [ ['pkgnum', 'ticketid'] ],
7472       'foreign_keys' => [
7473                           { columns    => [ 'pkgnum' ],
7474                             table      => 'cust_pkg',
7475                           },
7476                         ],
7477     },
7478
7479     'commission_schedule' => {
7480       'columns' => [
7481         'schedulenum',    'serial',     '',      '', '', '',
7482         'schedulename',  'varchar',     '', $char_d, '', '',
7483         'reasonnum',         'int', 'NULL',      '', '', '',
7484         'basis',         'varchar', 'NULL',      32, '', '',
7485       ],
7486       'primary_key'  => 'schedulenum',
7487       'unique'       => [],
7488       'index'        => [],
7489     },
7490
7491     'commission_rate' => {
7492       'columns' => [
7493         'commissionratenum', 'serial',     '',      '', '', '',
7494         'schedulenum',       'int',     '',      '', '', '',
7495         'cycle',             'int',     '',      '', '', '',
7496         'amount',            @money_type,          '', '',
7497         'percent',           'decimal','',   '7,4', '', '',
7498       ],
7499       'primary_key'  => 'commissionratenum',
7500       'unique'       => [ [ 'schedulenum', 'cycle', ] ],
7501       'index'        => [],
7502       'foreign_keys' => [
7503                           { columns => [ 'schedulenum' ],
7504                             table   => 'commission_schedule',
7505                           },
7506                         ],
7507     },
7508
7509     'saved_search' => {
7510       'columns' => [
7511         'searchnum',    'serial',  '',          '', '', '',
7512         'usernum',      'int',     'NULL',      '', '', '',
7513         'searchname',   'varchar', '',     $char_d, '', '',
7514         'path',         'varchar', '',     $char_d, '', '',
7515         'params',       'text',    'NULL',      '', '', '',
7516         'disabled',     'char',    'NULL',       1, '', '',
7517         'freq',         'varchar', 'NULL',      16, '', '',
7518         'last_sent',    'int',     'NULL',      '', '', '',
7519         'format',       'varchar', 'NULL',      32, '', '',
7520       ],
7521       'primary_key'   => 'searchnum',
7522       'unique'        => [],
7523       'index'         => [],
7524       'foreign_keys'  => [
7525                            { columns => [ 'usernum' ],
7526                              table   => 'access_user',
7527                            },
7528                          ],
7529     },
7530
7531     'addr_status' => {
7532       'columns' => [
7533         'addrnum',  'serial',      '', '', '', '',
7534         'ip_addr',  'varchar', 'NULL', 40, '', '',
7535         '_date',    @date_type,            '', '',
7536         'up',       'char',    'NULL',  1, '', '',
7537         'delay',    'int',     'NULL', '', '', '',
7538       ],
7539       'primary_key'   => 'addrnum',
7540       'unique'        => [ [ 'ip_addr' ] ],
7541       'index'         => [ [ '_date' ] ],
7542       'foreign_keys'  => [],
7543     },
7544
7545     # name type nullability length default local
7546
7547     #'new_table' => {
7548     #  'columns' => [
7549     #    'num', 'serial',       '', '', '', '',
7550     #  ],
7551     #  'primary_key' => 'num',
7552     #  'unique' => [],
7553     #  'index'  => [],
7554     #},
7555
7556   };
7557
7558 }
7559
7560 =back
7561
7562 =head1 BUGS
7563
7564 =head1 SEE ALSO
7565
7566 L<DBIx::DBSchema>
7567
7568 =cut
7569
7570 1;
7571