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