FS/FS/Schema.pm

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