FS/FS/Schema.pm

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