FS/FS/Schema.pm

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