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