FS/FS/Schema.pm

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