FS/FS/Schema.pm

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