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