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