FS/FS/Schema.pm

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