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