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       ],
1379       'primary_key' => 'paynum',
1380       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
1381       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ], [ 'usernum' ] ],
1382     },
1383
1384     'cust_pay_void' => {
1385       'columns' => [
1386         'paynum',    'int',    '',   '', '', '',
1387         'custnum',   'int',    '',   '', '', '',
1388         'paid',      @money_type, '', '',
1389         '_date',     @date_type, '', '',
1390         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1391                                                   # index into payby table
1392                                                   # eventually
1393         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
1394         'paymask', 'varchar', 'NULL', $char_d, '', '',
1395         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1396         'closed',    'char', 'NULL', 1, '', '',
1397         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1398         'void_date', @date_type, '', '',
1399         'reason',    'varchar',   'NULL', $char_d, '', '',
1400         'otaker',   'varchar', 'NULL', 32, '', '',
1401         'usernum',   'int', 'NULL', '', '', '',
1402         'void_usernum',   'int', 'NULL', '', '', '',
1403       ],
1404       'primary_key' => 'paynum',
1405       'unique' => [],
1406       'index' => [ [ 'custnum' ], [ 'usernum' ], [ 'void_usernum' ] ],
1407     },
1408
1409     'cust_bill_pay' => {
1410       'columns' => [
1411         'billpaynum', 'serial',     '',   '', '', '',
1412         'invnum',  'int',     '',   '', '', '',
1413         'paynum',  'int',     '',   '', '', '',
1414         'amount',  @money_type, '', '',
1415         '_date',   @date_type, '', '',
1416         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1417       ],
1418       'primary_key' => 'billpaynum',
1419       'unique' => [],
1420       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
1421     },
1422
1423     'cust_bill_pay_batch' => {
1424       'columns' => [
1425         'billpaynum', 'serial',     '',   '', '', '',
1426         'invnum',  'int',     '',   '', '', '',
1427         'paybatchnum',  'int',     '',   '', '', '',
1428         'amount',  @money_type, '', '',
1429         '_date',   @date_type, '', '',
1430       ],
1431       'primary_key' => 'billpaynum',
1432       'unique' => [],
1433       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1434     },
1435
1436     'cust_bill_pay_pkg' => {
1437       'columns' => [
1438         'billpaypkgnum', 'serial', '', '', '', '',
1439         'billpaynum',       'int', '', '', '', '',
1440         'billpkgnum',       'int', '', '', '', '',
1441         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
1442         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
1443         'amount',         @money_type,     '', '',
1444         'setuprecur',      'varchar', '', $char_d, '', '',
1445         'sdate',   @date_type, '', '',
1446         'edate',   @date_type, '', '',
1447       ],
1448       'primary_key' => 'billpaypkgnum',
1449       'unique'      => [],
1450       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1451     },
1452
1453     'pay_batch' => { #batches of payments to an external processor
1454       'columns' => [
1455         'batchnum', 'serial',     '', '', '', '',
1456         'agentnum',    'int', 'NULL', '', '', '',
1457         'payby',      'char',     '',  4, '', '', # CARD/CHEK
1458         'status',     'char', 'NULL',  1, '', '',
1459         'download',       @date_type,     '', '',
1460         'upload',         @date_type,     '', '',
1461       ],
1462       'primary_key' => 'batchnum',
1463       'unique' => [],
1464       'index' => [],
1465     },
1466
1467     'cust_pay_batch' => { #list of customers in current CARD/CHEK batch
1468       'columns' => [
1469         'paybatchnum',   'serial',    '',   '', '', '',
1470         'batchnum',   'int',    '',   '', '', '',
1471         'invnum',   'int',    '',   '', '', '',
1472         'custnum',   'int',    '',   '', '', '',
1473         'last',     'varchar', '',     $char_d, '', '',
1474         'first',    'varchar', '',     $char_d, '', '',
1475         'address1', 'varchar', '',     $char_d, '', '',
1476         'address2', 'varchar', 'NULL', $char_d, '', '',
1477         'city',     'varchar', '',     $char_d, '', '',
1478         'state',    'varchar', 'NULL', $char_d, '', '',
1479         'zip',      'varchar', 'NULL', 10, '', '',
1480         'country',  'char', '',     2, '', '',
1481         #        'trancode', 'int', '', '', '', ''
1482         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1483         'payinfo',  'varchar', '',     512, '', '',
1484         #'exp',      @date_type, '', ''
1485         'exp',      'varchar', 'NULL',     11, '', '',
1486         'payname',  'varchar', 'NULL', $char_d, '', '',
1487         'amount',   @money_type, '', '',
1488         'status',   'varchar', 'NULL',     $char_d, '', '',
1489       ],
1490       'primary_key' => 'paybatchnum',
1491       'unique' => [],
1492       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1493     },
1494
1495     'fcc477map' => {
1496       'columns' => [
1497         'formkey',   'varchar',     '', 255, '', '',
1498         'formvalue',    'text', 'NULL',  '', '', '',
1499       ],
1500       'primary_key' => 'formkey',
1501       'unique'      => [],
1502       'index'       => [],
1503     },
1504
1505     'cust_pkg' => {
1506       'columns' => [
1507         'pkgnum',           'serial',     '', '', '', '',
1508         'custnum',             'int',     '', '', '', '',
1509         'pkgpart',             'int',     '', '', '', '',
1510         'pkgbatch',        'varchar', 'NULL', $char_d, '', '',
1511         'locationnum',         'int', 'NULL', '', '', '',
1512         'otaker',          'varchar', 'NULL', 32, '', '',
1513         'usernum',             'int', 'NULL', '', '', '',
1514         'order_date',     @date_type,             '', '',
1515         'start_date',     @date_type,             '', '',
1516         'setup',          @date_type,             '', '',
1517         'bill',           @date_type,             '', '',
1518         'last_bill',      @date_type,             '', '',
1519         'susp',           @date_type,             '', '',
1520         'adjourn',        @date_type,             '', '',
1521         'resume',         @date_type,             '', '',
1522         'cancel',         @date_type,             '', '',
1523         'uncancel',       @date_type,             '', '',
1524         'uncancel_pkgnum',     'int', 'NULL', '', '', '',
1525         'expire',         @date_type,             '', '',
1526         'contract_end',   @date_type,             '', '',
1527         'dundate',        @date_type,             '', '',
1528         'change_date',    @date_type,             '', '',
1529         'change_pkgnum',       'int', 'NULL', '', '', '',
1530         'change_pkgpart',      'int', 'NULL', '', '', '',
1531         'change_locationnum',  'int', 'NULL', '', '', '',
1532         'manual_flag',        'char', 'NULL',  1, '', '',
1533         'no_auto',            'char', 'NULL',  1, '', '',
1534         'quantity',            'int', 'NULL', '', '', '',
1535         'agent_pkgid',         'int', 'NULL', '', '', '',
1536         'waive_setup',        'char', 'NULL',  1, '', '',
1537         'recur_show_zero',    'char', 'NULL',  1, '', '',
1538         'setup_show_zero',    'char', 'NULL',  1, '', '',
1539       ],
1540       'primary_key' => 'pkgnum',
1541       'unique' => [],
1542       'index' => [ ['custnum'], ['pkgpart'], [ 'pkgbatch' ], [ 'locationnum' ],
1543                    [ 'usernum' ], [ 'agent_pkgid' ],
1544                    ['order_date'], [ 'start_date' ], ['setup'], ['bill'],
1545                    ['last_bill'], ['susp'], ['adjourn'], ['cancel'],
1546                    ['expire'], ['contract_end'], ['change_date'], ['no_auto'],
1547                  ],
1548     },
1549
1550     'cust_pkg_option' => {
1551       'columns' => [
1552         'optionnum', 'serial', '', '', '', '',
1553         'pkgnum', 'int', '', '', '', '',
1554         'optionname', 'varchar', '', $char_d, '', '',
1555         'optionvalue', 'text', 'NULL', '', '', '',
1556       ],
1557       'primary_key' => 'optionnum',
1558       'unique'      => [],
1559       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
1560     },
1561
1562     'cust_pkg_detail' => {
1563       'columns' => [
1564         'pkgdetailnum', 'serial', '',      '', '', '',
1565         'pkgnum',          'int', '',      '', '', '',
1566         'detail',      'varchar', '', $char_d, '', '',
1567         'detailtype',     'char', '',       1, '', '', # "I"nvoice or "C"omment
1568         'weight',          'int', '',      '', '', '',
1569       ],
1570       'primary_key' => 'pkgdetailnum',
1571       'unique' => [],
1572       'index'  => [ [ 'pkgnum', 'detailtype' ] ],
1573     },
1574
1575     'cust_pkg_reason' => {
1576       'columns' => [
1577         'num',      'serial',    '',   '', '', '',
1578         'pkgnum',   'int',    '',   '', '', '',
1579         'reasonnum','int',    '',   '', '', '',
1580         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
1581         'otaker',   'varchar', 'NULL', 32, '', '',
1582         'usernum',   'int', 'NULL', '', '', '',
1583         'date',     @date_type, '', '',
1584       ],
1585       'primary_key' => 'num',
1586       'unique' => [],
1587       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], [ 'usernum' ], ],
1588     },
1589
1590     'cust_pkg_discount' => {
1591       'columns' => [
1592         'pkgdiscountnum', 'serial', '',        '', '', '',
1593         'pkgnum',            'int', '',        '', '', '',
1594         'discountnum',       'int', '',        '', '', '',
1595         'months_used',   'decimal', 'NULL', '7,4', '', '',
1596         'end_date',     @date_type,                '', '',
1597         'otaker',        'varchar', 'NULL',    32, '', '',
1598         'usernum',           'int', 'NULL',    '', '', '',
1599         'disabled',         'char', 'NULL',     1, '', '',
1600       ],
1601       'primary_key' => 'pkgdiscountnum',
1602       'unique' => [],
1603       'index'  => [ [ 'pkgnum' ], [ 'discountnum' ], [ 'usernum' ], ],
1604     },
1605
1606     'cust_bill_pkg_discount' => {
1607       'columns' => [
1608         'billpkgdiscountnum', 'serial',        '', '', '', '',
1609         'billpkgnum',            'int',        '', '', '', '',
1610         'pkgdiscountnum',        'int',        '', '', '', '',
1611         'amount',          @money_type,                '', '',
1612         'months',            'decimal', 'NULL', '7,4', '', '',
1613       ],
1614       'primary_key' => 'billpkgdiscountnum',
1615       'unique' => [],
1616       'index' => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
1617     },
1618
1619     'discount' => {
1620       'columns' => [
1621         'discountnum', 'serial',     '',      '', '', '',
1622         #'agentnum',       'int', 'NULL',      '', '', '',
1623         'name',       'varchar', 'NULL', $char_d, '', '',
1624         'amount',   @money_type,                  '', '',
1625         'percent',    'decimal',     '',   '7,4', '', '',
1626         'months',     'decimal', 'NULL',   '7,4', '', '',
1627         'disabled',      'char', 'NULL',       1, '', '',
1628         'setup',      'char', 'NULL',       1, '', '',
1629       ],
1630       'primary_key' => 'discountnum',
1631       'unique' => [],
1632       'index'  => [], # [ 'agentnum' ], ],
1633     },
1634
1635     'cust_refund' => {
1636       'columns' => [
1637         'refundnum',    'serial',    '',   '', '', '',
1638         'custnum',  'int',    '',   '', '', '',
1639         '_date',        @date_type, '', '',
1640         'refund',       @money_type, '', '',
1641         'otaker',       'varchar',   'NULL',   32, '', '',
1642         'usernum',   'int', 'NULL', '', '', '',
1643         'reason',       'varchar',   '',   $char_d, '', '',
1644         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
1645                                                      # be index into payby
1646                                                      # table eventually
1647         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
1648         'paymask', 'varchar', 'NULL', $char_d, '', '',
1649         'paybatch',     'varchar',   'NULL', $char_d, '', '',
1650         'closed',    'char', 'NULL', 1, '', '',
1651       ],
1652       'primary_key' => 'refundnum',
1653       'unique' => [],
1654       'index' => [ ['custnum'], ['_date'], [ 'usernum' ], ],
1655     },
1656
1657     'cust_credit_refund' => {
1658       'columns' => [
1659         'creditrefundnum', 'serial',     '',   '', '', '',
1660         'crednum',  'int',     '',   '', '', '',
1661         'refundnum',  'int',     '',   '', '', '',
1662         'amount',  @money_type, '', '',
1663         '_date',   @date_type, '', '',
1664       ],
1665       'primary_key' => 'creditrefundnum',
1666       'unique' => [],
1667       'index' => [ ['crednum'], ['refundnum'] ],
1668     },
1669
1670
1671     'cust_svc' => {
1672       'columns' => [
1673         'svcnum',      'serial',     '', '', '', '',
1674         'pkgnum',         'int', 'NULL', '', '', '',
1675         'svcpart',        'int',     '', '', '', '',
1676         'agent_svcid',    'int', 'NULL', '', '', '',
1677         'overlimit',           @date_type,   '', '',
1678       ],
1679       'primary_key' => 'svcnum',
1680       'unique' => [],
1681       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'], [ 'agent_svcid' ] ],
1682     },
1683
1684     'cust_svc_option' => {
1685       'columns' => [
1686         'optionnum',   'serial', '', '', '', '',
1687         'svcnum',      'int', '', '', '', '',
1688         'optionname',  'varchar', '', $char_d, '', '',
1689         'optionvalue', 'text', 'NULL', '', '', '',
1690       ],
1691       'primary_key' => 'optionnum',
1692       'unique'      => [],
1693       'index'       => [ [ 'svcnum' ], [ 'optionname' ] ],
1694     },
1695
1696    'part_pkg' => {
1697       'columns' => [
1698         'pkgpart',       'serial',    '',   '', '', '',
1699         'pkg',           'varchar',   '',   $char_d, '', '',
1700         'comment',       'varchar',   '', 2*$char_d, '', '',
1701         'promo_code',    'varchar', 'NULL', $char_d, '', '',
1702         'setup',         @perl_type, '', '',
1703         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
1704         'recur',         @perl_type, '', '',
1705         'setuptax',      'char', 'NULL', 1, '', '',
1706         'recurtax',      'char', 'NULL', 1, '', '',
1707         'plan',          'varchar', 'NULL', $char_d, '', '',
1708         'plandata',      'text', 'NULL', '', '', '',
1709         'disabled',      'char', 'NULL', 1, '', '',
1710         'custom',        'char', 'NULL', 1, '', '',
1711         'taxclass',      'varchar', 'NULL', $char_d, '', '',
1712         'classnum',      'int',     'NULL', '', '', '',
1713         'addon_classnum','int',     'NULL', '', '', '',
1714         'taxproductnum', 'int',     'NULL', '', '', '',
1715         'setup_cost',    @money_typen,          '', '',
1716         'recur_cost',    @money_typen,          '', '',
1717         'pay_weight',    'real',    'NULL', '', '', '',
1718         'credit_weight', 'real',    'NULL', '', '', '',
1719         'agentnum',      'int',     'NULL', '', '', '',
1720         'fcc_ds0s',      'int',     'NULL', '', '', '',
1721         'fcc_voip_class','char',    'NULL',  1, '', '',
1722         'no_auto',          'char', 'NULL',  1, '', '',
1723         'recur_show_zero',  'char', 'NULL',  1, '', '',
1724         'setup_show_zero',  'char', 'NULL',  1, '', '',
1725       ],
1726       'primary_key' => 'pkgpart',
1727       'unique' => [],
1728       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'classnum' ],
1729                    [ 'agentnum' ], ['no_auto'],
1730                  ],
1731     },
1732
1733     'part_pkg_link' => {
1734       'columns' => [
1735         'pkglinknum',  'serial',   '',      '', '', '',
1736         'src_pkgpart', 'int',      '',      '', '', '',
1737         'dst_pkgpart', 'int',      '',      '', '', '',
1738         'link_type',   'varchar',  '', $char_d, '', '',
1739         'hidden',      'char', 'NULL',       1, '', '',
1740       ],
1741       'primary_key' => 'pkglinknum',
1742       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type', 'hidden' ] ],
1743       'index'  => [ [ 'src_pkgpart' ] ],
1744     },
1745     # XXX somewhat borked unique: we don't really want a hidden and unhidden
1746     # it turns out we'd prefer to use svc, bill, and invisibill (or something)
1747
1748     'part_pkg_discount' => {
1749       'columns' => [
1750         'pkgdiscountnum', 'serial',   '',      '', '', '',
1751         'pkgpart',        'int',      '',      '', '', '',
1752         'discountnum',    'int',      '',      '', '', '',
1753       ],
1754       'primary_key' => 'pkgdiscountnum',
1755       'unique' => [ [ 'pkgpart', 'discountnum' ] ],
1756       'index'  => [],
1757     },
1758
1759     'part_pkg_taxclass' => {
1760       'columns' => [
1761         'taxclassnum',  'serial', '',       '', '', '',
1762         'taxclass',     'varchar', '', $char_d, '', '',
1763         'disabled', 'char',   'NULL',         1, '', '',
1764       ],
1765       'primary_key' => 'taxclassnum',
1766       'unique'      => [ [ 'taxclass' ] ],
1767       'index'       => [ [ 'disabled' ] ],
1768     },
1769
1770     'part_pkg_taxproduct' => {
1771       'columns' => [
1772         'taxproductnum', 'serial',      '',        '', '', '',
1773         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
1774         'taxproduct',    'varchar',     '',   $char_d, '', '',
1775         'description',   'varchar',     '', 3*$char_d, '', '',
1776       ],
1777       'primary_key' => 'taxproductnum',
1778       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
1779       'index'       => [],
1780     },
1781
1782     'part_pkg_taxrate' => {
1783       'columns' => [
1784         'pkgtaxratenum', 'serial',  '',     '',      '', '',
1785         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
1786         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
1787         'taxproductnum', 'int',  '',     '',       '', '',
1788         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
1789         'county',           'varchar', 'NULL', $char_d, '', '',
1790         'state',            'varchar', 'NULL', $char_d, '', '',
1791         'local',            'varchar', 'NULL', $char_d, '', '',
1792         'country',          'char',    'NULL', 2,       '', '',
1793         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
1794         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
1795         'taxclassnum',      'int',     'NULL', '',      '', '',
1796         'effdate',          @date_type, '', '',
1797         'taxable',          'char',    'NULL', 1,       '', '',
1798       ],
1799       'primary_key' => 'pkgtaxratenum',
1800       'unique' => [],
1801       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1802     },
1803
1804     'part_pkg_taxoverride' => {
1805       'columns' => [
1806         'taxoverridenum', 'serial', '', '', '', '',
1807         'pkgpart',           'int', '', '', '', '',
1808         'taxclassnum',       'int', '', '', '', '',
1809         'usage_class',    'varchar', 'NULL', $char_d, '', '',
1810       ],
1811       'primary_key' => 'taxoverridenum',
1812       'unique' => [],
1813       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1814     },
1815
1816 #    'part_title' => {
1817 #      'columns' => [
1818 #        'titlenum',   'int',    '',   '',
1819 #        'title',      'varchar',   '',   $char_d,
1820 #      ],
1821 #      'primary_key' => 'titlenum',
1822 #      'unique' => [ [] ],
1823 #      'index' => [ [] ],
1824 #    },
1825
1826     'pkg_svc' => {
1827       'columns' => [
1828         'pkgsvcnum',  'serial', '',  '', '', '',
1829         'pkgpart',    'int',    '',   '', '', '',
1830         'svcpart',    'int',    '',   '', '', '',
1831         'quantity',   'int',    '',   '', '', '',
1832         'primary_svc','char', 'NULL',  1, '', '',
1833         'hidden',     'char', 'NULL',  1, '', '',
1834       ],
1835       'primary_key' => 'pkgsvcnum',
1836       'unique' => [ ['pkgpart', 'svcpart'] ],
1837       'index' => [ ['pkgpart'], ['quantity'] ],
1838     },
1839
1840     'part_referral' => {
1841       'columns' => [
1842         'refnum',   'serial',     '',        '', '', '',
1843         'referral', 'varchar',    '',   $char_d, '', '',
1844         'disabled', 'char',   'NULL',         1, '', '',
1845         'agentnum', 'int',    'NULL',        '', '', '',
1846       ],
1847       'primary_key' => 'refnum',
1848       'unique' => [],
1849       'index' => [ ['disabled'], ['agentnum'], ],
1850     },
1851
1852     'part_svc' => {
1853       'columns' => [
1854         'svcpart',             'serial',     '',        '', '', '',
1855         'svc',                'varchar',     '',   $char_d, '', '',
1856         'svcdb',              'varchar',     '',   $char_d, '', '',
1857         'disabled',              'char', 'NULL',         1, '', '',
1858         'preserve',              'char', 'NULL',         1, '', '',
1859         'selfservice_access', 'varchar', 'NULL',   $char_d, '', '',
1860       ],
1861       'primary_key' => 'svcpart',
1862       'unique' => [],
1863       'index' => [ [ 'disabled' ] ],
1864     },
1865
1866     'part_svc_column' => {
1867       'columns' => [
1868         'columnnum',   'serial',      '',      '', '', '',
1869         'svcpart',     'int',         '',      '', '', '',
1870         'columnname',  'varchar',     '',      64, '', '',
1871         'columnlabel', 'varchar', 'NULL', $char_d, '', '',
1872         'columnvalue', 'varchar', 'NULL',     512, '', '',
1873         'columnflag',  'char',    'NULL',       1, '', '',
1874       ],
1875       'primary_key' => 'columnnum',
1876       'unique' => [ [ 'svcpart', 'columnname' ] ],
1877       'index' => [ [ 'svcpart' ] ],
1878     },
1879
1880     #(this should be renamed to part_pop)
1881     'svc_acct_pop' => {
1882       'columns' => [
1883         'popnum',    'serial',    '',   '', '', '',
1884         'city',      'varchar',   '',   $char_d, '', '',
1885         'state',     'varchar',   '',   $char_d, '', '',
1886         'ac',        'char',   '',   3, '', '',
1887         'exch',      'char',   '',   3, '', '',
1888         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
1889       ],
1890       'primary_key' => 'popnum',
1891       'unique' => [],
1892       'index' => [ [ 'state' ] ],
1893     },
1894
1895     'part_pop_local' => {
1896       'columns' => [
1897         'localnum',  'serial',     '',     '', '', '',
1898         'popnum',    'int',     '',     '', '', '',
1899         'city',      'varchar', 'NULL', $char_d, '', '',
1900         'state',     'char',    'NULL', 2, '', '',
1901         'npa',       'char',    '',     3, '', '',
1902         'nxx',       'char',    '',     3, '', '',
1903       ],
1904       'primary_key' => 'localnum',
1905       'unique' => [],
1906       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1907     },
1908
1909     'qual' => {
1910       'columns' => [
1911         'qualnum',  'serial',     '',     '', '', '',
1912         'custnum',    'int',     'NULL',     '', '', '',
1913         'prospectnum',    'int',     'NULL',     '', '', '',
1914         'locationnum',    'int',     'NULL',     '', '', '',
1915         'phonenum',     'varchar', 'NULL',       24, '', '',
1916         'exportnum',      'int', 'NULL', '', '', '',
1917         'vendor_qual_id',      'varchar', 'NULL', $char_d, '', '',
1918         'status',      'char', '', 1, '', '',
1919       ],
1920       'primary_key' => 'qualnum',
1921       'unique' => [],
1922       'index' => [ [ 'locationnum' ], ['custnum'], ['prospectnum'],
1923                     ['phonenum'], ['vendor_qual_id'] ],
1924     },
1925
1926     'qual_option' => {
1927       'columns' => [
1928         'optionnum', 'serial', '', '', '', '',
1929         'qualnum',  'int',     '',     '', '', '',
1930         'optionname', 'varchar', '', $char_d, '', '',
1931         'optionvalue', 'text', 'NULL', '', '', '',
1932       ],
1933       'primary_key' => 'optionnum',
1934       'unique' => [],
1935       'index' => [],
1936     },
1937
1938     'svc_acct' => {
1939       'columns' => [
1940         'svcnum',    'int',    '',   '', '', '',
1941         'username',  'varchar',   '',   $username_len, '', '',
1942         '_password', 'varchar',   'NULL',  512, '', '',
1943         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1944         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
1945         'popnum',    'int',    'NULL',   '', '', '',
1946         'sectornum', 'int', 'NULL',      '', '', '',
1947         'uid',       'int', 'NULL',   '', '', '',
1948         'gid',       'int', 'NULL',   '', '', '',
1949         'finger',    'varchar',   'NULL',   2*$char_d, '', '',
1950         'dir',       'varchar',   'NULL',   $char_d, '', '',
1951         'shell',     'varchar',   'NULL',   $char_d, '', '',
1952         'quota',     'varchar',   'NULL',   $char_d, '', '',
1953         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
1954         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
1955         'seconds_threshold',   'int', 'NULL',   '', '', '',
1956         'upbytes',   'bigint', 'NULL',   '', '', '',
1957         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
1958         'downbytes', 'bigint', 'NULL',   '', '', '',
1959         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
1960         'totalbytes','bigint', 'NULL',   '', '', '',
1961         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
1962         'domsvc',    'int',     '', '', '', '',
1963         'pbxsvc',    'int', 'NULL', '', '', '',
1964         'last_login',  @date_type, '', '',
1965         'last_logout', @date_type, '', '',
1966         #cardfortress field(s)
1967         'cf_privatekey',      'text', 'NULL',      '', '', '',
1968         #communigate pro fields (quota = MaxAccountSize)
1969         'cgp_aliases',     'varchar', 'NULL',     255, '', '',
1970         #settings
1971         'cgp_type',        'varchar', 'NULL', $char_d, '', '', #AccountType
1972         'file_quota',      'varchar', 'NULL', $char_d, '', '', #MaxWebSize
1973         'file_maxnum',     'varchar', 'NULL', $char_d, '', '', #MaxWebFiles
1974         'file_maxsize',    'varchar', 'NULL', $char_d, '', '', #MaxFileSize
1975         'cgp_accessmodes', 'varchar', 'NULL',     255, '', '', #AccessModes
1976         'password_selfchange','char', 'NULL',       1, '', '', #PWDAllowed
1977         'password_recover',   'char', 'NULL',       1, 'Y','', #PasswordRecovery
1978         'cgp_rulesallowed','varchar', 'NULL', $char_d, '', '', #RulesAllowed
1979         'cgp_rpopallowed',    'char', 'NULL',       1, '', '', #RPOPAllowed
1980         'cgp_mailtoall',      'char', 'NULL',       1, '', '', #MailToAll
1981         'cgp_addmailtrailer', 'char', 'NULL',       1, '', '', #AddMailTrailer
1982         'cgp_archiveafter',    'int', 'NULL',      '', '', '', #ArchiveMessagesAfter
1983         #XXX mailing lists
1984         #preferences
1985         'cgp_deletemode',     'varchar', 'NULL', $char_d, '', '',#DeleteMode
1986         'cgp_emptytrash',     'varchar', 'NULL', $char_d, '', '',#EmptyTrash
1987         'cgp_language',       'varchar', 'NULL', $char_d, '', '',#Language
1988         'cgp_timezone',       'varchar', 'NULL', $char_d, '', '',#TimeZone
1989         'cgp_skinname',       'varchar', 'NULL', $char_d, '', '',#SkinName
1990         'cgp_prontoskinname', 'varchar', 'NULL', $char_d, '', '',#ProntoSkinName
1991         'cgp_sendmdnmode',    'varchar', 'NULL', $char_d, '', '',#SendMDNMode
1992         #mail
1993         #XXX RPOP settings
1994       ],
1995       'primary_key' => 'svcnum',
1996       #'unique' => [ [ 'username', 'domsvc' ] ],
1997       'unique' => [],
1998       'index' => [ ['username'], ['domsvc'], ['pbxsvc'] ],
1999     },
2000
2001     'acct_rt_transaction' => {
2002       'columns' => [
2003         'svcrtid',   'int',    '',   '', '', '',
2004         'svcnum',    'int',    '',   '', '', '',
2005         'transaction_id',       'int', '',   '', '', '',
2006         '_date',   @date_type, '', '',
2007         'seconds',   'int', '',   '', '', '', #uhhhh
2008         'support',   'int', '',   '', '', '',
2009       ],
2010       'primary_key' => 'svcrtid',
2011       'unique' => [],
2012       'index' => [ ['svcnum', 'transaction_id'] ],
2013     },
2014
2015     #'svc_charge' => {
2016     #  'columns' => [
2017     #    'svcnum',    'int',    '',   '',
2018     #    'amount',    @money_type,
2019     #  ],
2020     #  'primary_key' => 'svcnum',
2021     #  'unique' => [ [] ],
2022     #  'index' => [ [] ],
2023     #},
2024
2025     'svc_domain' => {
2026       'columns' => [
2027         'svcnum',           'int',    '',        '', '', '',
2028         'domain',       'varchar',    '',   $char_d, '', '',
2029         'suffix',       'varchar', 'NULL',  $char_d, '', '',
2030         'catchall',         'int', 'NULL',       '', '', '',
2031         'parent_svcnum',    'int', 'NULL',       '', '', '',
2032         'registrarnum',     'int', 'NULL',       '', '', '',
2033         'registrarkey', 'varchar', 'NULL',      512, '', '',
2034         'setup_date',      @date_type, '', '',
2035         'renewal_interval', 'int', 'NULL',       '', '', '',
2036         'expiration_date', @date_type, '', '',
2037         'au_registrant_name',       'varchar', 'NULL',  $char_d, '', '',
2038         'au_eligibility_type',      'varchar', 'NULL',  $char_d, '', '',
2039         #communigate pro fields (quota = MaxAccountSize)
2040         'max_accounts',     'int', 'NULL',       '', '', '',
2041         'trailer',         'text', 'NULL',       '', '', '',
2042         'cgp_aliases',  'varchar', 'NULL',      255, '', '',
2043         'cgp_accessmodes','varchar','NULL',     255, '', '', #DomainAccessModes
2044         'cgp_certificatetype','varchar','NULL', $char_d, '', '',
2045         #settings
2046         'acct_def_password_selfchange',   'char', 'NULL',       1,  '', '',
2047         'acct_def_password_recover',      'char', 'NULL',       1, 'Y', '',
2048         'acct_def_cgp_accessmodes',    'varchar', 'NULL',     255,  '', '',
2049         'acct_def_quota',              'varchar', 'NULL', $char_d,  '', '',
2050         'acct_def_file_quota',         'varchar', 'NULL', $char_d,  '', '',
2051         'acct_def_file_maxnum',        'varchar', 'NULL', $char_d,  '', '',
2052         'acct_def_file_maxsize',       'varchar', 'NULL', $char_d,  '', '',
2053         'acct_def_cgp_rulesallowed',   'varchar', 'NULL', $char_d,  '', '',
2054         'acct_def_cgp_rpopallowed',       'char', 'NULL',       1,  '', '',
2055         'acct_def_cgp_mailtoall',         'char', 'NULL',       1,  '', '',
2056         'acct_def_cgp_addmailtrailer',    'char', 'NULL',       1,  '', '',
2057         'acct_def_cgp_archiveafter',       'int', 'NULL',      '',  '', '',
2058         #preferences
2059         'acct_def_cgp_deletemode',     'varchar', 'NULL', $char_d,  '', '',
2060         'acct_def_cgp_emptytrash',     'varchar', 'NULL', $char_d,  '', '',
2061         'acct_def_cgp_language',       'varchar', 'NULL', $char_d,  '', '',
2062         'acct_def_cgp_timezone',       'varchar', 'NULL', $char_d,  '', '',
2063         'acct_def_cgp_skinname',       'varchar', 'NULL', $char_d,  '', '',
2064         'acct_def_cgp_prontoskinname', 'varchar', 'NULL', $char_d,  '', '',
2065         'acct_def_cgp_sendmdnmode',    'varchar', 'NULL', $char_d,  '', '',
2066       ],
2067       'primary_key' => 'svcnum',
2068       'unique' => [ ],
2069       'index' => [ ['domain'] ],
2070     },
2071
2072     'svc_dsl' => {
2073       'columns' => [
2074         'svcnum',                    'int',    '',        '', '', '',
2075         'pushed',                    'int', 'NULL',       '', '', '',
2076         'desired_due_date',          'int', 'NULL',       '', '', '',
2077         'due_date',                  'int', 'NULL',       '', '', '',
2078         'vendor_order_id',       'varchar', 'NULL', $char_d,  '', '',
2079         'vendor_qual_id',        'varchar', 'NULL', $char_d,  '', '',
2080         'vendor_order_type',     'varchar', 'NULL', $char_d,  '', '',
2081         'vendor_order_status',   'varchar', 'NULL', $char_d,  '', '',
2082         'first',                 'varchar', 'NULL', $char_d,  '', '',
2083         'last',                  'varchar', 'NULL', $char_d,  '', '',
2084         'company',               'varchar', 'NULL', $char_d,  '', '',
2085         'phonenum',              'varchar', 'NULL',      24, '', '',
2086         'gateway_access_number', 'varchar', 'NULL',      24, '', '',
2087         'loop_type',                'char', 'NULL',       1, '', '',
2088         'local_voice_provider',  'varchar', 'NULL', $char_d, '', '',
2089         'circuitnum',            'varchar', 'NULL', $char_d, '', '',
2090         'rate_band',             'varchar', 'NULL', $char_d, '', '',
2091         'vpi',                       'int', 'NULL',      '', '', '',
2092         'vci',                       'int', 'NULL',      '', '', '',
2093         'isp_chg',                  'char', 'NULL',       1, '', '',
2094         'isp_prev',              'varchar', 'NULL', $char_d, '', '',
2095         'username',              'varchar', 'NULL', $char_d, '', '',
2096         'password',              'varchar', 'NULL', $char_d, '', '',
2097         'staticips',                'text', 'NULL',      '', '', '',
2098         'monitored',                'char', 'NULL',       1, '', '',
2099         'last_pull',                 'int', 'NULL',      '', '', '',
2100       ],
2101       'primary_key' => 'svcnum',
2102       'unique' => [ ],
2103       'index' => [ ['phonenum'], ['vendor_order_id'] ],
2104     },
2105
2106     'dsl_device' => {
2107       'columns' => [
2108         'devicenum', 'serial',     '', '', '', '',
2109         #part_device?  or our own part_dsl_device?
2110         #'devicepart',   'int',     '', '', '', '',
2111         'svcnum',       'int',     '', '', '', '',
2112         'mac_addr', 'varchar',     '', 12, '', '',
2113       ],
2114       'primary_key' => 'devicenum',
2115       'unique' => [ [ 'mac_addr' ], ],
2116       'index'  => [ [ 'svcnum' ], ], # [ 'devicepart' ] ],
2117     },
2118
2119     'dsl_note' => {
2120       'columns' => [
2121         'notenum',           'serial',    '',        '', '', '',
2122         'svcnum',     'int', '',       '', '', '',
2123         'author',     'varchar', 'NULL', $char_d,  '', '',
2124         'priority',   'char', 'NULL',       1,  '', '',
2125         '_date',     'int', 'NULL',       '', '', '',
2126         'note',     'text', '',       '', '', '',
2127       ],
2128       'primary_key' => 'notenum',
2129       'unique' => [ ],
2130       'index' => [ ['svcnum'] ],
2131     },
2132
2133     'svc_dish' => {
2134       'columns' => [
2135         'svcnum',   'int',     '',     '', '', '',
2136         'acctnum',  'varchar', '',     16, '', '',
2137         'installdate', @date_type,         '', '',
2138         'note',     'text',    'NULL', '', '', '',
2139       ],
2140       'primary_key' => 'svcnum',
2141       'unique' => [ ],
2142       'index' => [ ],
2143     },
2144
2145     'svc_hardware' => {
2146       'columns' => [
2147         'svcnum',   'int',     '',          '', '', '',
2148         'typenum',  'int',     '',          '', '', '',
2149         'serial',   'varchar', 'NULL', $char_d, '', '',
2150         'ip_addr',  'varchar', 'NULL',      40, '', '',
2151         'hw_addr',  'varchar', 'NULL',      12, '', '',
2152         'smartcard','varchar', 'NULL',      30, '', '',
2153         'statusnum','int',     'NULL',      '', '', '',
2154         'note',     'text',    'NULL',      '', '', '',
2155       ],
2156       'primary_key' => 'svcnum',
2157       'unique' => [ ],
2158       'index' => [ ],
2159     },
2160
2161     'hardware_class' => {
2162       'columns' => [
2163         'classnum',   'serial', '',      '', '', '',
2164         'classname', 'varchar', '', $char_d, '', '',
2165       ],
2166       'primary_key' => 'classnum',
2167       'unique' => [ ],
2168       'index'  => [ ],
2169     },
2170
2171     'hardware_type' => {
2172       'columns' => [
2173         'typenum',  'serial',     '',      '', '', '',
2174         'classnum',    'int',     '',      '', '', '',
2175         'model',   'varchar',     '', $char_d, '', '',
2176         'revision','varchar', 'NULL', $char_d, '', '',
2177       ],
2178       'primary_key' => 'typenum',
2179       'unique' => [ [ 'classnum', 'model', 'revision' ] ],
2180       'index'  => [ ],
2181     },
2182
2183     'hardware_status' => {
2184       'columns' => [
2185         'statusnum', 'serial', '',      '', '', '',
2186         'label'    ,'varchar', '', $char_d, '', '',
2187         'disabled',    'char', 'NULL',   1, '', '',
2188       ],
2189       'primary_key' => 'statusnum',
2190       'unique' => [ ],
2191       'index'  => [ ],
2192     },
2193
2194     'domain_record' => {
2195       'columns' => [
2196         'recnum',    'serial',     '',  '', '', '',
2197         'svcnum',    'int',     '',  '', '', '',
2198         'reczone',   'varchar', '',  255, '', '',
2199         'recaf',     'char',    '',  2, '', '',
2200         'rectype',   'varchar',    '',  5, '', '',
2201         'recdata',   'varchar', '',  255, '', '',
2202         'ttl',       'int',     'NULL', '', '', '',
2203       ],
2204       'primary_key' => 'recnum',
2205       'unique'      => [],
2206       'index'       => [ ['svcnum'] ],
2207     },
2208
2209     'registrar' => {
2210       'columns' => [
2211         'registrarnum',   'serial', '',      '', '', '',
2212         'registrarname', 'varchar', '', $char_d, '', '',
2213       ],
2214       'primary_key' => 'registrarnum',
2215       'unique'      => [],
2216       'index'       => [],
2217     },
2218
2219     'cgp_rule' => {
2220       'columns' => [
2221         'rulenum',  'serial',     '',      '', '', '',
2222         'name',    'varchar',     '', $char_d, '', '',
2223         'comment', 'varchar', 'NULL', $char_d, '', '',
2224         'svcnum',      'int',     '',      '', '', '',
2225         'priority',    'int',     '',      '', '', '',
2226       ],
2227       'primary_key' => 'rulenum',
2228       'unique'      => [ [ 'svcnum', 'name' ] ],
2229       'index'       => [ [ 'svcnum' ] ],
2230     },
2231
2232     'cgp_rule_condition' => {
2233       'columns' => [
2234         'ruleconditionnum',  'serial',     '',      '', '', '',
2235         'conditionname',    'varchar',     '', $char_d, '', '',
2236         'op',               'varchar', 'NULL', $char_d, '', '',
2237         'params',           'varchar', 'NULL',     255, '', '',
2238         'rulenum',              'int',     '',      '', '', '',
2239       ],
2240       'primary_key' => 'ruleconditionnum',
2241       'unique'      => [],
2242       'index'       => [ [ 'rulenum' ] ],
2243     },
2244
2245     'cgp_rule_action' => {
2246        'columns' => [
2247         'ruleactionnum',  'serial',     '',      '', '', '',
2248         'action',        'varchar',     '', $char_d, '', '',
2249         'params',        'varchar', 'NULL',     255, '', '',
2250         'rulenum',           'int',     '',      '', '', '',
2251       ],
2252       'primary_key' => 'ruleactionnum',
2253       'unique'      => [],
2254       'index'       => [ [ 'rulenum' ] ],
2255    },
2256
2257     'svc_forward' => {
2258       'columns' => [
2259         'svcnum',   'int',            '',   '', '', '',
2260         'srcsvc',   'int',        'NULL',   '', '', '',
2261         'src',      'varchar',    'NULL',  255, '', '',
2262         'dstsvc',   'int',        'NULL',   '', '', '',
2263         'dst',      'varchar',    'NULL',  255, '', '',
2264       ],
2265       'primary_key' => 'svcnum',
2266       'unique'      => [],
2267       'index'       => [ ['srcsvc'], ['dstsvc'] ],
2268     },
2269
2270     'svc_www' => {
2271       'columns' => [
2272         'svcnum',   'int',      '',  '', '', '',
2273         'recnum',   'int',      '',  '', '', '',
2274         'usersvc',  'int',  'NULL',  '', '', '',
2275         'config',   'text', 'NULL',  '', '', '',
2276       ],
2277       'primary_key' => 'svcnum',
2278       'unique'      => [],
2279       'index'       => [],
2280     },
2281
2282     #'svc_wo' => {
2283     #  'columns' => [
2284     #    'svcnum',    'int',    '',   '',
2285     #    'svcnum',    'int',    '',   '',
2286     #    'svcnum',    'int',    '',   '',
2287     #    'worker',    'varchar',   '',   $char_d,
2288     #    '_date',     @date_type,
2289     #  ],
2290     #  'primary_key' => 'svcnum',
2291     #  'unique' => [ [] ],
2292     #  'index' => [ [] ],
2293     #},
2294
2295     'prepay_credit' => {
2296       'columns' => [
2297         'prepaynum',   'serial',     '',   '', '', '',
2298         'identifier',  'varchar', '', $char_d, '', '',
2299         'amount',      @money_type, '', '',
2300         'seconds',     'int',     'NULL', '', '', '',
2301         'upbytes',     'bigint',     'NULL', '', '', '',
2302         'downbytes',   'bigint',     'NULL', '', '', '',
2303         'totalbytes',  'bigint',     'NULL', '', '', '',
2304         'agentnum',    'int',     'NULL', '', '', '',
2305       ],
2306       'primary_key' => 'prepaynum',
2307       'unique'      => [ ['identifier'] ],
2308       'index'       => [],
2309     },
2310
2311     'port' => {
2312       'columns' => [
2313         'portnum',  'serial',     '',   '', '', '',
2314         'ip',       'varchar', 'NULL', 15, '', '',
2315         'nasport',  'int',     'NULL', '', '', '',
2316         'nasnum',   'int',     '',   '', '', '',
2317       ],
2318       'primary_key' => 'portnum',
2319       'unique'      => [],
2320       'index'       => [],
2321     },
2322
2323     'nas' => {
2324       'columns' => [
2325         'nasnum',       'serial',     '',  '',              '', '',
2326         'nasname',     'varchar',     '', 128,              '', '',
2327         'shortname',   'varchar', 'NULL',  32,              '', '',
2328         'type',        'varchar',     '',  30,         'other', '',
2329         'ports',           'int', 'NULL',  '',              '', '',
2330         'secret',      'varchar',     '',  60,        'secret', '',
2331         'server',      'varchar', 'NULL',  64,              '', '',
2332         'community',   'varchar', 'NULL',  50,              '', '',
2333         'description', 'varchar',     '', 200, 'RADIUS Client', '',
2334         'svcnum',          'int', 'NULL',  '',              '', '',
2335       ],
2336       'primary_key' => 'nasnum',
2337       'unique'      => [ [ 'nasname' ], ],
2338       'index'       => [],
2339     },
2340
2341     'export_nas' => {
2342       'columns' => [
2343         'exportnasnum', 'serial', '', '', '', '',
2344         'exportnum',       'int', '', '', '', '',
2345         'nasnum',          'int', '', '', '', '',
2346       ],
2347       'primary_key' => 'exportnasnum',
2348       'unique'      => [ [ 'exportnum', 'nasnum' ] ],
2349       'index'       => [ [ 'exportnum' ], [ 'nasnum' ] ],
2350     },
2351
2352     'queue' => {
2353       'columns' => [
2354         'jobnum',      'serial',     '',      '', '', '',
2355         'job',        'varchar',     '',     512, '', '',
2356         '_date',          'int',     '',      '', '', '',
2357         'status',     'varchar',     '', $char_d, '', '',
2358         'statustext',    'text', 'NULL',      '', '', '',
2359         'svcnum',         'int', 'NULL',      '', '', '',
2360         'custnum',        'int', 'NULL',      '', '', '',
2361         'secure',        'char', 'NULL',       1, '', '',
2362         'priority',       'int', 'NULL',      '', '', '',
2363       ],
2364       'primary_key' => 'jobnum',
2365       'unique'      => [],
2366       'index'       => [ [ 'secure' ], [ 'priority' ],
2367                          [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
2368                        ],
2369     },
2370
2371     'queue_arg' => {
2372       'columns' => [
2373         'argnum', 'serial', '', '', '', '',
2374         'jobnum', 'int', '', '', '', '',
2375         'frozen', 'char', 'NULL',       1, '', '',
2376         'arg', 'text', 'NULL', '', '', '',
2377       ],
2378       'primary_key' => 'argnum',
2379       'unique'      => [],
2380       'index'       => [ [ 'jobnum' ] ],
2381     },
2382
2383     'queue_depend' => {
2384       'columns' => [
2385         'dependnum', 'serial', '', '', '', '',
2386         'jobnum', 'int', '', '', '', '',
2387         'depend_jobnum', 'int', '', '', '', '',
2388       ],
2389       'primary_key' => 'dependnum',
2390       'unique'      => [],
2391       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
2392     },
2393
2394     'export_svc' => {
2395       'columns' => [
2396         'exportsvcnum' => 'serial', '', '', '', '',
2397         'exportnum'    => 'int', '', '', '', '',
2398         'svcpart'      => 'int', '', '', '', '',
2399       ],
2400       'primary_key' => 'exportsvcnum',
2401       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
2402       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
2403     },
2404
2405     'export_device' => {
2406       'columns' => [
2407         'exportdevicenum' => 'serial', '', '', '', '',
2408         'exportnum'    => 'int', '', '', '', '',
2409         'devicepart'      => 'int', '', '', '', '',
2410       ],
2411       'primary_key' => 'exportdevicenum',
2412       'unique'      => [ [ 'exportnum', 'devicepart' ] ],
2413       'index'       => [ [ 'exportnum' ], [ 'devicepart' ] ],
2414     },
2415
2416     'part_export' => {
2417       'columns' => [
2418         'exportnum', 'serial', '', '', '', '',
2419         'exportname', 'varchar', 'NULL', $char_d, '', '',
2420         'machine', 'varchar', '', $char_d, '', '',
2421         'exporttype', 'varchar', '', $char_d, '', '',
2422         'nodomain',     'char', 'NULL', 1, '', '',
2423       ],
2424       'primary_key' => 'exportnum',
2425       'unique'      => [],
2426       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
2427     },
2428
2429     'part_export_option' => {
2430       'columns' => [
2431         'optionnum', 'serial', '', '', '', '',
2432         'exportnum', 'int', '', '', '', '',
2433         'optionname', 'varchar', '', $char_d, '', '',
2434         'optionvalue', 'text', 'NULL', '', '', '',
2435       ],
2436       'primary_key' => 'optionnum',
2437       'unique'      => [],
2438       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
2439     },
2440
2441     'radius_usergroup' => {
2442       'columns' => [
2443         'usergroupnum', 'serial', '', '', '', '',
2444         'svcnum',       'int', '', '', '', '',
2445         'groupname',    'varchar', 'NULL', $char_d, '', '',
2446         'groupnum',     'int', 'NULL', '', '', '',
2447       ],
2448       'primary_key' => 'usergroupnum',
2449       'unique'      => [],
2450       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
2451     },
2452
2453     'radius_group' => {
2454       'columns' => [
2455         'groupnum', 'serial', '', '', '', '',
2456         'groupname',    'varchar', '', $char_d, '', '',
2457         'description',  'varchar', 'NULL', $char_d, '', '',
2458         'priority', 'int', '', '', '1', '',
2459         'speed_up', 'int', 'NULL', '', '', '',
2460         'speed_down', 'int', 'NULL', '', '', '',
2461       ],
2462       'primary_key' => 'groupnum',
2463       'unique'      => [ ['groupname'] ],
2464       'index'       => [],
2465     },
2466
2467     'radius_attr' => {
2468       'columns' => [
2469         'attrnum',   'serial', '',      '', '', '',
2470         'groupnum',     'int', '',      '', '', '',
2471         'attrname', 'varchar', '', $char_d, '', '',
2472         'value',    'varchar', '',     255, '', '',
2473         'attrtype',    'char', '',       1, '', '',
2474         'op',          'char', '',       2, '', '',
2475       ],
2476       'primary_key' => 'attrnum',
2477       'unique'      => [],
2478       'index'       => [ ['groupnum'], ],
2479     },
2480
2481     'msgcat' => {
2482       'columns' => [
2483         'msgnum', 'serial', '', '', '', '',
2484         'msgcode', 'varchar', '', 255, '', '',
2485         'locale', 'varchar', '', 16, '', '',
2486         'msg', 'text', '', '', '', '',
2487       ],
2488       'primary_key' => 'msgnum',
2489       'unique'      => [ [ 'msgcode', 'locale' ] ],
2490       'index'       => [],
2491     },
2492
2493     'cust_tax_exempt' => {
2494       'columns' => [
2495         'exemptnum', 'serial', '', '', '', '',
2496         'custnum',   'int', '', '', '', '',
2497         'taxnum',    'int', '', '', '', '',
2498         'year',      'int', '', '', '', '',
2499         'month',     'int', '', '', '', '',
2500         'amount',   @money_type, '', '',
2501       ],
2502       'primary_key' => 'exemptnum',
2503       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
2504       'index'       => [],
2505     },
2506
2507     'cust_tax_exempt_pkg' => {
2508       'columns' => [
2509         'exemptpkgnum',  'serial', '', '', '', '',
2510         #'custnum',      'int', '', '', '', ''
2511         'billpkgnum',   'int', '', '', '', '',
2512         'taxnum',       'int', '', '', '', '',
2513         'year',         'int', '', '', '', '',
2514         'month',        'int', '', '', '', '',
2515         'creditbillpkgnum', 'int', 'NULL', '', '', '',
2516         'amount',       @money_type, '', '',
2517       ],
2518       'primary_key' => 'exemptpkgnum',
2519       'unique' => [],
2520       'index'  => [ [ 'taxnum', 'year', 'month' ],
2521                     [ 'billpkgnum' ],
2522                     [ 'taxnum' ],
2523                     [ 'creditbillpkgnum' ],
2524                   ],
2525     },
2526
2527     'router' => {
2528       'columns' => [
2529         'routernum', 'serial', '', '', '', '',
2530         'routername', 'varchar', '', $char_d, '', '',
2531         'svcnum', 'int', 'NULL', '', '', '',
2532         'agentnum',   'int', 'NULL', '', '', '',
2533         'manual_addr', 'char', 'NULL', 1, '', '',
2534       ],
2535       'primary_key' => 'routernum',
2536       'unique'      => [],
2537       'index'       => [],
2538     },
2539
2540     'part_svc_router' => {
2541       'columns' => [
2542         'svcrouternum', 'serial', '', '', '', '',
2543         'svcpart', 'int', '', '', '', '',
2544         'routernum', 'int', '', '', '', '',
2545       ],
2546       'primary_key' => 'svcrouternum',
2547       'unique'      => [],
2548       'index'       => [],
2549     },
2550
2551     'addr_block' => {
2552       'columns' => [
2553         'blocknum', 'serial', '', '', '', '',
2554         'routernum', 'int', '', '', '', '',
2555         'ip_gateway', 'varchar', '', 15, '', '',
2556         'ip_netmask', 'int', '', '', '', '',
2557         'agentnum',   'int', 'NULL', '', '', '',
2558         'manual_flag', 'char', 'NULL', 1, '', '',
2559       ],
2560       'primary_key' => 'blocknum',
2561       'unique'      => [ [ 'blocknum', 'routernum' ] ],
2562       'index'       => [],
2563     },
2564
2565     'svc_broadband' => {
2566       'columns' => [
2567         'svcnum',                  'int',     '',      '', '', '',
2568         'description',         'varchar', 'NULL', $char_d, '', '',
2569         'routernum',               'int', 'NULL',      '', '', '',
2570         'blocknum',                'int', 'NULL',      '', '', '',
2571         'sectornum',               'int', 'NULL',      '', '', '',
2572         'speed_up',                'int', 'NULL',      '', '', '',
2573         'speed_down',              'int', 'NULL',      '', '', '',
2574         'ip_addr',             'varchar', 'NULL',      15, '', '',
2575         'mac_addr',            'varchar', 'NULL',      12, '', '',
2576         'authkey',             'varchar', 'NULL',      32, '', '',
2577         'latitude',            'decimal', 'NULL',  '10,7', '', '',
2578         'longitude',           'decimal', 'NULL',  '10,7', '', '',
2579         'altitude',            'decimal', 'NULL',      '', '', '',
2580         'vlan_profile',        'varchar', 'NULL', $char_d, '', '',
2581         'performance_profile', 'varchar', 'NULL', $char_d, '', '',
2582         'plan_id',             'varchar', 'NULL', $char_d, '', '',
2583       ],
2584       'primary_key' => 'svcnum',
2585       'unique'      => [ [ 'ip_addr' ], [ 'mac_addr' ] ],
2586       'index'       => [],
2587     },
2588
2589     'tower' => {
2590       'columns' => [
2591         'towernum',   'serial',     '',      '', '', '',
2592         #'agentnum',      'int', 'NULL',      '', '', '',
2593         'towername', 'varchar',     '', $char_d, '', '',
2594         'disabled',     'char', 'NULL',       1, '', '',
2595         'latitude', 'decimal', 'NULL',   '10,7', '', '',
2596         'longitude','decimal', 'NULL',   '10,7', '', '',
2597         'altitude', 'decimal', 'NULL',       '', '', '',
2598         'coord_auto',  'char', 'NULL',        1, '', '',
2599       ],
2600       'primary_key' => 'towernum',
2601       'unique'      => [ [ 'towername' ] ], # , 'agentnum' ] ],
2602       'index'       => [],
2603     },
2604
2605     'tower_sector' => {
2606       'columns' => [
2607         'sectornum',   'serial',     '',      '', '', '',
2608         'towernum',       'int',     '',      '', '', '',
2609         'sectorname', 'varchar',     '', $char_d, '', '',
2610         'ip_addr',    'varchar', 'NULL',      15, '', '',
2611       ],
2612       'primary_key' => 'sectornum',
2613       'unique'      => [ [ 'towernum', 'sectorname' ], [ 'ip_addr' ], ],
2614       'index'       => [ [ 'towernum' ] ],
2615     },
2616
2617     'part_virtual_field' => {
2618       'columns' => [
2619         'vfieldpart', 'serial', '', '', '', '',
2620         'dbtable', 'varchar', '', 32, '', '',
2621         'name', 'varchar', '', 32, '', '',
2622         'length', 'int', 'NULL', '', '', '',
2623         'label', 'varchar', 'NULL', 80, '', '',
2624       ],
2625       'primary_key' => 'vfieldpart',
2626       'unique' => [],
2627       'index' => [],
2628     },
2629
2630     'virtual_field' => {
2631       'columns' => [
2632         'vfieldnum', 'serial', '', '', '', '',
2633         'recnum', 'int', '', '', '', '',
2634         'vfieldpart', 'int', '', '', '', '',
2635         'value', 'varchar', '', 128, '', '',
2636       ],
2637       'primary_key' => 'vfieldnum',
2638       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
2639       'index' => [],
2640     },
2641
2642     'acct_snarf' => {
2643       'columns' => [
2644         'snarfnum',    'serial',     '',      '', '', '',
2645         'snarfname',  'varchar', 'NULL', $char_d, '', '',
2646         'svcnum',         'int',     '',      '', '', '',
2647         'machine',    'varchar',     '',     255, '', '',
2648         'protocol',   'varchar',     '', $char_d, '', '',
2649         'username',   'varchar',     '', $char_d, '', '',
2650         '_password',  'varchar',     '', $char_d, '', '',
2651         'check_freq',     'int', 'NULL',      '', '', '',
2652         'leavemail',     'char', 'NULL',       1, '', '',
2653         'apop',          'char', 'NULL',       1, '', '',
2654         'tls',           'char', 'NULL',       1, '', '',
2655         'mailbox',    'varchar', 'NULL', $char_d, '', '',
2656       ],
2657       'primary_key' => 'snarfnum',
2658       'unique' => [],
2659       'index'  => [ [ 'svcnum' ] ],
2660     },
2661
2662     'svc_external' => {
2663       'columns' => [
2664         'svcnum',     'int',     '',      '', '', '',
2665         'id',      'bigint', 'NULL',      '', '', '',
2666         'title',  'varchar', 'NULL', $char_d, '', '',
2667       ],
2668       'primary_key' => 'svcnum',
2669       'unique'      => [],
2670       'index'       => [],
2671     },
2672
2673     'cust_pay_refund' => {
2674       'columns' => [
2675         'payrefundnum', 'serial', '', '', '', '',
2676         'paynum',  'int', '', '', '', '',
2677         'refundnum',  'int', '', '', '', '',
2678         '_date',    @date_type, '', '',
2679         'amount',   @money_type, '', '',
2680       ],
2681       'primary_key' => 'payrefundnum',
2682       'unique' => [],
2683       'index' => [ ['paynum'], ['refundnum'] ],
2684     },
2685
2686     'part_pkg_option' => {
2687       'columns' => [
2688         'optionnum', 'serial', '', '', '', '',
2689         'pkgpart', 'int', '', '', '', '',
2690         'optionname', 'varchar', '', $char_d, '', '',
2691         'optionvalue', 'text', 'NULL', '', '', '',
2692       ],
2693       'primary_key' => 'optionnum',
2694       'unique'      => [],
2695       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
2696     },
2697
2698     'part_pkg_vendor' => {
2699       'columns' => [
2700         'num', 'serial', '', '', '', '',
2701         'pkgpart', 'int', '', '', '', '',
2702         'exportnum', 'int', '', '', '', '',
2703         'vendor_pkg_id', 'varchar', '', $char_d, '', '',
2704       ],
2705       'primary_key' => 'num',
2706       'unique' => [ [ 'pkgpart', 'exportnum' ] ],
2707       'index'       => [ [ 'pkgpart' ] ],
2708     },
2709
2710     'part_pkg_report_option' => {
2711       'columns' => [
2712         'num',      'serial',   '',      '', '', '',
2713         'name',     'varchar',  '', $char_d, '', '',
2714         'disabled', 'char', 'NULL',       1, '', '',
2715       ],
2716       'primary_key' => 'num',
2717       'unique' => [ [ 'name' ] ],
2718       'index' => [ [ 'disabled' ] ],
2719     },
2720
2721     'rate' => {
2722       'columns' => [
2723         'ratenum',  'serial', '', '', '', '',
2724         'ratename', 'varchar', '', $char_d, '', '',
2725       ],
2726       'primary_key' => 'ratenum',
2727       'unique'      => [],
2728       'index'       => [],
2729     },
2730
2731     'rate_detail' => {
2732       'columns' => [
2733         'ratedetailnum',   'serial',  '',     '',      '', '',
2734         'ratenum',         'int',     '',     '',      '', '',
2735         'orig_regionnum',  'int', 'NULL',     '',      '', '',
2736         'dest_regionnum',  'int',     '',     '',      '', '',
2737         'min_included',    'int',     '',     '',      '', '',
2738         'conn_charge',     'decimal', '', '10,4', '0.0000', '',
2739         'conn_sec',        'int',     '',     '',      '0', '',
2740         'min_charge',      'decimal', '', '10,5',       '', '',
2741         'sec_granularity', 'int',     '',     '',       '', '',
2742         'ratetimenum',     'int', 'NULL',     '',       '', '',
2743         'classnum',        'int', 'NULL',     '',       '', '',
2744         'cdrtypenum',      'int', 'NULL',     '',       '', '',
2745         'region_group', 'char', 'NULL',        1,       '', '',
2746       ],
2747       'primary_key' => 'ratedetailnum',
2748       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
2749       'index'       => [ [ 'ratenum', 'dest_regionnum' ],
2750                          [ 'ratenum', 'ratetimenum' ]
2751                        ],
2752     },
2753
2754     'rate_region' => {
2755       'columns' => [
2756         'regionnum',   'serial',      '', '', '', '',
2757         'regionname',  'varchar',     '', $char_d, '', '',
2758       ],
2759       'primary_key' => 'regionnum',
2760       'unique'      => [],
2761       'index'       => [],
2762     },
2763
2764     'rate_prefix' => {
2765       'columns' => [
2766         'prefixnum',   'serial',      '', '', '', '',
2767         'regionnum',   'int',         '', '', '', '',
2768         'countrycode', 'varchar',     '',  3, '', '',
2769         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
2770         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
2771         'latanum',     'int',     'NULL',      '', '', '',
2772         'state',       'char',    'NULL',       2, '', '',
2773         'ocn',         'char',    'NULL',       4, '', '',
2774       ],
2775       'primary_key' => 'prefixnum',
2776       'unique'      => [],
2777       'index'       => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
2778     },
2779
2780     'rate_time' => {
2781       'columns' => [
2782         'ratetimenum', 'serial',      '',      '', '', '',
2783         'ratetimename',   'varchar',      '', $char_d, '', '',
2784       ],
2785       'primary_key' => 'ratetimenum',
2786       'unique'      => [],
2787       'index'       => [],
2788     },
2789
2790     'rate_time_interval' => {
2791       'columns' => [
2792         'intervalnum', 'serial', '', '', '', '',
2793         'stime',          'int', '', '', '', '',
2794         'etime',          'int', '', '', '', '',
2795         'ratetimenum',    'int', '', '', '', '',
2796       ],
2797       'primary_key' => 'intervalnum',
2798       'unique'      => [],
2799       'index'       => [],
2800     },
2801
2802     #not really part of the above rate_ stuff (used with flat rate rather than
2803     # rated billing), but could be eventually, and its a rate
2804     'rate_tier' => {
2805       'columns' => [
2806         'tiernum',   'serial', '',      '', '', '',
2807         'tiername', 'varchar', '', $char_d, '', '',
2808       ],
2809       'primary_key' => 'tiernum',
2810       'unique'      => [ [ 'tiername'], ],
2811       'index'       => [],
2812     },
2813
2814     'rate_tier_detail' => {
2815       'columns' => [
2816         'tierdetailnum', 'serial', '',     '', '', '',
2817         'tiernum',          'int', '',     '', '', '',
2818         'min_quan',         'int', '',     '', '', '',
2819         'min_charge',   'decimal', '', '10,4', '', '',
2820       ],
2821       'primary_key' => 'tierdetailnum',
2822       'unique'      => [],
2823       'index'       => [ ['tiernum'], ],
2824     },
2825
2826     'usage_class' => {
2827       'columns' => [
2828         'classnum',    'serial',      '',      '', '', '',
2829         'weight',      'int',     'NULL',      '', '', '',
2830         'classname',   'varchar',     '', $char_d, '', '',
2831         'format',      'varchar', 'NULL', $char_d, '', '',
2832         'disabled',    'char',    'NULL',       1, '', '',
2833       ],
2834       'primary_key' => 'classnum',
2835       'unique' => [],
2836       'index' => [ ['disabled'] ],
2837     },
2838
2839     'reg_code' => {
2840       'columns' => [
2841         'codenum',   'serial',    '', '', '', '',
2842         'code',      'varchar',   '', $char_d, '', '',
2843         'agentnum',  'int',       '', '', '', '',
2844       ],
2845       'primary_key' => 'codenum',
2846       'unique'      => [ [ 'agentnum', 'code' ] ],
2847       'index'       => [ [ 'agentnum' ] ],
2848     },
2849
2850     'reg_code_pkg' => {
2851       'columns' => [
2852         'codepkgnum', 'serial', '', '', '', '',
2853         'codenum',   'int',    '', '', '', '',
2854         'pkgpart',   'int',    '', '', '', '',
2855       ],
2856       'primary_key' => 'codepkgnum',
2857       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
2858       'index'       => [ [ 'codenum' ] ],
2859     },
2860
2861     'clientapi_session' => {
2862       'columns' => [
2863         'sessionnum',  'serial',  '', '', '', '',
2864         'sessionid',  'varchar',  '', $char_d, '', '',
2865         'namespace',  'varchar',  '', $char_d, '', '',
2866       ],
2867       'primary_key' => 'sessionnum',
2868       'unique'      => [ [ 'sessionid', 'namespace' ] ],
2869       'index'       => [],
2870     },
2871
2872     'clientapi_session_field' => {
2873       'columns' => [
2874         'fieldnum',    'serial',     '', '', '', '',
2875         'sessionnum',     'int',     '', '', '', '',
2876         'fieldname',  'varchar',     '', $char_d, '', '',
2877         'fieldvalue',    'text', 'NULL', '', '', '',
2878       ],
2879       'primary_key' => 'fieldnum',
2880       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
2881       'index'       => [],
2882     },
2883
2884     'payment_gateway' => {
2885       'columns' => [
2886         'gatewaynum',       'serial',   '',     '', '', '',
2887         'gateway_namespace','varchar',  'NULL', $char_d, '', '',
2888         'gateway_module',   'varchar',  '',     $char_d, '', '',
2889         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
2890         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
2891         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
2892         'gateway_callback_url', 'varchar',  'NULL', $char_d, '', '',
2893         'disabled',   'char',  'NULL',   1, '', '',
2894       ],
2895       'primary_key' => 'gatewaynum',
2896       'unique' => [],
2897       'index'  => [ [ 'disabled' ] ],
2898     },
2899
2900     'payment_gateway_option' => {
2901       'columns' => [
2902         'optionnum',   'serial',  '',     '', '', '',
2903         'gatewaynum',  'int',     '',     '', '', '',
2904         'optionname',  'varchar', '',     $char_d, '', '',
2905         'optionvalue', 'text',    'NULL', '', '', '',
2906       ],
2907       'primary_key' => 'optionnum',
2908       'unique'      => [],
2909       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
2910     },
2911
2912     'agent_payment_gateway' => {
2913       'columns' => [
2914         'agentgatewaynum', 'serial', '', '', '', '',
2915         'agentnum',        'int', '', '', '', '',
2916         'gatewaynum',      'int', '', '', '', '',
2917         'cardtype',        'varchar', 'NULL', $char_d, '', '',
2918         'taxclass',        'varchar', 'NULL', $char_d, '', '',
2919       ],
2920       'primary_key' => 'agentgatewaynum',
2921       'unique'      => [],
2922       'index'       => [ [ 'agentnum', 'cardtype' ], ],
2923     },
2924
2925     'banned_pay' => {
2926       'columns' => [
2927         'bannum',  'serial',   '',     '', '', '',
2928         'payby',   'char',     '',       4, '', '',
2929         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
2930         #'paymask', 'varchar',  'NULL', $char_d, '', ''
2931         '_date',            @date_type,         '', '',
2932         'end_date',         @date_type,         '', '',
2933         'otaker',  'varchar',  'NULL',      32, '', '',
2934         'usernum',     'int',  'NULL',      '', '', '',
2935         'bantype', 'varchar',  'NULL', $char_d, '', '',
2936         'reason',  'varchar',  'NULL', $char_d, '', '',
2937       ],
2938       'primary_key' => 'bannum',
2939       'unique'      => [],
2940       'index'       => [ [ 'payby', 'payinfo' ], [ 'usernum' ], ],
2941     },
2942
2943     'pkg_category' => {
2944       'columns' => [
2945         'categorynum',   'serial',  '', '', '', '',
2946         'categoryname',  'varchar', '', $char_d, '', '',
2947         'weight',         'int', 'NULL',  '', '', '',
2948         'condense',      'char', 'NULL',   1, '', '',
2949         'disabled',      'char', 'NULL',   1, '', '',
2950       ],
2951       'primary_key' => 'categorynum',
2952       'unique' => [],
2953       'index' => [ ['disabled'] ],
2954     },
2955
2956     'pkg_class' => {
2957       'columns' => [
2958         'classnum',    'serial',   '',      '', '', '',
2959         'classname',   'varchar',  '', $char_d, '', '',
2960         'categorynum', 'int',  'NULL',      '', '', '',
2961         'disabled',    'char', 'NULL',       1, '', '',
2962         'fcc_ds0s',      'int',     'NULL', '', '', '',
2963       ],
2964       'primary_key' => 'classnum',
2965       'unique' => [],
2966       'index' => [ ['disabled'] ],
2967     },
2968
2969     'cdr' => {
2970       'columns' => [
2971         # qw( name type null length default local );
2972
2973         ###
2974         #asterisk fields
2975         ###
2976
2977         'acctid',   'bigserial',  '', '', '', '',
2978         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
2979         'calldate', 'timestamp',   '',      '', \'now()', '',
2980         'clid',        'varchar',  '', $char_d, \"''", '',
2981         'src',         'varchar',  '', $char_d, \"''", '',
2982         'dst',         'varchar',  '', $char_d, \"''", '',
2983         'dcontext',    'varchar',  '', $char_d, \"''", '',
2984         'channel',     'varchar',  '', $char_d, \"''", '',
2985         'dstchannel',  'varchar',  '', $char_d, \"''", '',
2986         'lastapp',     'varchar',  '', $char_d, \"''", '',
2987         'lastdata',    'varchar',  '', $char_d, \"''", '',
2988
2989         #these don't seem to be logged by most of the SQL cdr_* modules
2990         #except tds under sql-illegal names, so;
2991         # ... don't rely on them for rating?
2992         # and, what they hey, i went ahead and changed the names and data types
2993         # to freeside-style dates...
2994           #'start',  'timestamp', 'NULL',  '',    '', '',
2995           #'answer', 'timestamp', 'NULL',  '',    '', '',
2996           #'end',    'timestamp', 'NULL',  '',    '', '',
2997         'startdate',  @date_type, '', '',
2998         'answerdate', @date_type, '', '',
2999         'enddate',    @date_type, '', '',
3000         #
3001
3002         'duration',    'int',      '',      '',     0, '',
3003         'billsec',     'int',      '',      '',     0, '',
3004         'disposition', 'varchar',  '',      45, \"''", '',
3005         'amaflags',    'int',      '',      '',     0, '',
3006         'accountcode', 'varchar',  '',      20, \"''", '',
3007         'uniqueid',    'varchar',  '', $char_d, \"''", '',
3008         'userfield',   'varchar',  '',     512, \"''", '',
3009
3010         'max_callers', 'int',  'NULL',      '',    '', '',
3011
3012         ###
3013         # old fields for unitel/RSLCOM/convergent that don't map to asterisk
3014         # ones we adoped moved to "own fields" section below
3015         # charged_party, upstream_price, rated_price, carrierid, cdrtypenum
3016         ###
3017
3018         'upstream_currency',      'char', 'NULL',       3, '', '',
3019         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
3020
3021         # how it was rated internally...
3022         'ratedetailnum',           'int', 'NULL',      '', '', '',
3023
3024         'distance',            'decimal', 'NULL',      '', '', '',
3025         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
3026
3027         #cdr_calltype: the big list in appendix 2
3028         'calltypenum',             'int', 'NULL',      '', '', '',
3029
3030         'description',         'varchar', 'NULL', $char_d, '', '',
3031         'quantity',                'int', 'NULL',      '', '', '',
3032
3033         'upstream_rateid',         'int', 'NULL',      '', '', '',
3034
3035         ###
3036         #and now for our own fields
3037         ###
3038
3039         'cdrtypenum',              'int', 'NULL',      '', '', '',
3040
3041         'charged_party',       'varchar', 'NULL', $char_d, '', '',
3042
3043         'upstream_price',      'decimal', 'NULL',  '10,4', '', '',
3044         'upstream_src_regionname', 'varchar', 'NULL', $char_d, '', '',
3045         'upstream_dst_regionname', 'varchar', 'NULL', $char_d, '', '',
3046
3047         # how it was rated internally...
3048         'rated_price',         'decimal', 'NULL',  '10,4', '', '',
3049         'rated_seconds',           'int', 'NULL',      '', '', '',
3050         'rated_minutes', 'double precision', 'NULL',   '', '', '',
3051
3052         'carrierid',               'int', 'NULL',      '', '', '',
3053
3054         # service it was matched to
3055         'svcnum',             'int',   'NULL',     '',   '', '',
3056
3057         #NULL, done (or something)
3058         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
3059
3060         #NULL, done (or something)
3061         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '',
3062
3063         #an indexed place to put big numbers
3064         'cdrid',         'bigint',     'NULL',     '',  '', '',
3065
3066         #for taqua accountcode rewriting, for starters
3067         'sessionnum',       'int',    'NULL',      '', '', '',
3068         'subscriber',   'varchar',    'NULL', $char_d, '', '',
3069
3070         #old
3071         'cdrbatch',     'varchar',    'NULL',     255, '', '',
3072         #new
3073         'cdrbatchnum',      'int',    'NULL',      '', '', '',
3074
3075       ],
3076       'primary_key' => 'acctid',
3077       'unique' => [],
3078       'index' => [ [ 'calldate' ],
3079                    [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
3080                    [ 'lastapp' ],
3081                    ['accountcode'], ['uniqueid'], ['carrierid'], ['cdrid'],
3082                    [ 'sessionnum' ], [ 'subscriber' ],
3083                    [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
3084                    [ 'cdrbatch' ], [ 'cdrbatchnum' ],
3085                  ],
3086     },
3087
3088     'cdr_batch' => {
3089       'columns' => [
3090         'cdrbatchnum',   'serial',    '',   '', '', '',
3091         'cdrbatch', 'varchar', 'NULL', 255, '', '',
3092         '_date',     @date_type, '', '',
3093       ],
3094       'primary_key' => 'cdrbatchnum',
3095       'unique' => [ [ 'cdrbatch' ] ],
3096       'index' => [],
3097     },
3098
3099     'cdr_termination' => {
3100       'columns' => [
3101         'cdrtermnum', 'bigserial',     '',      '', '', '',
3102         'acctid',        'bigint',     '',      '', '', '',
3103         'termpart',         'int',     '',      '', '', '',#future use see below
3104         'rated_price',  'decimal', 'NULL',  '10,4', '', '',
3105         'rated_seconds',    'int', 'NULL',      '', '', '',
3106         'rated_minutes', 'double precision', 'NULL',   '', '', '',
3107         'status',       'varchar', 'NULL',      32, '', '',
3108         'svcnum',           'int', 'NULL',      '', '', '',
3109       ],
3110       'primary_key' => 'cdrtermnum',
3111       'unique'      => [ [ 'acctid', 'termpart' ] ],
3112       'index'       => [ [ 'acctid' ], [ 'status' ], ],
3113     },
3114
3115     #to handle multiple termination/settlement passes...
3116    # 'part_termination' => {
3117    #   'columns' => [
3118    #     'termpart',       'int', '',      '', '', '',
3119    #     'termname',   'varchar', '', $char_d, '', '',
3120    #     'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
3121    #   ],
3122    #   'primary_key' => 'termpart',
3123    #   'unique' => [],
3124    #   'index'  => [],
3125    # },
3126
3127     #the remaining cdr_ tables are not really used
3128     'cdr_calltype' => {
3129       'columns' => [
3130         'calltypenum',   'serial',  '', '', '', '',
3131         'calltypename',  'varchar', '', $char_d, '', '',
3132       ],
3133       'primary_key' => 'calltypenum',
3134       'unique'      => [],
3135       'index'       => [],
3136     },
3137
3138     'cdr_type' => {
3139       'columns' => [
3140         'cdrtypenum'  => 'serial',  '', '', '', '',
3141         'cdrtypename' => 'varchar', '', $char_d, '', '',
3142       ],
3143       'primary_key' => 'cdrtypenum',
3144       'unique'      => [],
3145       'index'       => [],
3146     },
3147
3148     'cdr_carrier' => {
3149       'columns' => [
3150         'carrierid'   => 'serial',  '', '', '', '',
3151         'carriername' => 'varchar', '', $char_d, '', '',
3152       ],
3153       'primary_key' => 'carrierid',
3154       'unique'      => [],
3155       'index'       => [],
3156     },
3157
3158     #'cdr_file' => {
3159     #  'columns' => [
3160     #    'filenum',    'serial',     '', '', '', '',
3161     #    'filename',  'varchar',     '', '', '', '',
3162     #    'status',    'varchar', 'NULL', '', '', '',
3163     #  ],
3164     #  'primary_key' => 'filenum',
3165     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
3166     #                                   # agent-virtualize or have a customer
3167     #                                   # with dup-filename needs or something
3168     #                                   # (only used by cdr.http_and_import for
3169     #                                   #  chrissakes)
3170     #  'index'  => [],
3171     #},
3172
3173     'inventory_item' => {
3174       'columns' => [
3175         'itemnum',   'serial',      '',      '', '', '',
3176         'classnum',  'int',         '',      '', '', '',
3177         'agentnum',  'int',     'NULL',      '', '', '',
3178         'item',      'varchar',     '', $char_d, '', '',
3179         'svcnum',    'int',     'NULL',      '', '', '',
3180         'svc_field', 'varchar', 'NULL', $char_d, '', '',
3181       ],
3182       'primary_key' => 'itemnum',
3183       'unique' => [ [ 'classnum', 'item' ] ],
3184       'index'  => [ [ 'classnum' ], [ 'agentnum' ], [ 'svcnum' ] ],
3185     },
3186
3187     'inventory_class' => {
3188       'columns' => [
3189         'classnum',  'serial',       '',      '', '', '',
3190         'classname', 'varchar',      '', $char_d, '', '',
3191       ],
3192       'primary_key' => 'classnum',
3193       'unique' => [],
3194       'index'  => [],
3195     },
3196
3197     'access_user' => {
3198       'columns' => [
3199         'usernum',   'serial',  '',      '', '', '',
3200         'username',  'varchar', '', $char_d, '', '',
3201         '_password', 'varchar', '', $char_d, '', '',
3202         'last',      'varchar', '', $char_d, '', '',
3203         'first',     'varchar', '', $char_d, '', '',
3204         'user_custnum',  'int', 'NULL',  '', '', '',
3205         'disabled',     'char', 'NULL',   1, '', '',
3206       ],
3207       'primary_key' => 'usernum',
3208       'unique' => [ [ 'username' ] ],
3209       'index'  => [ [ 'user_custnum' ] ],
3210     },
3211
3212     'access_user_pref' => {
3213       'columns' => [
3214         'prefnum',    'serial',       '', '', '', '',
3215         'usernum',     'int',       '', '', '', '',
3216         'prefname', 'varchar', '', $char_d, '', '',
3217         'prefvalue', 'text', 'NULL', '', '', '',
3218         'expiration', @date_type, '', '',
3219       ],
3220       'primary_key' => 'prefnum',
3221       'unique' => [],
3222       'index'  => [ [ 'usernum' ] ],
3223     },
3224
3225     'access_group' => {
3226       'columns' => [
3227         'groupnum',   'serial', '',      '', '', '',
3228         'groupname', 'varchar', '', $char_d, '', '',
3229       ],
3230       'primary_key' => 'groupnum',
3231       'unique' => [ [ 'groupname' ] ],
3232       'index'  => [],
3233     },
3234
3235     'access_usergroup' => {
3236       'columns' => [
3237         'usergroupnum', 'serial', '', '', '', '',
3238         'usernum',         'int', '', '', '', '',
3239         'groupnum',        'int', '', '', '', '',
3240       ],
3241       'primary_key' => 'usergroupnum',
3242       'unique' => [ [ 'usernum', 'groupnum' ] ],
3243       'index'  => [ [ 'usernum' ] ],
3244     },
3245
3246     'access_groupagent' => {
3247       'columns' => [
3248         'groupagentnum', 'serial', '', '', '', '',
3249         'groupnum',         'int', '', '', '', '',
3250         'agentnum',         'int', '', '', '', '',
3251       ],
3252       'primary_key' => 'groupagentnum',
3253       'unique' => [ [ 'groupnum', 'agentnum' ] ],
3254       'index'  => [ [ 'groupnum' ] ],
3255     },
3256
3257     'access_right' => {
3258       'columns' => [
3259         'rightnum',   'serial', '',      '', '', '',
3260         'righttype', 'varchar', '', $char_d, '', '',
3261         'rightobjnum',   'int', '',      '', '', '',
3262         'rightname', 'varchar', '', $char_d, '', '',
3263       ],
3264       'primary_key' => 'rightnum',
3265       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
3266       'index'  => [],
3267     },
3268
3269     'svc_phone' => {
3270       'columns' => [
3271         'svcnum',       'int',         '',      '', '', '',
3272         'countrycode',  'varchar',     '',       3, '', '',
3273         'phonenum',     'varchar',     '',      15, '', '',  #12 ?
3274         'pin',          'varchar', 'NULL', $char_d, '', '',
3275         'sip_password', 'varchar', 'NULL', $char_d, '', '',
3276         'phone_name',   'varchar', 'NULL', $char_d, '', '',
3277         'pbxsvc',           'int', 'NULL',      '', '', '',
3278         'domsvc',           'int', 'NULL',      '', '', '',
3279         'locationnum',      'int', 'NULL', '', '', '',
3280         'forwarddst',     'varchar',     'NULL',      15, '', '',
3281         'email',           'varchar', 'NULL',  255, '', '',
3282         'lnp_status',   'varchar', 'NULL', $char_d, '', '',
3283         'portable',     'char', 'NULL',       1,  '', '',
3284         'lrn',     'char',     'NULL',      10, '', '',
3285         'lnp_desired_due_date',     'int', 'NULL',       '', '', '',
3286         'lnp_due_date',     'int', 'NULL',       '', '', '',
3287         'lnp_other_provider', 'varchar', 'NULL', $char_d,  '', '',
3288         'lnp_other_provider_account', 'varchar', 'NULL', $char_d,  '', '',
3289         'lnp_reject_reason', 'varchar', 'NULL', $char_d,  '', '',
3290       ],
3291       'primary_key' => 'svcnum',
3292       'unique' => [],
3293       'index'  => [ ['countrycode', 'phonenum'], ['pbxsvc'], ['domsvc'],
3294                     ['locationnum'],
3295                   ],
3296     },
3297
3298     'phone_device' => {
3299       'columns' => [
3300         'devicenum', 'serial',     '', '', '', '',
3301         'devicepart',   'int',     '', '', '', '',
3302         'svcnum',       'int',     '', '', '', '',
3303         'mac_addr', 'varchar', 'NULL', 12, '', '',
3304       ],
3305       'primary_key' => 'devicenum',
3306       'unique' => [ [ 'mac_addr' ], ],
3307       'index'  => [ [ 'devicepart' ], [ 'svcnum' ], ],
3308     },
3309
3310     'part_device' => {
3311       'columns' => [
3312         'devicepart', 'serial',  '',      '', '', '',
3313         'devicename', 'varchar', '', $char_d, '', '',
3314         'inventory_classnum', 'int', 'NULL', '', '', '',
3315       ],
3316       'primary_key' => 'devicepart',
3317       'unique' => [ [ 'devicename' ] ], #?
3318       'index'  => [],
3319     },
3320
3321     'phone_avail' => {
3322       'columns' => [
3323         'availnum',    'serial',      '',      '', '', '',
3324         'exportnum',   'int',         '',      '', '', '',
3325         'countrycode', 'varchar',     '',       3, '', '',
3326         'state',       'char',    'NULL',       2, '', '',
3327         'npa',         'char',        '',       3, '', '',
3328         'nxx',         'char',    'NULL',       3, '', '',
3329         'station',     'char',    'NULL',       4, '', '',
3330         'name',        'varchar', 'NULL', $char_d, '', '',
3331         'rate_center_abbrev', 'varchar', 'NULL', $char_d, '', '',
3332         'latanum',      'int',     'NULL',      '', '', '',
3333         'msanum',       'int', 'NULL', '', '', '',
3334         'ordernum',      'int',     'NULL',      '', '', '',
3335         'svcnum',      'int',     'NULL',      '', '', '',
3336         'availbatch', 'varchar',  'NULL', $char_d, '', '',
3337       ],
3338       'primary_key' => 'availnum',
3339       'unique' => [],
3340       'index'  => [ [ 'exportnum', 'countrycode', 'state' ],     #npa search
3341                     [ 'exportnum', 'countrycode', 'npa' ],       #nxx search
3342                     [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
3343                     [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
3344                     [ 'svcnum' ],
3345                     [ 'availbatch' ],
3346                     [ 'latanum' ],
3347                   ],
3348     },
3349
3350     'lata' => {
3351       'columns' => [
3352         'latanum',    'int',      '',      '', '', '',
3353         'description',   'varchar',    '',      $char_d, '', '',
3354         'have_usage',   'int',    'NULL',      '', '', '',
3355       ],
3356       'primary_key' => 'latanum',
3357       'unique' => [],
3358       'index'  => [],
3359     },
3360
3361     'msa' => {
3362       'columns' => [
3363         'msanum',    'int',      '',      '', '', '',
3364         'description',   'varchar',    '',      $char_d, '', '',
3365       ],
3366       'primary_key' => 'msanum',
3367       'unique' => [],
3368       'index'  => [],
3369     },
3370
3371     'rate_center' => {
3372       'columns' => [
3373         'ratecenternum',    'serial',      '',      '', '', '',
3374         'description',   'varchar',    '',      $char_d, '', '',
3375       ],
3376       'primary_key' => 'ratecenternum',
3377       'unique' => [],
3378       'index'  => [],
3379     },
3380
3381     'did_vendor' => {
3382       'columns' => [
3383         'vendornum',    'serial',      '',      '', '', '',
3384         'vendorname',   'varchar',        '',     $char_d, '', '',
3385       ],
3386       'primary_key' => 'vendornum',
3387       'unique' => [],
3388       'index'  => [],
3389     },
3390
3391     'did_order_item' => {
3392       'columns' => [
3393         'orderitemnum',    'serial',      '',      '', '', '',
3394         'ordernum',    'int',      '',      '', '', '',
3395         'msanum',      'int',     'NULL',      '', '', '',
3396         'npa',      'int',     'NULL',      '', '', '',
3397         'latanum',      'int',     'NULL',      '', '', '',
3398         'ratecenternum',      'int',     'NULL',      '', '', '',
3399         'state',       'char',    'NULL',       2, '', '',
3400         'quantity',      'int',     '',      '', '', '',
3401         'custnum',   'int', 'NULL', '', '', '',
3402       ],
3403       'primary_key' => 'orderitemnum',
3404       'unique' => [],
3405       'index'  => [],
3406     },
3407
3408     'did_order' => {
3409       'columns' => [
3410         'ordernum',    'serial',      '',      '', '', '',
3411         'vendornum',   'int',       '',      '', '', '',
3412         'vendor_order_id',   'varchar',  'NULL',   $char_d, '', '',
3413         'custnum',   'int', 'NULL', '', '', '',
3414         'submitted',      'int',     '',      '', '', '',
3415         'confirmed',      'int',     'NULL',      '', '', '',
3416         'received',      'int',     'NULL',      '', '', '',
3417       ],
3418       'primary_key' => 'ordernum',
3419       'unique' => [ [ 'vendornum', 'vendor_order_id' ] ],
3420       'index'  => [],
3421     },
3422
3423     'reason_type' => {
3424       'columns' => [
3425         'typenum',   'serial',  '', '', '', '',
3426         'class',     'char', '', 1, '', '',
3427         'type',     'varchar', '', $char_d, '', '',
3428       ],
3429       'primary_key' => 'typenum',
3430       'unique' => [],
3431       'index' => [],
3432     },
3433
3434     'reason' => {
3435       'columns' => [
3436         'reasonnum',     'serial',  '', '', '', '',
3437         'reason_type',   'int',  '', '', '', '',
3438         'reason',        'text', '', '', '', '',
3439         'disabled',      'char',    'NULL', 1, '', '',
3440         'unsuspend_pkgpart', 'int',  'NULL', '', '', '',
3441         'unsuspend_hold','char',    'NULL', 1, '', '',
3442       ],
3443       'primary_key' => 'reasonnum',
3444       'unique' => [],
3445       'index' => [],
3446     },
3447
3448     'conf' => {
3449       'columns' => [
3450         'confnum',  'serial',     '',      '', '', '',
3451         'agentnum', 'int',    'NULL',      '', '', '',
3452         'locale',   'varchar','NULL',      16, '', '',
3453         'name',     'varchar',    '', $char_d, '', '',
3454         'value',    'text',   'NULL',      '', '', '',
3455       ],
3456       'primary_key' => 'confnum',
3457       'unique' => [ [ 'agentnum', 'locale', 'name' ] ],
3458       'index' => [],
3459     },
3460
3461     'pkg_referral' => {
3462       'columns' => [
3463         'pkgrefnum',     'serial', '', '', '', '',
3464         'pkgnum',        'int',    '', '', '', '',
3465         'refnum',        'int',    '', '', '', '',
3466       ],
3467       'primary_key' => 'pkgrefnum',
3468       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
3469       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
3470     },
3471
3472     'svc_pbx' => {
3473       'columns' => [
3474         'svcnum',           'int',     '',      '', '', '',
3475         'id',               'int', 'NULL',      '', '', '',
3476         'title',        'varchar', 'NULL', $char_d, '', '',
3477         'max_extensions',   'int', 'NULL',      '', '', '',
3478         'max_simultaneous', 'int', 'NULL',      '', '', '',
3479       ],
3480       'primary_key' => 'svcnum',
3481       'unique' => [],
3482       'index'  => [ [ 'id' ] ],
3483     },
3484
3485     'svc_mailinglist' => { #svc_group?
3486       'columns' => [
3487         'svcnum',            'int',     '',            '', '', '',
3488         'username',      'varchar',     '', $username_len, '', '',
3489         'domsvc',            'int',     '',            '', '', '',
3490         'listnum',           'int',     '',            '', '', '',
3491         'reply_to',         'char', 'NULL',             1, '', '',#SetReplyTo
3492         'remove_from',      'char', 'NULL',             1, '', '',#RemoveAuthor
3493         'reject_auto',      'char', 'NULL',             1, '', '',#RejectAuto
3494         'remove_to_and_cc', 'char', 'NULL',             1, '', '',#RemoveToAndCc
3495       ],
3496       'primary_key' => 'svcnum',
3497       'unique' => [],
3498       'index'  => [ ['username'], ['domsvc'], ['listnum'] ],
3499     },
3500
3501     'mailinglist' => {
3502       'columns' => [
3503         'listnum',   'serial', '',      '', '', '',
3504         'listname', 'varchar', '', $char_d, '', '',
3505       ],
3506       'primary_key' => 'listnum',
3507       'unique' => [],
3508       'index'  => [],
3509     },
3510
3511     'mailinglistmember' => {
3512       'columns' => [
3513         'membernum',        'serial',     '',   '', '', '',
3514         'listnum',             'int',     '',   '', '', '',
3515         'svcnum',              'int', 'NULL',   '', '', '',
3516         'contactemailnum',     'int', 'NULL',   '', '', '',
3517         'email',           'varchar', 'NULL',  255, '', '',
3518       ],
3519       'primary_key' => 'membernum',
3520       'unique'      => [],
3521       'index'       => [['listnum'],['svcnum'],['contactemailnum'],['email']],
3522     },
3523
3524     'bill_batch' => {
3525       'columns' => [
3526         'batchnum',         'serial',     '',  '', '', '',
3527         'agentnum',            'int', 'NULL',  '', '', '',
3528         'status',             'char', 'NULL', '1', '', '',
3529         'pdf',                'blob', 'NULL',  '', '', '',
3530       ],
3531       'primary_key' => 'batchnum',
3532       'unique'      => [],
3533       'index'       => [ ['agentnum'] ],
3534     },
3535
3536     'cust_bill_batch' => {
3537       'columns' => [
3538         'billbatchnum',     'serial',     '', '', '', '',
3539         'batchnum',            'int',     '', '', '', '',
3540         'invnum',              'int',     '', '', '', '',
3541       ],
3542       'primary_key' => 'billbatchnum',
3543       'unique'      => [],
3544       'index'       => [ [ 'batchnum' ], [ 'invnum' ] ],
3545     },
3546
3547     'cust_bill_batch_option' => {
3548       'columns' => [
3549         'optionnum', 'serial', '', '', '', '',
3550         'billbatchnum', 'int', '', '', '', '',
3551         'optionname', 'varchar', '', $char_d, '', '',
3552         'optionvalue', 'text', 'NULL', '', '', '',
3553       ],
3554       'primary_key' => 'optionnum',
3555       'unique'      => [],
3556       'index'       => [ [ 'billbatchnum' ], [ 'optionname' ] ],
3557     },
3558
3559     'msg_template' => {
3560       'columns' => [
3561         'msgnum',     'serial',     '',      '', '', '',
3562         'msgname',   'varchar',     '', $char_d, '', '',
3563         'agentnum',      'int', 'NULL',      '', '', '',
3564         'subject',   'varchar', 'NULL',     512, '', '',
3565         'mime_type', 'varchar',     '', $char_d, '', '',
3566         'body',         'blob', 'NULL',      '', '', '',
3567         'disabled',     'char', 'NULL',       1, '', '',
3568         'from_addr', 'varchar', 'NULL',     255, '', '',
3569         'bcc_addr',  'varchar', 'NULL',     255, '', '',
3570       ],
3571       'primary_key' => 'msgnum',
3572       'unique'      => [ ],
3573       'index'       => [ ['agentnum'], ],
3574     },
3575
3576     'template_content' => {
3577       'columns' => [
3578         'contentnum', 'serial',     '',      '', '', '',
3579         'msgnum',        'int',     '',      '', '', '',
3580         'locale',    'varchar', 'NULL',      16, '', '',
3581         'subject',   'varchar', 'NULL',     512, '', '',
3582         'body',         'text', 'NULL',      '', '', '',
3583       ],
3584       'primary_key' => 'contentnum',
3585       'unique'      => [ ['msgnum', 'locale'] ],
3586       'index'       => [ ],
3587     },
3588
3589     'cust_msg' => {
3590       'columns' => [
3591         'custmsgnum', 'serial',     '',     '', '', '',
3592         'custnum',       'int',     '',     '', '', '',
3593         'msgnum',        'int', 'NULL',     '', '', '',
3594         '_date',    @date_type,                 '', '',
3595         'env_from',  'varchar', 'NULL',    255, '', '',
3596         'env_to',    'varchar', 'NULL',    255, '', '',
3597         'header',       'blob', 'NULL',     '', '', '',
3598         'body',         'blob', 'NULL',     '', '', '',
3599         'error',     'varchar', 'NULL',    255, '', '',
3600         'status',    'varchar',     '',$char_d, '', '',
3601       ],
3602       'primary_key' => 'custmsgnum',
3603       'unique'      => [ ],
3604       'index'       => [ ['custnum'], ],
3605     },
3606
3607     'svc_cert' => {
3608       'columns' => [
3609         'svcnum',                'int',     '',      '', '', '',
3610         'recnum',                'int', 'NULL',      '', '', '',
3611         'privatekey',           'text', 'NULL',      '', '', '',
3612         'csr',                  'text', 'NULL',      '', '', '',
3613         'certificate',          'text', 'NULL',      '', '', '',
3614         'cacert',               'text', 'NULL',      '', '', '',
3615         'common_name',       'varchar', 'NULL', $char_d, '', '',
3616         'organization',      'varchar', 'NULL', $char_d, '', '',
3617         'organization_unit', 'varchar', 'NULL', $char_d, '', '',
3618         'city',              'varchar', 'NULL', $char_d, '', '',
3619         'state',             'varchar', 'NULL', $char_d, '', '',
3620         'country',              'char', 'NULL',       2, '', '',
3621         'cert_contact',      'varchar', 'NULL', $char_d, '', '',
3622       ],
3623       'primary_key' => 'svcnum',
3624       'unique' => [],
3625       'index'  => [], #recnum
3626     },
3627
3628     'svc_port' => {
3629       'columns' => [
3630         'svcnum',                'int',     '',      '', '', '',
3631         'serviceid', 'varchar', '', 64, '', '', #srvexport / reportfields
3632       ],
3633       'primary_key' => 'svcnum',
3634       'unique' => [],
3635       'index'  => [], #recnum
3636     },
3637
3638     'areacode'  => {
3639       'columns' => [
3640         'areanum',   'serial',        '',      '', '', '',
3641         'code',        'char',        '',       3, '', '',
3642         'country',     'char',    'NULL',       2, '', '',
3643         'state',       'char',    'NULL',       2, '', '',
3644         'description','varchar',  'NULL',     255, '', '',
3645       ],
3646       'primary_key' => 'areanum',
3647       'unique' => [ [ 'areanum' ] ],
3648       'index'  => [],
3649     },
3650
3651     'upgrade_journal' => {
3652       'columns' => [
3653         'upgradenum', 'serial', '', '', '', '',
3654         '_date', 'int', '', '', '', '',
3655         'upgrade', 'varchar', '', $char_d, '', '',
3656         'status', 'varchar', '', $char_d, '', '',
3657         'statustext', 'varchar', 'NULL', $char_d, '', '',
3658       ],
3659       'primary_key' => 'upgradenum',
3660       'unique' => [ [ 'upgradenum' ] ],
3661       'index' => [ [ 'upgrade' ] ],
3662     },
3663
3664     'log' => {
3665       'columns' => [
3666         'lognum',     'serial', '', '', '', '',
3667         '_date',      'int', '', '', '', '',
3668         'agentnum',   'int', 'NULL', '', '', '',
3669         'tablename',  'varchar', 'NULL', $char_d, '', '',
3670         'tablenum',   'int',  'NULL', '', '', '',
3671         'level',      'int',  '', '', '', '',
3672         'message',    'text', '', '', '', '',
3673       ],
3674       'primary_key' => 'lognum',
3675       'unique'      => [],
3676       'index'       => [ ['_date'], ['level'] ],
3677     },
3678
3679     'log_context' => {
3680       'columns' => [
3681         'logcontextnum', 'serial', '', '', '', '',
3682         'lognum', 'int', '', '', '', '',
3683         'context', 'varchar', '', 32, '', '',
3684       ],
3685       'primary_key' => 'logcontextnum',
3686       'unique' => [ [ 'lognum', 'context' ] ],
3687       'index' => [],
3688     },
3689
3690     %{ tables_hashref_torrus() },
3691
3692     # tables of ours for doing torrus virtual port combining
3693     'torrus_srvderive' => {
3694       'columns' => [
3695         'derivenum',     'serial',     '', '', '', '',
3696         'serviceid',    'varchar',     '', 64, '', '', #srvexport / reportfields
3697         'last_srv_date',   'date', 'NULL', '', '', '',
3698       ],
3699       'primary_key' => 'derivenum',
3700       'unique' => [ ['serviceid'] ],
3701       'index'  => [],
3702     },
3703
3704     'torrus_srvderive_component' => {
3705       'columns' => [
3706         'componentnum', 'serial', '', '', '', '',
3707         'derivenum',       'int', '', '', '', '',
3708         'serviceid',   'varchar', '', 64, '', '', #srvexport / reportfields
3709       ],
3710       'primary_key' => 'componentnum',
3711       'unique'      => [ [ 'derivenum', 'serviceid' ], ],
3712       'index'       => [ [ 'derivenum', ], ],
3713     },
3714
3715
3716     # name type nullability length default local
3717
3718     #'new_table' => {
3719     #  'columns' => [
3720     #    'num', 'serial',       '', '', '', '',
3721     #  ],
3722     #  'primary_key' => 'num',
3723     #  'unique' => [],
3724     #  'index'  => [],
3725     #},
3726
3727   };
3728
3729 }
3730
3731 =back
3732
3733 =head1 BUGS
3734
3735 =head1 SEE ALSO
3736
3737 L<DBIx::DBSchema>
3738
3739 =cut
3740
3741 1;
3742