FS/FS/Schema.pm

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