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       unless ( defined $hash{'default'} ) {
 106         warn "$tablename:\n".
 107              join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
 108       }
 109
 110       push @columns, new DBIx::DBSchema::Column ( \%hash );
 111     }
 112
 113     #false laziness w/sub indices in DBIx::DBSchema::DBD (well, sorta)
 114     #and sub sql_create_table in DBIx::DBSchema::Table (slighty more?)
 115     my $unique = $tables_hashref->{$tablename}{'unique'};
 116     my $index  = $tables_hashref->{$tablename}{'index'};
 117     my @indices = ();
 118     push @indices, map {
 119                          DBIx::DBSchema::Index->new({
 120                            'name'    => $tablename. $indexnum++,
 121                            'unique'  => 1,
 122                            'columns' => $_,
 123                          });
 124                        }
 125                        @$unique;
 126     push @indices, map {
 127                          DBIx::DBSchema::Index->new({
 128                            'name'    => $tablename. $indexnum++,
 129                            'unique'  => 0,
 130                            'columns' => $_,
 131                          });
 132                        }
 133                        @$index;
 134
 135     DBIx::DBSchema::Table->new({
 136       'name'          => $tablename,
 137       'primary_key'   => $tables_hashref->{$tablename}{'primary_key'},
 138       'columns'       => \@columns,
 139       'indices'       => \@indices,
 140       'local_options' => $local_options,
 141     });
 142
 143   } keys %$tables_hashref;
 144
 145   if ( $DEBUG ) {
 146     warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
 147     warn "[debug]$me   $_\n" foreach $dbdef->tables;
 148   }
 149
 150   #add radius attributes to svc_acct
 151   #
 152   #my($svc_acct)=$dbdef->table('svc_acct');
 153   #
 154   #my($attribute);
 155   #foreach $attribute (@attributes) {
 156   #  $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
 157   #    'radius_'. $attribute,
 158   #    'varchar',
 159   #    'NULL',
 160   #    $char_d,
 161   #  ));
 162   #}
 163   #
 164   #foreach $attribute (@check_attributes) {
 165   #  $svc_acct->addcolumn( new DBIx::DBSchema::Column (
 166   #    'rc_'. $attribute,
 167   #    'varchar',
 168   #    'NULL',
 169   #    $char_d,
 170   #  ));
 171   #}
 172
 173   #create history tables (false laziness w/create-history-tables)
 174   foreach my $table (
 175     grep { ! /^clientapi_session/ }
 176     grep { ! /^h_/ }
 177     $dbdef->tables
 178   ) {
 179     my $tableobj = $dbdef->table($table)
 180       or die "unknown table $table";
 181
 182     my %indices = $tableobj->indices;
 183
 184     my %h_indices = map {
 185                           ( "h_$_" =>
 186                               DBIx::DBSchema::Index->new({
 187                                 'name'    => 'h_'. $indices{$_}->name,
 188                                 'unique'  => 0,
 189                                 'columns' => [ @{$indices{$_}->columns} ],
 190                               })
 191                           );
 192                         }
 193                         keys %indices;
 194
 195     $h_indices{"h_${table}_srckey"} = DBIx::DBSchema::Index->new({
 196                                         'name'    => "h_${table}_srckey",
 197                                         'unique'  => 0,
 198                                         'columns' => [ 'history_action', #right?
 199                                                        $tableobj->primary_key,
 200                                                      ],
 201                                       });
 202
 203     $h_indices{"h_${table}_srckey2"} = DBIx::DBSchema::Index->new({
 204                                          'name'    => "h_${table}_srckey2",
 205                                          'unique'  => 0,
 206                                          'columns' => [ 'history_date',
 207                                                         $tableobj->primary_key,
 208                                                       ],
 209                                        });
 210
 211     my $h_tableobj = DBIx::DBSchema::Table->new( {
 212       'name'          => "h_$table",
 213       'primary_key'   => 'historynum',
 214       'indices'       => \%h_indices,
 215       'local_options' => $local_options,
 216       'columns'       => [
 217           DBIx::DBSchema::Column->new( {
 218             'name'    => 'historynum',
 219             'type'    => 'serial',
 220             'null'    => 'NOT NULL',
 221             'length'  => '',
 222             'default' => '',
 223             'local'   => '',
 224           } ),
 225           DBIx::DBSchema::Column->new( {
 226             'name'    => 'history_date',
 227             'type'    => 'int',
 228             'null'    => 'NULL',
 229             'length'  => '',
 230             'default' => '',
 231             'local'   => '',
 232           } ),
 233           DBIx::DBSchema::Column->new( {
 234             'name'    => 'history_user',
 235             'type'    => 'varchar',
 236             'null'    => 'NOT NULL',
 237             'length'  => '80',
 238             'default' => '',
 239             'local'   => '',
 240           } ),
 241           DBIx::DBSchema::Column->new( {
 242             'name'    => 'history_action',
 243             'type'    => 'varchar',
 244             'null'    => 'NOT NULL',
 245             'length'  => '80',
 246             'default' => '',
 247             'local'   => '',
 248           } ),
 249           map {
 250             my $column = $tableobj->column($_);
 251
 252             #clone so as to not disturb the original
 253             $column = DBIx::DBSchema::Column->new( {
 254               map { $_ => $column->$_() }
 255                 qw( name type null length default local )
 256             } );
 257
 258             if ( $column->type =~ /^(\w*)SERIAL$/i ) {
 259               $column->type('int');
 260               $column->null('NULL');
 261             }
 262             #$column->default('')
 263             #  if $column->default =~ /^nextval\(/i;
 264             #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
 265             #$column->local($local);
 266             $column;
 267           } $tableobj->columns
 268       ],
 269     } );
 270     $dbdef->addtable($h_tableobj);
 271   }
 272
 273   if ( $datasrc =~ /^dbi:mysql/i ) {
 274
 275     my $dup_lock_table = DBIx::DBSchema::Table->new( {
 276       'name'          => 'duplicate_lock',
 277       'primary_key'   => 'duplocknum',
 278       'local_options' => $local_options,
 279       'columns'       => [
 280         DBIx::DBSchema::Column->new( {
 281           'name'    => 'duplocknum',
 282           'type'    => 'serial',
 283           'null'    => 'NOT NULL',
 284           'length'  => '',
 285           'default' => '',
 286           'local'   => '',
 287         } ),
 288         DBIx::DBSchema::Column->new( {
 289           'name'    => 'lockname',
 290           'type'    => 'varchar',
 291           'null'    => 'NOT NULL',
 292           'length'  => '80',
 293           'default' => '',
 294           'local'   => '',
 295         } ),
 296       ],
 297       'indices' => { 'duplicate_lock1' =>
 298                        DBIx::DBSchema::Index->new({
 299                          'name'    => 'duplicate_lock1',
 300                          'unique'  => 1,
 301                          'columns' => [ 'lockname' ],
 302                        })
 303                    },
 304     } );
 305
 306     $dbdef->addtable($dup_lock_table);
 307
 308   }
 309
 310   $dbdef;
 311
 312 }
 313
 314 sub tables_hashref {
 315
 316   my $char_d = 80; #default maxlength for text fields
 317
 318   #my(@date_type)  = ( 'timestamp', '', ''     );
 319   my @date_type  = ( 'int', 'NULL', ''     );
 320   my @perl_type = ( 'text', 'NULL', ''  );
 321   my @money_type = ( 'decimal',   '', '10,2' );
 322   my @money_typen = ( 'decimal',   'NULL', '10,2' );
 323   my @taxrate_type  = ( 'decimal',   '',     '14,8' ); # requires pg 8 for
 324   my @taxrate_typen = ( 'decimal',   'NULL', '14,8' ); # fs-upgrade to work
 325
 326   my $username_len = 32; #usernamemax config file
 327
 328     # name type nullability length default local
 329
 330   return {
 331
 332     'agent' => {
 333       'columns' => [
 334         'agentnum',          'serial',    '',       '', '', '',
 335         'agent',            'varchar',    '',  $char_d, '', '',
 336         'typenum',              'int',    '',       '', '', '',
 337         'ticketing_queueid',    'int', 'NULL',      '', '', '',
 338         'invoice_template', 'varchar', 'NULL', $char_d, '', '',
 339         'agent_custnum',        'int', 'NULL',      '', '', '',
 340         'disabled',            'char', 'NULL',       1, '', '',
 341         'username',         'varchar', 'NULL', $char_d, '', '', #deprecated
 342         '_password',        'varchar', 'NULL', $char_d, '', '', #deprecated
 343         'freq',              'int', 'NULL', '', '', '', #deprecated (never used)
 344         'prog',                     @perl_type, '', '', #deprecated (never used)
 345       ],
 346       'primary_key' => 'agentnum',
 347       #'unique' => [ [ 'agent_custnum' ] ], #one agent per customer?
 348                                             #insert is giving it a value, tho..
 349       #'index' => [ ['typenum'], ['disabled'] ],
 350       'unique' => [],
 351       'index' => [ ['typenum'], ['disabled'], ['agent_custnum'] ],
 352     },
 353
 354     'agent_type' => {
 355       'columns' => [
 356         'typenum',   'serial',  '', '', '', '',
 357         'atype',     'varchar', '', $char_d, '', '',
 358       ],
 359       'primary_key' => 'typenum',
 360       'unique' => [],
 361       'index' => [],
 362     },
 363
 364     'type_pkgs' => {
 365       'columns' => [
 366         'typepkgnum', 'serial', '', '', '', '',
 367         'typenum',   'int',  '', '', '', '',
 368         'pkgpart',   'int',  '', '', '', '',
 369       ],
 370       'primary_key' => 'typepkgnum',
 371       'unique' => [ ['typenum', 'pkgpart'] ],
 372       'index' => [ ['typenum'] ],
 373     },
 374
 375     'cust_bill' => {
 376       'columns' => [
 377         'invnum',    'serial',  '', '', '', '',
 378         'custnum',   'int',  '', '', '', '',
 379         '_date',     @date_type, '', '',
 380         'charged',   @money_type, '', '',
 381         'printed',   'int',  '', '', '', '',
 382         'closed',    'char', 'NULL', 1, '', '',
 383       ],
 384       'primary_key' => 'invnum',
 385       'unique' => [],
 386       'index' => [ ['custnum'], ['_date'] ],
 387     },
 388
 389     'cust_bill_event' => {
 390       'columns' => [
 391         'eventnum',    'serial',  '', '', '', '',
 392         'invnum',   'int',  '', '', '', '',
 393         'eventpart',   'int',  '', '', '', '',
 394         '_date',     @date_type, '', '',
 395         'status', 'varchar', '', $char_d, '', '',
 396         'statustext', 'text', 'NULL', '', '', '',
 397       ],
 398       'primary_key' => 'eventnum',
 399       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 400       'unique' => [],
 401       'index' => [ ['invnum'], ['status'], ['eventpart'] ],
 402     },
 403
 404     'part_bill_event' => {
 405       'columns' => [
 406         'eventpart',    'serial',  '', '', '', '',
 407         'freq',        'varchar',       'NULL',     $char_d, '', '',
 408         'payby',       'char',  '', 4, '', '',
 409         'event',       'varchar',           '',     $char_d, '', '',
 410         'eventcode',    @perl_type, '', '',
 411         'seconds',     'int', 'NULL', '', '', '',
 412         'weight',      'int', '', '', '', '',
 413         'plan',       'varchar', 'NULL', $char_d, '', '',
 414         'plandata',   'text', 'NULL', '', '', '',
 415         'reason',     'int', 'NULL', '', '', '',
 416         'disabled',     'char', 'NULL', 1, '', '',
 417       ],
 418       'primary_key' => 'eventpart',
 419       'unique' => [],
 420       'index' => [ ['payby'], ['disabled'], ],
 421     },
 422
 423     'part_event' => {
 424       'columns' => [
 425         'eventpart',   'serial',      '',      '', '', '',
 426         'agentnum',    'int',     'NULL',      '', '', '',
 427         'event',       'varchar',     '', $char_d, '', '',
 428         'eventtable',  'varchar',     '', $char_d, '', '',
 429         'check_freq',  'varchar', 'NULL', $char_d, '', '',
 430         'weight',      'int',         '',      '', '', '',
 431         'action',      'varchar',     '', $char_d, '', '',
 432         'disabled',     'char',   'NULL',       1, '', '',
 433       ],
 434       'primary_key' => 'eventpart',
 435       'unique' => [],
 436       'index' => [ ['agentnum'], ['eventtable'], ['check_freq'], ['disabled'], ],
 437     },
 438
 439     'part_event_option' => {
 440       'columns' => [
 441         'optionnum', 'serial', '', '', '', '',
 442         'eventpart', 'int', '', '', '', '',
 443         'optionname', 'varchar', '', $char_d, '', '',
 444         'optionvalue', 'text', 'NULL', '', '', '',
 445       ],
 446       'primary_key' => 'optionnum',
 447       'unique'      => [],
 448       'index'       => [ [ 'eventpart' ], [ 'optionname' ] ],
 449     },
 450
 451     'part_event_condition' => {
 452       'columns' => [
 453         'eventconditionnum', 'serial', '', '', '', '',
 454         'eventpart', 'int', '', '', '', '',
 455         'conditionname', 'varchar', '', $char_d, '', '',
 456       ],
 457       'primary_key' => 'eventconditionnum',
 458       'unique'      => [],
 459       'index'       => [ [ 'eventpart' ], [ 'conditionname' ] ],
 460     },
 461
 462     'part_event_condition_option' => {
 463       'columns' => [
 464         'optionnum', 'serial', '', '', '', '',
 465         'eventconditionnum', 'int', '', '', '', '',
 466         'optionname', 'varchar', '', $char_d, '', '',
 467         'optionvalue', 'text', 'NULL', '', '', '',
 468       ],
 469       'primary_key' => 'optionnum',
 470       'unique'      => [],
 471       'index'       => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
 472     },
 473
 474     'part_event_condition_option_option' => {
 475       'columns' => [
 476         'optionoptionnum', 'serial', '', '', '', '',
 477         'optionnum', 'int', '', '', '', '',
 478         'optionname', 'varchar', '', $char_d, '', '',
 479         'optionvalue', 'text', 'NULL', '', '', '',
 480       ],
 481       'primary_key' => 'optionoptionnum',
 482       'unique'      => [],
 483       'index'       => [ [ 'optionnum' ], [ 'optionname' ] ],
 484     },
 485
 486     'cust_event' => {
 487       'columns' => [
 488         'eventnum',    'serial',  '', '', '', '',
 489         'eventpart',   'int',  '', '', '', '',
 490         'tablenum',   'int',  '', '', '', '',
 491         '_date',     @date_type, '', '',
 492         'status', 'varchar', '', $char_d, '', '',
 493         'statustext', 'text', 'NULL', '', '', '',
 494       ],
 495       'primary_key' => 'eventnum',
 496       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 497       'unique' => [],
 498       'index' => [ ['eventpart'], ['tablenum'], ['status'] ],
 499     },
 500
 501     'cust_bill_pkg' => {
 502       'columns' => [
 503         'billpkgnum',        'serial',     '',      '', '', '',
 504         'invnum',               'int',     '',      '', '', '',
 505         'pkgnum',               'int',     '',      '', '', '',
 506         'pkgpart_override',     'int', 'NULL',      '', '', '',
 507         'setup',               @money_type,             '', '',
 508         'recur',               @money_type,             '', '',
 509         'sdate',               @date_type,              '', '',
 510         'edate',               @date_type,              '', '',
 511         'itemdesc',         'varchar', 'NULL', $char_d, '', '',
 512         'section',          'varchar', 'NULL', $char_d, '', '',
 513         'quantity',             'int', 'NULL',      '', '', '',
 514         'unitsetup',           @money_typen,            '', '',
 515         'unitrecur',           @money_typen,            '', '',
 516       ],
 517       'primary_key' => 'billpkgnum',
 518       'unique' => [],
 519       'index' => [ ['invnum'], [ 'pkgnum' ] ],
 520     },
 521
 522     'cust_bill_pkg_detail' => {
 523       'columns' => [
 524         'detailnum', 'serial', '', '', '', '',
 525         'billpkgnum', 'int', 'NULL', '', '', '',        # should not be nullable
 526         'pkgnum',  'int', 'NULL', '', '', '',           # deprecated
 527         'invnum',  'int', 'NULL', '', '', '',           # deprecated
 528         'amount',  @money_typen, '', '',
 529         'format',  'char', 'NULL', 1, '', '',
 530         'classnum', 'char', 'NULL', 1, '', '',
 531         'detail',  'varchar', '', 255, '', '',
 532       ],
 533       'primary_key' => 'detailnum',
 534       'unique' => [],
 535       'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
 536     },
 537
 538     'cust_bill_pkg_display' => {
 539       'columns' => [
 540         'billpkgdisplaynum', 'serial', '', '', '', '',
 541         'billpkgnum', 'int', '', '', '', '',
 542         'section',  'varchar', 'NULL', $char_d, '', '',
 543         #'unitsetup', @money_typen, '', '',     #override the linked real one?
 544         #'unitrecur', @money_typen, '', '',     #this too?
 545         'post_total', 'char', 'NULL', 1, '', '',
 546         'type',       'char', 'NULL', 1, '', '',
 547         'summary',    'char', 'NULL', 1, '', '',
 548       ],
 549       'primary_key' => 'billpkgdisplaynum',
 550       'unique' => [],
 551       'index' => [ ['billpkgnum'], ],
 552     },
 553
 554     'cust_bill_pkg_tax_location' => {
 555       'columns' => [
 556         'billpkgtaxlocationnum', 'serial',      '', '', '', '',
 557         'billpkgnum',               'int',      '', '', '', '',
 558         'taxnum',                   'int',      '', '', '', '',
 559         'taxtype',              'varchar', $char_d, '', '', '',
 560         'pkgnum',                   'int',      '', '', '', '',
 561         'locationnum',              'int',      '', '', '', '', #redundant?
 562         'amount',                   @money_type,        '', '',
 563       ],
 564       'primary_key' => 'billpkgtaxlocationnum',
 565       'unique' => [],
 566       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'pkgnum' ], [ 'locationnum' ] ],
 567     },
 568
 569     'cust_credit' => {
 570       'columns' => [
 571         'crednum',  'serial', '', '', '', '',
 572         'custnum',  'int', '', '', '', '',
 573         '_date',    @date_type, '', '',
 574         'amount',   @money_type, '', '',
 575         'otaker',   'varchar', '', 32, '', '',
 576         'reason',   'text', 'NULL', '', '', '',
 577         'reasonnum', 'int', 'NULL', '', '', '',
 578         'addlinfo', 'text', 'NULL', '', '', '',
 579         'closed',    'char', 'NULL', 1, '', '',
 580       ],
 581       'primary_key' => 'crednum',
 582       'unique' => [],
 583       'index' => [ ['custnum'], ['_date'] ],
 584     },
 585
 586     'cust_credit_bill' => {
 587       'columns' => [
 588         'creditbillnum', 'serial', '', '', '', '',
 589         'crednum',  'int', '', '', '', '',
 590         'invnum',  'int', '', '', '', '',
 591         '_date',    @date_type, '', '',
 592         'amount',   @money_type, '', '',
 593       ],
 594       'primary_key' => 'creditbillnum',
 595       'unique' => [],
 596       'index' => [ ['crednum'], ['invnum'] ],
 597     },
 598
 599     'cust_credit_bill_pkg' => {
 600       'columns' => [
 601         'creditbillpkgnum', 'serial', '',      '', '', '',
 602         'creditbillnum',       'int', '',      '', '', '',
 603         'billpkgnum',          'int', '',      '', '', '',
 604         'amount',            @money_type,          '', '',
 605         'setuprecur',      'varchar', '', $char_d, '', '',
 606         'sdate',   @date_type, '', '',
 607         'edate',   @date_type, '', '',
 608       ],
 609       'primary_key' => 'creditbillpkgnum',
 610       'unique'      => [],
 611       'index'       => [ [ 'creditbillnum' ], [ 'billpkgnum' ], ],
 612     },
 613
 614     'cust_main' => {
 615       'columns' => [
 616         'custnum',  'serial',  '',     '', '', '',
 617         'agentnum', 'int',  '',     '', '', '',
 618         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
 619         'custbatch', 'varchar', 'NULL', $char_d, '', '',
 620 #        'titlenum', 'int',  'NULL',   '', '', '',
 621         'last',     'varchar', '',     $char_d, '', '',
 622 #        'middle',   'varchar', 'NULL', $char_d, '', '',
 623         'first',    'varchar', '',     $char_d, '', '',
 624         'ss',       'varchar', 'NULL', 11, '', '',
 625         'stateid', 'varchar', 'NULL', $char_d, '', '',
 626         'stateid_state', 'varchar', 'NULL', $char_d, '', '',
 627         'birthdate' ,@date_type, '', '',
 628         'signupdate',@date_type, '', '',
 629         'dundate',   @date_type, '', '',
 630         'company',  'varchar', 'NULL', $char_d, '', '',
 631         'address1', 'varchar', '',     $char_d, '', '',
 632         'address2', 'varchar', 'NULL', $char_d, '', '',
 633         'city',     'varchar', '',     $char_d, '', '',
 634         'county',   'varchar', 'NULL', $char_d, '', '',
 635         'state',    'varchar', 'NULL', $char_d, '', '',
 636         'zip',      'varchar', 'NULL', 10, '', '',
 637         'country',  'char', '',     2, '', '',
 638         'daytime',  'varchar', 'NULL', 20, '', '',
 639         'night',    'varchar', 'NULL', 20, '', '',
 640         'fax',      'varchar', 'NULL', 12, '', '',
 641         'ship_last',     'varchar', 'NULL', $char_d, '', '',
 642 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '',
 643         'ship_first',    'varchar', 'NULL', $char_d, '', '',
 644         'ship_company',  'varchar', 'NULL', $char_d, '', '',
 645         'ship_address1', 'varchar', 'NULL', $char_d, '', '',
 646         'ship_address2', 'varchar', 'NULL', $char_d, '', '',
 647         'ship_city',     'varchar', 'NULL', $char_d, '', '',
 648         'ship_county',   'varchar', 'NULL', $char_d, '', '',
 649         'ship_state',    'varchar', 'NULL', $char_d, '', '',
 650         'ship_zip',      'varchar', 'NULL', 10, '', '',
 651         'ship_country',  'char', 'NULL', 2, '', '',
 652         'ship_daytime',  'varchar', 'NULL', 20, '', '',
 653         'ship_night',    'varchar', 'NULL', 20, '', '',
 654         'ship_fax',      'varchar', 'NULL', 12, '', '',
 655         'payby',    'char', '',     4, '', '',
 656         'payinfo',  'varchar', 'NULL', 512, '', '',
 657         'paycvv',   'varchar', 'NULL', 512, '', '',
 658         'paymask', 'varchar', 'NULL', $char_d, '', '',
 659         #'paydate',  @date_type, '', '',
 660         'paydate',  'varchar', 'NULL', 10, '', '',
 661         'paystart_month', 'int', 'NULL', '', '', '',
 662         'paystart_year',  'int', 'NULL', '', '', '',
 663         'payissue', 'varchar', 'NULL', 2, '', '',
 664         'payname',  'varchar', 'NULL', $char_d, '', '',
 665         'paystate', 'varchar', 'NULL', $char_d, '', '',
 666         'paytype',  'varchar', 'NULL', $char_d, '', '',
 667         'payip',    'varchar', 'NULL', 15, '', '',
 668         'geocode',  'varchar', 'NULL', 20,  '', '',
 669         'tax',      'char', 'NULL', 1, '', '',
 670         'otaker',   'varchar', '',    32, '', '',
 671         'refnum',   'int',  '',     '', '', '',
 672         'referral_custnum', 'int',  'NULL', '', '', '',
 673         'comments', 'text', 'NULL', '', '', '',
 674         'spool_cdr','char', 'NULL', 1, '', '',
 675         'squelch_cdr','char', 'NULL', 1, '', '',
 676         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 677       ],
 678       'primary_key' => 'custnum',
 679       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
 680       #'index' => [ ['last'], ['company'] ],
 681       'index' => [
 682                    [ 'agentnum' ], [ 'refnum' ], [ 'custbatch' ],
 683                    [ 'referral_custnum' ],
 684                    [ 'payby' ], [ 'paydate' ],
 685                    #billing
 686                    [ 'last' ], [ 'company' ],
 687                    [ 'county' ], [ 'state' ], [ 'country' ],
 688                    [ 'zip' ],
 689                    [ 'daytime' ], [ 'night' ], [ 'fax' ],
 690                    #shipping
 691                    [ 'ship_last' ], [ 'ship_company' ],
 692                    [ 'ship_county' ], [ 'ship_state' ], [ 'ship_country' ],
 693                    [ 'ship_zip' ],
 694                    [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
 695                  ],
 696     },
 697
 698     #eventually use for billing & ship from cust_main too
 699     #for now, just cust_pkg locations
 700     'cust_location' => {
 701       'columns' => [
 702         'locationnum',  'serial',     '',      '', '', '',
 703         'custnum',         'int',     '',      '', '', '',
 704         'address1',    'varchar',     '', $char_d, '', '',
 705         'address2',    'varchar', 'NULL', $char_d, '', '',
 706         'city',        'varchar',     '', $char_d, '', '',
 707         'county',      'varchar', 'NULL', $char_d, '', '',
 708         'state',       'varchar', 'NULL', $char_d, '', '',
 709         'zip',         'varchar', 'NULL',      10, '', '',
 710         'country',        'char',     '',       2, '', '',
 711         'geocode',     'varchar', 'NULL',      20, '', '',
 712       ],
 713       'primary_key' => 'locationnum',
 714       'unique'      => [],
 715       'index'       => [ [ 'custnum' ],
 716                          [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
 717                        ],
 718     },
 719
 720     'cust_main_invoice' => {
 721       'columns' => [
 722         'destnum',  'serial',  '',     '', '', '',
 723         'custnum',  'int',  '',     '', '', '',
 724         'dest',     'varchar', '',  $char_d, '', '',
 725       ],
 726       'primary_key' => 'destnum',
 727       'unique' => [],
 728       'index' => [ ['custnum'], ],
 729     },
 730
 731     'cust_main_note' => {
 732       'columns' => [
 733         'notenum',  'serial',  '',     '', '', '',
 734         'custnum',  'int',  '',     '', '', '',
 735         '_date',    @date_type, '', '',
 736         'otaker',   'varchar', '',    32, '', '',
 737         'comments', 'text', 'NULL', '', '', '',
 738       ],
 739       'primary_key' => 'notenum',
 740       'unique' => [],
 741       'index' => [ [ 'custnum' ], [ '_date' ], ],
 742     },
 743
 744     'cust_main_county' => { #county+state+country are checked off the
 745                             #cust_main_county for validation and to provide
 746                             # a tax rate.
 747       'columns' => [
 748         'taxnum',   'serial',   '',    '', '', '',
 749         'state',    'varchar',  'NULL',    $char_d, '', '',
 750         'county',   'varchar',  'NULL',    $char_d, '', '',
 751         'country',  'char',  '', 2, '', '',
 752         'taxclass',   'varchar', 'NULL', $char_d, '', '',
 753         'exempt_amount', @money_type, '', '',
 754         'tax',      'real',  '',    '', '', '', #tax %
 755         'taxname',  'varchar',  'NULL',    $char_d, '', '',
 756         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
 757         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
 758       ],
 759       'primary_key' => 'taxnum',
 760       'unique' => [],
 761   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
 762       'index' => [ [ 'county' ], [ 'state' ], [ 'country' ],
 763                    [ 'taxclass' ],
 764                  ],
 765     },
 766
 767     'tax_rate'    => {
 768       'columns' => [
 769         'taxnum',       'serial',     '',      '', '', '',
 770         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
 771         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
 772         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
 773         'taxclassnum', 'int',      '',      '', '', '',
 774         'effective_date', @date_type, '', '',
 775         'tax',        @taxrate_type,      '', '',        # tax %
 776         'excessrate', @taxrate_typen,     '', '',        # second tax %
 777         'taxbase',    @money_typen, '', '',              # amount at first tax rate
 778         'taxmax',     @money_typen, '', '',              # maximum about at both rates
 779         'usetax',        @taxrate_typen,     '', '',     # tax % when non-local
 780         'useexcessrate', @taxrate_typen,     '', '',     # second tax % when non-local
 781         'unittype',    'int',  'NULL', '', '', '',      # for fee
 782         'fee',         @taxrate_typen,     '', '',      # amount tax per unit
 783         'excessfee',   @taxrate_typen,     '', '',      # second amount tax per unit
 784         'feebase',     @taxrate_typen,     '', '',      # units taxed at first rate
 785         'feemax',      @taxrate_typen,     '', '',      # maximum number of unit taxed
 786         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
 787         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
 788         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
 789         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
 790         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
 791         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
 792         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
 793         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
 794         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
 795         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
 796       ],
 797       'primary_key' => 'taxnum',
 798       'unique' => [],
 799       'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
 800     },
 801
 802     'cust_tax_location' => {
 803       'columns' => [
 804         'custlocationnum', 'serial',  '',     '', '', '',
 805         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
 806         'city',            'varchar', 'NULL', $char_d, '', '',
 807         'postalcity',      'varchar', 'NULL', $char_d, '', '',
 808         'county',          'varchar', 'NULL', $char_d, '', '',
 809         'zip',             'char',    '',     5,  '', '',
 810         'state',           'char',    '',     2,  '', '',
 811         'plus4hi',         'char',    'NULL', 4,  '', '',
 812         'plus4lo',         'char',    'NULL', 4,  '', '',
 813         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
 814         'cityflag',        'char',    'NULL', 1,  '', '', # I(n)/O(out)/B(oth)/NULL
 815         'geocode',         'varchar', '',    20,  '', '',
 816       ],
 817       'primary_key' => 'custlocationnum',
 818       'unique' => [],
 819       'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
 820     },
 821
 822     'tax_class' => {
 823       'columns' => [
 824         'taxclassnum',  'serial',  '',            '', '', '',
 825         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
 826         'taxclass',     'varchar', '',       $char_d, '', '',
 827         'description',  'varchar', '',     2*$char_d, '', '',
 828       ],
 829       'primary_key' => 'taxclassnum',
 830       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
 831       'index' => [],
 832     },
 833
 834     'cust_pay_pending' => {
 835       'columns' => [
 836         'paypendingnum','serial',      '',  '', '', '',
 837         'custnum',      'int',         '',  '', '', '',
 838         'paid',         @money_type,            '', '',
 839         '_date',        @date_type,             '', '',
 840         'payby',        'char',        '',   4, '', '', #CARD/BILL/COMP, should
 841                                                         # be index into payby
 842                                                         # table eventually
 843         'payinfo',      'varchar', 'NULL', 512, '', '', #see cust_main above
 844         'paymask',      'varchar', 'NULL', $char_d, '', '',
 845         'paydate',      'varchar', 'NULL', 10, '', '',
 846         #'paybatch',     'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
 847         'payunique',    'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
 848
 849         'status',       'varchar',     '', $char_d, '', '',
 850         'session_id',   'varchar', 'NULL', $char_d, '', '', #only need 32
 851         'statustext',   'text',    'NULL',  '', '', '',
 852         'gatewaynum',   'int',     'NULL',  '', '', '',
 853         #'cust_balance', @money_type,            '', '',
 854         'paynum',       'int',     'NULL',  '', '', '',
 855         'jobnum',       'int',     'NULL',  '', '', '',
 856       ],
 857       'primary_key' => 'paypendingnum',
 858       'unique'      => [ [ 'payunique' ] ],
 859       'index'       => [ [ 'custnum' ], [ 'status' ], ],
 860     },
 861
 862     'cust_pay' => {
 863       'columns' => [
 864         'paynum',   'serial',    '',   '', '', '',
 865         'custnum',  'int',    '',   '', '', '',
 866         '_date',    @date_type, '', '',
 867         'paid',     @money_type, '', '',
 868         'otaker',   'varchar', 'NULL', 32, '', '',  #NULL for the upgrade so we can create & populate the field
 869         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 870                                                  # index into payby table
 871                                                  # eventually
 872         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
 873         'paymask', 'varchar', 'NULL', $char_d, '', '',
 874         'paydate',  'varchar', 'NULL', 10, '', '',
 875         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 876         'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
 877         'closed',    'char', 'NULL', 1, '', '',
 878       ],
 879       'primary_key' => 'paynum',
 880       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
 881       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
 882     },
 883
 884     'cust_pay_void' => {
 885       'columns' => [
 886         'paynum',    'int',    '',   '', '', '',
 887         'custnum',   'int',    '',   '', '', '',
 888         'paid',      @money_type, '', '',
 889         '_date',     @date_type, '', '',
 890         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 891                                                   # index into payby table
 892                                                   # eventually
 893         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
 894         'paymask', 'varchar', 'NULL', $char_d, '', '',
 895         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 896         'closed',    'char', 'NULL', 1, '', '',
 897         'void_date', @date_type, '', '',
 898         'reason',    'varchar',   'NULL', $char_d, '', '',
 899         'otaker',   'varchar', '', 32, '', '',
 900       ],
 901       'primary_key' => 'paynum',
 902       'unique' => [],
 903       'index' => [ [ 'custnum' ] ],
 904     },
 905
 906     'cust_bill_pay' => {
 907       'columns' => [
 908         'billpaynum', 'serial',     '',   '', '', '',
 909         'invnum',  'int',     '',   '', '', '',
 910         'paynum',  'int',     '',   '', '', '',
 911         'amount',  @money_type, '', '',
 912         '_date',   @date_type, '', '',
 913       ],
 914       'primary_key' => 'billpaynum',
 915       'unique' => [],
 916       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
 917     },
 918
 919     'cust_bill_pay_batch' => {
 920       'columns' => [
 921         'billpaynum', 'serial',     '',   '', '', '',
 922         'invnum',  'int',     '',   '', '', '',
 923         'paybatchnum',  'int',     '',   '', '', '',
 924         'amount',  @money_type, '', '',
 925         '_date',   @date_type, '', '',
 926       ],
 927       'primary_key' => 'billpaynum',
 928       'unique' => [],
 929       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
 930     },
 931
 932     'cust_bill_pay_pkg' => {
 933       'columns' => [
 934         'billpaypkgnum', 'serial', '', '', '', '',
 935         'billpaynum',       'int', '', '', '', '',
 936         'billpkgnum',       'int', '', '', '', '',
 937         'amount',         @money_type,     '', '',
 938         'setuprecur',      'varchar', '', $char_d, '', '',
 939         'sdate',   @date_type, '', '',
 940         'edate',   @date_type, '', '',
 941       ],
 942       'primary_key' => 'billpaypkgnum',
 943       'unique'      => [],
 944       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
 945     },
 946
 947     'pay_batch' => { #batches of payments to an external processor
 948       'columns' => [
 949         'batchnum',   'serial',    '',   '', '', '',
 950         'payby',      'char',      '',    4, '', '', # CARD/CHEK
 951         'status',     'char', 'NULL',     1, '', '',
 952         'download',   @date_type, '', '',
 953         'upload',     @date_type, '', '',
 954       ],
 955       'primary_key' => 'batchnum',
 956       'unique' => [],
 957       'index' => [],
 958     },
 959
 960     'cust_pay_batch' => { #what's this used for again?  list of customers
 961                           #in current CARD batch? (necessarily CARD?)
 962       'columns' => [
 963         'paybatchnum',   'serial',    '',   '', '', '',
 964         'batchnum',   'int',    '',   '', '', '',
 965         'invnum',   'int',    '',   '', '', '',
 966         'custnum',   'int',    '',   '', '', '',
 967         'last',     'varchar', '',     $char_d, '', '',
 968         'first',    'varchar', '',     $char_d, '', '',
 969         'address1', 'varchar', '',     $char_d, '', '',
 970         'address2', 'varchar', 'NULL', $char_d, '', '',
 971         'city',     'varchar', '',     $char_d, '', '',
 972         'state',    'varchar', 'NULL', $char_d, '', '',
 973         'zip',      'varchar', 'NULL', 10, '', '',
 974         'country',  'char', '',     2, '', '',
 975         #        'trancode', 'int', '', '', '', ''
 976         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 977         'payinfo',  'varchar', '',     512, '', '',
 978         #'exp',      @date_type, '', ''
 979         'exp',      'varchar', 'NULL',     11, '', '',
 980         'payname',  'varchar', 'NULL', $char_d, '', '',
 981         'amount',   @money_type, '', '',
 982         'status',   'varchar', 'NULL',     $char_d, '', '',
 983       ],
 984       'primary_key' => 'paybatchnum',
 985       'unique' => [],
 986       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
 987     },
 988
 989     'cust_pkg' => {
 990       'columns' => [
 991         'pkgnum',           'serial',     '', '', '', '',
 992         'custnum',             'int',     '', '', '', '',
 993         'pkgpart',             'int',     '', '', '', '',
 994         'locationnum',         'int', 'NULL', '', '', '',
 995         'otaker',          'varchar',     '', 32, '', '',
 996         'setup',          @date_type,             '', '',
 997         'bill',           @date_type,             '', '',
 998         'last_bill',      @date_type,             '', '',
 999         'susp',           @date_type,             '', '',
1000         'adjourn',        @date_type,             '', '',
1001         'cancel',         @date_type,             '', '',
1002         'expire',         @date_type,             '', '',
1003         'change_date',    @date_type,             '', '',
1004         'change_pkgnum',       'int', 'NULL', '', '', '',
1005         'change_pkgpart',      'int', 'NULL', '', '', '',
1006         'change_locationnum',  'int', 'NULL', '', '', '',
1007         'manual_flag',        'char', 'NULL',  1, '', '',
1008         'quantity',            'int', 'NULL', '', '', '',
1009       ],
1010       'primary_key' => 'pkgnum',
1011       'unique' => [],
1012       'index' => [ ['custnum'], ['pkgpart'], [ 'locationnum' ],
1013                    ['setup'], ['last_bill'], ['bill'], ['susp'], ['adjourn'],
1014                    ['expire'], ['cancel'],
1015                    ['change_date'],
1016                  ],
1017     },
1018
1019     'cust_pkg_option' => {
1020       'columns' => [
1021         'optionnum', 'serial', '', '', '', '',
1022         'pkgnum', 'int', '', '', '', '',
1023         'optionname', 'varchar', '', $char_d, '', '',
1024         'optionvalue', 'text', 'NULL', '', '', '',
1025       ],
1026       'primary_key' => 'optionnum',
1027       'unique'      => [],
1028       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
1029     },
1030
1031     'cust_pkg_detail' => {
1032       'columns' => [
1033         'pkgdetailnum', 'serial', '',      '', '', '',
1034         'pkgnum',          'int', '',      '', '', '',
1035         'detail',      'varchar', '', $char_d, '', '',
1036         'detailtype',     'char', '',       1, '', '', # "I"nvoice or "C"omment
1037         'weight',          'int', '',      '', '', '',
1038       ],
1039       'primary_key' => 'pkgdetailnum',
1040       'unique' => [],
1041       'index'  => [ [ 'pkgnum', 'detailtype' ] ],
1042     },
1043
1044     'cust_pkg_reason' => {
1045       'columns' => [
1046         'num',      'serial',    '',   '', '', '',
1047         'pkgnum',   'int',    '',   '', '', '',
1048         'reasonnum','int',    '',   '', '', '',
1049         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
1050         'otaker',   'varchar', '', 32, '', '',
1051         'date',     @date_type, '', '',
1052       ],
1053       'primary_key' => 'num',
1054       'unique' => [],
1055       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], ],
1056     },
1057
1058     'cust_refund' => {
1059       'columns' => [
1060         'refundnum',    'serial',    '',   '', '', '',
1061         'custnum',  'int',    '',   '', '', '',
1062         '_date',        @date_type, '', '',
1063         'refund',       @money_type, '', '',
1064         'otaker',       'varchar',   '',   32, '', '',
1065         'reason',       'varchar',   '',   $char_d, '', '',
1066         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
1067                                                      # be index into payby
1068                                                      # table eventually
1069         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
1070         'paymask', 'varchar', 'NULL', $char_d, '', '',
1071         'paybatch',     'varchar',   'NULL', $char_d, '', '',
1072         'closed',    'char', 'NULL', 1, '', '',
1073       ],
1074       'primary_key' => 'refundnum',
1075       'unique' => [],
1076       'index' => [ ['custnum'], ['_date'] ],
1077     },
1078
1079     'cust_credit_refund' => {
1080       'columns' => [
1081         'creditrefundnum', 'serial',     '',   '', '', '',
1082         'crednum',  'int',     '',   '', '', '',
1083         'refundnum',  'int',     '',   '', '', '',
1084         'amount',  @money_type, '', '',
1085         '_date',   @date_type, '', '',
1086       ],
1087       'primary_key' => 'creditrefundnum',
1088       'unique' => [],
1089       'index' => [ ['crednum'], ['refundnum'] ],
1090     },
1091
1092
1093     'cust_svc' => {
1094       'columns' => [
1095         'svcnum',    'serial',    '',   '', '', '',
1096         'pkgnum',    'int',    'NULL',   '', '', '',
1097         'svcpart',   'int',    '',   '', '', '',
1098         'overlimit', @date_type, '', '',
1099       ],
1100       'primary_key' => 'svcnum',
1101       'unique' => [],
1102       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1103     },
1104
1105     'cust_svc_option' => {
1106       'columns' => [
1107         'optionnum',   'serial', '', '', '', '',
1108         'svcnum',      'int', '', '', '', '',
1109         'optionname',  'varchar', '', $char_d, '', '',
1110         'optionvalue', 'text', 'NULL', '', '', '',
1111       ],
1112       'primary_key' => 'optionnum',
1113       'unique'      => [],
1114       'index'       => [ [ 'svcnum' ], [ 'optionname' ] ],
1115     },
1116
1117     'part_pkg' => {
1118       'columns' => [
1119         'pkgpart',       'serial',    '',   '', '', '',
1120         'pkg',           'varchar',   '',   $char_d, '', '',
1121         'comment',       'varchar',   '',   $char_d, '', '',
1122         'promo_code',    'varchar', 'NULL', $char_d, '', '',
1123         'setup',         @perl_type, '', '',
1124         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
1125         'recur',         @perl_type, '', '',
1126         'setuptax',      'char', 'NULL', 1, '', '',
1127         'recurtax',      'char', 'NULL', 1, '', '',
1128         'plan',          'varchar', 'NULL', $char_d, '', '',
1129         'plandata',      'text', 'NULL', '', '', '',
1130         'disabled',      'char', 'NULL', 1, '', '',
1131         'taxclass',      'varchar', 'NULL', $char_d, '', '',
1132         'classnum',      'int',     'NULL', '', '', '',
1133         'taxproductnum', 'int',     'NULL', '', '', '',
1134         'pay_weight',    'real',    'NULL', '', '', '',
1135         'credit_weight', 'real',    'NULL', '', '', '',
1136         'agentnum',      'int',     'NULL', '', '', '',
1137
1138       ],
1139       'primary_key' => 'pkgpart',
1140       'unique' => [],
1141       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
1142     },
1143
1144     'part_pkg_link' => {
1145       'columns' => [
1146         'pkglinknum',  'serial',  '',      '', '', '',
1147         'src_pkgpart', 'int',     '',      '', '', '',
1148         'dst_pkgpart', 'int',     '',      '', '', '',
1149         'link_type',   'varchar', '', $char_d, '', '',
1150       ],
1151       'primary_key' => 'pkglinknum',
1152       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type' ] ],
1153       'index'  => [ [ 'src_pkgpart' ] ],
1154     },
1155
1156     'part_pkg_taxclass' => {
1157       'columns' => [
1158         'taxclassnum',  'serial', '',       '', '', '',
1159         'taxclass',     'varchar', '', $char_d, '', '',
1160       ],
1161       'primary_key' => 'taxclassnum',
1162       'unique'      => [ [ 'taxclass' ] ],
1163       'index'       => [],
1164     },
1165
1166     'part_pkg_taxproduct' => {
1167       'columns' => [
1168         'taxproductnum', 'serial',      '',        '', '', '',
1169         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
1170         'taxproduct',    'varchar',     '',   $char_d, '', '',
1171         'description',   'varchar',     '', 3*$char_d, '', '',
1172       ],
1173       'primary_key' => 'taxproductnum',
1174       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
1175       'index'       => [],
1176     },
1177
1178     'part_pkg_taxrate' => {
1179       'columns' => [
1180         'pkgtaxratenum', 'serial',  '',     '',      '', '',
1181         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
1182         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
1183         'taxproductnum', 'int',  '',     '',       '', '',
1184         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
1185         'county',           'varchar', 'NULL', $char_d, '', '',
1186         'state',            'varchar', 'NULL', $char_d, '', '',
1187         'local',            'varchar', 'NULL', $char_d, '', '',
1188         'country',          'char',    'NULL', 2,       '', '',
1189         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
1190         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
1191         'taxclassnum',      'int',     'NULL', '',      '', '',
1192         'effdate',          @date_type, '', '',
1193         'taxable',          'char',    'NULL', 1,       '', '',
1194       ],
1195       'primary_key' => 'pkgtaxratenum',
1196       'unique' => [],
1197       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1198     },
1199
1200     'part_pkg_taxoverride' => {
1201       'columns' => [
1202         'taxoverridenum', 'serial', '', '', '', '',
1203         'pkgpart',        'serial', '', '', '', '',
1204         'taxclassnum',    'serial', '', '', '', '',
1205         'usage_class',    'varchar', 'NULL', $char_d, '', '',
1206       ],
1207       'primary_key' => 'taxoverridenum',
1208       'unique' => [],
1209       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1210     },
1211
1212 #    'part_title' => {
1213 #      'columns' => [
1214 #        'titlenum',   'int',    '',   '',
1215 #        'title',      'varchar',   '',   $char_d,
1216 #      ],
1217 #      'primary_key' => 'titlenum',
1218 #      'unique' => [ [] ],
1219 #      'index' => [ [] ],
1220 #    },
1221
1222     'pkg_svc' => {
1223       'columns' => [
1224         'pkgsvcnum',  'serial', '',  '', '', '',
1225         'pkgpart',    'int',    '',   '', '', '',
1226         'svcpart',    'int',    '',   '', '', '',
1227         'quantity',   'int',    '',   '', '', '',
1228         'primary_svc','char', 'NULL',  1, '', '',
1229       ],
1230       'primary_key' => 'pkgsvcnum',
1231       'unique' => [ ['pkgpart', 'svcpart'] ],
1232       'index' => [ ['pkgpart'] ],
1233     },
1234
1235     'part_referral' => {
1236       'columns' => [
1237         'refnum',   'serial',     '',        '', '', '',
1238         'referral', 'varchar',    '',   $char_d, '', '',
1239         'disabled', 'char',   'NULL',         1, '', '',
1240         'agentnum', 'int',    'NULL',        '', '', '',
1241       ],
1242       'primary_key' => 'refnum',
1243       'unique' => [],
1244       'index' => [ ['disabled'], ['agentnum'], ],
1245     },
1246
1247     'part_svc' => {
1248       'columns' => [
1249         'svcpart',    'serial',    '',   '', '', '',
1250         'svc',        'varchar',   '',   $char_d, '', '',
1251         'svcdb',      'varchar',   '',   $char_d, '', '',
1252         'disabled',   'char',  'NULL',   1, '', '',
1253       ],
1254       'primary_key' => 'svcpart',
1255       'unique' => [],
1256       'index' => [ [ 'disabled' ] ],
1257     },
1258
1259     'part_svc_column' => {
1260       'columns' => [
1261         'columnnum',   'serial',         '', '', '', '',
1262         'svcpart',     'int',         '', '', '', '',
1263         'columnname',  'varchar',     '', 64, '', '',
1264         'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1265         'columnflag',  'char',    'NULL', 1, '', '',
1266       ],
1267       'primary_key' => 'columnnum',
1268       'unique' => [ [ 'svcpart', 'columnname' ] ],
1269       'index' => [ [ 'svcpart' ] ],
1270     },
1271
1272     #(this should be renamed to part_pop)
1273     'svc_acct_pop' => {
1274       'columns' => [
1275         'popnum',    'serial',    '',   '', '', '',
1276         'city',      'varchar',   '',   $char_d, '', '',
1277         'state',     'varchar',   '',   $char_d, '', '',
1278         'ac',        'char',   '',   3, '', '',
1279         'exch',      'char',   '',   3, '', '',
1280         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
1281       ],
1282       'primary_key' => 'popnum',
1283       'unique' => [],
1284       'index' => [ [ 'state' ] ],
1285     },
1286
1287     'part_pop_local' => {
1288       'columns' => [
1289         'localnum',  'serial',     '',     '', '', '',
1290         'popnum',    'int',     '',     '', '', '',
1291         'city',      'varchar', 'NULL', $char_d, '', '',
1292         'state',     'char',    'NULL', 2, '', '',
1293         'npa',       'char',    '',     3, '', '',
1294         'nxx',       'char',    '',     3, '', '',
1295       ],
1296       'primary_key' => 'localnum',
1297       'unique' => [],
1298       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1299     },
1300
1301     'svc_acct' => {
1302       'columns' => [
1303         'svcnum',    'int',    '',   '', '', '',
1304         'username',  'varchar',   '',   $username_len, '', '',
1305         '_password', 'varchar',   '',  512, '', '',
1306         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1307         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
1308         'popnum',    'int',    'NULL',   '', '', '',
1309         'uid',       'int', 'NULL',   '', '', '',
1310         'gid',       'int', 'NULL',   '', '', '',
1311         'finger',    'varchar',   'NULL',   $char_d, '', '',
1312         'dir',       'varchar',   'NULL',   $char_d, '', '',
1313         'shell',     'varchar',   'NULL',   $char_d, '', '',
1314         'quota',     'varchar',   'NULL',   $char_d, '', '',
1315         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
1316         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
1317         'seconds_threshold',   'int', 'NULL',   '', '', '',
1318         'upbytes',   'bigint', 'NULL',   '', '', '',
1319         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
1320         'downbytes', 'bigint', 'NULL',   '', '', '',
1321         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
1322         'totalbytes','bigint', 'NULL',   '', '', '',
1323         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
1324         'domsvc',    'int', '',   '', '', '',
1325         'last_login',  @date_type, '', '',
1326         'last_logout', @date_type, '', '',
1327       ],
1328       'primary_key' => 'svcnum',
1329       #'unique' => [ [ 'username', 'domsvc' ] ],
1330       'unique' => [],
1331       'index' => [ ['username'], ['domsvc'] ],
1332     },
1333
1334     'acct_rt_transaction' => {
1335       'columns' => [
1336         'svcrtid',   'int',    '',   '', '', '',
1337         'svcnum',    'int',    '',   '', '', '',
1338         'transaction_id',       'int', '',   '', '', '',
1339         '_date',   @date_type, '', '',
1340         'seconds',   'int', '',   '', '', '', #uhhhh
1341         'support',   'int', '',   '', '', '',
1342       ],
1343       'primary_key' => 'svcrtid',
1344       'unique' => [],
1345       'index' => [ ['svcnum', 'transaction_id'] ],
1346     },
1347
1348     #'svc_charge' => {
1349     #  'columns' => [
1350     #    'svcnum',    'int',    '',   '',
1351     #    'amount',    @money_type,
1352     #  ],
1353     #  'primary_key' => 'svcnum',
1354     #  'unique' => [ [] ],
1355     #  'index' => [ [] ],
1356     #},
1357
1358     'svc_domain' => {
1359       'columns' => [
1360         'svcnum',           'int',    '',        '', '', '',
1361         'domain',       'varchar',    '',   $char_d, '', '',
1362         'suffix',       'varchar', 'NULL',  $char_d, '', '',
1363         'catchall',         'int', 'NULL',       '', '', '',
1364         'parent_svcnum',    'int', 'NULL',       '', '', '',
1365         'registrarnum',     'int', 'NULL',       '', '', '',
1366         'registrarkey', 'varchar', 'NULL',      512, '', '',
1367         'setup_date',  @date_type, '', '',
1368         'renewal_interval', 'int', 'NULL',       '', '', '',
1369         'expiration_date', @date_type, '', '',
1370       ],
1371       'primary_key' => 'svcnum',
1372       'unique' => [ ],
1373       'index' => [ ['domain'] ],
1374     },
1375
1376     'domain_record' => {
1377       'columns' => [
1378         'recnum',    'serial',     '',  '', '', '',
1379         'svcnum',    'int',     '',  '', '', '',
1380         'reczone',   'varchar', '',  255, '', '',
1381         'recaf',     'char',    '',  2, '', '',
1382         'rectype',   'varchar',    '',  5, '', '',
1383         'recdata',   'varchar', '',  255, '', '',
1384       ],
1385       'primary_key' => 'recnum',
1386       'unique'      => [],
1387       'index'       => [ ['svcnum'] ],
1388     },
1389
1390     'registrar' => {
1391       'columns' => [
1392         'registrarnum',   'serial', '',      '', '', '',
1393         'registrarname', 'varchar', '', $char_d, '', '',
1394       ],
1395       'primary_key' => 'registrarnum',
1396       'unique'      => [],
1397       'index'       => [],
1398     },
1399
1400     'svc_forward' => {
1401       'columns' => [
1402         'svcnum',   'int',            '',   '', '', '',
1403         'srcsvc',   'int',        'NULL',   '', '', '',
1404         'src',      'varchar',    'NULL',  255, '', '',
1405         'dstsvc',   'int',        'NULL',   '', '', '',
1406         'dst',      'varchar',    'NULL',  255, '', '',
1407       ],
1408       'primary_key' => 'svcnum',
1409       'unique'      => [],
1410       'index'       => [ ['srcsvc'], ['dstsvc'] ],
1411     },
1412
1413     'svc_www' => {
1414       'columns' => [
1415         'svcnum',   'int',      '',  '', '', '',
1416         'recnum',   'int',      '',  '', '', '',
1417         'usersvc',  'int',  'NULL',  '', '', '',
1418         'config',   'text', 'NULL',  '', '', '',
1419       ],
1420       'primary_key' => 'svcnum',
1421       'unique'      => [],
1422       'index'       => [],
1423     },
1424
1425     #'svc_wo' => {
1426     #  'columns' => [
1427     #    'svcnum',    'int',    '',   '',
1428     #    'svcnum',    'int',    '',   '',
1429     #    'svcnum',    'int',    '',   '',
1430     #    'worker',    'varchar',   '',   $char_d,
1431     #    '_date',     @date_type,
1432     #  ],
1433     #  'primary_key' => 'svcnum',
1434     #  'unique' => [ [] ],
1435     #  'index' => [ [] ],
1436     #},
1437
1438     'prepay_credit' => {
1439       'columns' => [
1440         'prepaynum',   'serial',     '',   '', '', '',
1441         'identifier',  'varchar', '', $char_d, '', '',
1442         'amount',      @money_type, '', '',
1443         'seconds',     'int',     'NULL', '', '', '',
1444         'upbytes',     'bigint',     'NULL', '', '', '',
1445         'downbytes',   'bigint',     'NULL', '', '', '',
1446         'totalbytes',  'bigint',     'NULL', '', '', '',
1447         'agentnum',    'int',     'NULL', '', '', '',
1448       ],
1449       'primary_key' => 'prepaynum',
1450       'unique'      => [ ['identifier'] ],
1451       'index'       => [],
1452     },
1453
1454     'port' => {
1455       'columns' => [
1456         'portnum',  'serial',     '',   '', '', '',
1457         'ip',       'varchar', 'NULL', 15, '', '',
1458         'nasport',  'int',     'NULL', '', '', '',
1459         'nasnum',   'int',     '',   '', '', '',
1460       ],
1461       'primary_key' => 'portnum',
1462       'unique'      => [],
1463       'index'       => [],
1464     },
1465
1466     'nas' => {
1467       'columns' => [
1468         'nasnum',   'serial',     '',    '', '', '',
1469         'nas',      'varchar', '',    $char_d, '', '',
1470         'nasip',    'varchar', '',    15, '', '',
1471         'nasfqdn',  'varchar', '',    $char_d, '', '',
1472         'last',     'int',     '',    '', '', '',
1473       ],
1474       'primary_key' => 'nasnum',
1475       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
1476       'index'       => [ [ 'last' ] ],
1477     },
1478
1479 #    'session' => {
1480 #      'columns' => [
1481 #        'sessionnum', 'serial',       '',   '', '', '',
1482 #        'portnum',    'int',       '',   '', '', '',
1483 #        'svcnum',     'int',       '',   '', '', '',
1484 #        'login',      @date_type, '', '',
1485 #        'logout',     @date_type, '', '',
1486 #      ],
1487 #      'primary_key' => 'sessionnum',
1488 #      'unique'      => [],
1489 #      'index'       => [ [ 'portnum' ] ],
1490 #    },
1491
1492     'queue' => {
1493       'columns' => [
1494         'jobnum',      'serial',     '',      '', '', '',
1495         'job',           'text',     '',      '', '', '',
1496         '_date',          'int',     '',      '', '', '',
1497         'status',     'varchar',     '', $char_d, '', '',
1498         'statustext',    'text', 'NULL',      '', '', '',
1499         'svcnum',         'int', 'NULL',      '', '', '',
1500         'custnum',        'int', 'NULL',      '', '', '',
1501         'secure',        'char', 'NULL',       1, '', '',
1502       ],
1503       'primary_key' => 'jobnum',
1504       'unique'      => [],
1505       'index'       => [ [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ] ],
1506     },
1507
1508     'queue_arg' => {
1509       'columns' => [
1510         'argnum', 'serial', '', '', '', '',
1511         'jobnum', 'int', '', '', '', '',
1512         'arg', 'text', 'NULL', '', '', '',
1513       ],
1514       'primary_key' => 'argnum',
1515       'unique'      => [],
1516       'index'       => [ [ 'jobnum' ] ],
1517     },
1518
1519     'queue_depend' => {
1520       'columns' => [
1521         'dependnum', 'serial', '', '', '', '',
1522         'jobnum', 'int', '', '', '', '',
1523         'depend_jobnum', 'int', '', '', '', '',
1524       ],
1525       'primary_key' => 'dependnum',
1526       'unique'      => [],
1527       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1528     },
1529
1530     'export_svc' => {
1531       'columns' => [
1532         'exportsvcnum' => 'serial', '', '', '', '',
1533         'exportnum'    => 'int', '', '', '', '',
1534         'svcpart'      => 'int', '', '', '', '',
1535       ],
1536       'primary_key' => 'exportsvcnum',
1537       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
1538       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
1539     },
1540
1541     'part_export' => {
1542       'columns' => [
1543         'exportnum', 'serial', '', '', '', '',
1544         'machine', 'varchar', '', $char_d, '', '',
1545         'exporttype', 'varchar', '', $char_d, '', '',
1546         'nodomain',     'char', 'NULL', 1, '', '',
1547       ],
1548       'primary_key' => 'exportnum',
1549       'unique'      => [],
1550       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
1551     },
1552
1553     'part_export_option' => {
1554       'columns' => [
1555         'optionnum', 'serial', '', '', '', '',
1556         'exportnum', 'int', '', '', '', '',
1557         'optionname', 'varchar', '', $char_d, '', '',
1558         'optionvalue', 'text', 'NULL', '', '', '',
1559       ],
1560       'primary_key' => 'optionnum',
1561       'unique'      => [],
1562       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
1563     },
1564
1565     'radius_usergroup' => {
1566       'columns' => [
1567         'usergroupnum', 'serial', '', '', '', '',
1568         'svcnum',       'int', '', '', '', '',
1569         'groupname',    'varchar', '', $char_d, '', '',
1570       ],
1571       'primary_key' => 'usergroupnum',
1572       'unique'      => [],
1573       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
1574     },
1575
1576     'msgcat' => {
1577       'columns' => [
1578         'msgnum', 'serial', '', '', '', '',
1579         'msgcode', 'varchar', '', $char_d, '', '',
1580         'locale', 'varchar', '', 16, '', '',
1581         'msg', 'text', '', '', '', '',
1582       ],
1583       'primary_key' => 'msgnum',
1584       'unique'      => [ [ 'msgcode', 'locale' ] ],
1585       'index'       => [],
1586     },
1587
1588     'cust_tax_exempt' => {
1589       'columns' => [
1590         'exemptnum', 'serial', '', '', '', '',
1591         'custnum',   'int', '', '', '', '',
1592         'taxnum',    'int', '', '', '', '',
1593         'year',      'int', '', '', '', '',
1594         'month',     'int', '', '', '', '',
1595         'amount',   @money_type, '', '',
1596       ],
1597       'primary_key' => 'exemptnum',
1598       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1599       'index'       => [],
1600     },
1601
1602     'cust_tax_exempt_pkg' => {
1603       'columns' => [
1604         'exemptpkgnum',  'serial', '', '', '', '',
1605         #'custnum',      'int', '', '', '', ''
1606         'billpkgnum',   'int', '', '', '', '',
1607         'taxnum',       'int', '', '', '', '',
1608         'year',         'int', '', '', '', '',
1609         'month',        'int', '', '', '', '',
1610         'amount',       @money_type, '', '',
1611       ],
1612       'primary_key' => 'exemptpkgnum',
1613       'unique' => [],
1614       'index'  => [ [ 'taxnum', 'year', 'month' ],
1615                     [ 'billpkgnum' ],
1616                     [ 'taxnum' ]
1617                   ],
1618     },
1619
1620     'router' => {
1621       'columns' => [
1622         'routernum', 'serial', '', '', '', '',
1623         'routername', 'varchar', '', $char_d, '', '',
1624         'svcnum', 'int', 'NULL', '', '', '',
1625         'agentnum',   'int', 'NULL', '', '', '',
1626       ],
1627       'primary_key' => 'routernum',
1628       'unique'      => [],
1629       'index'       => [],
1630     },
1631
1632     'part_svc_router' => {
1633       'columns' => [
1634         'svcrouternum', 'serial', '', '', '', '',
1635         'svcpart', 'int', '', '', '', '',
1636         'routernum', 'int', '', '', '', '',
1637       ],
1638       'primary_key' => 'svcrouternum',
1639       'unique'      => [],
1640       'index'       => [],
1641     },
1642
1643     'addr_block' => {
1644       'columns' => [
1645         'blocknum', 'serial', '', '', '', '',
1646         'routernum', 'int', '', '', '', '',
1647         'ip_gateway', 'varchar', '', 15, '', '',
1648         'ip_netmask', 'int', '', '', '', '',
1649         'agentnum',   'int', 'NULL', '', '', '',
1650         'manual_flag', 'char', 'NULL', 1, '', '',
1651       ],
1652       'primary_key' => 'blocknum',
1653       'unique'      => [ [ 'blocknum', 'routernum' ] ],
1654       'index'       => [],
1655     },
1656
1657     'svc_broadband' => {
1658       'columns' => [
1659         'svcnum', 'int', '', '', '', '',
1660         'description', 'varchar', 'NULL', $char_d, '', '',
1661         'blocknum', 'int', '', '', '', '',
1662         'speed_up', 'int', '', '', '', '',
1663         'speed_down', 'int', '', '', '', '',
1664         'ip_addr', 'varchar', '', 15, '', '',
1665         'mac_addr', 'varchar', 'NULL', 12, '', '',
1666         'authkey',  'varchar', 'NULL', 32, '', '',
1667         'latitude', 'decimal', 'NULL', '', '', '',
1668         'longitude', 'decimal', 'NULL', '', '', '',
1669         'altitude', 'decimal', 'NULL', '', '', '',
1670         'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1671         'performance_profile', 'varchar', 'NULL', $char_d, '', '',
1672       ],
1673       'primary_key' => 'svcnum',
1674       'unique'      => [ [ 'mac_addr' ] ],
1675       'index'       => [],
1676     },
1677
1678     'part_virtual_field' => {
1679       'columns' => [
1680         'vfieldpart', 'serial', '', '', '', '',
1681         'dbtable', 'varchar', '', 32, '', '',
1682         'name', 'varchar', '', 32, '', '',
1683         'check_block', 'text', 'NULL', '', '', '',
1684         'length', 'int', 'NULL', '', '', '',
1685         'list_source', 'text', 'NULL', '', '', '',
1686         'label', 'varchar', 'NULL', 80, '', '',
1687       ],
1688       'primary_key' => 'vfieldpart',
1689       'unique' => [],
1690       'index' => [],
1691     },
1692
1693     'virtual_field' => {
1694       'columns' => [
1695         'vfieldnum', 'serial', '', '', '', '',
1696         'recnum', 'int', '', '', '', '',
1697         'vfieldpart', 'int', '', '', '', '',
1698         'value', 'varchar', '', 128, '', '',
1699       ],
1700       'primary_key' => 'vfieldnum',
1701       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1702       'index' => [],
1703     },
1704
1705     'acct_snarf' => {
1706       'columns' => [
1707         'snarfnum',  'int', '', '', '', '',
1708         'svcnum',    'int', '', '', '', '',
1709         'machine',   'varchar', '', 255, '', '',
1710         'protocol',  'varchar', '', $char_d, '', '',
1711         'username',  'varchar', '', $char_d, '', '',
1712         '_password', 'varchar', '', $char_d, '', '',
1713       ],
1714       'primary_key' => 'snarfnum',
1715       'unique' => [],
1716       'index'  => [ [ 'svcnum' ] ],
1717     },
1718
1719     'svc_external' => {
1720       'columns' => [
1721         'svcnum', 'int', '', '', '', '',
1722         'id',     'int', 'NULL', '', '', '',
1723         'title',  'varchar', 'NULL', $char_d, '', '',
1724       ],
1725       'primary_key' => 'svcnum',
1726       'unique'      => [],
1727       'index'       => [],
1728     },
1729
1730     'cust_pay_refund' => {
1731       'columns' => [
1732         'payrefundnum', 'serial', '', '', '', '',
1733         'paynum',  'int', '', '', '', '',
1734         'refundnum',  'int', '', '', '', '',
1735         '_date',    @date_type, '', '',
1736         'amount',   @money_type, '', '',
1737       ],
1738       'primary_key' => 'payrefundnum',
1739       'unique' => [],
1740       'index' => [ ['paynum'], ['refundnum'] ],
1741     },
1742
1743     'part_pkg_option' => {
1744       'columns' => [
1745         'optionnum', 'serial', '', '', '', '',
1746         'pkgpart', 'int', '', '', '', '',
1747         'optionname', 'varchar', '', $char_d, '', '',
1748         'optionvalue', 'text', 'NULL', '', '', '',
1749       ],
1750       'primary_key' => 'optionnum',
1751       'unique'      => [],
1752       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
1753     },
1754
1755     'rate' => {
1756       'columns' => [
1757         'ratenum',  'serial', '', '', '', '',
1758         'ratename', 'varchar', '', $char_d, '', '',
1759       ],
1760       'primary_key' => 'ratenum',
1761       'unique'      => [],
1762       'index'       => [],
1763     },
1764
1765     'rate_detail' => {
1766       'columns' => [
1767         'ratedetailnum',   'serial', '', '', '', '',
1768         'ratenum',         'int',     '', '', '', '',
1769         'orig_regionnum',  'int', 'NULL', '', '', '',
1770         'dest_regionnum',  'int',     '', '', '', '',
1771         'min_included',    'int',     '', '', '', '',
1772         #'min_charge',      @money_type, '', '',
1773         'min_charge',      'decimal', '', '10,5', '', '',
1774         'sec_granularity', 'int',     '', '', '', '',
1775         #time period (link to table of periods)?
1776         'classnum',        'int',     'NULL', '', '', '',
1777       ],
1778       'primary_key' => 'ratedetailnum',
1779       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1780       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
1781     },
1782
1783     'rate_region' => {
1784       'columns' => [
1785         'regionnum',   'serial',      '', '', '', '',
1786         'regionname',  'varchar',     '', $char_d, '', '',
1787       ],
1788       'primary_key' => 'regionnum',
1789       'unique'      => [],
1790       'index'       => [],
1791     },
1792
1793     'rate_prefix' => {
1794       'columns' => [
1795         'prefixnum',   'serial',      '', '', '', '',
1796         'regionnum',   'int',         '', '', '', '',
1797         'countrycode', 'varchar',     '',  3, '', '',
1798         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
1799         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
1800       ],
1801       'primary_key' => 'prefixnum',
1802       'unique'      => [],
1803       'index'       => [ [ 'countrycode' ], [ 'regionnum' ] ],
1804     },
1805
1806     'usage_class' => {
1807       'columns' => [
1808         'classnum',    'serial',   '',      '', '', '',
1809         'classname',   'varchar',  '', $char_d, '', '',
1810         'disabled',    'char', 'NULL',       1, '', '',
1811       ],
1812       'primary_key' => 'classnum',
1813       'unique' => [],
1814       'index' => [ ['disabled'] ],
1815     },
1816
1817     'reg_code' => {
1818       'columns' => [
1819         'codenum',   'serial',    '', '', '', '',
1820         'code',      'varchar',   '', $char_d, '', '',
1821         'agentnum',  'int',       '', '', '', '',
1822       ],
1823       'primary_key' => 'codenum',
1824       'unique'      => [ [ 'agentnum', 'code' ] ],
1825       'index'       => [ [ 'agentnum' ] ],
1826     },
1827
1828     'reg_code_pkg' => {
1829       'columns' => [
1830         'codepkgnum', 'serial', '', '', '', '',
1831         'codenum',   'int',    '', '', '', '',
1832         'pkgpart',   'int',    '', '', '', '',
1833       ],
1834       'primary_key' => 'codepkgnum',
1835       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
1836       'index'       => [ [ 'codenum' ] ],
1837     },
1838
1839     'clientapi_session' => {
1840       'columns' => [
1841         'sessionnum',  'serial',  '', '', '', '',
1842         'sessionid',  'varchar',  '', $char_d, '', '',
1843         'namespace',  'varchar',  '', $char_d, '', '',
1844       ],
1845       'primary_key' => 'sessionnum',
1846       'unique'      => [ [ 'sessionid', 'namespace' ] ],
1847       'index'       => [],
1848     },
1849
1850     'clientapi_session_field' => {
1851       'columns' => [
1852         'fieldnum',    'serial',     '', '', '', '',
1853         'sessionnum',     'int',     '', '', '', '',
1854         'fieldname',  'varchar',     '', $char_d, '', '',
1855         'fieldvalue',    'text', 'NULL', '', '', '',
1856       ],
1857       'primary_key' => 'fieldnum',
1858       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
1859       'index'       => [],
1860     },
1861
1862     'payment_gateway' => {
1863       'columns' => [
1864         'gatewaynum',       'serial',   '',     '', '', '',
1865         'gateway_namespace','varchar',  'NULL', $char_d, '', '',
1866         'gateway_module',   'varchar',  '',     $char_d, '', '',
1867         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
1868         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
1869         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
1870         'gateway_callback_url', 'varchar',  'NULL', $char_d, '', '',
1871         'disabled',   'char',  'NULL',   1, '', '',
1872       ],
1873       'primary_key' => 'gatewaynum',
1874       'unique' => [],
1875       'index'  => [ [ 'disabled' ] ],
1876     },
1877
1878     'payment_gateway_option' => {
1879       'columns' => [
1880         'optionnum',   'serial',  '',     '', '', '',
1881         'gatewaynum',  'int',     '',     '', '', '',
1882         'optionname',  'varchar', '',     $char_d, '', '',
1883         'optionvalue', 'text',    'NULL', '', '', '',
1884       ],
1885       'primary_key' => 'optionnum',
1886       'unique'      => [],
1887       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1888     },
1889
1890     'agent_payment_gateway' => {
1891       'columns' => [
1892         'agentgatewaynum', 'serial', '', '', '', '',
1893         'agentnum',        'int', '', '', '', '',
1894         'gatewaynum',      'int', '', '', '', '',
1895         'cardtype',        'varchar', 'NULL', $char_d, '', '',
1896         'taxclass',        'varchar', 'NULL', $char_d, '', '',
1897       ],
1898       'primary_key' => 'agentgatewaynum',
1899       'unique'      => [],
1900       'index'       => [ [ 'agentnum', 'cardtype' ], ],
1901     },
1902
1903     'banned_pay' => {
1904       'columns' => [
1905         'bannum',  'serial',   '',     '', '', '',
1906         'payby',   'char',     '',       4, '', '',
1907         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
1908         #'paymask', 'varchar',  'NULL', $char_d, '', ''
1909         '_date',   @date_type, '', '',
1910         'otaker',  'varchar',  '',     32, '', '',
1911         'reason',  'varchar',  'NULL', $char_d, '', '',
1912       ],
1913       'primary_key' => 'bannum',
1914       'unique'      => [ [ 'payby', 'payinfo' ] ],
1915       'index'       => [],
1916     },
1917
1918     'pkg_category' => {
1919       'columns' => [
1920         'categorynum',   'serial',  '', '', '', '',
1921         'categoryname',  'varchar', '', $char_d, '', '',
1922         'disabled',      'char', 'NULL',   1, '', '',
1923       ],
1924       'primary_key' => 'categorynum',
1925       'unique' => [],
1926       'index' => [ ['disabled'] ],
1927     },
1928
1929     'pkg_class' => {
1930       'columns' => [
1931         'classnum',    'serial',   '',      '', '', '',
1932         'classname',   'varchar',  '', $char_d, '', '',
1933         'categorynum', 'int',  'NULL',      '', '', '',
1934         'disabled',    'char', 'NULL',       1, '', '',
1935       ],
1936       'primary_key' => 'classnum',
1937       'unique' => [],
1938       'index' => [ ['disabled'] ],
1939     },
1940
1941     'cdr' => {
1942       'columns' => [
1943         # qw( name type null length default local );
1944
1945         ###
1946         #asterisk fields
1947         ###
1948
1949         'acctid',   'bigserial',  '', '', '', '',
1950         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1951         'calldate', 'timestamp',   '',      '', \'now()', '',
1952         'clid',        'varchar',  '', $char_d, \"''", '',
1953         'src',         'varchar',  '', $char_d, \"''", '',
1954         'dst',         'varchar',  '', $char_d, \"''", '',
1955         'dcontext',    'varchar',  '', $char_d, \"''", '',
1956         'channel',     'varchar',  '', $char_d, \"''", '',
1957         'dstchannel',  'varchar',  '', $char_d, \"''", '',
1958         'lastapp',     'varchar',  '', $char_d, \"''", '',
1959         'lastdata',    'varchar',  '', $char_d, \"''", '',
1960
1961         #these don't seem to be logged by most of the SQL cdr_* modules
1962         #except tds under sql-illegal names, so;
1963         # ... don't rely on them for rating?
1964         # and, what they hey, i went ahead and changed the names and data types
1965         # to freeside-style dates...
1966           #'start',  'timestamp', 'NULL',  '',    '', '',
1967           #'answer', 'timestamp', 'NULL',  '',    '', '',
1968           #'end',    'timestamp', 'NULL',  '',    '', '',
1969         'startdate',  @date_type, '', '',
1970         'answerdate', @date_type, '', '',
1971         'enddate',    @date_type, '', '',
1972         #
1973
1974         'duration',    'int',      '',      '',     0, '',
1975         'billsec',     'int',      '',      '',     0, '',
1976         'disposition', 'varchar',  '',      45, \"''", '',
1977         'amaflags',    'int',      '',      '',     0, '',
1978         'accountcode', 'varchar',  '',      20, \"''", '',
1979         'uniqueid',    'varchar',  '',      32, \"''", '',
1980         'userfield',   'varchar',  '',     255, \"''", '',
1981
1982         ###
1983         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1984         # defaults
1985         ###
1986
1987         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1988         'cdrtypenum',              'int', 'NULL',      '', '', '',
1989
1990         'charged_party',       'varchar', 'NULL', $char_d, '', '',
1991
1992         'upstream_currency',      'char', 'NULL',       3, '', '',
1993         'upstream_price',      'decimal', 'NULL',  '10,2', '', '',
1994         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
1995
1996         # how it was rated internally...
1997         'ratedetailnum',           'int', 'NULL',      '', '', '',
1998         'rated_price',         'decimal', 'NULL',  '10,2', '', '',
1999
2000         'distance',            'decimal', 'NULL',      '', '', '',
2001         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
2002
2003         #cdr_calltype: the big list in appendix 2
2004         'calltypenum',             'int', 'NULL',      '', '', '',
2005
2006         'description',         'varchar', 'NULL', $char_d, '', '',
2007         'quantity',                'int', 'NULL',      '', '', '',
2008
2009         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
2010         'carrierid',               'int', 'NULL',      '', '', '',
2011
2012         'upstream_rateid',         'int', 'NULL',      '', '', '',
2013
2014         ###
2015         #and now for our own fields
2016         ###
2017
2018         # a svcnum... right..?
2019         'svcnum',             'int',   'NULL',     '',   '', '',
2020
2021         #NULL, done (or something)
2022         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
2023
2024         #NULL, done (or something)
2025         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '',
2026
2027         'cdrbatch', 'varchar', 'NULL', $char_d, '', '',
2028
2029       ],
2030       'primary_key' => 'acctid',
2031       'unique' => [],
2032       'index' => [ [ 'calldate' ], [ 'src' ], [ 'dst' ], [ 'charged_party' ], [ 'accountcode' ], [ 'freesidestatus' ], [ 'freesiderewritestatus' ], [ 'cdrbatch' ], ],
2033     },
2034
2035     'cdr_calltype' => {
2036       'columns' => [
2037         'calltypenum',   'serial',  '', '', '', '',
2038         'calltypename',  'varchar', '', $char_d, '', '',
2039       ],
2040       'primary_key' => 'calltypenum',
2041       'unique'      => [],
2042       'index'       => [],
2043     },
2044
2045     'cdr_type' => {
2046       'columns' => [
2047         'cdrtypenum'  => 'serial',  '', '', '', '',
2048         'cdrtypename' => 'varchar', '', $char_d, '', '',
2049       ],
2050       'primary_key' => 'cdrtypenum',
2051       'unique'      => [],
2052       'index'       => [],
2053     },
2054
2055     'cdr_carrier' => {
2056       'columns' => [
2057         'carrierid'   => 'serial',  '', '', '', '',
2058         'carriername' => 'varchar', '', $char_d, '', '',
2059       ],
2060       'primary_key' => 'carrierid',
2061       'unique'      => [],
2062       'index'       => [],
2063     },
2064
2065     #map upstream rateid to ours...
2066     'cdr_upstream_rate' => {
2067       'columns' => [
2068         'upstreamratenum', 'serial',  '', '', '', '',
2069         'upstream_rateid', 'varchar', '', $char_d, '', '',
2070         'ratedetailnum',   'int', 'NULL', '', '', '',
2071       ],
2072       'primary_key' => 'upstreamratenum', #XXX need a primary key
2073       'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
2074       'index'  => [],
2075     },
2076
2077     #'cdr_file' => {
2078     #  'columns' => [
2079     #    'filenum',    'serial',     '', '', '', '',
2080     #    'filename',  'varchar',     '', '', '', '',
2081     #    'status',    'varchar', 'NULL', '', '', '',
2082     #  ],
2083     #  'primary_key' => 'filenum',
2084     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
2085     #                                   # agent-virtualize or have a customer
2086     #                                   # with dup-filename needs or something
2087     #                                   # (only used by cdr.http_and_import for
2088     #                                   #  chrissakes)
2089     #  'index'  => [],
2090     #},
2091
2092     'inventory_item' => {
2093       'columns' => [
2094         'itemnum',  'serial',      '',      '', '', '',
2095         'classnum', 'int',         '',      '', '', '',
2096         'item',     'varchar',     '', $char_d, '', '',
2097         'svcnum',   'int',     'NULL',      '', '', '',
2098       ],
2099       'primary_key' => 'itemnum',
2100       'unique' => [ [ 'classnum', 'item' ] ],
2101       'index'  => [ [ 'classnum' ], [ 'svcnum' ] ],
2102     },
2103
2104     'inventory_class' => {
2105       'columns' => [
2106         'classnum',  'serial',       '',      '', '', '',
2107         'classname', 'varchar',      '', $char_d, '', '',
2108       ],
2109       'primary_key' => 'classnum',
2110       'unique' => [],
2111       'index'  => [],
2112     },
2113
2114     'access_user' => {
2115       'columns' => [
2116         'usernum',   'serial',  '',      '', '', '',
2117         'username',  'varchar', '', $char_d, '', '',
2118         '_password', 'varchar', '', $char_d, '', '',
2119         'last',      'varchar', '', $char_d, '', '',
2120         'first',     'varchar', '', $char_d, '', '',
2121         'disabled',     'char', 'NULL',   1, '', '',
2122       ],
2123       'primary_key' => 'usernum',
2124       'unique' => [ [ 'username' ] ],
2125       'index'  => [],
2126     },
2127
2128     'access_user_pref' => {
2129       'columns' => [
2130         'prefnum',    'serial',       '', '', '', '',
2131         'usernum',     'int',       '', '', '', '',
2132         'prefname', 'varchar', '', $char_d, '', '',
2133         'prefvalue', 'text', 'NULL', '', '', '',
2134         'expiration', @date_type, '', '',
2135       ],
2136       'primary_key' => 'prefnum',
2137       'unique' => [],
2138       'index'  => [ [ 'usernum' ] ],
2139     },
2140
2141     'access_group' => {
2142       'columns' => [
2143         'groupnum',   'serial', '',      '', '', '',
2144         'groupname', 'varchar', '', $char_d, '', '',
2145       ],
2146       'primary_key' => 'groupnum',
2147       'unique' => [ [ 'groupname' ] ],
2148       'index'  => [],
2149     },
2150
2151     'access_usergroup' => {
2152       'columns' => [
2153         'usergroupnum', 'serial', '', '', '', '',
2154         'usernum',         'int', '', '', '', '',
2155         'groupnum',        'int', '', '', '', '',
2156       ],
2157       'primary_key' => 'usergroupnum',
2158       'unique' => [ [ 'usernum', 'groupnum' ] ],
2159       'index'  => [ [ 'usernum' ] ],
2160     },
2161
2162     'access_groupagent' => {
2163       'columns' => [
2164         'groupagentnum', 'serial', '', '', '', '',
2165         'groupnum',         'int', '', '', '', '',
2166         'agentnum',         'int', '', '', '', '',
2167       ],
2168       'primary_key' => 'groupagentnum',
2169       'unique' => [ [ 'groupnum', 'agentnum' ] ],
2170       'index'  => [ [ 'groupnum' ] ],
2171     },
2172
2173     'access_right' => {
2174       'columns' => [
2175         'rightnum',   'serial', '',      '', '', '',
2176         'righttype', 'varchar', '', $char_d, '', '',
2177         'rightobjnum',   'int', '',      '', '', '',
2178         'rightname', 'varchar', '', $char_d, '', '',
2179       ],
2180       'primary_key' => 'rightnum',
2181       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2182       'index'  => [],
2183     },
2184
2185     'svc_phone' => {
2186       'columns' => [
2187         'svcnum',       'int',         '',      '', '', '',
2188         'countrycode',  'varchar',     '',       3, '', '',
2189         'phonenum',     'varchar',     '',      15, '', '',  #12 ?
2190         'pin',          'varchar', 'NULL', $char_d, '', '',
2191         'sip_password', 'varchar', 'NULL', $char_d, '', '',
2192         'phone_name',   'varchar', 'NULL', $char_d, '', '',
2193       ],
2194       'primary_key' => 'svcnum',
2195       'unique' => [],
2196       'index'  => [ [ 'countrycode', 'phonenum' ] ],
2197     },
2198
2199     'phone_avail' => {
2200       'columns' => [
2201         'availnum',    'serial',      '',      '', '', '',
2202         'exportnum',   'int',         '',      '', '', '',
2203         'countrycode', 'varchar',     '',       3, '', '',
2204         'state',       'char',    'NULL',       2, '', '',
2205         'npa',         'char',        '',       3, '', '',
2206         'nxx',         'char',    'NULL',       3, '', '',
2207         'station',     'char',    'NULL',       4, '', '',
2208         'name',        'varchar', 'NULL', $char_d, '', '',
2209         'svcnum',      'int',     'NULL',      '', '', '',
2210         'availbatch', 'varchar',  'NULL', $char_d, '', '',
2211       ],
2212       'primary_key' => 'availnum',
2213       'unique' => [],
2214       'index'  => [ [ 'exportnum', 'countrycode', 'state' ],     #npa search
2215                     [ 'exportnum', 'countrycode', 'npa' ],       #nxx search
2216                     [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
2217                     [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
2218                     [ 'svcnum' ],
2219                     [ 'availbatch' ],
2220                   ],
2221     },
2222
2223     'reason_type' => {
2224       'columns' => [
2225         'typenum',   'serial',  '', '', '', '',
2226         'class',     'char', '', 1, '', '',
2227         'type',     'varchar', '', $char_d, '', '',
2228       ],
2229       'primary_key' => 'typenum',
2230       'unique' => [],
2231       'index' => [],
2232     },
2233
2234     'reason' => {
2235       'columns' => [
2236         'reasonnum',     'serial',  '', '', '', '',
2237         'reason_type',   'int',  '', '', '', '',
2238         'reason',        'text', '', '', '', '',
2239         'disabled',      'char',    'NULL', 1, '', '',
2240       ],
2241       'primary_key' => 'reasonnum',
2242       'unique' => [],
2243       'index' => [],
2244     },
2245
2246     'conf' => {
2247       'columns' => [
2248         'confnum',  'serial',  '', '', '', '',
2249         'agentnum', 'int',  'NULL', '', '', '',
2250         'name',     'varchar', '', $char_d, '', '',
2251         'value',    'text', 'NULL', '', '', '',
2252       ],
2253       'primary_key' => 'confnum',
2254       'unique' => [ [ 'agentnum', 'name' ]],
2255       'index' => [],
2256     },
2257
2258     'pkg_referral' => {
2259       'columns' => [
2260         'pkgrefnum',     'serial', '', '', '', '',
2261         'pkgnum',        'int',    '', '', '', '',
2262         'refnum',        'int',    '', '', '', '',
2263       ],
2264       'primary_key' => 'pkgrefnum',
2265       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
2266       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
2267     },
2268     # name type nullability length default local
2269
2270     #'new_table' => {
2271     #  'columns' => [
2272     #    'num', 'serial',       '', '', '', '',
2273     #  ],
2274     #  'primary_key' => 'num',
2275     #  'unique' => [],
2276     #  'index'  => [],
2277     #},
2278
2279   };
2280
2281 }
2282
2283 =back
2284
2285 =head1 BUGS
2286
2287 =head1 SEE ALSO
2288
2289 L<DBIx::DBSchema>
2290
2291 =cut
2292
2293 1;
2294