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_pkg_discount' => {
1313       'columns' => [
1314         'pkgdiscountnum', 'serial', '',     '', '', '',
1315         'pkgnum',            'int', '',     '', '', '',
1316         'discountnum',       'int', '',     '', '', '',
1317         'months_used',   'decimal', 'NULL', '', '', '',
1318         'end_date',     @date_type,             '', '',
1319         'otaker',        'varchar', '',     32, '', '',
1320         'disabled',         'char', 'NULL',  1, '', '',
1321       ],
1322       'primary_key' => 'pkgdiscountnum',
1323       'unique' => [],
1324       'index'  => [ [ 'pkgnum' ], [ 'discountnum' ] ],
1325     },
1326
1327     'cust_bill_pkg_discount' => {
1328       'columns' => [
1329         'billpkgdiscountnum', 'serial',     '', '', '', '',
1330         'billpkgnum',            'int',     '', '', '', '',
1331         'pkgdiscountnum',        'int',     '', '', '', '',
1332         'amount',          @money_type,             '', '',
1333         'months',            'decimal', 'NULL', '', '', '',
1334       ],
1335       'primary_key' => 'billpkgdiscountnum',
1336       'unique' => [],
1337       'index' => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
1338     },
1339
1340     'discount' => {
1341       'columns' => [
1342         'discountnum', 'serial',     '',      '', '', '',
1343         #'agentnum',       'int', 'NULL',      '', '', '',
1344         'name',       'varchar', 'NULL', $char_d, '', '',
1345         'amount',   @money_type,                  '', '',
1346         'percent',    'decimal',     '',      '', '', '',
1347         'months',     'decimal', 'NULL',      '', '', '',
1348         'disabled',      'char', 'NULL',       1, '', '',
1349       ],
1350       'primary_key' => 'discountnum',
1351       'unique' => [],
1352       'index'  => [], # [ 'agentnum' ], ],
1353     },
1354
1355     'cust_refund' => {
1356       'columns' => [
1357         'refundnum',    'serial',    '',   '', '', '',
1358         'custnum',  'int',    '',   '', '', '',
1359         '_date',        @date_type, '', '',
1360         'refund',       @money_type, '', '',
1361         'otaker',       'varchar',   '',   32, '', '',
1362         'reason',       'varchar',   '',   $char_d, '', '',
1363         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
1364                                                      # be index into payby
1365                                                      # table eventually
1366         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
1367         'paymask', 'varchar', 'NULL', $char_d, '', '',
1368         'paybatch',     'varchar',   'NULL', $char_d, '', '',
1369         'closed',    'char', 'NULL', 1, '', '',
1370       ],
1371       'primary_key' => 'refundnum',
1372       'unique' => [],
1373       'index' => [ ['custnum'], ['_date'] ],
1374     },
1375
1376     'cust_credit_refund' => {
1377       'columns' => [
1378         'creditrefundnum', 'serial',     '',   '', '', '',
1379         'crednum',  'int',     '',   '', '', '',
1380         'refundnum',  'int',     '',   '', '', '',
1381         'amount',  @money_type, '', '',
1382         '_date',   @date_type, '', '',
1383       ],
1384       'primary_key' => 'creditrefundnum',
1385       'unique' => [],
1386       'index' => [ ['crednum'], ['refundnum'] ],
1387     },
1388
1389
1390     'cust_svc' => {
1391       'columns' => [
1392         'svcnum',    'serial',    '',   '', '', '',
1393         'pkgnum',    'int',    'NULL',   '', '', '',
1394         'svcpart',   'int',    '',   '', '', '',
1395         'overlimit', @date_type, '', '',
1396       ],
1397       'primary_key' => 'svcnum',
1398       'unique' => [],
1399       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1400     },
1401
1402     'cust_svc_option' => {
1403       'columns' => [
1404         'optionnum',   'serial', '', '', '', '',
1405         'svcnum',      'int', '', '', '', '',
1406         'optionname',  'varchar', '', $char_d, '', '',
1407         'optionvalue', 'text', 'NULL', '', '', '',
1408       ],
1409       'primary_key' => 'optionnum',
1410       'unique'      => [],
1411       'index'       => [ [ 'svcnum' ], [ 'optionname' ] ],
1412     },
1413
1414     'part_pkg' => {
1415       'columns' => [
1416         'pkgpart',       'serial',    '',   '', '', '',
1417         'pkg',           'varchar',   '',   $char_d, '', '',
1418         'comment',       'varchar',   '',   $char_d, '', '',
1419         'promo_code',    'varchar', 'NULL', $char_d, '', '',
1420         'setup',         @perl_type, '', '',
1421         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
1422         'recur',         @perl_type, '', '',
1423         'setuptax',      'char', 'NULL', 1, '', '',
1424         'recurtax',      'char', 'NULL', 1, '', '',
1425         'plan',          'varchar', 'NULL', $char_d, '', '',
1426         'plandata',      'text', 'NULL', '', '', '',
1427         'disabled',      'char', 'NULL', 1, '', '',
1428         'custom',        'char', 'NULL', 1, '', '',
1429         'taxclass',      'varchar', 'NULL', $char_d, '', '',
1430         'classnum',      'int',     'NULL', '', '', '',
1431         'addon_classnum','int',     'NULL', '', '', '',
1432         'taxproductnum', 'int',     'NULL', '', '', '',
1433         'setup_cost',    @money_typen,          '', '',
1434         'recur_cost',    @money_typen,          '', '',
1435         'pay_weight',    'real',    'NULL', '', '', '',
1436         'credit_weight', 'real',    'NULL', '', '', '',
1437         'agentnum',      'int',     'NULL', '', '', '',
1438
1439       ],
1440       'primary_key' => 'pkgpart',
1441       'unique' => [],
1442       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'classnum' ],
1443                    [ 'agentnum' ],
1444                  ],
1445     },
1446
1447     'part_pkg_link' => {
1448       'columns' => [
1449         'pkglinknum',  'serial',   '',      '', '', '',
1450         'src_pkgpart', 'int',      '',      '', '', '',
1451         'dst_pkgpart', 'int',      '',      '', '', '',
1452         'link_type',   'varchar',  '', $char_d, '', '',
1453         'hidden',      'char', 'NULL',       1, '', '',
1454       ],
1455       'primary_key' => 'pkglinknum',
1456       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type', 'hidden' ] ],
1457       'index'  => [ [ 'src_pkgpart' ] ],
1458     },
1459     # XXX somewhat borked unique: we don't really want a hidden and unhidden
1460     # it turns out we'd prefer to use svc, bill, and invisibill (or something)
1461
1462     'part_pkg_taxclass' => {
1463       'columns' => [
1464         'taxclassnum',  'serial', '',       '', '', '',
1465         'taxclass',     'varchar', '', $char_d, '', '',
1466         'disabled', 'char',   'NULL',         1, '', '',
1467       ],
1468       'primary_key' => 'taxclassnum',
1469       'unique'      => [ [ 'taxclass' ] ],
1470       'index'       => [ [ 'disabled' ] ],
1471     },
1472
1473     'part_pkg_taxproduct' => {
1474       'columns' => [
1475         'taxproductnum', 'serial',      '',        '', '', '',
1476         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
1477         'taxproduct',    'varchar',     '',   $char_d, '', '',
1478         'description',   'varchar',     '', 3*$char_d, '', '',
1479       ],
1480       'primary_key' => 'taxproductnum',
1481       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
1482       'index'       => [],
1483     },
1484
1485     'part_pkg_taxrate' => {
1486       'columns' => [
1487         'pkgtaxratenum', 'serial',  '',     '',      '', '',
1488         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
1489         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
1490         'taxproductnum', 'int',  '',     '',       '', '',
1491         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
1492         'county',           'varchar', 'NULL', $char_d, '', '',
1493         'state',            'varchar', 'NULL', $char_d, '', '',
1494         'local',            'varchar', 'NULL', $char_d, '', '',
1495         'country',          'char',    'NULL', 2,       '', '',
1496         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
1497         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
1498         'taxclassnum',      'int',     'NULL', '',      '', '',
1499         'effdate',          @date_type, '', '',
1500         'taxable',          'char',    'NULL', 1,       '', '',
1501       ],
1502       'primary_key' => 'pkgtaxratenum',
1503       'unique' => [],
1504       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1505     },
1506
1507     'part_pkg_taxoverride' => {
1508       'columns' => [
1509         'taxoverridenum', 'serial', '', '', '', '',
1510         'pkgpart',        'serial', '', '', '', '',
1511         'taxclassnum',    'serial', '', '', '', '',
1512         'usage_class',    'varchar', 'NULL', $char_d, '', '',
1513       ],
1514       'primary_key' => 'taxoverridenum',
1515       'unique' => [],
1516       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1517     },
1518
1519 #    'part_title' => {
1520 #      'columns' => [
1521 #        'titlenum',   'int',    '',   '',
1522 #        'title',      'varchar',   '',   $char_d,
1523 #      ],
1524 #      'primary_key' => 'titlenum',
1525 #      'unique' => [ [] ],
1526 #      'index' => [ [] ],
1527 #    },
1528
1529     'pkg_svc' => {
1530       'columns' => [
1531         'pkgsvcnum',  'serial', '',  '', '', '',
1532         'pkgpart',    'int',    '',   '', '', '',
1533         'svcpart',    'int',    '',   '', '', '',
1534         'quantity',   'int',    '',   '', '', '',
1535         'primary_svc','char', 'NULL',  1, '', '',
1536       ],
1537       'primary_key' => 'pkgsvcnum',
1538       'unique' => [ ['pkgpart', 'svcpart'] ],
1539       'index' => [ ['pkgpart'], ['quantity'] ],
1540     },
1541
1542     'part_referral' => {
1543       'columns' => [
1544         'refnum',   'serial',     '',        '', '', '',
1545         'referral', 'varchar',    '',   $char_d, '', '',
1546         'disabled', 'char',   'NULL',         1, '', '',
1547         'agentnum', 'int',    'NULL',        '', '', '',
1548       ],
1549       'primary_key' => 'refnum',
1550       'unique' => [],
1551       'index' => [ ['disabled'], ['agentnum'], ],
1552     },
1553
1554     'part_svc' => {
1555       'columns' => [
1556         'svcpart',    'serial',    '',   '', '', '',
1557         'svc',        'varchar',   '',   $char_d, '', '',
1558         'svcdb',      'varchar',   '',   $char_d, '', '',
1559         'disabled',   'char',  'NULL',   1, '', '',
1560       ],
1561       'primary_key' => 'svcpart',
1562       'unique' => [],
1563       'index' => [ [ 'disabled' ] ],
1564     },
1565
1566     'part_svc_column' => {
1567       'columns' => [
1568         'columnnum',   'serial',         '', '', '', '',
1569         'svcpart',     'int',         '', '', '', '',
1570         'columnname',  'varchar',     '', 64, '', '',
1571         'columnlabel', 'varchar', 'NULL', $char_d, '', '',
1572         'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1573         'columnflag',  'char',    'NULL', 1, '', '',
1574       ],
1575       'primary_key' => 'columnnum',
1576       'unique' => [ [ 'svcpart', 'columnname' ] ],
1577       'index' => [ [ 'svcpart' ] ],
1578     },
1579
1580     #(this should be renamed to part_pop)
1581     'svc_acct_pop' => {
1582       'columns' => [
1583         'popnum',    'serial',    '',   '', '', '',
1584         'city',      'varchar',   '',   $char_d, '', '',
1585         'state',     'varchar',   '',   $char_d, '', '',
1586         'ac',        'char',   '',   3, '', '',
1587         'exch',      'char',   '',   3, '', '',
1588         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
1589       ],
1590       'primary_key' => 'popnum',
1591       'unique' => [],
1592       'index' => [ [ 'state' ] ],
1593     },
1594
1595     'part_pop_local' => {
1596       'columns' => [
1597         'localnum',  'serial',     '',     '', '', '',
1598         'popnum',    'int',     '',     '', '', '',
1599         'city',      'varchar', 'NULL', $char_d, '', '',
1600         'state',     'char',    'NULL', 2, '', '',
1601         'npa',       'char',    '',     3, '', '',
1602         'nxx',       'char',    '',     3, '', '',
1603       ],
1604       'primary_key' => 'localnum',
1605       'unique' => [],
1606       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1607     },
1608
1609     'svc_acct' => {
1610       'columns' => [
1611         'svcnum',    'int',    '',   '', '', '',
1612         'username',  'varchar',   '',   $username_len, '', '',
1613         '_password', 'varchar',   'NULL',  512, '', '',
1614         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1615         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
1616         'popnum',    'int',    'NULL',   '', '', '',
1617         'uid',       'int', 'NULL',   '', '', '',
1618         'gid',       'int', 'NULL',   '', '', '',
1619         'finger',    'varchar',   'NULL',   $char_d, '', '',
1620         'dir',       'varchar',   'NULL',   $char_d, '', '',
1621         'shell',     'varchar',   'NULL',   $char_d, '', '',
1622         'quota',     'varchar',   'NULL',   $char_d, '', '',
1623         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
1624         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
1625         'seconds_threshold',   'int', 'NULL',   '', '', '',
1626         'upbytes',   'bigint', 'NULL',   '', '', '',
1627         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
1628         'downbytes', 'bigint', 'NULL',   '', '', '',
1629         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
1630         'totalbytes','bigint', 'NULL',   '', '', '',
1631         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
1632         'domsvc',    'int',     '', '', '', '',
1633         'pbxsvc',    'int', 'NULL', '', '', '',
1634         'last_login',  @date_type, '', '',
1635         'last_logout', @date_type, '', '',
1636         #communigate pro fields (quota = MaxAccountSize)
1637         'file_quota',      'varchar', 'NULL', $char_d, '', '', #MaxWebSize
1638         'file_maxnum',     'varchar', 'NULL', $char_d, '', '', #MaxWebFiles
1639         'file_maxsize',    'varchar', 'NULL', $char_d, '', '', #MaxFileSize
1640         'cgp_accessmodes', 'varchar', 'NULL',     255, '', '', #AccessModes
1641         'password_selfchange','char', 'NULL',       1, '', '',
1642         'password_recover',   'char', 'NULL',       1, '', '',
1643         'cgp_type',        'varchar', 'NULL', $char_d, '', '', #AccountType
1644         'cgp_aliases',     'varchar', 'NULL',     255, '', '',
1645         'cgp_deletemode',  'varchar', 'NULL', $char_d, '', '', #DeleteMode
1646         'cgp_emptytrash',  'varchar', 'NULL', $char_d, '', '', #EmptyTrash
1647       ],
1648       'primary_key' => 'svcnum',
1649       #'unique' => [ [ 'username', 'domsvc' ] ],
1650       'unique' => [],
1651       'index' => [ ['username'], ['domsvc'], ['pbxsvc'] ],
1652     },
1653
1654     'acct_rt_transaction' => {
1655       'columns' => [
1656         'svcrtid',   'int',    '',   '', '', '',
1657         'svcnum',    'int',    '',   '', '', '',
1658         'transaction_id',       'int', '',   '', '', '',
1659         '_date',   @date_type, '', '',
1660         'seconds',   'int', '',   '', '', '', #uhhhh
1661         'support',   'int', '',   '', '', '',
1662       ],
1663       'primary_key' => 'svcrtid',
1664       'unique' => [],
1665       'index' => [ ['svcnum', 'transaction_id'] ],
1666     },
1667
1668     #'svc_charge' => {
1669     #  'columns' => [
1670     #    'svcnum',    'int',    '',   '',
1671     #    'amount',    @money_type,
1672     #  ],
1673     #  'primary_key' => 'svcnum',
1674     #  'unique' => [ [] ],
1675     #  'index' => [ [] ],
1676     #},
1677
1678     'svc_domain' => {
1679       'columns' => [
1680         'svcnum',           'int',    '',        '', '', '',
1681         'domain',       'varchar',    '',   $char_d, '', '',
1682         'suffix',       'varchar', 'NULL',  $char_d, '', '',
1683         'catchall',         'int', 'NULL',       '', '', '',
1684         'parent_svcnum',    'int', 'NULL',       '', '', '',
1685         'registrarnum',     'int', 'NULL',       '', '', '',
1686         'registrarkey', 'varchar', 'NULL',      512, '', '',
1687         'setup_date',      @date_type, '', '',
1688         'renewal_interval', 'int', 'NULL',       '', '', '',
1689         'expiration_date', @date_type, '', '',
1690         'max_accounts',     'int', 'NULL',       '', '', '',
1691       ],
1692       'primary_key' => 'svcnum',
1693       'unique' => [ ],
1694       'index' => [ ['domain'] ],
1695     },
1696
1697     'domain_record' => {
1698       'columns' => [
1699         'recnum',    'serial',     '',  '', '', '',
1700         'svcnum',    'int',     '',  '', '', '',
1701         'reczone',   'varchar', '',  255, '', '',
1702         'recaf',     'char',    '',  2, '', '',
1703         'rectype',   'varchar',    '',  5, '', '',
1704         'recdata',   'varchar', '',  255, '', '',
1705       ],
1706       'primary_key' => 'recnum',
1707       'unique'      => [],
1708       'index'       => [ ['svcnum'] ],
1709     },
1710
1711     'registrar' => {
1712       'columns' => [
1713         'registrarnum',   'serial', '',      '', '', '',
1714         'registrarname', 'varchar', '', $char_d, '', '',
1715       ],
1716       'primary_key' => 'registrarnum',
1717       'unique'      => [],
1718       'index'       => [],
1719     },
1720
1721     'svc_forward' => {
1722       'columns' => [
1723         'svcnum',   'int',            '',   '', '', '',
1724         'srcsvc',   'int',        'NULL',   '', '', '',
1725         'src',      'varchar',    'NULL',  255, '', '',
1726         'dstsvc',   'int',        'NULL',   '', '', '',
1727         'dst',      'varchar',    'NULL',  255, '', '',
1728       ],
1729       'primary_key' => 'svcnum',
1730       'unique'      => [],
1731       'index'       => [ ['srcsvc'], ['dstsvc'] ],
1732     },
1733
1734     'svc_www' => {
1735       'columns' => [
1736         'svcnum',   'int',      '',  '', '', '',
1737         'recnum',   'int',      '',  '', '', '',
1738         'usersvc',  'int',  'NULL',  '', '', '',
1739         'config',   'text', 'NULL',  '', '', '',
1740       ],
1741       'primary_key' => 'svcnum',
1742       'unique'      => [],
1743       'index'       => [],
1744     },
1745
1746     #'svc_wo' => {
1747     #  'columns' => [
1748     #    'svcnum',    'int',    '',   '',
1749     #    'svcnum',    'int',    '',   '',
1750     #    'svcnum',    'int',    '',   '',
1751     #    'worker',    'varchar',   '',   $char_d,
1752     #    '_date',     @date_type,
1753     #  ],
1754     #  'primary_key' => 'svcnum',
1755     #  'unique' => [ [] ],
1756     #  'index' => [ [] ],
1757     #},
1758
1759     'prepay_credit' => {
1760       'columns' => [
1761         'prepaynum',   'serial',     '',   '', '', '',
1762         'identifier',  'varchar', '', $char_d, '', '',
1763         'amount',      @money_type, '', '',
1764         'seconds',     'int',     'NULL', '', '', '',
1765         'upbytes',     'bigint',     'NULL', '', '', '',
1766         'downbytes',   'bigint',     'NULL', '', '', '',
1767         'totalbytes',  'bigint',     'NULL', '', '', '',
1768         'agentnum',    'int',     'NULL', '', '', '',
1769       ],
1770       'primary_key' => 'prepaynum',
1771       'unique'      => [ ['identifier'] ],
1772       'index'       => [],
1773     },
1774
1775     'port' => {
1776       'columns' => [
1777         'portnum',  'serial',     '',   '', '', '',
1778         'ip',       'varchar', 'NULL', 15, '', '',
1779         'nasport',  'int',     'NULL', '', '', '',
1780         'nasnum',   'int',     '',   '', '', '',
1781       ],
1782       'primary_key' => 'portnum',
1783       'unique'      => [],
1784       'index'       => [],
1785     },
1786
1787     'nas' => {
1788       'columns' => [
1789         'nasnum',   'serial',     '',    '', '', '',
1790         'nas',      'varchar', '',    $char_d, '', '',
1791         'nasip',    'varchar', '',    15, '', '',
1792         'nasfqdn',  'varchar', '',    $char_d, '', '',
1793         'last',     'int',     '',    '', '', '',
1794       ],
1795       'primary_key' => 'nasnum',
1796       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
1797       'index'       => [ [ 'last' ] ],
1798     },
1799
1800 #    'session' => {
1801 #      'columns' => [
1802 #        'sessionnum', 'serial',       '',   '', '', '',
1803 #        'portnum',    'int',       '',   '', '', '',
1804 #        'svcnum',     'int',       '',   '', '', '',
1805 #        'login',      @date_type, '', '',
1806 #        'logout',     @date_type, '', '',
1807 #      ],
1808 #      'primary_key' => 'sessionnum',
1809 #      'unique'      => [],
1810 #      'index'       => [ [ 'portnum' ] ],
1811 #    },
1812
1813     'queue' => {
1814       'columns' => [
1815         'jobnum',      'serial',     '',      '', '', '',
1816         'job',        'varchar',     '',     512, '', '',
1817         '_date',          'int',     '',      '', '', '',
1818         'status',     'varchar',     '', $char_d, '', '',
1819         'statustext',    'text', 'NULL',      '', '', '',
1820         'svcnum',         'int', 'NULL',      '', '', '',
1821         'custnum',        'int', 'NULL',      '', '', '',
1822         'secure',        'char', 'NULL',       1, '', '',
1823         'priority',       'int', 'NULL',      '', '', '',
1824       ],
1825       'primary_key' => 'jobnum',
1826       'unique'      => [],
1827       'index'       => [ [ 'secure' ], [ 'priority' ],
1828                          [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
1829                        ],
1830     },
1831
1832     'queue_arg' => {
1833       'columns' => [
1834         'argnum', 'serial', '', '', '', '',
1835         'jobnum', 'int', '', '', '', '',
1836         'frozen', 'char', 'NULL',       1, '', '',
1837         'arg', 'text', 'NULL', '', '', '',
1838       ],
1839       'primary_key' => 'argnum',
1840       'unique'      => [],
1841       'index'       => [ [ 'jobnum' ] ],
1842     },
1843
1844     'queue_depend' => {
1845       'columns' => [
1846         'dependnum', 'serial', '', '', '', '',
1847         'jobnum', 'int', '', '', '', '',
1848         'depend_jobnum', 'int', '', '', '', '',
1849       ],
1850       'primary_key' => 'dependnum',
1851       'unique'      => [],
1852       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1853     },
1854
1855     'export_svc' => {
1856       'columns' => [
1857         'exportsvcnum' => 'serial', '', '', '', '',
1858         'exportnum'    => 'int', '', '', '', '',
1859         'svcpart'      => 'int', '', '', '', '',
1860       ],
1861       'primary_key' => 'exportsvcnum',
1862       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
1863       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
1864     },
1865
1866     'export_device' => {
1867       'columns' => [
1868         'exportdevicenum' => 'serial', '', '', '', '',
1869         'exportnum'    => 'int', '', '', '', '',
1870         'devicepart'      => 'int', '', '', '', '',
1871       ],
1872       'primary_key' => 'exportdevicenum',
1873       'unique'      => [ [ 'exportnum', 'devicepart' ] ],
1874       'index'       => [ [ 'exportnum' ], [ 'devicepart' ] ],
1875     },
1876
1877     'part_export' => {
1878       'columns' => [
1879         'exportnum', 'serial', '', '', '', '',
1880         'machine', 'varchar', '', $char_d, '', '',
1881         'exporttype', 'varchar', '', $char_d, '', '',
1882         'nodomain',     'char', 'NULL', 1, '', '',
1883       ],
1884       'primary_key' => 'exportnum',
1885       'unique'      => [],
1886       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
1887     },
1888
1889     'part_export_option' => {
1890       'columns' => [
1891         'optionnum', 'serial', '', '', '', '',
1892         'exportnum', 'int', '', '', '', '',
1893         'optionname', 'varchar', '', $char_d, '', '',
1894         'optionvalue', 'text', 'NULL', '', '', '',
1895       ],
1896       'primary_key' => 'optionnum',
1897       'unique'      => [],
1898       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
1899     },
1900
1901     'radius_usergroup' => {
1902       'columns' => [
1903         'usergroupnum', 'serial', '', '', '', '',
1904         'svcnum',       'int', '', '', '', '',
1905         'groupname',    'varchar', '', $char_d, '', '',
1906       ],
1907       'primary_key' => 'usergroupnum',
1908       'unique'      => [],
1909       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
1910     },
1911
1912     'msgcat' => {
1913       'columns' => [
1914         'msgnum', 'serial', '', '', '', '',
1915         'msgcode', 'varchar', '', $char_d, '', '',
1916         'locale', 'varchar', '', 16, '', '',
1917         'msg', 'text', '', '', '', '',
1918       ],
1919       'primary_key' => 'msgnum',
1920       'unique'      => [ [ 'msgcode', 'locale' ] ],
1921       'index'       => [],
1922     },
1923
1924     'cust_tax_exempt' => {
1925       'columns' => [
1926         'exemptnum', 'serial', '', '', '', '',
1927         'custnum',   'int', '', '', '', '',
1928         'taxnum',    'int', '', '', '', '',
1929         'year',      'int', '', '', '', '',
1930         'month',     'int', '', '', '', '',
1931         'amount',   @money_type, '', '',
1932       ],
1933       'primary_key' => 'exemptnum',
1934       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1935       'index'       => [],
1936     },
1937
1938     'cust_tax_exempt_pkg' => {
1939       'columns' => [
1940         'exemptpkgnum',  'serial', '', '', '', '',
1941         #'custnum',      'int', '', '', '', ''
1942         'billpkgnum',   'int', '', '', '', '',
1943         'taxnum',       'int', '', '', '', '',
1944         'year',         'int', '', '', '', '',
1945         'month',        'int', '', '', '', '',
1946         'creditbillpkgnum', 'int', 'NULL', '', '', '',
1947         'amount',       @money_type, '', '',
1948       ],
1949       'primary_key' => 'exemptpkgnum',
1950       'unique' => [],
1951       'index'  => [ [ 'taxnum', 'year', 'month' ],
1952                     [ 'billpkgnum' ],
1953                     [ 'taxnum' ],
1954                     [ 'creditbillpkgnum' ],
1955                   ],
1956     },
1957
1958     'router' => {
1959       'columns' => [
1960         'routernum', 'serial', '', '', '', '',
1961         'routername', 'varchar', '', $char_d, '', '',
1962         'svcnum', 'int', 'NULL', '', '', '',
1963         'agentnum',   'int', 'NULL', '', '', '',
1964       ],
1965       'primary_key' => 'routernum',
1966       'unique'      => [],
1967       'index'       => [],
1968     },
1969
1970     'part_svc_router' => {
1971       'columns' => [
1972         'svcrouternum', 'serial', '', '', '', '',
1973         'svcpart', 'int', '', '', '', '',
1974         'routernum', 'int', '', '', '', '',
1975       ],
1976       'primary_key' => 'svcrouternum',
1977       'unique'      => [],
1978       'index'       => [],
1979     },
1980
1981     'addr_block' => {
1982       'columns' => [
1983         'blocknum', 'serial', '', '', '', '',
1984         'routernum', 'int', '', '', '', '',
1985         'ip_gateway', 'varchar', '', 15, '', '',
1986         'ip_netmask', 'int', '', '', '', '',
1987         'agentnum',   'int', 'NULL', '', '', '',
1988         'manual_flag', 'char', 'NULL', 1, '', '',
1989       ],
1990       'primary_key' => 'blocknum',
1991       'unique'      => [ [ 'blocknum', 'routernum' ] ],
1992       'index'       => [],
1993     },
1994
1995     'svc_broadband' => {
1996       'columns' => [
1997         'svcnum', 'int', '', '', '', '',
1998         'description', 'varchar', 'NULL', $char_d, '', '',
1999         'blocknum', 'int', 'NULL', '', '', '',
2000         'speed_up', 'int', '', '', '', '',
2001         'speed_down', 'int', '', '', '', '',
2002         'ip_addr', 'varchar', 'NULL', 15, '', '',
2003         'mac_addr', 'varchar', 'NULL', 12, '', '',
2004         'authkey',  'varchar', 'NULL', 32, '', '',
2005         'latitude', 'decimal', 'NULL', '', '', '',
2006         'longitude', 'decimal', 'NULL', '', '', '',
2007         'altitude', 'decimal', 'NULL', '', '', '',
2008         'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
2009         'performance_profile', 'varchar', 'NULL', $char_d, '', '',
2010       ],
2011       'primary_key' => 'svcnum',
2012       'unique'      => [ [ 'mac_addr' ] ],
2013       'index'       => [],
2014     },
2015
2016     'part_virtual_field' => {
2017       'columns' => [
2018         'vfieldpart', 'serial', '', '', '', '',
2019         'dbtable', 'varchar', '', 32, '', '',
2020         'name', 'varchar', '', 32, '', '',
2021         'check_block', 'text', 'NULL', '', '', '',
2022         'length', 'int', 'NULL', '', '', '',
2023         'list_source', 'text', 'NULL', '', '', '',
2024         'label', 'varchar', 'NULL', 80, '', '',
2025       ],
2026       'primary_key' => 'vfieldpart',
2027       'unique' => [],
2028       'index' => [],
2029     },
2030
2031     'virtual_field' => {
2032       'columns' => [
2033         'vfieldnum', 'serial', '', '', '', '',
2034         'recnum', 'int', '', '', '', '',
2035         'vfieldpart', 'int', '', '', '', '',
2036         'value', 'varchar', '', 128, '', '',
2037       ],
2038       'primary_key' => 'vfieldnum',
2039       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
2040       'index' => [],
2041     },
2042
2043     'acct_snarf' => {
2044       'columns' => [
2045         'snarfnum',  'int', '', '', '', '',
2046         'svcnum',    'int', '', '', '', '',
2047         'machine',   'varchar', '', 255, '', '',
2048         'protocol',  'varchar', '', $char_d, '', '',
2049         'username',  'varchar', '', $char_d, '', '',
2050         '_password', 'varchar', '', $char_d, '', '',
2051       ],
2052       'primary_key' => 'snarfnum',
2053       'unique' => [],
2054       'index'  => [ [ 'svcnum' ] ],
2055     },
2056
2057     'svc_external' => {
2058       'columns' => [
2059         'svcnum', 'int', '', '', '', '',
2060         'id',     'int', 'NULL', '', '', '',
2061         'title',  'varchar', 'NULL', $char_d, '', '',
2062       ],
2063       'primary_key' => 'svcnum',
2064       'unique'      => [],
2065       'index'       => [],
2066     },
2067
2068     'cust_pay_refund' => {
2069       'columns' => [
2070         'payrefundnum', 'serial', '', '', '', '',
2071         'paynum',  'int', '', '', '', '',
2072         'refundnum',  'int', '', '', '', '',
2073         '_date',    @date_type, '', '',
2074         'amount',   @money_type, '', '',
2075       ],
2076       'primary_key' => 'payrefundnum',
2077       'unique' => [],
2078       'index' => [ ['paynum'], ['refundnum'] ],
2079     },
2080
2081     'part_pkg_option' => {
2082       'columns' => [
2083         'optionnum', 'serial', '', '', '', '',
2084         'pkgpart', 'int', '', '', '', '',
2085         'optionname', 'varchar', '', $char_d, '', '',
2086         'optionvalue', 'text', 'NULL', '', '', '',
2087       ],
2088       'primary_key' => 'optionnum',
2089       'unique'      => [],
2090       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
2091     },
2092
2093     'part_pkg_report_option' => {
2094       'columns' => [
2095         'num',      'serial',   '',      '', '', '',
2096         'name',     'varchar',  '', $char_d, '', '',
2097         'disabled', 'char', 'NULL',       1, '', '',
2098       ],
2099       'primary_key' => 'num',
2100       'unique' => [ [ 'name' ] ],
2101       'index' => [ [ 'disabled' ] ],
2102     },
2103
2104     'rate' => {
2105       'columns' => [
2106         'ratenum',  'serial', '', '', '', '',
2107         'ratename', 'varchar', '', $char_d, '', '',
2108       ],
2109       'primary_key' => 'ratenum',
2110       'unique'      => [],
2111       'index'       => [],
2112     },
2113
2114     'rate_detail' => {
2115       'columns' => [
2116         'ratedetailnum',   'serial', '', '', '', '',
2117         'ratenum',         'int',     '', '', '', '',
2118         'orig_regionnum',  'int', 'NULL', '', '', '',
2119         'dest_regionnum',  'int',     '', '', '', '',
2120         'min_included',    'int',     '', '', '', '',
2121         #'min_charge',      @money_type, '', '',
2122         'min_charge',      'decimal', '', '10,5', '', '',
2123         'sec_granularity', 'int',     '', '', '', '',
2124         #time period (link to table of periods)?
2125         'classnum',        'int',     'NULL', '', '', '',
2126       ],
2127       'primary_key' => 'ratedetailnum',
2128       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
2129       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
2130     },
2131
2132     'rate_region' => {
2133       'columns' => [
2134         'regionnum',   'serial',      '', '', '', '',
2135         'regionname',  'varchar',     '', $char_d, '', '',
2136       ],
2137       'primary_key' => 'regionnum',
2138       'unique'      => [],
2139       'index'       => [],
2140     },
2141
2142     'rate_prefix' => {
2143       'columns' => [
2144         'prefixnum',   'serial',      '', '', '', '',
2145         'regionnum',   'int',         '', '', '', '',
2146         'countrycode', 'varchar',     '',  3, '', '',
2147         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
2148         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
2149       ],
2150       'primary_key' => 'prefixnum',
2151       'unique'      => [],
2152       'index'       => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
2153     },
2154
2155     'usage_class' => {
2156       'columns' => [
2157         'classnum',    'serial',      '',      '', '', '',
2158         'weight',      'int',     'NULL',      '', '', '',
2159         'classname',   'varchar',     '', $char_d, '', '',
2160         'format',      'varchar', 'NULL', $char_d, '', '',
2161         'disabled',    'char',    'NULL',       1, '', '',
2162       ],
2163       'primary_key' => 'classnum',
2164       'unique' => [],
2165       'index' => [ ['disabled'] ],
2166     },
2167
2168     'reg_code' => {
2169       'columns' => [
2170         'codenum',   'serial',    '', '', '', '',
2171         'code',      'varchar',   '', $char_d, '', '',
2172         'agentnum',  'int',       '', '', '', '',
2173       ],
2174       'primary_key' => 'codenum',
2175       'unique'      => [ [ 'agentnum', 'code' ] ],
2176       'index'       => [ [ 'agentnum' ] ],
2177     },
2178
2179     'reg_code_pkg' => {
2180       'columns' => [
2181         'codepkgnum', 'serial', '', '', '', '',
2182         'codenum',   'int',    '', '', '', '',
2183         'pkgpart',   'int',    '', '', '', '',
2184       ],
2185       'primary_key' => 'codepkgnum',
2186       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
2187       'index'       => [ [ 'codenum' ] ],
2188     },
2189
2190     'clientapi_session' => {
2191       'columns' => [
2192         'sessionnum',  'serial',  '', '', '', '',
2193         'sessionid',  'varchar',  '', $char_d, '', '',
2194         'namespace',  'varchar',  '', $char_d, '', '',
2195       ],
2196       'primary_key' => 'sessionnum',
2197       'unique'      => [ [ 'sessionid', 'namespace' ] ],
2198       'index'       => [],
2199     },
2200
2201     'clientapi_session_field' => {
2202       'columns' => [
2203         'fieldnum',    'serial',     '', '', '', '',
2204         'sessionnum',     'int',     '', '', '', '',
2205         'fieldname',  'varchar',     '', $char_d, '', '',
2206         'fieldvalue',    'text', 'NULL', '', '', '',
2207       ],
2208       'primary_key' => 'fieldnum',
2209       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
2210       'index'       => [],
2211     },
2212
2213     'payment_gateway' => {
2214       'columns' => [
2215         'gatewaynum',       'serial',   '',     '', '', '',
2216         'gateway_namespace','varchar',  'NULL', $char_d, '', '',
2217         'gateway_module',   'varchar',  '',     $char_d, '', '',
2218         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
2219         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
2220         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
2221         'gateway_callback_url', 'varchar',  'NULL', $char_d, '', '',
2222         'disabled',   'char',  'NULL',   1, '', '',
2223       ],
2224       'primary_key' => 'gatewaynum',
2225       'unique' => [],
2226       'index'  => [ [ 'disabled' ] ],
2227     },
2228
2229     'payment_gateway_option' => {
2230       'columns' => [
2231         'optionnum',   'serial',  '',     '', '', '',
2232         'gatewaynum',  'int',     '',     '', '', '',
2233         'optionname',  'varchar', '',     $char_d, '', '',
2234         'optionvalue', 'text',    'NULL', '', '', '',
2235       ],
2236       'primary_key' => 'optionnum',
2237       'unique'      => [],
2238       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
2239     },
2240
2241     'agent_payment_gateway' => {
2242       'columns' => [
2243         'agentgatewaynum', 'serial', '', '', '', '',
2244         'agentnum',        'int', '', '', '', '',
2245         'gatewaynum',      'int', '', '', '', '',
2246         'cardtype',        'varchar', 'NULL', $char_d, '', '',
2247         'taxclass',        'varchar', 'NULL', $char_d, '', '',
2248       ],
2249       'primary_key' => 'agentgatewaynum',
2250       'unique'      => [],
2251       'index'       => [ [ 'agentnum', 'cardtype' ], ],
2252     },
2253
2254     'banned_pay' => {
2255       'columns' => [
2256         'bannum',  'serial',   '',     '', '', '',
2257         'payby',   'char',     '',       4, '', '',
2258         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
2259         #'paymask', 'varchar',  'NULL', $char_d, '', ''
2260         '_date',   @date_type, '', '',
2261         'otaker',  'varchar',  '',     32, '', '',
2262         'reason',  'varchar',  'NULL', $char_d, '', '',
2263       ],
2264       'primary_key' => 'bannum',
2265       'unique'      => [ [ 'payby', 'payinfo' ] ],
2266       'index'       => [],
2267     },
2268
2269     'pkg_category' => {
2270       'columns' => [
2271         'categorynum',   'serial',  '', '', '', '',
2272         'categoryname',  'varchar', '', $char_d, '', '',
2273         'weight',         'int', 'NULL',  '', '', '',
2274         'condense',      'char', 'NULL',   1, '', '',
2275         'disabled',      'char', 'NULL',   1, '', '',
2276       ],
2277       'primary_key' => 'categorynum',
2278       'unique' => [],
2279       'index' => [ ['disabled'] ],
2280     },
2281
2282     'pkg_class' => {
2283       'columns' => [
2284         'classnum',    'serial',   '',      '', '', '',
2285         'classname',   'varchar',  '', $char_d, '', '',
2286         'categorynum', 'int',  'NULL',      '', '', '',
2287         'disabled',    'char', 'NULL',       1, '', '',
2288       ],
2289       'primary_key' => 'classnum',
2290       'unique' => [],
2291       'index' => [ ['disabled'] ],
2292     },
2293
2294     'cdr' => {
2295       'columns' => [
2296         # qw( name type null length default local );
2297
2298         ###
2299         #asterisk fields
2300         ###
2301
2302         'acctid',   'bigserial',  '', '', '', '',
2303         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
2304         'calldate', 'timestamp',   '',      '', \'now()', '',
2305         'clid',        'varchar',  '', $char_d, \"''", '',
2306         'src',         'varchar',  '', $char_d, \"''", '',
2307         'dst',         'varchar',  '', $char_d, \"''", '',
2308         'dcontext',    'varchar',  '', $char_d, \"''", '',
2309         'channel',     'varchar',  '', $char_d, \"''", '',
2310         'dstchannel',  'varchar',  '', $char_d, \"''", '',
2311         'lastapp',     'varchar',  '', $char_d, \"''", '',
2312         'lastdata',    'varchar',  '', $char_d, \"''", '',
2313
2314         #these don't seem to be logged by most of the SQL cdr_* modules
2315         #except tds under sql-illegal names, so;
2316         # ... don't rely on them for rating?
2317         # and, what they hey, i went ahead and changed the names and data types
2318         # to freeside-style dates...
2319           #'start',  'timestamp', 'NULL',  '',    '', '',
2320           #'answer', 'timestamp', 'NULL',  '',    '', '',
2321           #'end',    'timestamp', 'NULL',  '',    '', '',
2322         'startdate',  @date_type, '', '',
2323         'answerdate', @date_type, '', '',
2324         'enddate',    @date_type, '', '',
2325         #
2326
2327         'duration',    'int',      '',      '',     0, '',
2328         'billsec',     'int',      '',      '',     0, '',
2329         'disposition', 'varchar',  '',      45, \"''", '',
2330         'amaflags',    'int',      '',      '',     0, '',
2331         'accountcode', 'varchar',  '',      20, \"''", '',
2332         'uniqueid',    'varchar',  '',      32, \"''", '',
2333         'userfield',   'varchar',  '',     255, \"''", '',
2334
2335         ###
2336         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
2337         # defaults
2338         # though these are now used elsewhere:
2339         # charged_party, upstream_price, rated_price, carrierid
2340         ###
2341
2342         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
2343         'cdrtypenum',              'int', 'NULL',      '', '', '',
2344
2345         'charged_party',       'varchar', 'NULL', $char_d, '', '',
2346
2347         'upstream_currency',      'char', 'NULL',       3, '', '',
2348         'upstream_price',      'decimal', 'NULL',  '10,2', '', '',
2349         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
2350
2351         # how it was rated internally...
2352         'ratedetailnum',           'int', 'NULL',      '', '', '',
2353         'rated_price',         'decimal', 'NULL',  '10,4', '', '',
2354
2355         'distance',            'decimal', 'NULL',      '', '', '',
2356         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
2357
2358         #cdr_calltype: the big list in appendix 2
2359         'calltypenum',             'int', 'NULL',      '', '', '',
2360
2361         'description',         'varchar', 'NULL', $char_d, '', '',
2362         'quantity',                'int', 'NULL',      '', '', '',
2363
2364         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
2365         'carrierid',               'int', 'NULL',      '', '', '',
2366
2367         'upstream_rateid',         'int', 'NULL',      '', '', '',
2368
2369         ###
2370         #and now for our own fields
2371         ###
2372
2373         # a svcnum... right..?
2374         'svcnum',             'int',   'NULL',     '',   '', '',
2375
2376         #NULL, done (or something)
2377         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
2378
2379         #NULL, done (or something)
2380         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '',
2381
2382         #an indexed place to put big numbers
2383         'cdrid',         'bigint',     'NULL',     '',  '', '',
2384
2385         #old
2386         'cdrbatch', 'varchar', 'NULL', 255, '', '',
2387         #new
2388         'cdrbatchnum', 'int', 'NULL', '', '', '',
2389
2390       ],
2391       'primary_key' => 'acctid',
2392       'unique' => [],
2393       'index' => [ [ 'calldate' ],
2394                    [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
2395                    [ 'accountcode' ], [ 'carrierid' ], [ 'cdrid' ],
2396                    [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
2397                    [ 'cdrbatch' ], [ 'cdrbatchnum' ],
2398                  ],
2399     },
2400
2401     'cdr_batch' => {
2402       'columns' => [
2403         'cdrbatchnum',   'serial',    '',   '', '', '',
2404         'cdrbatch', 'varchar', 'NULL', 255, '', '',
2405         '_date',     @date_type, '', '',
2406       ],
2407       'primary_key' => 'cdrbatchnum',
2408       'unique' => [ [ 'cdrbatch' ] ],
2409       'index' => [],
2410     },
2411
2412     'cdr_termination' => {
2413       'columns' => [
2414         'cdrtermnum', 'bigserial',     '',      '', '', '',
2415         'acctid',        'bigint',     '',      '', '', '',
2416         'termpart',         'int',     '',      '', '', '',#future use see below
2417         'rated_price',  'decimal', 'NULL',  '10,4', '', '',
2418         'status',       'varchar', 'NULL',      32, '', '',
2419       ],
2420       'primary_key' => 'cdrtermnum',
2421       'unique'      => [ [ 'acctid', 'termpart' ] ],
2422       'index'       => [ [ 'acctid' ], [ 'status' ], ],
2423     },
2424
2425     #to handle multiple termination/settlement passes...
2426    # 'part_termination' => {
2427    #   'columns' => [
2428    #     'termpart',       'int', '',      '', '', '',
2429    #     'termname',   'varchar', '', $char_d, '', '',
2430    #     'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
2431    #   ],
2432    #   'primary_key' => 'termpart',
2433    #   'unique' => [],
2434    #   'index'  => [],
2435    # },
2436
2437     #the remaining cdr_ tables are not really used
2438     'cdr_calltype' => {
2439       'columns' => [
2440         'calltypenum',   'serial',  '', '', '', '',
2441         'calltypename',  'varchar', '', $char_d, '', '',
2442       ],
2443       'primary_key' => 'calltypenum',
2444       'unique'      => [],
2445       'index'       => [],
2446     },
2447
2448     'cdr_type' => {
2449       'columns' => [
2450         'cdrtypenum'  => 'serial',  '', '', '', '',
2451         'cdrtypename' => 'varchar', '', $char_d, '', '',
2452       ],
2453       'primary_key' => 'cdrtypenum',
2454       'unique'      => [],
2455       'index'       => [],
2456     },
2457
2458     'cdr_carrier' => {
2459       'columns' => [
2460         'carrierid'   => 'serial',  '', '', '', '',
2461         'carriername' => 'varchar', '', $char_d, '', '',
2462       ],
2463       'primary_key' => 'carrierid',
2464       'unique'      => [],
2465       'index'       => [],
2466     },
2467
2468     #'cdr_file' => {
2469     #  'columns' => [
2470     #    'filenum',    'serial',     '', '', '', '',
2471     #    'filename',  'varchar',     '', '', '', '',
2472     #    'status',    'varchar', 'NULL', '', '', '',
2473     #  ],
2474     #  'primary_key' => 'filenum',
2475     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
2476     #                                   # agent-virtualize or have a customer
2477     #                                   # with dup-filename needs or something
2478     #                                   # (only used by cdr.http_and_import for
2479     #                                   #  chrissakes)
2480     #  'index'  => [],
2481     #},
2482
2483     'inventory_item' => {
2484       'columns' => [
2485         'itemnum',  'serial',      '',      '', '', '',
2486         'classnum', 'int',         '',      '', '', '',
2487         'item',     'varchar',     '', $char_d, '', '',
2488         'svcnum',   'int',     'NULL',      '', '', '',
2489       ],
2490       'primary_key' => 'itemnum',
2491       'unique' => [ [ 'classnum', 'item' ] ],
2492       'index'  => [ [ 'classnum' ], [ 'svcnum' ] ],
2493     },
2494
2495     'inventory_class' => {
2496       'columns' => [
2497         'classnum',  'serial',       '',      '', '', '',
2498         'classname', 'varchar',      '', $char_d, '', '',
2499       ],
2500       'primary_key' => 'classnum',
2501       'unique' => [],
2502       'index'  => [],
2503     },
2504
2505     'access_user' => {
2506       'columns' => [
2507         'usernum',   'serial',  '',      '', '', '',
2508         'username',  'varchar', '', $char_d, '', '',
2509         '_password', 'varchar', '', $char_d, '', '',
2510         'last',      'varchar', '', $char_d, '', '',
2511         'first',     'varchar', '', $char_d, '', '',
2512         'disabled',     'char', 'NULL',   1, '', '',
2513       ],
2514       'primary_key' => 'usernum',
2515       'unique' => [ [ 'username' ] ],
2516       'index'  => [],
2517     },
2518
2519     'access_user_pref' => {
2520       'columns' => [
2521         'prefnum',    'serial',       '', '', '', '',
2522         'usernum',     'int',       '', '', '', '',
2523         'prefname', 'varchar', '', $char_d, '', '',
2524         'prefvalue', 'text', 'NULL', '', '', '',
2525         'expiration', @date_type, '', '',
2526       ],
2527       'primary_key' => 'prefnum',
2528       'unique' => [],
2529       'index'  => [ [ 'usernum' ] ],
2530     },
2531
2532     'access_group' => {
2533       'columns' => [
2534         'groupnum',   'serial', '',      '', '', '',
2535         'groupname', 'varchar', '', $char_d, '', '',
2536       ],
2537       'primary_key' => 'groupnum',
2538       'unique' => [ [ 'groupname' ] ],
2539       'index'  => [],
2540     },
2541
2542     'access_usergroup' => {
2543       'columns' => [
2544         'usergroupnum', 'serial', '', '', '', '',
2545         'usernum',         'int', '', '', '', '',
2546         'groupnum',        'int', '', '', '', '',
2547       ],
2548       'primary_key' => 'usergroupnum',
2549       'unique' => [ [ 'usernum', 'groupnum' ] ],
2550       'index'  => [ [ 'usernum' ] ],
2551     },
2552
2553     'access_groupagent' => {
2554       'columns' => [
2555         'groupagentnum', 'serial', '', '', '', '',
2556         'groupnum',         'int', '', '', '', '',
2557         'agentnum',         'int', '', '', '', '',
2558       ],
2559       'primary_key' => 'groupagentnum',
2560       'unique' => [ [ 'groupnum', 'agentnum' ] ],
2561       'index'  => [ [ 'groupnum' ] ],
2562     },
2563
2564     'access_right' => {
2565       'columns' => [
2566         'rightnum',   'serial', '',      '', '', '',
2567         'righttype', 'varchar', '', $char_d, '', '',
2568         'rightobjnum',   'int', '',      '', '', '',
2569         'rightname', 'varchar', '', $char_d, '', '',
2570       ],
2571       'primary_key' => 'rightnum',
2572       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2573       'index'  => [],
2574     },
2575
2576     'svc_phone' => {
2577       'columns' => [
2578         'svcnum',       'int',         '',      '', '', '',
2579         'countrycode',  'varchar',     '',       3, '', '',
2580         'phonenum',     'varchar',     '',      15, '', '',  #12 ?
2581         'pin',          'varchar', 'NULL', $char_d, '', '',
2582         'sip_password', 'varchar', 'NULL', $char_d, '', '',
2583         'phone_name',   'varchar', 'NULL', $char_d, '', '',
2584         'pbxsvc',           'int', 'NULL',      '', '', '',
2585       ],
2586       'primary_key' => 'svcnum',
2587       'unique' => [],
2588       'index'  => [ [ 'countrycode', 'phonenum' ], ['pbxsvc'] ],
2589     },
2590
2591     'phone_device' => {
2592       'columns' => [
2593         'devicenum', 'serial',     '', '', '', '',
2594         'devicepart',   'int',     '', '', '', '',
2595         'svcnum',       'int',     '', '', '', '',
2596         'mac_addr', 'varchar', 'NULL', 12, '', '',
2597       ],
2598       'primary_key' => 'devicenum',
2599       'unique' => [ [ 'mac_addr' ], ],
2600       'index'  => [ [ 'devicepart' ], [ 'svcnum' ], ],
2601     },
2602
2603     'part_device' => {
2604       'columns' => [
2605         'devicepart', 'serial',  '',      '', '', '',
2606         'devicename', 'varchar', '', $char_d, '', '',
2607         #'classnum', #tie to an inventory class?
2608       ],
2609       'primary_key' => 'devicepart',
2610       'unique' => [ [ 'devicename' ] ], #?
2611       'index'  => [],
2612     },
2613
2614     'phone_avail' => {
2615       'columns' => [
2616         'availnum',    'serial',      '',      '', '', '',
2617         'exportnum',   'int',         '',      '', '', '',
2618         'countrycode', 'varchar',     '',       3, '', '',
2619         'state',       'char',    'NULL',       2, '', '',
2620         'npa',         'char',        '',       3, '', '',
2621         'nxx',         'char',    'NULL',       3, '', '',
2622         'station',     'char',    'NULL',       4, '', '',
2623         'name',        'varchar', 'NULL', $char_d, '', '',
2624         'svcnum',      'int',     'NULL',      '', '', '',
2625         'availbatch', 'varchar',  'NULL', $char_d, '', '',
2626       ],
2627       'primary_key' => 'availnum',
2628       'unique' => [],
2629       'index'  => [ [ 'exportnum', 'countrycode', 'state' ],     #npa search
2630                     [ 'exportnum', 'countrycode', 'npa' ],       #nxx search
2631                     [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
2632                     [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
2633                     [ 'svcnum' ],
2634                     [ 'availbatch' ],
2635                   ],
2636     },
2637
2638     'reason_type' => {
2639       'columns' => [
2640         'typenum',   'serial',  '', '', '', '',
2641         'class',     'char', '', 1, '', '',
2642         'type',     'varchar', '', $char_d, '', '',
2643       ],
2644       'primary_key' => 'typenum',
2645       'unique' => [],
2646       'index' => [],
2647     },
2648
2649     'reason' => {
2650       'columns' => [
2651         'reasonnum',     'serial',  '', '', '', '',
2652         'reason_type',   'int',  '', '', '', '',
2653         'reason',        'text', '', '', '', '',
2654         'disabled',      'char',    'NULL', 1, '', '',
2655       ],
2656       'primary_key' => 'reasonnum',
2657       'unique' => [],
2658       'index' => [],
2659     },
2660
2661     'conf' => {
2662       'columns' => [
2663         'confnum',  'serial',  '', '', '', '',
2664         'agentnum', 'int',  'NULL', '', '', '',
2665         'name',     'varchar', '', $char_d, '', '',
2666         'value',    'text', 'NULL', '', '', '',
2667       ],
2668       'primary_key' => 'confnum',
2669       'unique' => [ [ 'agentnum', 'name' ]],
2670       'index' => [],
2671     },
2672
2673     'pkg_referral' => {
2674       'columns' => [
2675         'pkgrefnum',     'serial', '', '', '', '',
2676         'pkgnum',        'int',    '', '', '', '',
2677         'refnum',        'int',    '', '', '', '',
2678       ],
2679       'primary_key' => 'pkgrefnum',
2680       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
2681       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
2682     },
2683
2684     'svc_pbx' => {
2685       'columns' => [
2686         'svcnum',         'int',     '',      '', '', '',
2687         'id',             'int', 'NULL',      '', '', '',
2688         'title',      'varchar', 'NULL', $char_d, '', '',
2689         'max_extensions', 'int', 'NULL',      '', '', '',
2690       ],
2691       'primary_key' => 'svcnum',
2692       'unique' => [],
2693       'index'  => [ [ 'id' ] ],
2694     },
2695
2696
2697     # name type nullability length default local
2698
2699     #'new_table' => {
2700     #  'columns' => [
2701     #    'num', 'serial',       '', '', '', '',
2702     #  ],
2703     #  'primary_key' => 'num',
2704     #  'unique' => [],
2705     #  'index'  => [],
2706     #},
2707
2708   };
2709
2710 }
2711
2712 =back
2713
2714 =head1 BUGS
2715
2716 =head1 SEE ALSO
2717
2718 L<DBIx::DBSchema>
2719
2720 =cut
2721
2722 1;
2723