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