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