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