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