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