FS/FS/Schema.pm

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