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