FS/FS/Schema.pm

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