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