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