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         'censustract', 'varchar', 'NULL', 20,  '', '', # 7 to save space?
 690         'tax',      'char', 'NULL', 1, '', '',
 691         'otaker',   'varchar', '',    32, '', '',
 692         'refnum',   'int',  '',     '', '', '',
 693         'referral_custnum', 'int',  'NULL', '', '', '',
 694         'comments', 'text', 'NULL', '', '', '',
 695         'spool_cdr','char', 'NULL', 1, '', '',
 696         'squelch_cdr','char', 'NULL', 1, '', '',
 697         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 698         'archived', 'char', 'NULL', 1, '', '',
 699       ],
 700       'primary_key' => 'custnum',
 701       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
 702       #'index' => [ ['last'], ['company'] ],
 703       'index' => [
 704                    [ 'agentnum' ], [ 'refnum' ], [ 'custbatch' ],
 705                    [ 'referral_custnum' ],
 706                    [ 'payby' ], [ 'paydate' ],
 707                    [ 'archived' ],
 708                    #billing
 709                    [ 'last' ], [ 'company' ],
 710                    [ 'county' ], [ 'state' ], [ 'country' ],
 711                    [ 'zip' ],
 712                    [ 'daytime' ], [ 'night' ], [ 'fax' ],
 713                    #shipping
 714                    [ 'ship_last' ], [ 'ship_company' ],
 715                    [ 'ship_county' ], [ 'ship_state' ], [ 'ship_country' ],
 716                    [ 'ship_zip' ],
 717                    [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
 718                  ],
 719     },
 720
 721     'cust_recon' => {  # what purpose does this serve?
 722       'columns' => [
 723         'reconid',      'serial',  '',          '', '', '',
 724         'recondate',    @date_type,                 '', '',
 725         'custnum',      'int'   ,  '',          '', '', '',
 726         'agentnum',     'int',     '',          '', '', '',
 727         'last',         'varchar', '',     $char_d, '', '',
 728         'first',        'varchar', '',     $char_d, '', '',
 729         'address1',     'varchar', '',     $char_d, '', '',
 730         'address2',     'varchar', 'NULL', $char_d, '', '',
 731         'city',         'varchar', '',     $char_d, '', '',
 732         'state',        'varchar', 'NULL', $char_d, '', '',
 733         'zip',          'varchar', 'NULL',      10, '', '',
 734         'pkg',          'varchar', 'NULL', $char_d, '', '',
 735         'adjourn',      @date_type,                 '', '',
 736         'status',       'varchar', 'NULL',      10, '', '',
 737         'agent_custid', 'varchar',  '',    $char_d, '', '',
 738         'agent_pkg',    'varchar', 'NULL', $char_d, '', '',
 739         'agent_adjourn', @date_type,                '', '',
 740         'comments',     'text',    'NULL',      '', '', '',
 741       ],
 742       'primary_key' => 'reconid',
 743       'unique' => [],
 744       'index' => [],
 745     },
 746
 747     #eventually use for billing & ship from cust_main too
 748     #for now, just cust_pkg locations
 749     'cust_location' => {
 750       'columns' => [
 751         'locationnum',  'serial',     '',      '', '', '',
 752         'custnum',         'int',     '',      '', '', '',
 753         'address1',    'varchar',     '', $char_d, '', '',
 754         'address2',    'varchar', 'NULL', $char_d, '', '',
 755         'city',        'varchar',     '', $char_d, '', '',
 756         'county',      'varchar', 'NULL', $char_d, '', '',
 757         'state',       'varchar', 'NULL', $char_d, '', '',
 758         'zip',         'varchar', 'NULL',      10, '', '',
 759         'country',        'char',     '',       2, '', '',
 760         'geocode',     'varchar', 'NULL',      20, '', '',
 761       ],
 762       'primary_key' => 'locationnum',
 763       'unique'      => [],
 764       'index'       => [ [ 'custnum' ],
 765                          [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
 766                        ],
 767     },
 768
 769     'cust_main_invoice' => {
 770       'columns' => [
 771         'destnum',  'serial',  '',     '', '', '',
 772         'custnum',  'int',  '',     '', '', '',
 773         'dest',     'varchar', '',  $char_d, '', '',
 774       ],
 775       'primary_key' => 'destnum',
 776       'unique' => [],
 777       'index' => [ ['custnum'], ],
 778     },
 779
 780     'cust_main_note' => {
 781       'columns' => [
 782         'notenum',  'serial',  '',     '', '', '',
 783         'custnum',  'int',  '',     '', '', '',
 784         '_date',    @date_type, '', '',
 785         'otaker',   'varchar', '',    32, '', '',
 786         'comments', 'text', 'NULL', '', '', '',
 787       ],
 788       'primary_key' => 'notenum',
 789       'unique' => [],
 790       'index' => [ [ 'custnum' ], [ '_date' ], ],
 791     },
 792
 793     'cust_main_exemption' => {
 794       'columns' => [
 795         'exemptionnum', 'serial', '',      '', '', '',
 796         'custnum',         'int', '',      '', '', '',
 797         'taxname',     'varchar', '', $char_d, '', '',
 798         #start/end dates?  for reporting?
 799       ],
 800       'primary_key' => 'exemptionnum',
 801       'unique'      => [],
 802       'index'       => [ [ 'custnum' ] ],
 803     },
 804
 805     'cust_tax_adjustment' => {
 806       'columns' => [
 807         'adjustmentnum', 'serial',     '',      '', '', '',
 808         'custnum',          'int',     '',      '', '', '',
 809         'taxname',      'varchar',     '', $char_d, '', '',
 810         'amount',    @money_type,                   '', '',
 811         'comment',     'varchar',  'NULL', $char_d, '', '',
 812         'billpkgnum',       'int', 'NULL',      '', '', '',
 813         #more?  no cust_bill_pkg_tax_location?
 814       ],
 815       'primary_key' => 'adjustmentnum',
 816       'unique'      => [],
 817       'index'       => [ [ 'custnum' ], [ 'billpkgnum' ] ],
 818     },
 819
 820     'cust_main_county' => { #county+state+country are checked off the
 821                             #cust_main_county for validation and to provide
 822                             # a tax rate.
 823       'columns' => [
 824         'taxnum',   'serial',   '',    '', '', '',
 825         'state',    'varchar',  'NULL',    $char_d, '', '',
 826         'county',   'varchar',  'NULL',    $char_d, '', '',
 827         'country',  'char',  '', 2, '', '',
 828         'taxclass',   'varchar', 'NULL', $char_d, '', '',
 829         'exempt_amount', @money_type, '', '',
 830         'tax',      'real',  '',    '', '', '', #tax %
 831         'taxname',  'varchar',  'NULL',    $char_d, '', '',
 832         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
 833         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
 834       ],
 835       'primary_key' => 'taxnum',
 836       'unique' => [],
 837   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
 838       'index' => [ [ 'county' ], [ 'state' ], [ 'country' ],
 839                    [ 'taxclass' ],
 840                  ],
 841     },
 842
 843     'tax_rate'    => {
 844       'columns' => [
 845         'taxnum',       'serial',     '',      '', '', '',
 846         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
 847         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
 848         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
 849         'taxclassnum', 'int',      '',      '', '', '',
 850         'effective_date', @date_type, '', '',
 851         'tax',        @taxrate_type,      '', '',        # tax %
 852         'excessrate', @taxrate_typen,     '', '',        # second tax %
 853         'taxbase',    @money_typen, '', '',              # amount at first tax rate
 854         'taxmax',     @money_typen, '', '',              # maximum about at both rates
 855         'usetax',        @taxrate_typen,     '', '',     # tax % when non-local
 856         'useexcessrate', @taxrate_typen,     '', '',     # second tax % when non-local
 857         'unittype',    'int',  'NULL', '', '', '',      # for fee
 858         'fee',         @taxrate_typen,     '', '',      # amount tax per unit
 859         'excessfee',   @taxrate_typen,     '', '',      # second amount tax per unit
 860         'feebase',     @taxrate_typen,     '', '',      # units taxed at first rate
 861         'feemax',      @taxrate_typen,     '', '',      # maximum number of unit taxed
 862         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
 863         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
 864         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
 865         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
 866         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
 867         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
 868         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
 869         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
 870         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
 871         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
 872       ],
 873       'primary_key' => 'taxnum',
 874       'unique' => [],
 875       'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
 876     },
 877
 878     'tax_rate_location' => {
 879       'columns' => [
 880         'taxratelocationnum', 'serial',  '',     '', '', '',
 881         'data_vendor',        'varchar', 'NULL', $char_d, '', '',
 882         'geocode',            'varchar', '',     20,      '', '',
 883         'city',               'varchar', 'NULL', $char_d, '', '',
 884         'county',             'varchar', 'NULL', $char_d, '', '',
 885         'state',              'char',    'NULL',       2, '', '',
 886         'disabled',           'char',    'NULL', 1, '', '',
 887       ],
 888       'primary_key' => 'taxratelocationnum',
 889       'unique' => [],
 890       'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
 891     },
 892
 893     'cust_tax_location' => {
 894       'columns' => [
 895         'custlocationnum', 'serial',  '',     '', '', '',
 896         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
 897         'city',            'varchar', 'NULL', $char_d, '', '',
 898         'postalcity',      'varchar', 'NULL', $char_d, '', '',
 899         'county',          'varchar', 'NULL', $char_d, '', '',
 900         'zip',             'char',    '',     5,  '', '',
 901         'state',           'char',    '',     2,  '', '',
 902         'plus4hi',         'char',    'NULL', 4,  '', '',
 903         'plus4lo',         'char',    'NULL', 4,  '', '',
 904         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
 905         'cityflag',        'char',    'NULL', 1,  '', '', # I(n)/O(out)/B(oth)/NULL
 906         'geocode',         'varchar', '',    20,  '', '',
 907       ],
 908       'primary_key' => 'custlocationnum',
 909       'unique' => [],
 910       'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
 911     },
 912
 913     'tax_class' => {
 914       'columns' => [
 915         'taxclassnum',  'serial',  '',            '', '', '',
 916         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
 917         'taxclass',     'varchar', '',       $char_d, '', '',
 918         'description',  'varchar', '',     2*$char_d, '', '',
 919       ],
 920       'primary_key' => 'taxclassnum',
 921       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
 922       'index' => [],
 923     },
 924
 925     'cust_pay_pending' => {
 926       'columns' => [
 927         'paypendingnum','serial',      '',  '', '', '',
 928         'custnum',      'int',         '',  '', '', '',
 929         'paid',         @money_type,            '', '',
 930         '_date',        @date_type,             '', '',
 931         'payby',        'char',        '',   4, '', '', #CARD/BILL/COMP, should
 932                                                         # be index into payby
 933                                                         # table eventually
 934         'payinfo',      'varchar', 'NULL', 512, '', '', #see cust_main above
 935         'paymask',      'varchar', 'NULL', $char_d, '', '',
 936         'paydate',      'varchar', 'NULL', 10, '', '',
 937         'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
 938         #'paybatch',     'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
 939         'payunique',    'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
 940
 941         'status',       'varchar',     '', $char_d, '', '',
 942         'session_id',   'varchar', 'NULL', $char_d, '', '', #only need 32
 943         'statustext',   'text',    'NULL',  '', '', '',
 944         'gatewaynum',   'int',     'NULL',  '', '', '',
 945         #'cust_balance', @money_type,            '', '',
 946         'paynum',       'int',     'NULL',  '', '', '',
 947         'jobnum',       'int',     'NULL',  '', '', '',
 948       ],
 949       'primary_key' => 'paypendingnum',
 950       'unique'      => [ [ 'payunique' ] ],
 951       'index'       => [ [ 'custnum' ], [ 'status' ], ],
 952     },
 953
 954     'cust_pay' => {
 955       'columns' => [
 956         'paynum',   'serial',    '',   '', '', '',
 957         'custnum',  'int',    '',   '', '', '',
 958         '_date',    @date_type, '', '',
 959         'paid',     @money_type, '', '',
 960         'otaker',   'varchar', 'NULL', 32, '', '',  #NULL for the upgrade so we can create & populate the field
 961         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 962                                                  # index into payby table
 963                                                  # eventually
 964         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
 965         'paymask', 'varchar', 'NULL', $char_d, '', '',
 966         'paydate',  'varchar', 'NULL', 10, '', '',
 967         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 968         'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
 969         'closed',    'char', 'NULL', 1, '', '',
 970       ],
 971       'primary_key' => 'paynum',
 972       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
 973       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
 974     },
 975
 976     'cust_pay_void' => {
 977       'columns' => [
 978         'paynum',    'int',    '',   '', '', '',
 979         'custnum',   'int',    '',   '', '', '',
 980         'paid',      @money_type, '', '',
 981         '_date',     @date_type, '', '',
 982         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 983                                                   # index into payby table
 984                                                   # eventually
 985         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
 986         'paymask', 'varchar', 'NULL', $char_d, '', '',
 987         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 988         'closed',    'char', 'NULL', 1, '', '',
 989         'void_date', @date_type, '', '',
 990         'reason',    'varchar',   'NULL', $char_d, '', '',
 991         'otaker',   'varchar', '', 32, '', '',
 992       ],
 993       'primary_key' => 'paynum',
 994       'unique' => [],
 995       'index' => [ [ 'custnum' ] ],
 996     },
 997
 998     'cust_bill_pay' => {
 999       'columns' => [
1000         'billpaynum', 'serial',     '',   '', '', '',
1001         'invnum',  'int',     '',   '', '', '',
1002         'paynum',  'int',     '',   '', '', '',
1003         'amount',  @money_type, '', '',
1004         '_date',   @date_type, '', '',
1005       ],
1006       'primary_key' => 'billpaynum',
1007       'unique' => [],
1008       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
1009     },
1010
1011     'cust_bill_pay_batch' => {
1012       'columns' => [
1013         'billpaynum', 'serial',     '',   '', '', '',
1014         'invnum',  'int',     '',   '', '', '',
1015         'paybatchnum',  'int',     '',   '', '', '',
1016         'amount',  @money_type, '', '',
1017         '_date',   @date_type, '', '',
1018       ],
1019       'primary_key' => 'billpaynum',
1020       'unique' => [],
1021       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1022     },
1023
1024     'cust_bill_pay_pkg' => {
1025       'columns' => [
1026         'billpaypkgnum', 'serial', '', '', '', '',
1027         'billpaynum',       'int', '', '', '', '',
1028         'billpkgnum',       'int', '', '', '', '',
1029         'amount',         @money_type,     '', '',
1030         'setuprecur',      'varchar', '', $char_d, '', '',
1031         'sdate',   @date_type, '', '',
1032         'edate',   @date_type, '', '',
1033       ],
1034       'primary_key' => 'billpaypkgnum',
1035       'unique'      => [],
1036       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1037     },
1038
1039     'pay_batch' => { #batches of payments to an external processor
1040       'columns' => [
1041         'batchnum',   'serial',    '',   '', '', '',
1042         'payby',      'char',      '',    4, '', '', # CARD/CHEK
1043         'status',     'char', 'NULL',     1, '', '',
1044         'download',   @date_type, '', '',
1045         'upload',     @date_type, '', '',
1046       ],
1047       'primary_key' => 'batchnum',
1048       'unique' => [],
1049       'index' => [],
1050     },
1051
1052     'cust_pay_batch' => { #what's this used for again?  list of customers
1053                           #in current CARD batch? (necessarily CARD?)
1054       'columns' => [
1055         'paybatchnum',   'serial',    '',   '', '', '',
1056         'batchnum',   'int',    '',   '', '', '',
1057         'invnum',   'int',    '',   '', '', '',
1058         'custnum',   'int',    '',   '', '', '',
1059         'last',     'varchar', '',     $char_d, '', '',
1060         'first',    'varchar', '',     $char_d, '', '',
1061         'address1', 'varchar', '',     $char_d, '', '',
1062         'address2', 'varchar', 'NULL', $char_d, '', '',
1063         'city',     'varchar', '',     $char_d, '', '',
1064         'state',    'varchar', 'NULL', $char_d, '', '',
1065         'zip',      'varchar', 'NULL', 10, '', '',
1066         'country',  'char', '',     2, '', '',
1067         #        'trancode', 'int', '', '', '', ''
1068         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1069         'payinfo',  'varchar', '',     512, '', '',
1070         #'exp',      @date_type, '', ''
1071         'exp',      'varchar', 'NULL',     11, '', '',
1072         'payname',  'varchar', 'NULL', $char_d, '', '',
1073         'amount',   @money_type, '', '',
1074         'status',   'varchar', 'NULL',     $char_d, '', '',
1075       ],
1076       'primary_key' => 'paybatchnum',
1077       'unique' => [],
1078       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1079     },
1080
1081     'cust_pkg' => {
1082       'columns' => [
1083         'pkgnum',           'serial',     '', '', '', '',
1084         'custnum',             'int',     '', '', '', '',
1085         'pkgpart',             'int',     '', '', '', '',
1086         'locationnum',         'int', 'NULL', '', '', '',
1087         'otaker',          'varchar',     '', 32, '', '',
1088         'start_date',     @date_type,             '', '',
1089         'setup',          @date_type,             '', '',
1090         'bill',           @date_type,             '', '',
1091         'last_bill',      @date_type,             '', '',
1092         'susp',           @date_type,             '', '',
1093         'adjourn',        @date_type,             '', '',
1094         'cancel',         @date_type,             '', '',
1095         'expire',         @date_type,             '', '',
1096         'change_date',    @date_type,             '', '',
1097         'change_pkgnum',       'int', 'NULL', '', '', '',
1098         'change_pkgpart',      'int', 'NULL', '', '', '',
1099         'change_locationnum',  'int', 'NULL', '', '', '',
1100         'manual_flag',        'char', 'NULL',  1, '', '',
1101         'quantity',            'int', 'NULL', '', '', '',
1102       ],
1103       'primary_key' => 'pkgnum',
1104       'unique' => [],
1105       'index' => [ ['custnum'], ['pkgpart'], [ 'locationnum' ],
1106                    [ 'start_date' ], ['setup'], ['last_bill'], ['bill'],
1107                    ['susp'], ['adjourn'], ['expire'], ['cancel'],
1108                    ['change_date'],
1109                  ],
1110     },
1111
1112     'cust_pkg_option' => {
1113       'columns' => [
1114         'optionnum', 'serial', '', '', '', '',
1115         'pkgnum', 'int', '', '', '', '',
1116         'optionname', 'varchar', '', $char_d, '', '',
1117         'optionvalue', 'text', 'NULL', '', '', '',
1118       ],
1119       'primary_key' => 'optionnum',
1120       'unique'      => [],
1121       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
1122     },
1123
1124     'cust_pkg_detail' => {
1125       'columns' => [
1126         'pkgdetailnum', 'serial', '',      '', '', '',
1127         'pkgnum',          'int', '',      '', '', '',
1128         'detail',      'varchar', '', $char_d, '', '',
1129         'detailtype',     'char', '',       1, '', '', # "I"nvoice or "C"omment
1130         'weight',          'int', '',      '', '', '',
1131       ],
1132       'primary_key' => 'pkgdetailnum',
1133       'unique' => [],
1134       'index'  => [ [ 'pkgnum', 'detailtype' ] ],
1135     },
1136
1137     'cust_pkg_reason' => {
1138       'columns' => [
1139         'num',      'serial',    '',   '', '', '',
1140         'pkgnum',   'int',    '',   '', '', '',
1141         'reasonnum','int',    '',   '', '', '',
1142         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
1143         'otaker',   'varchar', '', 32, '', '',
1144         'date',     @date_type, '', '',
1145       ],
1146       'primary_key' => 'num',
1147       'unique' => [],
1148       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], ],
1149     },
1150
1151     'cust_refund' => {
1152       'columns' => [
1153         'refundnum',    'serial',    '',   '', '', '',
1154         'custnum',  'int',    '',   '', '', '',
1155         '_date',        @date_type, '', '',
1156         'refund',       @money_type, '', '',
1157         'otaker',       'varchar',   '',   32, '', '',
1158         'reason',       'varchar',   '',   $char_d, '', '',
1159         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
1160                                                      # be index into payby
1161                                                      # table eventually
1162         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
1163         'paymask', 'varchar', 'NULL', $char_d, '', '',
1164         'paybatch',     'varchar',   'NULL', $char_d, '', '',
1165         'closed',    'char', 'NULL', 1, '', '',
1166       ],
1167       'primary_key' => 'refundnum',
1168       'unique' => [],
1169       'index' => [ ['custnum'], ['_date'] ],
1170     },
1171
1172     'cust_credit_refund' => {
1173       'columns' => [
1174         'creditrefundnum', 'serial',     '',   '', '', '',
1175         'crednum',  'int',     '',   '', '', '',
1176         'refundnum',  'int',     '',   '', '', '',
1177         'amount',  @money_type, '', '',
1178         '_date',   @date_type, '', '',
1179       ],
1180       'primary_key' => 'creditrefundnum',
1181       'unique' => [],
1182       'index' => [ ['crednum'], ['refundnum'] ],
1183     },
1184
1185
1186     'cust_svc' => {
1187       'columns' => [
1188         'svcnum',    'serial',    '',   '', '', '',
1189         'pkgnum',    'int',    'NULL',   '', '', '',
1190         'svcpart',   'int',    '',   '', '', '',
1191         'overlimit', @date_type, '', '',
1192       ],
1193       'primary_key' => 'svcnum',
1194       'unique' => [],
1195       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1196     },
1197
1198     'cust_svc_option' => {
1199       'columns' => [
1200         'optionnum',   'serial', '', '', '', '',
1201         'svcnum',      'int', '', '', '', '',
1202         'optionname',  'varchar', '', $char_d, '', '',
1203         'optionvalue', 'text', 'NULL', '', '', '',
1204       ],
1205       'primary_key' => 'optionnum',
1206       'unique'      => [],
1207       'index'       => [ [ 'svcnum' ], [ 'optionname' ] ],
1208     },
1209
1210     'part_pkg' => {
1211       'columns' => [
1212         'pkgpart',       'serial',    '',   '', '', '',
1213         'pkg',           'varchar',   '',   $char_d, '', '',
1214         'comment',       'varchar',   '',   $char_d, '', '',
1215         'promo_code',    'varchar', 'NULL', $char_d, '', '',
1216         'setup',         @perl_type, '', '',
1217         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
1218         'recur',         @perl_type, '', '',
1219         'setuptax',      'char', 'NULL', 1, '', '',
1220         'recurtax',      'char', 'NULL', 1, '', '',
1221         'plan',          'varchar', 'NULL', $char_d, '', '',
1222         'plandata',      'text', 'NULL', '', '', '',
1223         'disabled',      'char', 'NULL', 1, '', '',
1224         'custom',        'char', 'NULL', 1, '', '',
1225         'taxclass',      'varchar', 'NULL', $char_d, '', '',
1226         'classnum',      'int',     'NULL', '', '', '',
1227         'taxproductnum', 'int',     'NULL', '', '', '',
1228         'setup_cost',    @money_typen,          '', '',
1229         'recur_cost',    @money_typen,          '', '',
1230         'pay_weight',    'real',    'NULL', '', '', '',
1231         'credit_weight', 'real',    'NULL', '', '', '',
1232         'agentnum',      'int',     'NULL', '', '', '',
1233
1234       ],
1235       'primary_key' => 'pkgpart',
1236       'unique' => [],
1237       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
1238     },
1239
1240     'part_pkg_link' => {
1241       'columns' => [
1242         'pkglinknum',  'serial',  '',      '', '', '',
1243         'src_pkgpart', 'int',     '',      '', '', '',
1244         'dst_pkgpart', 'int',     '',      '', '', '',
1245         'link_type',   'varchar', '', $char_d, '', '',
1246       ],
1247       'primary_key' => 'pkglinknum',
1248       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type' ] ],
1249       'index'  => [ [ 'src_pkgpart' ] ],
1250     },
1251
1252     'part_pkg_taxclass' => {
1253       'columns' => [
1254         'taxclassnum',  'serial', '',       '', '', '',
1255         'taxclass',     'varchar', '', $char_d, '', '',
1256       ],
1257       'primary_key' => 'taxclassnum',
1258       'unique'      => [ [ 'taxclass' ] ],
1259       'index'       => [],
1260     },
1261
1262     'part_pkg_taxproduct' => {
1263       'columns' => [
1264         'taxproductnum', 'serial',      '',        '', '', '',
1265         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
1266         'taxproduct',    'varchar',     '',   $char_d, '', '',
1267         'description',   'varchar',     '', 3*$char_d, '', '',
1268       ],
1269       'primary_key' => 'taxproductnum',
1270       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
1271       'index'       => [],
1272     },
1273
1274     'part_pkg_taxrate' => {
1275       'columns' => [
1276         'pkgtaxratenum', 'serial',  '',     '',      '', '',
1277         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
1278         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
1279         'taxproductnum', 'int',  '',     '',       '', '',
1280         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
1281         'county',           'varchar', 'NULL', $char_d, '', '',
1282         'state',            'varchar', 'NULL', $char_d, '', '',
1283         'local',            'varchar', 'NULL', $char_d, '', '',
1284         'country',          'char',    'NULL', 2,       '', '',
1285         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
1286         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
1287         'taxclassnum',      'int',     'NULL', '',      '', '',
1288         'effdate',          @date_type, '', '',
1289         'taxable',          'char',    'NULL', 1,       '', '',
1290       ],
1291       'primary_key' => 'pkgtaxratenum',
1292       'unique' => [],
1293       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1294     },
1295
1296     'part_pkg_taxoverride' => {
1297       'columns' => [
1298         'taxoverridenum', 'serial', '', '', '', '',
1299         'pkgpart',        'serial', '', '', '', '',
1300         'taxclassnum',    'serial', '', '', '', '',
1301         'usage_class',    'varchar', 'NULL', $char_d, '', '',
1302       ],
1303       'primary_key' => 'taxoverridenum',
1304       'unique' => [],
1305       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1306     },
1307
1308 #    'part_title' => {
1309 #      'columns' => [
1310 #        'titlenum',   'int',    '',   '',
1311 #        'title',      'varchar',   '',   $char_d,
1312 #      ],
1313 #      'primary_key' => 'titlenum',
1314 #      'unique' => [ [] ],
1315 #      'index' => [ [] ],
1316 #    },
1317
1318     'pkg_svc' => {
1319       'columns' => [
1320         'pkgsvcnum',  'serial', '',  '', '', '',
1321         'pkgpart',    'int',    '',   '', '', '',
1322         'svcpart',    'int',    '',   '', '', '',
1323         'quantity',   'int',    '',   '', '', '',
1324         'primary_svc','char', 'NULL',  1, '', '',
1325       ],
1326       'primary_key' => 'pkgsvcnum',
1327       'unique' => [ ['pkgpart', 'svcpart'] ],
1328       'index' => [ ['pkgpart'], ['quantity'] ],
1329     },
1330
1331     'part_referral' => {
1332       'columns' => [
1333         'refnum',   'serial',     '',        '', '', '',
1334         'referral', 'varchar',    '',   $char_d, '', '',
1335         'disabled', 'char',   'NULL',         1, '', '',
1336         'agentnum', 'int',    'NULL',        '', '', '',
1337       ],
1338       'primary_key' => 'refnum',
1339       'unique' => [],
1340       'index' => [ ['disabled'], ['agentnum'], ],
1341     },
1342
1343     'part_svc' => {
1344       'columns' => [
1345         'svcpart',    'serial',    '',   '', '', '',
1346         'svc',        'varchar',   '',   $char_d, '', '',
1347         'svcdb',      'varchar',   '',   $char_d, '', '',
1348         'disabled',   'char',  'NULL',   1, '', '',
1349       ],
1350       'primary_key' => 'svcpart',
1351       'unique' => [],
1352       'index' => [ [ 'disabled' ] ],
1353     },
1354
1355     'part_svc_column' => {
1356       'columns' => [
1357         'columnnum',   'serial',         '', '', '', '',
1358         'svcpart',     'int',         '', '', '', '',
1359         'columnname',  'varchar',     '', 64, '', '',
1360         'columnlabel', 'varchar', 'NULL', $char_d, '', '',
1361         'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1362         'columnflag',  'char',    'NULL', 1, '', '',
1363       ],
1364       'primary_key' => 'columnnum',
1365       'unique' => [ [ 'svcpart', 'columnname' ] ],
1366       'index' => [ [ 'svcpart' ] ],
1367     },
1368
1369     #(this should be renamed to part_pop)
1370     'svc_acct_pop' => {
1371       'columns' => [
1372         'popnum',    'serial',    '',   '', '', '',
1373         'city',      'varchar',   '',   $char_d, '', '',
1374         'state',     'varchar',   '',   $char_d, '', '',
1375         'ac',        'char',   '',   3, '', '',
1376         'exch',      'char',   '',   3, '', '',
1377         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
1378       ],
1379       'primary_key' => 'popnum',
1380       'unique' => [],
1381       'index' => [ [ 'state' ] ],
1382     },
1383
1384     'part_pop_local' => {
1385       'columns' => [
1386         'localnum',  'serial',     '',     '', '', '',
1387         'popnum',    'int',     '',     '', '', '',
1388         'city',      'varchar', 'NULL', $char_d, '', '',
1389         'state',     'char',    'NULL', 2, '', '',
1390         'npa',       'char',    '',     3, '', '',
1391         'nxx',       'char',    '',     3, '', '',
1392       ],
1393       'primary_key' => 'localnum',
1394       'unique' => [],
1395       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1396     },
1397
1398     'svc_acct' => {
1399       'columns' => [
1400         'svcnum',    'int',    '',   '', '', '',
1401         'username',  'varchar',   '',   $username_len, '', '',
1402         '_password', 'varchar',   '',  512, '', '',
1403         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1404         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
1405         'popnum',    'int',    'NULL',   '', '', '',
1406         'uid',       'int', 'NULL',   '', '', '',
1407         'gid',       'int', 'NULL',   '', '', '',
1408         'finger',    'varchar',   'NULL',   $char_d, '', '',
1409         'dir',       'varchar',   'NULL',   $char_d, '', '',
1410         'shell',     'varchar',   'NULL',   $char_d, '', '',
1411         'quota',     'varchar',   'NULL',   $char_d, '', '',
1412         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
1413         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
1414         'seconds_threshold',   'int', 'NULL',   '', '', '',
1415         'upbytes',   'bigint', 'NULL',   '', '', '',
1416         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
1417         'downbytes', 'bigint', 'NULL',   '', '', '',
1418         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
1419         'totalbytes','bigint', 'NULL',   '', '', '',
1420         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
1421         'domsvc',    'int', '',   '', '', '',
1422         'last_login',  @date_type, '', '',
1423         'last_logout', @date_type, '', '',
1424       ],
1425       'primary_key' => 'svcnum',
1426       #'unique' => [ [ 'username', 'domsvc' ] ],
1427       'unique' => [],
1428       'index' => [ ['username'], ['domsvc'] ],
1429     },
1430
1431     'acct_rt_transaction' => {
1432       'columns' => [
1433         'svcrtid',   'int',    '',   '', '', '',
1434         'svcnum',    'int',    '',   '', '', '',
1435         'transaction_id',       'int', '',   '', '', '',
1436         '_date',   @date_type, '', '',
1437         'seconds',   'int', '',   '', '', '', #uhhhh
1438         'support',   'int', '',   '', '', '',
1439       ],
1440       'primary_key' => 'svcrtid',
1441       'unique' => [],
1442       'index' => [ ['svcnum', 'transaction_id'] ],
1443     },
1444
1445     #'svc_charge' => {
1446     #  'columns' => [
1447     #    'svcnum',    'int',    '',   '',
1448     #    'amount',    @money_type,
1449     #  ],
1450     #  'primary_key' => 'svcnum',
1451     #  'unique' => [ [] ],
1452     #  'index' => [ [] ],
1453     #},
1454
1455     'svc_domain' => {
1456       'columns' => [
1457         'svcnum',           'int',    '',        '', '', '',
1458         'domain',       'varchar',    '',   $char_d, '', '',
1459         'suffix',       'varchar', 'NULL',  $char_d, '', '',
1460         'catchall',         'int', 'NULL',       '', '', '',
1461         'parent_svcnum',    'int', 'NULL',       '', '', '',
1462         'registrarnum',     'int', 'NULL',       '', '', '',
1463         'registrarkey', 'varchar', 'NULL',      512, '', '',
1464         'setup_date',  @date_type, '', '',
1465         'renewal_interval', 'int', 'NULL',       '', '', '',
1466         'expiration_date', @date_type, '', '',
1467       ],
1468       'primary_key' => 'svcnum',
1469       'unique' => [ ],
1470       'index' => [ ['domain'] ],
1471     },
1472
1473     'domain_record' => {
1474       'columns' => [
1475         'recnum',    'serial',     '',  '', '', '',
1476         'svcnum',    'int',     '',  '', '', '',
1477         'reczone',   'varchar', '',  255, '', '',
1478         'recaf',     'char',    '',  2, '', '',
1479         'rectype',   'varchar',    '',  5, '', '',
1480         'recdata',   'varchar', '',  255, '', '',
1481       ],
1482       'primary_key' => 'recnum',
1483       'unique'      => [],
1484       'index'       => [ ['svcnum'] ],
1485     },
1486
1487     'registrar' => {
1488       'columns' => [
1489         'registrarnum',   'serial', '',      '', '', '',
1490         'registrarname', 'varchar', '', $char_d, '', '',
1491       ],
1492       'primary_key' => 'registrarnum',
1493       'unique'      => [],
1494       'index'       => [],
1495     },
1496
1497     'svc_forward' => {
1498       'columns' => [
1499         'svcnum',   'int',            '',   '', '', '',
1500         'srcsvc',   'int',        'NULL',   '', '', '',
1501         'src',      'varchar',    'NULL',  255, '', '',
1502         'dstsvc',   'int',        'NULL',   '', '', '',
1503         'dst',      'varchar',    'NULL',  255, '', '',
1504       ],
1505       'primary_key' => 'svcnum',
1506       'unique'      => [],
1507       'index'       => [ ['srcsvc'], ['dstsvc'] ],
1508     },
1509
1510     'svc_www' => {
1511       'columns' => [
1512         'svcnum',   'int',      '',  '', '', '',
1513         'recnum',   'int',      '',  '', '', '',
1514         'usersvc',  'int',  'NULL',  '', '', '',
1515         'config',   'text', 'NULL',  '', '', '',
1516       ],
1517       'primary_key' => 'svcnum',
1518       'unique'      => [],
1519       'index'       => [],
1520     },
1521
1522     #'svc_wo' => {
1523     #  'columns' => [
1524     #    'svcnum',    'int',    '',   '',
1525     #    'svcnum',    'int',    '',   '',
1526     #    'svcnum',    'int',    '',   '',
1527     #    'worker',    'varchar',   '',   $char_d,
1528     #    '_date',     @date_type,
1529     #  ],
1530     #  'primary_key' => 'svcnum',
1531     #  'unique' => [ [] ],
1532     #  'index' => [ [] ],
1533     #},
1534
1535     'prepay_credit' => {
1536       'columns' => [
1537         'prepaynum',   'serial',     '',   '', '', '',
1538         'identifier',  'varchar', '', $char_d, '', '',
1539         'amount',      @money_type, '', '',
1540         'seconds',     'int',     'NULL', '', '', '',
1541         'upbytes',     'bigint',     'NULL', '', '', '',
1542         'downbytes',   'bigint',     'NULL', '', '', '',
1543         'totalbytes',  'bigint',     'NULL', '', '', '',
1544         'agentnum',    'int',     'NULL', '', '', '',
1545       ],
1546       'primary_key' => 'prepaynum',
1547       'unique'      => [ ['identifier'] ],
1548       'index'       => [],
1549     },
1550
1551     'port' => {
1552       'columns' => [
1553         'portnum',  'serial',     '',   '', '', '',
1554         'ip',       'varchar', 'NULL', 15, '', '',
1555         'nasport',  'int',     'NULL', '', '', '',
1556         'nasnum',   'int',     '',   '', '', '',
1557       ],
1558       'primary_key' => 'portnum',
1559       'unique'      => [],
1560       'index'       => [],
1561     },
1562
1563     'nas' => {
1564       'columns' => [
1565         'nasnum',   'serial',     '',    '', '', '',
1566         'nas',      'varchar', '',    $char_d, '', '',
1567         'nasip',    'varchar', '',    15, '', '',
1568         'nasfqdn',  'varchar', '',    $char_d, '', '',
1569         'last',     'int',     '',    '', '', '',
1570       ],
1571       'primary_key' => 'nasnum',
1572       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
1573       'index'       => [ [ 'last' ] ],
1574     },
1575
1576 #    'session' => {
1577 #      'columns' => [
1578 #        'sessionnum', 'serial',       '',   '', '', '',
1579 #        'portnum',    'int',       '',   '', '', '',
1580 #        'svcnum',     'int',       '',   '', '', '',
1581 #        'login',      @date_type, '', '',
1582 #        'logout',     @date_type, '', '',
1583 #      ],
1584 #      'primary_key' => 'sessionnum',
1585 #      'unique'      => [],
1586 #      'index'       => [ [ 'portnum' ] ],
1587 #    },
1588
1589     'queue' => {
1590       'columns' => [
1591         'jobnum',      'serial',     '',      '', '', '',
1592         'job',           'text',     '',      '', '', '',
1593         '_date',          'int',     '',      '', '', '',
1594         'status',     'varchar',     '', $char_d, '', '',
1595         'statustext',    'text', 'NULL',      '', '', '',
1596         'svcnum',         'int', 'NULL',      '', '', '',
1597         'custnum',        'int', 'NULL',      '', '', '',
1598         'secure',        'char', 'NULL',       1, '', '',
1599         'priority',       'int', 'NULL',      '', '', '',
1600       ],
1601       'primary_key' => 'jobnum',
1602       'unique'      => [],
1603       'index'       => [ [ 'secure' ], [ 'priority' ],
1604                          [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
1605                        ],
1606     },
1607
1608     'queue_arg' => {
1609       'columns' => [
1610         'argnum', 'serial', '', '', '', '',
1611         'jobnum', 'int', '', '', '', '',
1612         'arg', 'text', 'NULL', '', '', '',
1613       ],
1614       'primary_key' => 'argnum',
1615       'unique'      => [],
1616       'index'       => [ [ 'jobnum' ] ],
1617     },
1618
1619     'queue_depend' => {
1620       'columns' => [
1621         'dependnum', 'serial', '', '', '', '',
1622         'jobnum', 'int', '', '', '', '',
1623         'depend_jobnum', 'int', '', '', '', '',
1624       ],
1625       'primary_key' => 'dependnum',
1626       'unique'      => [],
1627       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1628     },
1629
1630     'export_svc' => {
1631       'columns' => [
1632         'exportsvcnum' => 'serial', '', '', '', '',
1633         'exportnum'    => 'int', '', '', '', '',
1634         'svcpart'      => 'int', '', '', '', '',
1635       ],
1636       'primary_key' => 'exportsvcnum',
1637       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
1638       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
1639     },
1640
1641     'part_export' => {
1642       'columns' => [
1643         'exportnum', 'serial', '', '', '', '',
1644         'machine', 'varchar', '', $char_d, '', '',
1645         'exporttype', 'varchar', '', $char_d, '', '',
1646         'nodomain',     'char', 'NULL', 1, '', '',
1647       ],
1648       'primary_key' => 'exportnum',
1649       'unique'      => [],
1650       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
1651     },
1652
1653     'part_export_option' => {
1654       'columns' => [
1655         'optionnum', 'serial', '', '', '', '',
1656         'exportnum', 'int', '', '', '', '',
1657         'optionname', 'varchar', '', $char_d, '', '',
1658         'optionvalue', 'text', 'NULL', '', '', '',
1659       ],
1660       'primary_key' => 'optionnum',
1661       'unique'      => [],
1662       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
1663     },
1664
1665     'radius_usergroup' => {
1666       'columns' => [
1667         'usergroupnum', 'serial', '', '', '', '',
1668         'svcnum',       'int', '', '', '', '',
1669         'groupname',    'varchar', '', $char_d, '', '',
1670       ],
1671       'primary_key' => 'usergroupnum',
1672       'unique'      => [],
1673       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
1674     },
1675
1676     'msgcat' => {
1677       'columns' => [
1678         'msgnum', 'serial', '', '', '', '',
1679         'msgcode', 'varchar', '', $char_d, '', '',
1680         'locale', 'varchar', '', 16, '', '',
1681         'msg', 'text', '', '', '', '',
1682       ],
1683       'primary_key' => 'msgnum',
1684       'unique'      => [ [ 'msgcode', 'locale' ] ],
1685       'index'       => [],
1686     },
1687
1688     'cust_tax_exempt' => {
1689       'columns' => [
1690         'exemptnum', 'serial', '', '', '', '',
1691         'custnum',   'int', '', '', '', '',
1692         'taxnum',    'int', '', '', '', '',
1693         'year',      'int', '', '', '', '',
1694         'month',     'int', '', '', '', '',
1695         'amount',   @money_type, '', '',
1696       ],
1697       'primary_key' => 'exemptnum',
1698       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1699       'index'       => [],
1700     },
1701
1702     'cust_tax_exempt_pkg' => {
1703       'columns' => [
1704         'exemptpkgnum',  'serial', '', '', '', '',
1705         #'custnum',      'int', '', '', '', ''
1706         'billpkgnum',   'int', '', '', '', '',
1707         'taxnum',       'int', '', '', '', '',
1708         'year',         'int', '', '', '', '',
1709         'month',        'int', '', '', '', '',
1710         'amount',       @money_type, '', '',
1711       ],
1712       'primary_key' => 'exemptpkgnum',
1713       'unique' => [],
1714       'index'  => [ [ 'taxnum', 'year', 'month' ],
1715                     [ 'billpkgnum' ],
1716                     [ 'taxnum' ]
1717                   ],
1718     },
1719
1720     'router' => {
1721       'columns' => [
1722         'routernum', 'serial', '', '', '', '',
1723         'routername', 'varchar', '', $char_d, '', '',
1724         'svcnum', 'int', 'NULL', '', '', '',
1725         'agentnum',   'int', 'NULL', '', '', '',
1726       ],
1727       'primary_key' => 'routernum',
1728       'unique'      => [],
1729       'index'       => [],
1730     },
1731
1732     'part_svc_router' => {
1733       'columns' => [
1734         'svcrouternum', 'serial', '', '', '', '',
1735         'svcpart', 'int', '', '', '', '',
1736         'routernum', 'int', '', '', '', '',
1737       ],
1738       'primary_key' => 'svcrouternum',
1739       'unique'      => [],
1740       'index'       => [],
1741     },
1742
1743     'addr_block' => {
1744       'columns' => [
1745         'blocknum', 'serial', '', '', '', '',
1746         'routernum', 'int', '', '', '', '',
1747         'ip_gateway', 'varchar', '', 15, '', '',
1748         'ip_netmask', 'int', '', '', '', '',
1749         'agentnum',   'int', 'NULL', '', '', '',
1750         'manual_flag', 'char', 'NULL', 1, '', '',
1751       ],
1752       'primary_key' => 'blocknum',
1753       'unique'      => [ [ 'blocknum', 'routernum' ] ],
1754       'index'       => [],
1755     },
1756
1757     'svc_broadband' => {
1758       'columns' => [
1759         'svcnum', 'int', '', '', '', '',
1760         'description', 'varchar', 'NULL', $char_d, '', '',
1761         'blocknum', 'int', '', '', '', '',
1762         'speed_up', 'int', '', '', '', '',
1763         'speed_down', 'int', '', '', '', '',
1764         'ip_addr', 'varchar', '', 15, '', '',
1765         'mac_addr', 'varchar', 'NULL', 12, '', '',
1766         'authkey',  'varchar', 'NULL', 32, '', '',
1767         'latitude', 'decimal', 'NULL', '', '', '',
1768         'longitude', 'decimal', 'NULL', '', '', '',
1769         'altitude', 'decimal', 'NULL', '', '', '',
1770         'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1771         'performance_profile', 'varchar', 'NULL', $char_d, '', '',
1772       ],
1773       'primary_key' => 'svcnum',
1774       'unique'      => [ [ 'mac_addr' ] ],
1775       'index'       => [],
1776     },
1777
1778     'part_virtual_field' => {
1779       'columns' => [
1780         'vfieldpart', 'serial', '', '', '', '',
1781         'dbtable', 'varchar', '', 32, '', '',
1782         'name', 'varchar', '', 32, '', '',
1783         'check_block', 'text', 'NULL', '', '', '',
1784         'length', 'int', 'NULL', '', '', '',
1785         'list_source', 'text', 'NULL', '', '', '',
1786         'label', 'varchar', 'NULL', 80, '', '',
1787       ],
1788       'primary_key' => 'vfieldpart',
1789       'unique' => [],
1790       'index' => [],
1791     },
1792
1793     'virtual_field' => {
1794       'columns' => [
1795         'vfieldnum', 'serial', '', '', '', '',
1796         'recnum', 'int', '', '', '', '',
1797         'vfieldpart', 'int', '', '', '', '',
1798         'value', 'varchar', '', 128, '', '',
1799       ],
1800       'primary_key' => 'vfieldnum',
1801       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1802       'index' => [],
1803     },
1804
1805     'acct_snarf' => {
1806       'columns' => [
1807         'snarfnum',  'int', '', '', '', '',
1808         'svcnum',    'int', '', '', '', '',
1809         'machine',   'varchar', '', 255, '', '',
1810         'protocol',  'varchar', '', $char_d, '', '',
1811         'username',  'varchar', '', $char_d, '', '',
1812         '_password', 'varchar', '', $char_d, '', '',
1813       ],
1814       'primary_key' => 'snarfnum',
1815       'unique' => [],
1816       'index'  => [ [ 'svcnum' ] ],
1817     },
1818
1819     'svc_external' => {
1820       'columns' => [
1821         'svcnum', 'int', '', '', '', '',
1822         'id',     'int', 'NULL', '', '', '',
1823         'title',  'varchar', 'NULL', $char_d, '', '',
1824       ],
1825       'primary_key' => 'svcnum',
1826       'unique'      => [],
1827       'index'       => [],
1828     },
1829
1830     'cust_pay_refund' => {
1831       'columns' => [
1832         'payrefundnum', 'serial', '', '', '', '',
1833         'paynum',  'int', '', '', '', '',
1834         'refundnum',  'int', '', '', '', '',
1835         '_date',    @date_type, '', '',
1836         'amount',   @money_type, '', '',
1837       ],
1838       'primary_key' => 'payrefundnum',
1839       'unique' => [],
1840       'index' => [ ['paynum'], ['refundnum'] ],
1841     },
1842
1843     'part_pkg_option' => {
1844       'columns' => [
1845         'optionnum', 'serial', '', '', '', '',
1846         'pkgpart', 'int', '', '', '', '',
1847         'optionname', 'varchar', '', $char_d, '', '',
1848         'optionvalue', 'text', 'NULL', '', '', '',
1849       ],
1850       'primary_key' => 'optionnum',
1851       'unique'      => [],
1852       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
1853     },
1854
1855     'part_pkg_report_option' => {
1856       'columns' => [
1857         'num',      'serial',   '',      '', '', '',
1858         'name',     'varchar',  '', $char_d, '', '',
1859         'disabled', 'char', 'NULL',       1, '', '',
1860       ],
1861       'primary_key' => 'num',
1862       'unique' => [ [ 'name' ] ],
1863       'index' => [ [ 'disabled' ] ],
1864     },
1865
1866     'rate' => {
1867       'columns' => [
1868         'ratenum',  'serial', '', '', '', '',
1869         'ratename', 'varchar', '', $char_d, '', '',
1870       ],
1871       'primary_key' => 'ratenum',
1872       'unique'      => [],
1873       'index'       => [],
1874     },
1875
1876     'rate_detail' => {
1877       'columns' => [
1878         'ratedetailnum',   'serial', '', '', '', '',
1879         'ratenum',         'int',     '', '', '', '',
1880         'orig_regionnum',  'int', 'NULL', '', '', '',
1881         'dest_regionnum',  'int',     '', '', '', '',
1882         'min_included',    'int',     '', '', '', '',
1883         #'min_charge',      @money_type, '', '',
1884         'min_charge',      'decimal', '', '10,5', '', '',
1885         'sec_granularity', 'int',     '', '', '', '',
1886         #time period (link to table of periods)?
1887         'classnum',        'int',     'NULL', '', '', '',
1888       ],
1889       'primary_key' => 'ratedetailnum',
1890       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1891       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
1892     },
1893
1894     'rate_region' => {
1895       'columns' => [
1896         'regionnum',   'serial',      '', '', '', '',
1897         'regionname',  'varchar',     '', $char_d, '', '',
1898       ],
1899       'primary_key' => 'regionnum',
1900       'unique'      => [],
1901       'index'       => [],
1902     },
1903
1904     'rate_prefix' => {
1905       'columns' => [
1906         'prefixnum',   'serial',      '', '', '', '',
1907         'regionnum',   'int',         '', '', '', '',
1908         'countrycode', 'varchar',     '',  3, '', '',
1909         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
1910         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
1911       ],
1912       'primary_key' => 'prefixnum',
1913       'unique'      => [],
1914       'index'       => [ [ 'countrycode' ], [ 'regionnum' ] ],
1915     },
1916
1917     'usage_class' => {
1918       'columns' => [
1919         'classnum',    'serial',   '',      '', '', '',
1920         'classname',   'varchar',  '', $char_d, '', '',
1921         'disabled',    'char', 'NULL',       1, '', '',
1922       ],
1923       'primary_key' => 'classnum',
1924       'unique' => [],
1925       'index' => [ ['disabled'] ],
1926     },
1927
1928     'reg_code' => {
1929       'columns' => [
1930         'codenum',   'serial',    '', '', '', '',
1931         'code',      'varchar',   '', $char_d, '', '',
1932         'agentnum',  'int',       '', '', '', '',
1933       ],
1934       'primary_key' => 'codenum',
1935       'unique'      => [ [ 'agentnum', 'code' ] ],
1936       'index'       => [ [ 'agentnum' ] ],
1937     },
1938
1939     'reg_code_pkg' => {
1940       'columns' => [
1941         'codepkgnum', 'serial', '', '', '', '',
1942         'codenum',   'int',    '', '', '', '',
1943         'pkgpart',   'int',    '', '', '', '',
1944       ],
1945       'primary_key' => 'codepkgnum',
1946       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
1947       'index'       => [ [ 'codenum' ] ],
1948     },
1949
1950     'clientapi_session' => {
1951       'columns' => [
1952         'sessionnum',  'serial',  '', '', '', '',
1953         'sessionid',  'varchar',  '', $char_d, '', '',
1954         'namespace',  'varchar',  '', $char_d, '', '',
1955       ],
1956       'primary_key' => 'sessionnum',
1957       'unique'      => [ [ 'sessionid', 'namespace' ] ],
1958       'index'       => [],
1959     },
1960
1961     'clientapi_session_field' => {
1962       'columns' => [
1963         'fieldnum',    'serial',     '', '', '', '',
1964         'sessionnum',     'int',     '', '', '', '',
1965         'fieldname',  'varchar',     '', $char_d, '', '',
1966         'fieldvalue',    'text', 'NULL', '', '', '',
1967       ],
1968       'primary_key' => 'fieldnum',
1969       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
1970       'index'       => [],
1971     },
1972
1973     'payment_gateway' => {
1974       'columns' => [
1975         'gatewaynum',       'serial',   '',     '', '', '',
1976         'gateway_namespace','varchar',  'NULL', $char_d, '', '',
1977         'gateway_module',   'varchar',  '',     $char_d, '', '',
1978         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
1979         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
1980         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
1981         'gateway_callback_url', 'varchar',  'NULL', $char_d, '', '',
1982         'disabled',   'char',  'NULL',   1, '', '',
1983       ],
1984       'primary_key' => 'gatewaynum',
1985       'unique' => [],
1986       'index'  => [ [ 'disabled' ] ],
1987     },
1988
1989     'payment_gateway_option' => {
1990       'columns' => [
1991         'optionnum',   'serial',  '',     '', '', '',
1992         'gatewaynum',  'int',     '',     '', '', '',
1993         'optionname',  'varchar', '',     $char_d, '', '',
1994         'optionvalue', 'text',    'NULL', '', '', '',
1995       ],
1996       'primary_key' => 'optionnum',
1997       'unique'      => [],
1998       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1999     },
2000
2001     'agent_payment_gateway' => {
2002       'columns' => [
2003         'agentgatewaynum', 'serial', '', '', '', '',
2004         'agentnum',        'int', '', '', '', '',
2005         'gatewaynum',      'int', '', '', '', '',
2006         'cardtype',        'varchar', 'NULL', $char_d, '', '',
2007         'taxclass',        'varchar', 'NULL', $char_d, '', '',
2008       ],
2009       'primary_key' => 'agentgatewaynum',
2010       'unique'      => [],
2011       'index'       => [ [ 'agentnum', 'cardtype' ], ],
2012     },
2013
2014     'banned_pay' => {
2015       'columns' => [
2016         'bannum',  'serial',   '',     '', '', '',
2017         'payby',   'char',     '',       4, '', '',
2018         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
2019         #'paymask', 'varchar',  'NULL', $char_d, '', ''
2020         '_date',   @date_type, '', '',
2021         'otaker',  'varchar',  '',     32, '', '',
2022         'reason',  'varchar',  'NULL', $char_d, '', '',
2023       ],
2024       'primary_key' => 'bannum',
2025       'unique'      => [ [ 'payby', 'payinfo' ] ],
2026       'index'       => [],
2027     },
2028
2029     'pkg_category' => {
2030       'columns' => [
2031         'categorynum',   'serial',  '', '', '', '',
2032         'categoryname',  'varchar', '', $char_d, '', '',
2033         'disabled',      'char', 'NULL',   1, '', '',
2034       ],
2035       'primary_key' => 'categorynum',
2036       'unique' => [],
2037       'index' => [ ['disabled'] ],
2038     },
2039
2040     'pkg_class' => {
2041       'columns' => [
2042         'classnum',    'serial',   '',      '', '', '',
2043         'classname',   'varchar',  '', $char_d, '', '',
2044         'categorynum', 'int',  'NULL',      '', '', '',
2045         'disabled',    'char', 'NULL',       1, '', '',
2046       ],
2047       'primary_key' => 'classnum',
2048       'unique' => [],
2049       'index' => [ ['disabled'] ],
2050     },
2051
2052     'cdr' => {
2053       'columns' => [
2054         # qw( name type null length default local );
2055
2056         ###
2057         #asterisk fields
2058         ###
2059
2060         'acctid',   'bigserial',  '', '', '', '',
2061         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
2062         'calldate', 'timestamp',   '',      '', \'now()', '',
2063         'clid',        'varchar',  '', $char_d, \"''", '',
2064         'src',         'varchar',  '', $char_d, \"''", '',
2065         'dst',         'varchar',  '', $char_d, \"''", '',
2066         'dcontext',    'varchar',  '', $char_d, \"''", '',
2067         'channel',     'varchar',  '', $char_d, \"''", '',
2068         'dstchannel',  'varchar',  '', $char_d, \"''", '',
2069         'lastapp',     'varchar',  '', $char_d, \"''", '',
2070         'lastdata',    'varchar',  '', $char_d, \"''", '',
2071
2072         #these don't seem to be logged by most of the SQL cdr_* modules
2073         #except tds under sql-illegal names, so;
2074         # ... don't rely on them for rating?
2075         # and, what they hey, i went ahead and changed the names and data types
2076         # to freeside-style dates...
2077           #'start',  'timestamp', 'NULL',  '',    '', '',
2078           #'answer', 'timestamp', 'NULL',  '',    '', '',
2079           #'end',    'timestamp', 'NULL',  '',    '', '',
2080         'startdate',  @date_type, '', '',
2081         'answerdate', @date_type, '', '',
2082         'enddate',    @date_type, '', '',
2083         #
2084
2085         'duration',    'int',      '',      '',     0, '',
2086         'billsec',     'int',      '',      '',     0, '',
2087         'disposition', 'varchar',  '',      45, \"''", '',
2088         'amaflags',    'int',      '',      '',     0, '',
2089         'accountcode', 'varchar',  '',      20, \"''", '',
2090         'uniqueid',    'varchar',  '',      32, \"''", '',
2091         'userfield',   'varchar',  '',     255, \"''", '',
2092
2093         ###
2094         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
2095         # defaults
2096         ###
2097
2098         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
2099         'cdrtypenum',              'int', 'NULL',      '', '', '',
2100
2101         'charged_party',       'varchar', 'NULL', $char_d, '', '',
2102
2103         'upstream_currency',      'char', 'NULL',       3, '', '',
2104         'upstream_price',      'decimal', 'NULL',  '10,2', '', '',
2105         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
2106
2107         # how it was rated internally...
2108         'ratedetailnum',           'int', 'NULL',      '', '', '',
2109         'rated_price',         'decimal', 'NULL',  '10,2', '', '',
2110
2111         'distance',            'decimal', 'NULL',      '', '', '',
2112         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
2113
2114         #cdr_calltype: the big list in appendix 2
2115         'calltypenum',             'int', 'NULL',      '', '', '',
2116
2117         'description',         'varchar', 'NULL', $char_d, '', '',
2118         'quantity',                'int', 'NULL',      '', '', '',
2119
2120         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
2121         'carrierid',               'int', 'NULL',      '', '', '',
2122
2123         'upstream_rateid',         'int', 'NULL',      '', '', '',
2124
2125         ###
2126         #and now for our own fields
2127         ###
2128
2129         # a svcnum... right..?
2130         'svcnum',             'int',   'NULL',     '',   '', '',
2131
2132         #NULL, done (or something)
2133         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
2134
2135         #NULL, done (or something)
2136         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '',
2137
2138         'cdrbatch', 'varchar', 'NULL', 255, '', '',
2139
2140       ],
2141       'primary_key' => 'acctid',
2142       'unique' => [],
2143       'index' => [ [ 'calldate' ], [ 'src' ], [ 'dst' ], [ 'charged_party' ], [ 'accountcode' ], [ 'freesidestatus' ], [ 'freesiderewritestatus' ], [ 'cdrbatch' ], ],
2144     },
2145
2146     'cdr_calltype' => {
2147       'columns' => [
2148         'calltypenum',   'serial',  '', '', '', '',
2149         'calltypename',  'varchar', '', $char_d, '', '',
2150       ],
2151       'primary_key' => 'calltypenum',
2152       'unique'      => [],
2153       'index'       => [],
2154     },
2155
2156     'cdr_type' => {
2157       'columns' => [
2158         'cdrtypenum'  => 'serial',  '', '', '', '',
2159         'cdrtypename' => 'varchar', '', $char_d, '', '',
2160       ],
2161       'primary_key' => 'cdrtypenum',
2162       'unique'      => [],
2163       'index'       => [],
2164     },
2165
2166     'cdr_carrier' => {
2167       'columns' => [
2168         'carrierid'   => 'serial',  '', '', '', '',
2169         'carriername' => 'varchar', '', $char_d, '', '',
2170       ],
2171       'primary_key' => 'carrierid',
2172       'unique'      => [],
2173       'index'       => [],
2174     },
2175
2176     #map upstream rateid to ours...
2177     'cdr_upstream_rate' => {
2178       'columns' => [
2179         'upstreamratenum', 'serial',  '', '', '', '',
2180         'upstream_rateid', 'varchar', '', $char_d, '', '',
2181         'ratedetailnum',   'int', 'NULL', '', '', '',
2182       ],
2183       'primary_key' => 'upstreamratenum', #XXX need a primary key
2184       'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
2185       'index'  => [],
2186     },
2187
2188     #'cdr_file' => {
2189     #  'columns' => [
2190     #    'filenum',    'serial',     '', '', '', '',
2191     #    'filename',  'varchar',     '', '', '', '',
2192     #    'status',    'varchar', 'NULL', '', '', '',
2193     #  ],
2194     #  'primary_key' => 'filenum',
2195     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
2196     #                                   # agent-virtualize or have a customer
2197     #                                   # with dup-filename needs or something
2198     #                                   # (only used by cdr.http_and_import for
2199     #                                   #  chrissakes)
2200     #  'index'  => [],
2201     #},
2202
2203     'inventory_item' => {
2204       'columns' => [
2205         'itemnum',  'serial',      '',      '', '', '',
2206         'classnum', 'int',         '',      '', '', '',
2207         'item',     'varchar',     '', $char_d, '', '',
2208         'svcnum',   'int',     'NULL',      '', '', '',
2209       ],
2210       'primary_key' => 'itemnum',
2211       'unique' => [ [ 'classnum', 'item' ] ],
2212       'index'  => [ [ 'classnum' ], [ 'svcnum' ] ],
2213     },
2214
2215     'inventory_class' => {
2216       'columns' => [
2217         'classnum',  'serial',       '',      '', '', '',
2218         'classname', 'varchar',      '', $char_d, '', '',
2219       ],
2220       'primary_key' => 'classnum',
2221       'unique' => [],
2222       'index'  => [],
2223     },
2224
2225     'access_user' => {
2226       'columns' => [
2227         'usernum',   'serial',  '',      '', '', '',
2228         'username',  'varchar', '', $char_d, '', '',
2229         '_password', 'varchar', '', $char_d, '', '',
2230         'last',      'varchar', '', $char_d, '', '',
2231         'first',     'varchar', '', $char_d, '', '',
2232         'disabled',     'char', 'NULL',   1, '', '',
2233       ],
2234       'primary_key' => 'usernum',
2235       'unique' => [ [ 'username' ] ],
2236       'index'  => [],
2237     },
2238
2239     'access_user_pref' => {
2240       'columns' => [
2241         'prefnum',    'serial',       '', '', '', '',
2242         'usernum',     'int',       '', '', '', '',
2243         'prefname', 'varchar', '', $char_d, '', '',
2244         'prefvalue', 'text', 'NULL', '', '', '',
2245         'expiration', @date_type, '', '',
2246       ],
2247       'primary_key' => 'prefnum',
2248       'unique' => [],
2249       'index'  => [ [ 'usernum' ] ],
2250     },
2251
2252     'access_group' => {
2253       'columns' => [
2254         'groupnum',   'serial', '',      '', '', '',
2255         'groupname', 'varchar', '', $char_d, '', '',
2256       ],
2257       'primary_key' => 'groupnum',
2258       'unique' => [ [ 'groupname' ] ],
2259       'index'  => [],
2260     },
2261
2262     'access_usergroup' => {
2263       'columns' => [
2264         'usergroupnum', 'serial', '', '', '', '',
2265         'usernum',         'int', '', '', '', '',
2266         'groupnum',        'int', '', '', '', '',
2267       ],
2268       'primary_key' => 'usergroupnum',
2269       'unique' => [ [ 'usernum', 'groupnum' ] ],
2270       'index'  => [ [ 'usernum' ] ],
2271     },
2272
2273     'access_groupagent' => {
2274       'columns' => [
2275         'groupagentnum', 'serial', '', '', '', '',
2276         'groupnum',         'int', '', '', '', '',
2277         'agentnum',         'int', '', '', '', '',
2278       ],
2279       'primary_key' => 'groupagentnum',
2280       'unique' => [ [ 'groupnum', 'agentnum' ] ],
2281       'index'  => [ [ 'groupnum' ] ],
2282     },
2283
2284     'access_right' => {
2285       'columns' => [
2286         'rightnum',   'serial', '',      '', '', '',
2287         'righttype', 'varchar', '', $char_d, '', '',
2288         'rightobjnum',   'int', '',      '', '', '',
2289         'rightname', 'varchar', '', $char_d, '', '',
2290       ],
2291       'primary_key' => 'rightnum',
2292       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2293       'index'  => [],
2294     },
2295
2296     'svc_phone' => {
2297       'columns' => [
2298         'svcnum',       'int',         '',      '', '', '',
2299         'countrycode',  'varchar',     '',       3, '', '',
2300         'phonenum',     'varchar',     '',      15, '', '',  #12 ?
2301         'pin',          'varchar', 'NULL', $char_d, '', '',
2302         'sip_password', 'varchar', 'NULL', $char_d, '', '',
2303         'phone_name',   'varchar', 'NULL', $char_d, '', '',
2304       ],
2305       'primary_key' => 'svcnum',
2306       'unique' => [],
2307       'index'  => [ [ 'countrycode', 'phonenum' ] ],
2308     },
2309
2310     'phone_device' => {
2311       'columns' => [
2312         'devicenum', 'serial',     '', '', '', '',
2313         'devicepart',   'int',     '', '', '', '',
2314         'svcnum',       'int',     '', '', '', '',
2315         'mac_addr', 'varchar', 'NULL', 12, '', '',
2316       ],
2317       'primary_key' => 'devicenum',
2318       'unique' => [ [ 'mac_addr' ], ],
2319       'index'  => [ [ 'devicepart' ], [ 'svcnum' ], ],
2320     },
2321
2322     'part_device' => {
2323       'columns' => [
2324         'devicepart', 'serial',  '',      '', '', '',
2325         'devicename', 'varchar', '', $char_d, '', '',
2326         #'classnum', #tie to an inventory class?
2327       ],
2328       'primary_key' => 'devicepart',
2329       'unique' => [ [ 'devicename' ] ], #?
2330       'index'  => [],
2331     },
2332
2333     'phone_avail' => {
2334       'columns' => [
2335         'availnum',    'serial',      '',      '', '', '',
2336         'exportnum',   'int',         '',      '', '', '',
2337         'countrycode', 'varchar',     '',       3, '', '',
2338         'state',       'char',    'NULL',       2, '', '',
2339         'npa',         'char',        '',       3, '', '',
2340         'nxx',         'char',    'NULL',       3, '', '',
2341         'station',     'char',    'NULL',       4, '', '',
2342         'name',        'varchar', 'NULL', $char_d, '', '',
2343         'svcnum',      'int',     'NULL',      '', '', '',
2344         'availbatch', 'varchar',  'NULL', $char_d, '', '',
2345       ],
2346       'primary_key' => 'availnum',
2347       'unique' => [],
2348       'index'  => [ [ 'exportnum', 'countrycode', 'state' ],     #npa search
2349                     [ 'exportnum', 'countrycode', 'npa' ],       #nxx search
2350                     [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
2351                     [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
2352                     [ 'svcnum' ],
2353                     [ 'availbatch' ],
2354                   ],
2355     },
2356
2357     'reason_type' => {
2358       'columns' => [
2359         'typenum',   'serial',  '', '', '', '',
2360         'class',     'char', '', 1, '', '',
2361         'type',     'varchar', '', $char_d, '', '',
2362       ],
2363       'primary_key' => 'typenum',
2364       'unique' => [],
2365       'index' => [],
2366     },
2367
2368     'reason' => {
2369       'columns' => [
2370         'reasonnum',     'serial',  '', '', '', '',
2371         'reason_type',   'int',  '', '', '', '',
2372         'reason',        'text', '', '', '', '',
2373         'disabled',      'char',    'NULL', 1, '', '',
2374       ],
2375       'primary_key' => 'reasonnum',
2376       'unique' => [],
2377       'index' => [],
2378     },
2379
2380     'conf' => {
2381       'columns' => [
2382         'confnum',  'serial',  '', '', '', '',
2383         'agentnum', 'int',  'NULL', '', '', '',
2384         'name',     'varchar', '', $char_d, '', '',
2385         'value',    'text', 'NULL', '', '', '',
2386       ],
2387       'primary_key' => 'confnum',
2388       'unique' => [ [ 'agentnum', 'name' ]],
2389       'index' => [],
2390     },
2391
2392     'pkg_referral' => {
2393       'columns' => [
2394         'pkgrefnum',     'serial', '', '', '', '',
2395         'pkgnum',        'int',    '', '', '', '',
2396         'refnum',        'int',    '', '', '', '',
2397       ],
2398       'primary_key' => 'pkgrefnum',
2399       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
2400       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
2401     },
2402     # name type nullability length default local
2403
2404     #'new_table' => {
2405     #  'columns' => [
2406     #    'num', 'serial',       '', '', '', '',
2407     #  ],
2408     #  'primary_key' => 'num',
2409     #  'unique' => [],
2410     #  'index'  => [],
2411     #},
2412
2413   };
2414
2415 }
2416
2417 =back
2418
2419 =head1 BUGS
2420
2421 =head1 SEE ALSO
2422
2423 L<DBIx::DBSchema>
2424
2425 =cut
2426
2427 1;
2428