FS/FS/Schema.pm

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