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