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