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