FS/FS/Schema.pm

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