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