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