FS/FS/Schema.pm

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