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