FS/FS/Schema.pm

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