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