FS/FS/Schema.pm

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