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