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