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