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