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       #can be removed once we depend on DBIx::DBSchema 0.39;
 106       $hash{'type'} = 'LONGTEXT'
 107         if $hash{'type'} =~ /^TEXT$/i && $datasrc =~ /^dbi:mysql/i;
 108
 109       unless ( defined $hash{'default'} ) {
 110         warn "$tablename:\n".
 111              join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
 112       }
 113
 114       push @columns, new DBIx::DBSchema::Column ( \%hash );
 115     }
 116
 117     #false laziness w/sub indices in DBIx::DBSchema::DBD (well, sorta)
 118     #and sub sql_create_table in DBIx::DBSchema::Table (slighty more?)
 119     my $unique = $tables_hashref->{$tablename}{'unique'};
 120     warn "missing index for $tablename\n" unless defined $tables_hashref->{$tablename}{'index'};
 121     my @index  = @{ $tables_hashref->{$tablename}{'index'} };
 122
 123     # kludge to avoid avoid "BLOB/TEXT column 'statustext' used in key
 124     #  specification without a key length".
 125     # better solution: teach DBIx::DBSchema to specify a default length for
 126     #  MySQL indices on text columns, or just to support an index length at all
 127     #  so we can pass something in.
 128     # best solution: eliminate need for this index in cust_main::retry_realtime
 129     @index = grep { @{$_}[0] ne 'statustext' } @index
 130       if $datasrc =~ /^dbi:mysql/i;
 131
 132     my @indices = ();
 133     push @indices, map {
 134                          DBIx::DBSchema::Index->new({
 135                            'name'    => $tablename. $indexnum++,
 136                            'unique'  => 1,
 137                            'columns' => $_,
 138                          });
 139                        }
 140                        @$unique;
 141     push @indices, map {
 142                          DBIx::DBSchema::Index->new({
 143                            'name'    => $tablename. $indexnum++,
 144                            'unique'  => 0,
 145                            'columns' => $_,
 146                          });
 147                        }
 148                        @index;
 149
 150     DBIx::DBSchema::Table->new({
 151       'name'          => $tablename,
 152       'primary_key'   => $tables_hashref->{$tablename}{'primary_key'},
 153       'columns'       => \@columns,
 154       'indices'       => \@indices,
 155       'local_options' => $local_options,
 156     });
 157
 158   } keys %$tables_hashref;
 159
 160   if ( $DEBUG ) {
 161     warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
 162     warn "[debug]$me   $_\n" foreach $dbdef->tables;
 163   }
 164
 165   #add radius attributes to svc_acct
 166   #
 167   #my($svc_acct)=$dbdef->table('svc_acct');
 168   #
 169   #my($attribute);
 170   #foreach $attribute (@attributes) {
 171   #  $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
 172   #    'radius_'. $attribute,
 173   #    'varchar',
 174   #    'NULL',
 175   #    $char_d,
 176   #  ));
 177   #}
 178   #
 179   #foreach $attribute (@check_attributes) {
 180   #  $svc_acct->addcolumn( new DBIx::DBSchema::Column (
 181   #    'rc_'. $attribute,
 182   #    'varchar',
 183   #    'NULL',
 184   #    $char_d,
 185   #  ));
 186   #}
 187
 188   my $tables_hashref_torrus = tables_hashref_torrus();
 189
 190   #create history tables (false laziness w/create-history-tables)
 191   foreach my $table (
 192     grep {    ! /^clientapi_session/
 193            && ! /^h_/
 194            && ! $tables_hashref_torrus->{$_}
 195          }
 196       $dbdef->tables
 197   ) {
 198     my $tableobj = $dbdef->table($table)
 199       or die "unknown table $table";
 200
 201     my %h_indices = ();
 202
 203     unless ( $table eq 'cust_event' ) { #others?
 204
 205       my %indices = $tableobj->indices;
 206
 207       %h_indices = map {
 208                          ( "h_$_" =>
 209                              DBIx::DBSchema::Index->new({
 210                                'name'    => 'h_'. $indices{$_}->name,
 211                                'unique'  => 0,
 212                                'columns' => [ @{$indices{$_}->columns} ],
 213                              })
 214                          );
 215                        }
 216                        keys %indices;
 217
 218       $h_indices{"h_${table}_srckey"} =
 219         DBIx::DBSchema::Index->new({
 220           'name'    => "h_${table}_srckey",
 221           'unique'  => 0,
 222           'columns' => [ 'history_action', #right?
 223                          $tableobj->primary_key,
 224                        ],
 225         });
 226
 227       $h_indices{"h_${table}_srckey2"} =
 228          DBIx::DBSchema::Index->new({
 229            'name'    => "h_${table}_srckey2",
 230            'unique'  => 0,
 231            'columns' => [ 'history_date',
 232                           $tableobj->primary_key,
 233                         ],
 234          });
 235
 236     }
 237
 238     my $h_tableobj = DBIx::DBSchema::Table->new( {
 239       'name'          => "h_$table",
 240       'primary_key'   => 'historynum',
 241       'indices'       => \%h_indices,
 242       'local_options' => $local_options,
 243       'columns'       => [
 244           DBIx::DBSchema::Column->new( {
 245             'name'    => 'historynum',
 246             'type'    => 'serial',
 247             'null'    => 'NOT NULL',
 248             'length'  => '',
 249             'default' => '',
 250             'local'   => '',
 251           } ),
 252           DBIx::DBSchema::Column->new( {
 253             'name'    => 'history_date',
 254             'type'    => 'int',
 255             'null'    => 'NULL',
 256             'length'  => '',
 257             'default' => '',
 258             'local'   => '',
 259           } ),
 260           DBIx::DBSchema::Column->new( {
 261             'name'    => 'history_user',
 262             'type'    => 'varchar',
 263             'null'    => 'NOT NULL',
 264             'length'  => '80',
 265             'default' => '',
 266             'local'   => '',
 267           } ),
 268           DBIx::DBSchema::Column->new( {
 269             'name'    => 'history_action',
 270             'type'    => 'varchar',
 271             'null'    => 'NOT NULL',
 272             'length'  => '80',
 273             'default' => '',
 274             'local'   => '',
 275           } ),
 276           map {
 277             my $column = $tableobj->column($_);
 278
 279             #clone so as to not disturb the original
 280             $column = DBIx::DBSchema::Column->new( {
 281               map { $_ => $column->$_() }
 282                 qw( name type null length default local )
 283             } );
 284
 285             if ( $column->type =~ /^(\w*)SERIAL$/i ) {
 286               $column->type(uc($1).'INT');
 287               $column->null('NULL');
 288             }
 289             #$column->default('')
 290             #  if $column->default =~ /^nextval\(/i;
 291             #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
 292             #$column->local($local);
 293             $column;
 294           } $tableobj->columns
 295       ],
 296     } );
 297     $dbdef->addtable($h_tableobj);
 298   }
 299
 300   if ( $datasrc =~ /^dbi:mysql/i ) {
 301
 302     my $dup_lock_table = DBIx::DBSchema::Table->new( {
 303       'name'          => 'duplicate_lock',
 304       'primary_key'   => 'duplocknum',
 305       'local_options' => $local_options,
 306       'columns'       => [
 307         DBIx::DBSchema::Column->new( {
 308           'name'    => 'duplocknum',
 309           'type'    => 'serial',
 310           'null'    => 'NOT NULL',
 311           'length'  => '',
 312           'default' => '',
 313           'local'   => '',
 314         } ),
 315         DBIx::DBSchema::Column->new( {
 316           'name'    => 'lockname',
 317           'type'    => 'varchar',
 318           'null'    => 'NOT NULL',
 319           'length'  => '80',
 320           'default' => '',
 321           'local'   => '',
 322         } ),
 323       ],
 324       'indices' => { 'duplicate_lock1' =>
 325                        DBIx::DBSchema::Index->new({
 326                          'name'    => 'duplicate_lock1',
 327                          'unique'  => 1,
 328                          'columns' => [ 'lockname' ],
 329                        })
 330                    },
 331     } );
 332
 333     $dbdef->addtable($dup_lock_table);
 334
 335   }
 336
 337   $dbdef;
 338
 339 }
 340
 341 #torrus tables http://torrus.org/reporting_setup.pod.html#create_sql_tables
 342 sub tables_hashref_torrus {
 343
 344   return {
 345
 346     # Collector export table. It usually grows at several megabytes
 347     # per month, and is updated every 5 minutes
 348     'srvexport' => {
 349       'columns' => [
 350         'id',         'serial', '', '', '', '',
 351         'srv_date',     'date', '', '', '', '',#date and time of the data sample
 352         'srv_time',     'time', '', '', '', '',
 353         'serviceid', 'varchar', '', 64, '', '',#unique service ID per counter
 354         'value',     'double precision', '', '', '', '',#collected rate or gauge value
 355         'intvl', 'int', '', '', '', '', # collection interval - for counter volume calculation
 356       ],
 357       'primary_key' => 'id',
 358       'unique' => [],
 359       'index'  => [ ['srv_date'], ['srv_date', 'srv_time'], ['serviceid'], ],
 360     },
 361
 362     #Tables for (currently monthly only) report contents.
 363     #These are updated usually once per month, and read at the moment of
 364     #rendering the report output (HTML now, PDF or XML or Excel or whatever
 365     #in the future)
 366
 367     #DBIx::Sequence backend, theplatform-independent inplementation
 368     #of sequences
 369     'dbix_sequence_state' => {
 370       'columns' => [
 371         'id',       'serial', '', '', '', '',
 372         'dataset', 'varchar', '', 50, '', '',
 373         'state_id',    'int', '', '', '', '',
 374       ],
 375       'primary_key' => 'id',
 376       #CONSTRAINT pk_dbix_sequence PRIMARY KEY (dataset, state_id)
 377       'unique' => [ [ 'dataset', 'state_id' ], ],
 378       'index'  => [],
 379     },
 380
 381     'dbix_sequence_release' => {
 382       'columns' => [
 383         'id',       'serial', '', '', '', '',
 384         'dataset', 'varchar', '', 50, '', '',
 385         'released_id', 'int', '', '', '', '',
 386       ],
 387       'primary_key' => 'id',
 388       #CONSTRAINT pk_dbi_release PRIMARY KEY (dataset, released_id)
 389       'unique' => [ [ 'dataset', 'released_id', ] ],
 390       'index'  => [],
 391     },
 392
 393     #Each report is characterized by name, date and time.
 394     #Monthly reports are automatically assigned 00:00 of the 1st day
 395     #in the month. The report contains fields for every service ID
 396     #defined across all datasource trees.
 397     'reports' => {
 398       'columns' => [
 399         'id',          'serial', '', '', '', '',
 400         'rep_date',      'date', '', '', '', '',#Start date of the report
 401         'rep_time',      'time', '', '', '', '',#Start time of the report
 402         'reportname', 'varchar', '', 64, '', '',#Report name, such as
 403                                                 # MonthlyUsage
 404         'iscomplete',     'int', '', '', '', '',#0 when the report is in
 405                                                 # progress, 1 when it is ready
 406       ],
 407       'primary_key' => 'id',
 408       'unique' => [ [ qw(rep_date rep_time reportname) ] ],
 409       'index'  => [ [ 'rep_date' ] ],
 410     },
 411
 412     #Each report contains fields. For each service ID,
 413     #the report may contain several fields for various statistics.
 414     #Each field contains information about the units of the value it
 415     #contains
 416     'reportfields' => {
 417       'columns' => [
 418         'id',              'serial',     '', '',    '', '',
 419         'rep_id',             'int', 'NULL', '',    '', '',
 420         'name',           'varchar',     '', 64,    '', '',#name of the field,
 421                                                            # such as AVG or MAX
 422         'serviceid',      'varchar',     '', 64,    '', '',#service ID
 423         'value', 'double precision',     '', '',    '', '',#Numeric value
 424         'units',          'varchar',     '', 64, \"''", '',#Units, such as bytes
 425                                                            # or Mbps
 426       ],
 427       'primary_key', => 'id',
 428       'unique' => [ [ qw(rep_id name serviceid) ] ],
 429       'index'  => [],
 430     },
 431
 432   };
 433
 434 }
 435
 436 sub tables_hashref {
 437
 438   my $char_d = 80; #default maxlength for text fields
 439
 440   #my(@date_type)  = ( 'timestamp', '', ''     );
 441   my @date_type  = ( 'int', 'NULL', ''     );
 442   my @perl_type = ( 'text', 'NULL', ''  );
 443   my @money_type = ( 'decimal',   '', '10,2' );
 444   my @money_typen = ( 'decimal',   'NULL', '10,2' );
 445   my @taxrate_type  = ( 'decimal',   '',     '14,8' ); # requires pg 8 for
 446   my @taxrate_typen = ( 'decimal',   'NULL', '14,8' ); # fs-upgrade to work
 447
 448   my $username_len = 32; #usernamemax config file
 449
 450     # name type nullability length default local
 451
 452   return {
 453
 454     'agent' => {
 455       'columns' => [
 456         'agentnum',          'serial',    '',       '', '', '',
 457         'agent',            'varchar',    '',  $char_d, '', '',
 458         'typenum',              'int',    '',       '', '', '',
 459         'ticketing_queueid',    'int', 'NULL',      '', '', '',
 460         'invoice_template', 'varchar', 'NULL', $char_d, '', '',
 461         'agent_custnum',        'int', 'NULL',      '', '', '',
 462         'disabled',            'char', 'NULL',       1, '', '',
 463         'username',         'varchar', 'NULL', $char_d, '', '',
 464         '_password',        'varchar', 'NULL', $char_d, '', '',
 465         'freq',              'int', 'NULL', '', '', '', #deprecated (never used)
 466         'prog',                     @perl_type, '', '', #deprecated (never used)
 467       ],
 468       'primary_key' => 'agentnum',
 469       #'unique' => [ [ 'agent_custnum' ] ], #one agent per customer?
 470                                             #insert is giving it a value, tho..
 471       #'index' => [ ['typenum'], ['disabled'] ],
 472       'unique' => [],
 473       'index' => [ ['typenum'], ['disabled'], ['agent_custnum'] ],
 474     },
 475
 476     'agent_type' => {
 477       'columns' => [
 478         'typenum',   'serial',  '', '', '', '',
 479         'atype',     'varchar', '', $char_d, '', '',
 480       ],
 481       'primary_key' => 'typenum',
 482       'unique' => [],
 483       'index' => [],
 484     },
 485
 486     'type_pkgs' => {
 487       'columns' => [
 488         'typepkgnum', 'serial', '', '', '', '',
 489         'typenum',   'int',  '', '', '', '',
 490         'pkgpart',   'int',  '', '', '', '',
 491       ],
 492       'primary_key' => 'typepkgnum',
 493       'unique' => [ ['typenum', 'pkgpart'] ],
 494       'index' => [ ['typenum'] ],
 495     },
 496
 497     'cust_attachment' => {
 498       'columns' => [
 499         'attachnum', 'serial', '', '', '', '',
 500         'custnum',   'int', '', '', '', '',
 501         '_date',     @date_type, '', '',
 502         'otaker',    'varchar', 'NULL', 32, '', '',
 503         'usernum',   'int', 'NULL', '', '', '',
 504         'filename',  'varchar', '', 255, '', '',
 505         'mime_type', 'varchar', '', $char_d, '', '',
 506         'title',     'varchar', 'NULL', $char_d, '', '',
 507         'body',      'blob', 'NULL', '', '', '',
 508         'disabled',  @date_type, '', '',
 509       ],
 510       'primary_key' => 'attachnum',
 511       'unique'      => [],
 512       'index'       => [ ['custnum'], ['usernum'], ],
 513     },
 514
 515     'cust_bill' => {
 516       'columns' => [
 517         #regular fields
 518         'invnum',    'serial',     '', '', '', '',
 519         'custnum',      'int',     '', '', '', '',
 520         '_date',        @date_type,        '', '',
 521         'charged',      @money_type,       '', '',
 522         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 523
 524         #customer balance info at invoice generation time
 525         'previous_balance',   @money_typen, '', '',  #eventually not nullable
 526         'billing_balance',    @money_typen, '', '',  #eventually not nullable
 527
 528         #deprecated (unused by now, right?)
 529         'printed',      'int',     '', '', '', '',
 530
 531         #specific use cases
 532         'closed',      'char', 'NULL',  1, '', '', #not yet used much
 533         'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
 534         'agent_invid',  'int', 'NULL', '', '', '', #(varchar?) importing legacy
 535       ],
 536       'primary_key' => 'invnum',
 537       'unique' => [ [ 'custnum', 'agent_invid' ] ], #agentnum?  huh
 538       'index' => [ ['custnum'], ['_date'], ['statementnum'], ['agent_invid'] ],
 539     },
 540
 541     'cust_statement' => {
 542       'columns' => [
 543         'statementnum', 'serial', '', '', '', '',
 544         'custnum',         'int', '', '', '', '',
 545         '_date',           @date_type,    '', '',
 546       ],
 547       'primary_key' => 'statementnum',
 548       'unique' => [],
 549       'index' => [ ['custnum'], ['_date'], ],
 550     },
 551
 552     'cust_bill_event' => {
 553       'columns' => [
 554         'eventnum',    'serial',  '', '', '', '',
 555         'invnum',   'int',  '', '', '', '',
 556         'eventpart',   'int',  '', '', '', '',
 557         '_date',     @date_type, '', '',
 558         'status', 'varchar', '', $char_d, '', '',
 559         'statustext', 'text', 'NULL', '', '', '',
 560       ],
 561       'primary_key' => 'eventnum',
 562       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 563       'unique' => [],
 564       'index' => [ ['invnum'], ['status'], ['eventpart'],
 565                    ['statustext'], ['_date'],
 566                  ],
 567     },
 568
 569     'part_bill_event' => {
 570       'columns' => [
 571         'eventpart',    'serial',  '', '', '', '',
 572         'freq',        'varchar',       'NULL',     $char_d, '', '',
 573         'payby',       'char',  '', 4, '', '',
 574         'event',       'varchar',           '',     $char_d, '', '',
 575         'eventcode',    @perl_type, '', '',
 576         'seconds',     'int', 'NULL', '', '', '',
 577         'weight',      'int', '', '', '', '',
 578         'plan',       'varchar', 'NULL', $char_d, '', '',
 579         'plandata',   'text', 'NULL', '', '', '',
 580         'reason',     'int', 'NULL', '', '', '',
 581         'disabled',     'char', 'NULL', 1, '', '',
 582       ],
 583       'primary_key' => 'eventpart',
 584       'unique' => [],
 585       'index' => [ ['payby'], ['disabled'], ],
 586     },
 587
 588     'part_event' => {
 589       'columns' => [
 590         'eventpart',   'serial',      '',      '', '', '',
 591         'agentnum',    'int',     'NULL',      '', '', '',
 592         'event',       'varchar',     '', $char_d, '', '',
 593         'eventtable',  'varchar',     '', $char_d, '', '',
 594         'check_freq',  'varchar', 'NULL', $char_d, '', '',
 595         'weight',      'int',         '',      '', '', '',
 596         'action',      'varchar',     '', $char_d, '', '',
 597         'disabled',     'char',   'NULL',       1, '', '',
 598       ],
 599       'primary_key' => 'eventpart',
 600       'unique' => [],
 601       'index' => [ ['agentnum'], ['eventtable'], ['check_freq'], ['disabled'], ],
 602     },
 603
 604     'part_event_option' => {
 605       'columns' => [
 606         'optionnum', 'serial', '', '', '', '',
 607         'eventpart', 'int', '', '', '', '',
 608         'optionname', 'varchar', '', $char_d, '', '',
 609         'optionvalue', 'text', 'NULL', '', '', '',
 610       ],
 611       'primary_key' => 'optionnum',
 612       'unique'      => [],
 613       'index'       => [ [ 'eventpart' ], [ 'optionname' ] ],
 614     },
 615
 616     'part_event_condition' => {
 617       'columns' => [
 618         'eventconditionnum', 'serial', '', '', '', '',
 619         'eventpart', 'int', '', '', '', '',
 620         'conditionname', 'varchar', '', $char_d, '', '',
 621       ],
 622       'primary_key' => 'eventconditionnum',
 623       'unique'      => [],
 624       'index'       => [ [ 'eventpart' ], [ 'conditionname' ] ],
 625     },
 626
 627     'part_event_condition_option' => {
 628       'columns' => [
 629         'optionnum', 'serial', '', '', '', '',
 630         'eventconditionnum', 'int', '', '', '', '',
 631         'optionname', 'varchar', '', $char_d, '', '',
 632         'optionvalue', 'text', 'NULL', '', '', '',
 633       ],
 634       'primary_key' => 'optionnum',
 635       'unique'      => [],
 636       'index'       => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
 637     },
 638
 639     'part_event_condition_option_option' => {
 640       'columns' => [
 641         'optionoptionnum', 'serial', '', '', '', '',
 642         'optionnum', 'int', '', '', '', '',
 643         'optionname', 'varchar', '', $char_d, '', '',
 644         'optionvalue', 'text', 'NULL', '', '', '',
 645       ],
 646       'primary_key' => 'optionoptionnum',
 647       'unique'      => [],
 648       'index'       => [ [ 'optionnum' ], [ 'optionname' ] ],
 649     },
 650
 651     'cust_event' => {
 652       'columns' => [
 653         'eventnum',    'serial',  '', '', '', '',
 654         'eventpart',   'int',  '', '', '', '',
 655         'tablenum',   'int',  '', '', '', '',
 656         '_date',     @date_type, '', '',
 657         'status', 'varchar', '', $char_d, '', '',
 658         'statustext', 'text', 'NULL', '', '', '',
 659       ],
 660       'primary_key' => 'eventnum',
 661       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 662       'unique' => [],
 663       'index' => [ ['eventpart'], ['tablenum'], ['status'],
 664                    ['statustext'], ['_date'],
 665                  ],
 666     },
 667
 668     'cust_bill_pkg' => {
 669       'columns' => [
 670         'billpkgnum',        'serial',     '',      '', '', '',
 671         'invnum',               'int',     '',      '', '', '',
 672         'pkgnum',               'int',     '',      '', '', '',
 673         'pkgpart_override',     'int', 'NULL',      '', '', '',
 674         'setup',               @money_type,             '', '',
 675         'recur',               @money_type,             '', '',
 676         'sdate',               @date_type,              '', '',
 677         'edate',               @date_type,              '', '',
 678         'itemdesc',         'varchar', 'NULL', $char_d, '', '',
 679         'itemcomment',      'varchar', 'NULL', $char_d, '', '',
 680         'section',          'varchar', 'NULL', $char_d, '', '',
 681         'freq',             'varchar', 'NULL', $char_d, '', '',
 682         'quantity',             'int', 'NULL',      '', '', '',
 683         'unitsetup',           @money_typen,            '', '',
 684         'unitrecur',           @money_typen,            '', '',
 685         'hidden',              'char', 'NULL',       1, '', '',
 686       ],
 687       'primary_key' => 'billpkgnum',
 688       'unique' => [],
 689       'index' => [ ['invnum'], [ 'pkgnum' ], [ 'itemdesc' ], ],
 690     },
 691
 692     'cust_bill_pkg_detail' => {
 693       'columns' => [
 694         'detailnum', 'serial', '', '', '', '',
 695         'billpkgnum', 'int', 'NULL', '', '', '',        # should not be nullable
 696         'pkgnum',  'int', 'NULL', '', '', '',           # deprecated
 697         'invnum',  'int', 'NULL', '', '', '',           # deprecated
 698         'amount',  'decimal', 'NULL', '10,4', '', '',
 699         'format',  'char', 'NULL', 1, '', '',
 700         'classnum', 'int', 'NULL', '', '', '',
 701         'duration', 'int', 'NULL', '',  0, '',
 702         'phonenum', 'varchar', 'NULL', 15, '', '',
 703         'accountcode', 'varchar',  'NULL',      20, '', '',
 704         'startdate',  @date_type, '', '',
 705         'regionname', 'varchar', 'NULL', $char_d, '', '',
 706         'detail',  'varchar', '', 255, '', '',
 707       ],
 708       'primary_key' => 'detailnum',
 709       'unique' => [],
 710       'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
 711     },
 712
 713     'cust_bill_pkg_display' => {
 714       'columns' => [
 715         'billpkgdisplaynum', 'serial', '', '', '', '',
 716         'billpkgnum', 'int', '', '', '', '',
 717         'section',  'varchar', 'NULL', $char_d, '', '',
 718         #'unitsetup', @money_typen, '', '',     #override the linked real one?
 719         #'unitrecur', @money_typen, '', '',     #this too?
 720         'post_total', 'char', 'NULL', 1, '', '',
 721         'type',       'char', 'NULL', 1, '', '',
 722         'summary',    'char', 'NULL', 1, '', '',
 723       ],
 724       'primary_key' => 'billpkgdisplaynum',
 725       'unique' => [],
 726       'index' => [ ['billpkgnum'], ],
 727     },
 728
 729     'cust_bill_pkg_tax_location' => {
 730       'columns' => [
 731         'billpkgtaxlocationnum', 'serial',      '', '', '', '',
 732         'billpkgnum',               'int',      '', '', '', '',
 733         'taxnum',                   'int',      '', '', '', '',
 734         'taxtype',              'varchar',      '', $char_d, '', '',
 735         'pkgnum',                   'int',      '', '', '', '',
 736         'locationnum',              'int',      '', '', '', '', #redundant?
 737         'amount',                   @money_type,        '', '',
 738       ],
 739       'primary_key' => 'billpkgtaxlocationnum',
 740       'unique' => [],
 741       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'pkgnum' ], [ 'locationnum' ] ],
 742     },
 743
 744     'cust_bill_pkg_tax_rate_location' => {
 745       'columns' => [
 746         'billpkgtaxratelocationnum', 'serial',      '', '', '', '',
 747         'billpkgnum',                   'int',      '', '', '', '',
 748         'taxnum',                       'int',      '', '', '', '',
 749         'taxtype',                  'varchar',      '', $char_d, '', '',
 750         'locationtaxid',            'varchar',  'NULL', $char_d, '', '',
 751         'taxratelocationnum',           'int',      '', '', '', '',
 752         'amount',                       @money_type,        '', '',
 753       ],
 754       'primary_key' => 'billpkgtaxratelocationnum',
 755       'unique' => [],
 756       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'taxratelocationnum' ] ],
 757     },
 758
 759     'cust_credit' => {
 760       'columns' => [
 761         'crednum',  'serial', '', '', '', '',
 762         'custnum',  'int', '', '', '', '',
 763         '_date',    @date_type, '', '',
 764         'amount',   @money_type, '', '',
 765         'otaker',   'varchar', 'NULL', 32, '', '',
 766         'usernum',   'int', 'NULL', '', '', '',
 767         'reason',   'text', 'NULL', '', '', '',
 768         'reasonnum', 'int', 'NULL', '', '', '',
 769         'addlinfo', 'text', 'NULL', '', '', '',
 770         'closed',    'char', 'NULL', 1, '', '',
 771         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
 772         'eventnum', 'int', 'NULL', '', '', '', #triggering event for commission
 773       ],
 774       'primary_key' => 'crednum',
 775       'unique' => [],
 776       'index' => [ ['custnum'], ['_date'], ['usernum'], ['eventnum'] ],
 777     },
 778
 779     'cust_credit_bill' => {
 780       'columns' => [
 781         'creditbillnum', 'serial', '', '', '', '',
 782         'crednum',  'int', '', '', '', '',
 783         'invnum',  'int', '', '', '', '',
 784         '_date',    @date_type, '', '',
 785         'amount',   @money_type, '', '',
 786         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
 787       ],
 788       'primary_key' => 'creditbillnum',
 789       'unique' => [],
 790       'index' => [ ['crednum'], ['invnum'] ],
 791     },
 792
 793     'cust_credit_bill_pkg' => {
 794       'columns' => [
 795         'creditbillpkgnum', 'serial', '',      '', '', '',
 796         'creditbillnum',       'int', '',      '', '', '',
 797         'billpkgnum',          'int', '',      '', '', '',
 798         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
 799         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
 800         'amount',            @money_type,          '', '',
 801         'setuprecur',      'varchar', '', $char_d, '', '',
 802         'sdate',   @date_type, '', '',
 803         'edate',   @date_type, '', '',
 804       ],
 805       'primary_key' => 'creditbillpkgnum',
 806       'unique'      => [],
 807       'index'       => [ [ 'creditbillnum' ],
 808                          [ 'billpkgnum' ],
 809                          [ 'billpkgtaxlocationnum' ],
 810                          [ 'billpkgtaxratelocationnum' ],
 811                        ],
 812     },
 813
 814     'cust_main' => {
 815       'columns' => [
 816         'custnum',  'serial',  '',     '', '', '',
 817         'agentnum', 'int',  '',     '', '', '',
 818         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
 819         'classnum', 'int', 'NULL', '', '', '',
 820         'custbatch', 'varchar', 'NULL', $char_d, '', '',
 821 #        'titlenum', 'int',  'NULL',   '', '', '',
 822         'last',     'varchar', '',   2*$char_d, '', '',
 823 #        'middle',   'varchar', 'NULL', $char_d, '', '',
 824         'first',    'varchar', '',     $char_d, '', '',
 825         'ss',       'varchar', 'NULL', 11, '', '',
 826         'stateid', 'varchar', 'NULL', $char_d, '', '',
 827         'stateid_state', 'varchar', 'NULL', $char_d, '', '',
 828         'birthdate' ,@date_type, '', '',
 829         'signupdate',@date_type, '', '',
 830         'dundate',   @date_type, '', '',
 831         'company',  'varchar', 'NULL', $char_d, '', '',
 832         'address1', 'varchar', '',     $char_d, '', '',
 833         'address2', 'varchar', 'NULL', $char_d, '', '',
 834         'city',     'varchar', '',     $char_d, '', '',
 835         'county',   'varchar', 'NULL', $char_d, '', '',
 836         'state',    'varchar', 'NULL', $char_d, '', '',
 837         'zip',      'varchar', 'NULL', 10, '', '',
 838         'country',  'char', '',     2, '', '',
 839         'daytime',  'varchar', 'NULL', 20, '', '',
 840         'night',    'varchar', 'NULL', 20, '', '',
 841         'fax',      'varchar', 'NULL', 12, '', '',
 842         'ship_last',     'varchar', 'NULL', 2*$char_d, '', '',
 843 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '',
 844         'ship_first',    'varchar', 'NULL', $char_d, '', '',
 845         'ship_company',  'varchar', 'NULL', $char_d, '', '',
 846         'ship_address1', 'varchar', 'NULL', $char_d, '', '',
 847         'ship_address2', 'varchar', 'NULL', $char_d, '', '',
 848         'ship_city',     'varchar', 'NULL', $char_d, '', '',
 849         'ship_county',   'varchar', 'NULL', $char_d, '', '',
 850         'ship_state',    'varchar', 'NULL', $char_d, '', '',
 851         'ship_zip',      'varchar', 'NULL', 10, '', '',
 852         'ship_country',  'char', 'NULL', 2, '', '',
 853         'ship_daytime',  'varchar', 'NULL', 20, '', '',
 854         'ship_night',    'varchar', 'NULL', 20, '', '',
 855         'ship_fax',      'varchar', 'NULL', 12, '', '',
 856         'payby',    'char', '',     4, '', '',
 857         'payinfo',  'varchar', 'NULL', 512, '', '',
 858         'paycvv',   'varchar', 'NULL', 512, '', '',
 859         'paymask', 'varchar', 'NULL', $char_d, '', '',
 860         #'paydate',  @date_type, '', '',
 861         'paydate',  'varchar', 'NULL', 10, '', '',
 862         'paystart_month', 'int', 'NULL', '', '', '',
 863         'paystart_year',  'int', 'NULL', '', '', '',
 864         'payissue', 'varchar', 'NULL', 2, '', '',
 865         'payname',  'varchar', 'NULL', 2*$char_d, '', '',
 866         'paystate', 'varchar', 'NULL', $char_d, '', '',
 867         'paytype',  'varchar', 'NULL', $char_d, '', '',
 868         'payip',    'varchar', 'NULL', 15, '', '',
 869         'geocode',  'varchar', 'NULL', 20,  '', '',
 870         'censustract', 'varchar', 'NULL', 20,  '', '', # 7 to save space?
 871         'tax',      'char', 'NULL', 1, '', '',
 872         'otaker',   'varchar', 'NULL',    32, '', '',
 873         'usernum',   'int', 'NULL', '', '', '',
 874         'refnum',   'int',  '',     '', '', '',
 875         'referral_custnum', 'int',  'NULL', '', '', '',
 876         'comments', 'text', 'NULL', '', '', '',
 877         'spool_cdr','char', 'NULL', 1, '', '',
 878         'squelch_cdr','char', 'NULL', 1, '', '',
 879         'cdr_termination_percentage', 'decimal', 'NULL', '', '', '',
 880         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 881         'credit_limit', @money_typen, '', '',
 882         'archived', 'char', 'NULL', 1, '', '',
 883         'email_csv_cdr', 'char', 'NULL', 1, '', '',
 884         'accountcode_cdr', 'char', 'NULL', 1, '', '',
 885         'billday',   'int', 'NULL', '', '', '',
 886         'edit_subject', 'char', 'NULL', 1, '', '',
 887         'locale', 'varchar', 'NULL', 16, '', '',
 888       ],
 889       'primary_key' => 'custnum',
 890       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
 891       #'index' => [ ['last'], ['company'] ],
 892       'index' => [
 893                    [ 'agentnum' ], [ 'refnum' ], [ 'classnum' ], [ 'usernum' ],
 894                    [ 'custbatch' ],
 895                    [ 'referral_custnum' ],
 896                    [ 'payby' ], [ 'paydate' ],
 897                    [ 'archived' ],
 898                    #billing
 899                    [ 'last' ], [ 'company' ],
 900                    [ 'county' ], [ 'state' ], [ 'country' ],
 901                    [ 'zip' ],
 902                    [ 'daytime' ], [ 'night' ], [ 'fax' ],
 903                    #shipping
 904                    [ 'ship_last' ], [ 'ship_company' ],
 905                    [ 'ship_county' ], [ 'ship_state' ], [ 'ship_country' ],
 906                    [ 'ship_zip' ],
 907                    [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
 908                  ],
 909     },
 910
 911     'cust_recon' => {  # what purpose does this serve?
 912       'columns' => [
 913         'reconid',      'serial',  '',          '', '', '',
 914         'recondate',    @date_type,                 '', '',
 915         'custnum',      'int'   ,  '',          '', '', '',
 916         'agentnum',     'int',     '',          '', '', '',
 917         'last',         'varchar', '',     $char_d, '', '',
 918         'first',        'varchar', '',     $char_d, '', '',
 919         'address1',     'varchar', '',     $char_d, '', '',
 920         'address2',     'varchar', 'NULL', $char_d, '', '',
 921         'city',         'varchar', '',     $char_d, '', '',
 922         'state',        'varchar', 'NULL', $char_d, '', '',
 923         'zip',          'varchar', 'NULL',      10, '', '',
 924         'pkg',          'varchar', 'NULL', $char_d, '', '',
 925         'adjourn',      @date_type,                 '', '',
 926         'status',       'varchar', 'NULL',      10, '', '',
 927         'agent_custid', 'varchar',  '',    $char_d, '', '',
 928         'agent_pkg',    'varchar', 'NULL', $char_d, '', '',
 929         'agent_adjourn', @date_type,                '', '',
 930         'comments',     'text',    'NULL',      '', '', '',
 931       ],
 932       'primary_key' => 'reconid',
 933       'unique' => [],
 934       'index' => [],
 935     },
 936
 937     #eventually for cust_main too
 938     'contact' => {
 939       'columns' => [
 940         'contactnum', 'serial',     '',      '', '', '',
 941         'prospectnum',   'int', 'NULL',      '', '', '',
 942         'custnum',       'int', 'NULL',      '', '', '',
 943         'locationnum',   'int', 'NULL',      '', '', '', #not yet
 944 #        'titlenum',      'int', 'NULL',      '', '', '', #eg Mr. Mrs. Dr. Rev.
 945         'last',      'varchar',     '', $char_d, '', '',
 946 #        'middle',    'varchar', 'NULL', $char_d, '', '',
 947         'first',     'varchar',     '', $char_d, '', '',
 948         'title',     'varchar', 'NULL', $char_d, '', '', #eg Head Bottle Washer
 949         'comment',   'varchar', 'NULL', $char_d, '', '',
 950         'disabled',     'char', 'NULL',       1, '', '',
 951       ],
 952       'primary_key' => 'contactnum',
 953       'unique'      => [],
 954       'index'       => [ [ 'prospectnum' ], [ 'custnum' ], [ 'locationnum' ],
 955                          [ 'last' ], [ 'first' ],
 956                        ],
 957     },
 958
 959     'contact_phone' => {
 960       'columns' => [
 961         'contactphonenum', 'serial',     '', '', '', '',
 962         'contactnum',         'int',     '', '', '', '',
 963         'phonetypenum',       'int',     '', '', '', '',
 964         'countrycode',    'varchar',     '',  3, '', '',
 965         'phonenum',       'varchar',     '', 14, '', '',
 966         'extension',      'varchar', 'NULL',  7, '', '',
 967         #?#'comment',        'varchar',     '', $char_d, '', '',
 968       ],
 969       'primary_key' => 'contactphonenum',
 970       'unique'      => [],
 971       'index'       => [],
 972     },
 973
 974     'phone_type' => {
 975       'columns' => [
 976         'phonetypenum',  'serial', '',      '', '', '',
 977         'typename',     'varchar', '', $char_d, '', '',
 978         'weight',           'int', '',      '', '', '',
 979       ],
 980       'primary_key' => 'phonetypenum',
 981       'unique'      => [ [ 'typename' ], ],
 982       'index'       => [],
 983     },
 984
 985     'contact_email' => {
 986       'columns' => [
 987         'contactemailnum', 'serial', '',      '', '', '',
 988         'contactnum',         'int', '',      '', '', '',
 989         'emailaddress',   'varchar', '', $char_d, '', '',
 990       ],
 991       'primary_key' => 'contactemailnum',
 992       'unique'      => [ [ 'emailaddress' ], ],
 993       'index'       => [],
 994     },
 995
 996     'prospect_main' => {
 997       'columns' => [
 998         'prospectnum',  'serial',     '',      '', '', '',
 999         'agentnum',        'int',     '',      '', '', '',
1000         'company',     'varchar', 'NULL', $char_d, '', '',
1001         'add_date',   @date_type,                  '', '',
1002         'disabled',       'char', 'NULL',       1, '', '',
1003         'custnum',         'int', 'NULL',      '', '', '',
1004       ],
1005       'primary_key' => 'prospectnum',
1006       'unique'      => [],
1007       'index'       => [ [ 'company' ], [ 'agentnum' ], [ 'disabled' ] ],
1008     },
1009
1010     #eventually use for billing & ship from cust_main too
1011     #for now, just cust_pkg locations
1012     'cust_location' => { #'location' now that its prospects too, but...
1013       'columns' => [
1014         'locationnum',      'serial',     '',      '', '', '',
1015         'prospectnum',         'int', 'NULL',      '', '', '',
1016         'custnum',             'int', 'NULL',      '', '', '',
1017         'address1',        'varchar',     '', $char_d, '', '',
1018         'address2',        'varchar', 'NULL', $char_d, '', '',
1019         'city',            'varchar',     '', $char_d, '', '',
1020         'county',          'varchar', 'NULL', $char_d, '', '',
1021         'state',           'varchar', 'NULL', $char_d, '', '',
1022         'zip',             'varchar', 'NULL',      10, '', '',
1023         'country',            'char',     '',       2, '', '',
1024         'geocode',         'varchar', 'NULL',      20, '', '',
1025         'location_type',   'varchar', 'NULL',      20, '', '',
1026         'location_number', 'varchar', 'NULL',      20, '', '',
1027         'location_kind',      'char', 'NULL',       1, '', '',
1028         'disabled',           'char', 'NULL',       1, '', '',
1029       ],
1030       'primary_key' => 'locationnum',
1031       'unique'      => [],
1032       'index'       => [ [ 'prospectnum' ], [ 'custnum' ],
1033                          [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
1034                        ],
1035     },
1036
1037     'cust_main_invoice' => {
1038       'columns' => [
1039         'destnum',  'serial',  '',     '', '', '',
1040         'custnum',  'int',  '',     '', '', '',
1041         'dest',     'varchar', '',  $char_d, '', '',
1042       ],
1043       'primary_key' => 'destnum',
1044       'unique' => [],
1045       'index' => [ ['custnum'], ],
1046     },
1047
1048     'cust_main_note' => {
1049       'columns' => [
1050         'notenum',  'serial',  '',     '', '', '',
1051         'custnum',  'int',  '',     '', '', '',
1052         'classnum',      'int',     'NULL', '', '', '',
1053         '_date',    @date_type, '', '',
1054         'otaker',   'varchar', 'NULL',    32, '', '',
1055         'usernum',   'int', 'NULL', '', '', '',
1056         'comments', 'text', 'NULL', '', '', '',
1057       ],
1058       'primary_key' => 'notenum',
1059       'unique' => [],
1060       'index' => [ [ 'custnum' ], [ '_date' ], [ 'usernum' ], ],
1061     },
1062
1063     'cust_note_class' => {
1064       'columns' => [
1065         'classnum',    'serial',   '',      '', '', '',
1066         'classname',   'varchar',  '', $char_d, '', '',
1067         'disabled',    'char', 'NULL',       1, '', '',
1068       ],
1069       'primary_key' => 'classnum',
1070       'unique' => [],
1071       'index' => [ ['disabled'] ],
1072     },
1073
1074     'cust_category' => {
1075       'columns' => [
1076         'categorynum',   'serial',  '', '', '', '',
1077         'categoryname',  'varchar', '', $char_d, '', '',
1078         'weight',         'int', 'NULL',  '', '', '',
1079         'disabled',      'char', 'NULL',   1, '', '',
1080       ],
1081       'primary_key' => 'categorynum',
1082       'unique' => [],
1083       'index' => [ ['disabled'] ],
1084     },
1085
1086     'cust_class' => {
1087       'columns' => [
1088         'classnum',    'serial',   '',      '', '', '',
1089         'classname',   'varchar',  '', $char_d, '', '',
1090         'categorynum', 'int',  'NULL',      '', '', '',
1091         'disabled',    'char', 'NULL',       1, '', '',
1092       ],
1093       'primary_key' => 'classnum',
1094       'unique' => [],
1095       'index' => [ ['disabled'] ],
1096     },
1097
1098     'cust_tag' => {
1099       'columns' => [
1100         'custtagnum', 'serial', '', '', '', '',
1101         'custnum',       'int', '', '', '', '',
1102         'tagnum',        'int', '', '', '', '',
1103       ],
1104       'primary_key' => 'custtagnum',
1105       'unique'      => [ [ 'custnum', 'tagnum' ] ],
1106       'index'       => [ [ 'custnum' ] ],
1107     },
1108
1109     'part_tag' => {
1110       'columns' => [
1111         'tagnum',    'serial',     '',      '', '', '',
1112         'tagname',  'varchar',     '', $char_d, '', '',
1113         'tagdesc',  'varchar', 'NULL', $char_d, '', '',
1114         'tagcolor', 'varchar', 'NULL',       6, '', '',
1115         'disabled',    'char', 'NULL',       1, '', '',
1116       ],
1117       'primary_key' => 'tagnum',
1118       'unique'      => [], #[ [ 'tagname' ] ], #?
1119       'index'       => [ [ 'disabled' ] ],
1120     },
1121
1122     'cust_main_exemption' => {
1123       'columns' => [
1124         'exemptionnum', 'serial', '',      '', '', '',
1125         'custnum',         'int', '',      '', '', '',
1126         'taxname',     'varchar', '', $char_d, '', '',
1127         #start/end dates?  for reporting?
1128       ],
1129       'primary_key' => 'exemptionnum',
1130       'unique'      => [],
1131       'index'       => [ [ 'custnum' ] ],
1132     },
1133
1134     'cust_tax_adjustment' => {
1135       'columns' => [
1136         'adjustmentnum', 'serial',     '',      '', '', '',
1137         'custnum',          'int',     '',      '', '', '',
1138         'taxname',      'varchar',     '', $char_d, '', '',
1139         'amount',    @money_type,                   '', '',
1140         'comment',     'varchar',  'NULL', $char_d, '', '',
1141         'billpkgnum',       'int', 'NULL',      '', '', '',
1142         #more?  no cust_bill_pkg_tax_location?
1143       ],
1144       'primary_key' => 'adjustmentnum',
1145       'unique'      => [],
1146       'index'       => [ [ 'custnum' ], [ 'billpkgnum' ] ],
1147     },
1148
1149     'cust_main_county' => { #county+state+country are checked off the
1150                             #cust_main_county for validation and to provide
1151                             # a tax rate.
1152       'columns' => [
1153         'taxnum',   'serial',   '',    '', '', '',
1154         'city',     'varchar',  'NULL',    $char_d, '', '',
1155         'county',   'varchar',  'NULL',    $char_d, '', '',
1156         'state',    'varchar',  'NULL',    $char_d, '', '',
1157         'country',  'char',  '', 2, '', '',
1158         'taxclass',   'varchar', 'NULL', $char_d, '', '',
1159         'exempt_amount', @money_type, '', '',
1160         'tax',      'real',  '',    '', '', '', #tax %
1161         'taxname',  'varchar',  'NULL',    $char_d, '', '',
1162         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
1163         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
1164       ],
1165       'primary_key' => 'taxnum',
1166       'unique' => [],
1167   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
1168       'index' => [ [ 'city' ], [ 'county' ], [ 'state' ], [ 'country' ],
1169                    [ 'taxclass' ],
1170                  ],
1171     },
1172
1173     'tax_rate'    => {
1174       'columns' => [
1175         'taxnum',       'serial',     '',      '', '', '',
1176         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
1177         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
1178         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
1179         'taxclassnum', 'int',      '',      '', '', '',
1180         'effective_date', @date_type, '', '',
1181         'tax',        @taxrate_type,      '', '',        # tax %
1182         'excessrate', @taxrate_typen,     '', '',        # second tax %
1183         'taxbase',    @money_typen, '', '',              # amount at first tax rate
1184         'taxmax',     @money_typen, '', '',              # maximum about at both rates
1185         'usetax',        @taxrate_typen,     '', '',     # tax % when non-local
1186         'useexcessrate', @taxrate_typen,     '', '',     # second tax % when non-local
1187         'unittype',    'int',  'NULL', '', '', '',      # for fee
1188         'fee',         @taxrate_typen,     '', '',      # amount tax per unit
1189         'excessfee',   @taxrate_typen,     '', '',      # second amount tax per unit
1190         'feebase',     @taxrate_typen,     '', '',      # units taxed at first rate
1191         'feemax',      @taxrate_typen,     '', '',      # maximum number of unit taxed
1192         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
1193         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
1194         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
1195         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
1196         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
1197         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
1198         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
1199         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
1200         'inoutcity',   'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1201         'inoutlocal',  'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1202         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
1203         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
1204       ],
1205       'primary_key' => 'taxnum',
1206       'unique' => [],
1207       'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
1208     },
1209
1210     'tax_rate_location' => {
1211       'columns' => [
1212         'taxratelocationnum', 'serial',  '',     '', '', '',
1213         'data_vendor',        'varchar', 'NULL', $char_d, '', '',
1214         'geocode',            'varchar', '',     20,      '', '',
1215         'city',               'varchar', 'NULL', $char_d, '', '',
1216         'county',             'varchar', 'NULL', $char_d, '', '',
1217         'state',              'char',    'NULL',       2, '', '',
1218         'disabled',           'char',    'NULL', 1, '', '',
1219       ],
1220       'primary_key' => 'taxratelocationnum',
1221       'unique' => [],
1222       'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
1223     },
1224
1225     'cust_tax_location' => {
1226       'columns' => [
1227         'custlocationnum', 'serial',  '',     '', '', '',
1228         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
1229         'city',            'varchar', 'NULL', $char_d, '', '',
1230         'postalcity',      'varchar', 'NULL', $char_d, '', '',
1231         'county',          'varchar', 'NULL', $char_d, '', '',
1232         'zip',             'char',    '',     5,  '', '',
1233         'state',           'char',    '',     2,  '', '',
1234         'plus4hi',         'char',    'NULL', 4,  '', '',
1235         'plus4lo',         'char',    'NULL', 4,  '', '',
1236         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
1237         'cityflag',        'char',    'NULL', 1,  '', '', # I(n)/O(out)/B(oth)/NULL
1238         'geocode',         'varchar', '',    20,  '', '',
1239       ],
1240       'primary_key' => 'custlocationnum',
1241       'unique' => [],
1242       'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
1243     },
1244
1245     'tax_class' => {
1246       'columns' => [
1247         'taxclassnum',  'serial',  '',            '', '', '',
1248         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
1249         'taxclass',     'varchar', '',       $char_d, '', '',
1250         'description',  'varchar', '',     2*$char_d, '', '',
1251       ],
1252       'primary_key' => 'taxclassnum',
1253       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
1254       'index' => [],
1255     },
1256
1257     'cust_pay_pending' => {
1258       'columns' => [
1259         'paypendingnum','serial',      '',  '', '', '',
1260         'custnum',      'int',         '',  '', '', '',
1261         'paid',         @money_type,            '', '',
1262         '_date',        @date_type,             '', '',
1263         'payby',        'char',        '',   4, '', '', #CARD/BILL/COMP, should
1264                                                         # be index into payby
1265                                                         # table eventually
1266         'payinfo',      'varchar', 'NULL', 512, '', '', #see cust_main above
1267         'paymask',      'varchar', 'NULL', $char_d, '', '',
1268         'paydate',      'varchar', 'NULL', 10, '', '',
1269         'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
1270         #'paybatch',     'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1271         'payunique',    'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1272
1273         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1274         'status',       'varchar',     '', $char_d, '', '',
1275         'session_id',   'varchar', 'NULL', $char_d, '', '', #only need 32
1276         'statustext',   'text',    'NULL',  '', '', '',
1277         'gatewaynum',   'int',     'NULL',  '', '', '',
1278         #'cust_balance', @money_type,            '', '',
1279         'paynum',       'int',     'NULL',  '', '', '',
1280         'jobnum',       'int',     'NULL',  '', '', '',
1281       ],
1282       'primary_key' => 'paypendingnum',
1283       'unique'      => [ [ 'payunique' ] ],
1284       'index'       => [ [ 'custnum' ], [ 'status' ], ],
1285     },
1286
1287     'cust_pay' => {
1288       'columns' => [
1289         'paynum',   'serial',    '',   '', '', '',
1290         'custnum',  'int',    '',   '', '', '',
1291         '_date',    @date_type, '', '',
1292         'paid',     @money_type, '', '',
1293         'otaker',   'varchar', 'NULL', 32, '', '',
1294         'usernum',   'int', 'NULL', '', '', '',
1295         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1296                                                  # index into payby table
1297                                                  # eventually
1298         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
1299         'paymask', 'varchar', 'NULL', $char_d, '', '',
1300         'paydate',  'varchar', 'NULL', 10, '', '',
1301         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1302         'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1303         'closed',    'char', 'NULL', 1, '', '',
1304         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1305       ],
1306       'primary_key' => 'paynum',
1307       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
1308       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ], [ 'usernum' ] ],
1309     },
1310
1311     'cust_pay_void' => {
1312       'columns' => [
1313         'paynum',    'int',    '',   '', '', '',
1314         'custnum',   'int',    '',   '', '', '',
1315         'paid',      @money_type, '', '',
1316         '_date',     @date_type, '', '',
1317         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1318                                                   # index into payby table
1319                                                   # eventually
1320         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
1321         'paymask', 'varchar', 'NULL', $char_d, '', '',
1322         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1323         'closed',    'char', 'NULL', 1, '', '',
1324         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1325         'void_date', @date_type, '', '',
1326         'reason',    'varchar',   'NULL', $char_d, '', '',
1327         'otaker',   'varchar', 'NULL', 32, '', '',
1328         'usernum',   'int', 'NULL', '', '', '',
1329         'void_usernum',   'int', 'NULL', '', '', '',
1330       ],
1331       'primary_key' => 'paynum',
1332       'unique' => [],
1333       'index' => [ [ 'custnum' ], [ 'usernum' ], [ 'void_usernum' ] ],
1334     },
1335
1336     'cust_bill_pay' => {
1337       'columns' => [
1338         'billpaynum', 'serial',     '',   '', '', '',
1339         'invnum',  'int',     '',   '', '', '',
1340         'paynum',  'int',     '',   '', '', '',
1341         'amount',  @money_type, '', '',
1342         '_date',   @date_type, '', '',
1343         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1344       ],
1345       'primary_key' => 'billpaynum',
1346       'unique' => [],
1347       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
1348     },
1349
1350     'cust_bill_pay_batch' => {
1351       'columns' => [
1352         'billpaynum', 'serial',     '',   '', '', '',
1353         'invnum',  'int',     '',   '', '', '',
1354         'paybatchnum',  'int',     '',   '', '', '',
1355         'amount',  @money_type, '', '',
1356         '_date',   @date_type, '', '',
1357       ],
1358       'primary_key' => 'billpaynum',
1359       'unique' => [],
1360       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1361     },
1362
1363     'cust_bill_pay_pkg' => {
1364       'columns' => [
1365         'billpaypkgnum', 'serial', '', '', '', '',
1366         'billpaynum',       'int', '', '', '', '',
1367         'billpkgnum',       'int', '', '', '', '',
1368         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
1369         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
1370         'amount',         @money_type,     '', '',
1371         'setuprecur',      'varchar', '', $char_d, '', '',
1372         'sdate',   @date_type, '', '',
1373         'edate',   @date_type, '', '',
1374       ],
1375       'primary_key' => 'billpaypkgnum',
1376       'unique'      => [],
1377       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1378     },
1379
1380     'pay_batch' => { #batches of payments to an external processor
1381       'columns' => [
1382         'batchnum',   'serial',    '',   '', '', '',
1383         'payby',      'char',      '',    4, '', '', # CARD/CHEK
1384         'status',     'char', 'NULL',     1, '', '',
1385         'download',   @date_type, '', '',
1386         'upload',     @date_type, '', '',
1387       ],
1388       'primary_key' => 'batchnum',
1389       'unique' => [],
1390       'index' => [],
1391     },
1392
1393     'cust_pay_batch' => { #what's this used for again?  list of customers
1394                           #in current CARD batch? (necessarily CARD?)
1395       'columns' => [
1396         'paybatchnum',   'serial',    '',   '', '', '',
1397         'batchnum',   'int',    '',   '', '', '',
1398         'invnum',   'int',    '',   '', '', '',
1399         'custnum',   'int',    '',   '', '', '',
1400         'last',     'varchar', '',     $char_d, '', '',
1401         'first',    'varchar', '',     $char_d, '', '',
1402         'address1', 'varchar', '',     $char_d, '', '',
1403         'address2', 'varchar', 'NULL', $char_d, '', '',
1404         'city',     'varchar', '',     $char_d, '', '',
1405         'state',    'varchar', 'NULL', $char_d, '', '',
1406         'zip',      'varchar', 'NULL', 10, '', '',
1407         'country',  'char', '',     2, '', '',
1408         #        'trancode', 'int', '', '', '', ''
1409         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1410         'payinfo',  'varchar', '',     512, '', '',
1411         #'exp',      @date_type, '', ''
1412         'exp',      'varchar', 'NULL',     11, '', '',
1413         'payname',  'varchar', 'NULL', $char_d, '', '',
1414         'amount',   @money_type, '', '',
1415         'status',   'varchar', 'NULL',     $char_d, '', '',
1416       ],
1417       'primary_key' => 'paybatchnum',
1418       'unique' => [],
1419       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1420     },
1421
1422     'fcc477map' => {
1423       'columns' => [
1424         'formkey',   'varchar',     '', 255, '', '',
1425         'formvalue',    'text', 'NULL',  '', '', '',
1426       ],
1427       'primary_key' => 'formkey',
1428       'unique'      => [],
1429       'index'       => [],
1430     },
1431
1432     'cust_pkg' => {
1433       'columns' => [
1434         'pkgnum',           'serial',     '', '', '', '',
1435         'custnum',             'int',     '', '', '', '',
1436         'pkgpart',             'int',     '', '', '', '',
1437         'pkgbatch',        'varchar', 'NULL', $char_d, '', '',
1438         'locationnum',         'int', 'NULL', '', '', '',
1439         'otaker',          'varchar', 'NULL', 32, '', '',
1440         'usernum',             'int', 'NULL', '', '', '',
1441         'order_date',     @date_type,             '', '',
1442         'start_date',     @date_type,             '', '',
1443         'setup',          @date_type,             '', '',
1444         'bill',           @date_type,             '', '',
1445         'last_bill',      @date_type,             '', '',
1446         'susp',           @date_type,             '', '',
1447         'adjourn',        @date_type,             '', '',
1448         'cancel',         @date_type,             '', '',
1449         'expire',         @date_type,             '', '',
1450         'contract_end',   @date_type,             '', '',
1451         'dundate',        @date_type,             '', '',
1452         'change_date',    @date_type,             '', '',
1453         'change_pkgnum',       'int', 'NULL', '', '', '',
1454         'change_pkgpart',      'int', 'NULL', '', '', '',
1455         'change_locationnum',  'int', 'NULL', '', '', '',
1456         'manual_flag',        'char', 'NULL',  1, '', '',
1457         'no_auto',            'char', 'NULL',  1, '', '',
1458         'quantity',            'int', 'NULL', '', '', '',
1459         'agent_pkgid',         'int', 'NULL', '', '', '',
1460         'waive_setup',        'char', 'NULL',  1, '', '',
1461         'recur_show_zero',    'char', 'NULL',  1, '', '',
1462         'setup_show_zero',    'char', 'NULL',  1, '', '',
1463       ],
1464       'primary_key' => 'pkgnum',
1465       'unique' => [],
1466       'index' => [ ['custnum'], ['pkgpart'], [ 'pkgbatch' ], [ 'locationnum' ],
1467                    [ 'usernum' ], [ 'agent_pkgid' ],
1468                    ['order_date'], [ 'start_date' ], ['setup'], ['bill'],
1469                    ['last_bill'], ['susp'], ['adjourn'], ['cancel'],
1470                    ['expire'], ['contract_end'], ['change_date'], ['no_auto'],
1471                  ],
1472     },
1473
1474     'cust_pkg_option' => {
1475       'columns' => [
1476         'optionnum', 'serial', '', '', '', '',
1477         'pkgnum', 'int', '', '', '', '',
1478         'optionname', 'varchar', '', $char_d, '', '',
1479         'optionvalue', 'text', 'NULL', '', '', '',
1480       ],
1481       'primary_key' => 'optionnum',
1482       'unique'      => [],
1483       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
1484     },
1485
1486     'cust_pkg_detail' => {
1487       'columns' => [
1488         'pkgdetailnum', 'serial', '',      '', '', '',
1489         'pkgnum',          'int', '',      '', '', '',
1490         'detail',      'varchar', '', $char_d, '', '',
1491         'detailtype',     'char', '',       1, '', '', # "I"nvoice or "C"omment
1492         'weight',          'int', '',      '', '', '',
1493       ],
1494       'primary_key' => 'pkgdetailnum',
1495       'unique' => [],
1496       'index'  => [ [ 'pkgnum', 'detailtype' ] ],
1497     },
1498
1499     'cust_pkg_reason' => {
1500       'columns' => [
1501         'num',      'serial',    '',   '', '', '',
1502         'pkgnum',   'int',    '',   '', '', '',
1503         'reasonnum','int',    '',   '', '', '',
1504         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
1505         'otaker',   'varchar', 'NULL', 32, '', '',
1506         'usernum',   'int', 'NULL', '', '', '',
1507         'date',     @date_type, '', '',
1508       ],
1509       'primary_key' => 'num',
1510       'unique' => [],
1511       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], [ 'usernum' ], ],
1512     },
1513
1514     'cust_pkg_discount' => {
1515       'columns' => [
1516         'pkgdiscountnum', 'serial', '',     '', '', '',
1517         'pkgnum',            'int', '',     '', '', '',
1518         'discountnum',       'int', '',     '', '', '',
1519         'months_used',   'decimal', 'NULL', '', '', '',
1520         'end_date',     @date_type,             '', '',
1521         'otaker',        'varchar', 'NULL', 32, '', '',
1522         'usernum',           'int', 'NULL', '', '', '',
1523         'disabled',         'char', 'NULL',  1, '', '',
1524       ],
1525       'primary_key' => 'pkgdiscountnum',
1526       'unique' => [],
1527       'index'  => [ [ 'pkgnum' ], [ 'discountnum' ], [ 'usernum' ], ],
1528     },
1529
1530     'cust_bill_pkg_discount' => {
1531       'columns' => [
1532         'billpkgdiscountnum', 'serial',     '', '', '', '',
1533         'billpkgnum',            'int',     '', '', '', '',
1534         'pkgdiscountnum',        'int',     '', '', '', '',
1535         'amount',          @money_type,             '', '',
1536         'months',            'decimal', 'NULL', '', '', '',
1537       ],
1538       'primary_key' => 'billpkgdiscountnum',
1539       'unique' => [],
1540       'index' => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
1541     },
1542
1543     'discount' => {
1544       'columns' => [
1545         'discountnum', 'serial',     '',      '', '', '',
1546         #'agentnum',       'int', 'NULL',      '', '', '',
1547         'name',       'varchar', 'NULL', $char_d, '', '',
1548         'amount',   @money_type,                  '', '',
1549         'percent',    'decimal',     '',      '', '', '',
1550         'months',     'decimal', 'NULL',      '', '', '',
1551         'disabled',      'char', 'NULL',       1, '', '',
1552         'setup',      'char', 'NULL',       1, '', '',
1553       ],
1554       'primary_key' => 'discountnum',
1555       'unique' => [],
1556       'index'  => [], # [ 'agentnum' ], ],
1557     },
1558
1559     'cust_refund' => {
1560       'columns' => [
1561         'refundnum',    'serial',    '',   '', '', '',
1562         'custnum',  'int',    '',   '', '', '',
1563         '_date',        @date_type, '', '',
1564         'refund',       @money_type, '', '',
1565         'otaker',       'varchar',   'NULL',   32, '', '',
1566         'usernum',   'int', 'NULL', '', '', '',
1567         'reason',       'varchar',   '',   $char_d, '', '',
1568         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
1569                                                      # be index into payby
1570                                                      # table eventually
1571         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
1572         'paymask', 'varchar', 'NULL', $char_d, '', '',
1573         'paybatch',     'varchar',   'NULL', $char_d, '', '',
1574         'closed',    'char', 'NULL', 1, '', '',
1575       ],
1576       'primary_key' => 'refundnum',
1577       'unique' => [],
1578       'index' => [ ['custnum'], ['_date'], [ 'usernum' ], ],
1579     },
1580
1581     'cust_credit_refund' => {
1582       'columns' => [
1583         'creditrefundnum', 'serial',     '',   '', '', '',
1584         'crednum',  'int',     '',   '', '', '',
1585         'refundnum',  'int',     '',   '', '', '',
1586         'amount',  @money_type, '', '',
1587         '_date',   @date_type, '', '',
1588       ],
1589       'primary_key' => 'creditrefundnum',
1590       'unique' => [],
1591       'index' => [ ['crednum'], ['refundnum'] ],
1592     },
1593
1594
1595     'cust_svc' => {
1596       'columns' => [
1597         'svcnum',    'serial',    '',   '', '', '',
1598         'pkgnum',    'int',    'NULL',   '', '', '',
1599         'svcpart',   'int',    '',   '', '', '',
1600         'overlimit', @date_type, '', '',
1601       ],
1602       'primary_key' => 'svcnum',
1603       'unique' => [],
1604       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1605     },
1606
1607     'cust_svc_option' => {
1608       'columns' => [
1609         'optionnum',   'serial', '', '', '', '',
1610         'svcnum',      'int', '', '', '', '',
1611         'optionname',  'varchar', '', $char_d, '', '',
1612         'optionvalue', 'text', 'NULL', '', '', '',
1613       ],
1614       'primary_key' => 'optionnum',
1615       'unique'      => [],
1616       'index'       => [ [ 'svcnum' ], [ 'optionname' ] ],
1617     },
1618
1619    'part_pkg' => {
1620       'columns' => [
1621         'pkgpart',       'serial',    '',   '', '', '',
1622         'pkg',           'varchar',   '',   $char_d, '', '',
1623         'comment',       'varchar',   '', 2*$char_d, '', '',
1624         'promo_code',    'varchar', 'NULL', $char_d, '', '',
1625         'setup',         @perl_type, '', '',
1626         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
1627         'recur',         @perl_type, '', '',
1628         'setuptax',      'char', 'NULL', 1, '', '',
1629         'recurtax',      'char', 'NULL', 1, '', '',
1630         'plan',          'varchar', 'NULL', $char_d, '', '',
1631         'plandata',      'text', 'NULL', '', '', '',
1632         'disabled',      'char', 'NULL', 1, '', '',
1633         'custom',        'char', 'NULL', 1, '', '',
1634         'taxclass',      'varchar', 'NULL', $char_d, '', '',
1635         'classnum',      'int',     'NULL', '', '', '',
1636         'addon_classnum','int',     'NULL', '', '', '',
1637         'taxproductnum', 'int',     'NULL', '', '', '',
1638         'setup_cost',    @money_typen,          '', '',
1639         'recur_cost',    @money_typen,          '', '',
1640         'pay_weight',    'real',    'NULL', '', '', '',
1641         'credit_weight', 'real',    'NULL', '', '', '',
1642         'agentnum',      'int',     'NULL', '', '', '',
1643         'fcc_ds0s',      'int',     'NULL', '', '', '',
1644         'no_auto',          'char', 'NULL',  1, '', '',
1645         'recur_show_zero',  'char', 'NULL',  1, '', '',
1646         'setup_show_zero',  'char', 'NULL',  1, '', '',
1647       ],
1648       'primary_key' => 'pkgpart',
1649       'unique' => [],
1650       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'classnum' ],
1651                    [ 'agentnum' ], ['no_auto'],
1652                  ],
1653     },
1654
1655     'part_pkg_link' => {
1656       'columns' => [
1657         'pkglinknum',  'serial',   '',      '', '', '',
1658         'src_pkgpart', 'int',      '',      '', '', '',
1659         'dst_pkgpart', 'int',      '',      '', '', '',
1660         'link_type',   'varchar',  '', $char_d, '', '',
1661         'hidden',      'char', 'NULL',       1, '', '',
1662       ],
1663       'primary_key' => 'pkglinknum',
1664       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type', 'hidden' ] ],
1665       'index'  => [ [ 'src_pkgpart' ] ],
1666     },
1667     # XXX somewhat borked unique: we don't really want a hidden and unhidden
1668     # it turns out we'd prefer to use svc, bill, and invisibill (or something)
1669
1670     'part_pkg_discount' => {
1671       'columns' => [
1672         'pkgdiscountnum', 'serial',   '',      '', '', '',
1673         'pkgpart',        'int',      '',      '', '', '',
1674         'discountnum',    'int',      '',      '', '', '',
1675       ],
1676       'primary_key' => 'pkgdiscountnum',
1677       'unique' => [ [ 'pkgpart', 'discountnum' ] ],
1678       'index'  => [],
1679     },
1680
1681     'part_pkg_taxclass' => {
1682       'columns' => [
1683         'taxclassnum',  'serial', '',       '', '', '',
1684         'taxclass',     'varchar', '', $char_d, '', '',
1685         'disabled', 'char',   'NULL',         1, '', '',
1686       ],
1687       'primary_key' => 'taxclassnum',
1688       'unique'      => [ [ 'taxclass' ] ],
1689       'index'       => [ [ 'disabled' ] ],
1690     },
1691
1692     'part_pkg_taxproduct' => {
1693       'columns' => [
1694         'taxproductnum', 'serial',      '',        '', '', '',
1695         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
1696         'taxproduct',    'varchar',     '',   $char_d, '', '',
1697         'description',   'varchar',     '', 3*$char_d, '', '',
1698       ],
1699       'primary_key' => 'taxproductnum',
1700       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
1701       'index'       => [],
1702     },
1703
1704     'part_pkg_taxrate' => {
1705       'columns' => [
1706         'pkgtaxratenum', 'serial',  '',     '',      '', '',
1707         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
1708         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
1709         'taxproductnum', 'int',  '',     '',       '', '',
1710         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
1711         'county',           'varchar', 'NULL', $char_d, '', '',
1712         'state',            'varchar', 'NULL', $char_d, '', '',
1713         'local',            'varchar', 'NULL', $char_d, '', '',
1714         'country',          'char',    'NULL', 2,       '', '',
1715         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
1716         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
1717         'taxclassnum',      'int',     'NULL', '',      '', '',
1718         'effdate',          @date_type, '', '',
1719         'taxable',          'char',    'NULL', 1,       '', '',
1720       ],
1721       'primary_key' => 'pkgtaxratenum',
1722       'unique' => [],
1723       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1724     },
1725
1726     'part_pkg_taxoverride' => {
1727       'columns' => [
1728         'taxoverridenum', 'serial', '', '', '', '',
1729         'pkgpart',           'int', '', '', '', '',
1730         'taxclassnum',       'int', '', '', '', '',
1731         'usage_class',    'varchar', 'NULL', $char_d, '', '',
1732       ],
1733       'primary_key' => 'taxoverridenum',
1734       'unique' => [],
1735       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1736     },
1737
1738 #    'part_title' => {
1739 #      'columns' => [
1740 #        'titlenum',   'int',    '',   '',
1741 #        'title',      'varchar',   '',   $char_d,
1742 #      ],
1743 #      'primary_key' => 'titlenum',
1744 #      'unique' => [ [] ],
1745 #      'index' => [ [] ],
1746 #    },
1747
1748     'pkg_svc' => {
1749       'columns' => [
1750         'pkgsvcnum',  'serial', '',  '', '', '',
1751         'pkgpart',    'int',    '',   '', '', '',
1752         'svcpart',    'int',    '',   '', '', '',
1753         'quantity',   'int',    '',   '', '', '',
1754         'primary_svc','char', 'NULL',  1, '', '',
1755         'hidden',     'char', 'NULL',  1, '', '',
1756       ],
1757       'primary_key' => 'pkgsvcnum',
1758       'unique' => [ ['pkgpart', 'svcpart'] ],
1759       'index' => [ ['pkgpart'], ['quantity'] ],
1760     },
1761
1762     'part_referral' => {
1763       'columns' => [
1764         'refnum',   'serial',     '',        '', '', '',
1765         'referral', 'varchar',    '',   $char_d, '', '',
1766         'disabled', 'char',   'NULL',         1, '', '',
1767         'agentnum', 'int',    'NULL',        '', '', '',
1768       ],
1769       'primary_key' => 'refnum',
1770       'unique' => [],
1771       'index' => [ ['disabled'], ['agentnum'], ],
1772     },
1773
1774     'part_svc' => {
1775       'columns' => [
1776         'svcpart',    'serial',    '',   '', '', '',
1777         'svc',        'varchar',   '',   $char_d, '', '',
1778         'svcdb',      'varchar',   '',   $char_d, '', '',
1779         'disabled',   'char',  'NULL',   1, '', '',
1780         'preserve',   'char', 'NULL',  1, '', '',
1781       ],
1782       'primary_key' => 'svcpart',
1783       'unique' => [],
1784       'index' => [ [ 'disabled' ] ],
1785     },
1786
1787     'part_svc_column' => {
1788       'columns' => [
1789         'columnnum',   'serial',         '', '', '', '',
1790         'svcpart',     'int',         '', '', '', '',
1791         'columnname',  'varchar',     '', 64, '', '',
1792         'columnlabel', 'varchar', 'NULL', $char_d, '', '',
1793         'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1794         'columnflag',  'char',    'NULL', 1, '', '',
1795       ],
1796       'primary_key' => 'columnnum',
1797       'unique' => [ [ 'svcpart', 'columnname' ] ],
1798       'index' => [ [ 'svcpart' ] ],
1799     },
1800
1801     #(this should be renamed to part_pop)
1802     'svc_acct_pop' => {
1803       'columns' => [
1804         'popnum',    'serial',    '',   '', '', '',
1805         'city',      'varchar',   '',   $char_d, '', '',
1806         'state',     'varchar',   '',   $char_d, '', '',
1807         'ac',        'char',   '',   3, '', '',
1808         'exch',      'char',   '',   3, '', '',
1809         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
1810       ],
1811       'primary_key' => 'popnum',
1812       'unique' => [],
1813       'index' => [ [ 'state' ] ],
1814     },
1815
1816     'part_pop_local' => {
1817       'columns' => [
1818         'localnum',  'serial',     '',     '', '', '',
1819         'popnum',    'int',     '',     '', '', '',
1820         'city',      'varchar', 'NULL', $char_d, '', '',
1821         'state',     'char',    'NULL', 2, '', '',
1822         'npa',       'char',    '',     3, '', '',
1823         'nxx',       'char',    '',     3, '', '',
1824       ],
1825       'primary_key' => 'localnum',
1826       'unique' => [],
1827       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1828     },
1829
1830     'qual' => {
1831       'columns' => [
1832         'qualnum',  'serial',     '',     '', '', '',
1833         'custnum',    'int',     'NULL',     '', '', '',
1834         'prospectnum',    'int',     'NULL',     '', '', '',
1835         'locationnum',    'int',     'NULL',     '', '', '',
1836         'phonenum',     'varchar', 'NULL',       24, '', '',
1837         'exportnum',      'int', 'NULL', '', '', '',
1838         'vendor_qual_id',      'varchar', 'NULL', $char_d, '', '',
1839         'status',      'char', '', 1, '', '',
1840       ],
1841       'primary_key' => 'qualnum',
1842       'unique' => [],
1843       'index' => [ [ 'locationnum' ], ['custnum'], ['prospectnum'],
1844                     ['phonenum'], ['vendor_qual_id'] ],
1845     },
1846
1847     'qual_option' => {
1848       'columns' => [
1849         'optionnum', 'serial', '', '', '', '',
1850         'qualnum',  'int',     '',     '', '', '',
1851         'optionname', 'varchar', '', $char_d, '', '',
1852         'optionvalue', 'text', 'NULL', '', '', '',
1853       ],
1854       'primary_key' => 'optionnum',
1855       'unique' => [],
1856       'index' => [],
1857     },
1858
1859     'svc_acct' => {
1860       'columns' => [
1861         'svcnum',    'int',    '',   '', '', '',
1862         'username',  'varchar',   '',   $username_len, '', '',
1863         '_password', 'varchar',   'NULL',  512, '', '',
1864         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1865         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
1866         'popnum',    'int',    'NULL',   '', '', '',
1867         'uid',       'int', 'NULL',   '', '', '',
1868         'gid',       'int', 'NULL',   '', '', '',
1869         'finger',    'varchar',   'NULL',   2*$char_d, '', '',
1870         'dir',       'varchar',   'NULL',   $char_d, '', '',
1871         'shell',     'varchar',   'NULL',   $char_d, '', '',
1872         'quota',     'varchar',   'NULL',   $char_d, '', '',
1873         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
1874         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
1875         'seconds_threshold',   'int', 'NULL',   '', '', '',
1876         'upbytes',   'bigint', 'NULL',   '', '', '',
1877         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
1878         'downbytes', 'bigint', 'NULL',   '', '', '',
1879         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
1880         'totalbytes','bigint', 'NULL',   '', '', '',
1881         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
1882         'domsvc',    'int',     '', '', '', '',
1883         'pbxsvc',    'int', 'NULL', '', '', '',
1884         'last_login',  @date_type, '', '',
1885         'last_logout', @date_type, '', '',
1886         #cardfortress field(s)
1887         'cf_privatekey',      'text', 'NULL',      '', '', '',
1888         #communigate pro fields (quota = MaxAccountSize)
1889         'cgp_aliases',     'varchar', 'NULL',     255, '', '',
1890         #settings
1891         'cgp_type',        'varchar', 'NULL', $char_d, '', '', #AccountType
1892         'file_quota',      'varchar', 'NULL', $char_d, '', '', #MaxWebSize
1893         'file_maxnum',     'varchar', 'NULL', $char_d, '', '', #MaxWebFiles
1894         'file_maxsize',    'varchar', 'NULL', $char_d, '', '', #MaxFileSize
1895         'cgp_accessmodes', 'varchar', 'NULL',     255, '', '', #AccessModes
1896         'password_selfchange','char', 'NULL',       1, '', '', #PWDAllowed
1897         'password_recover',   'char', 'NULL',       1, 'Y','', #PasswordRecovery
1898         'cgp_rulesallowed','varchar', 'NULL', $char_d, '', '', #RulesAllowed
1899         'cgp_rpopallowed',    'char', 'NULL',       1, '', '', #RPOPAllowed
1900         'cgp_mailtoall',      'char', 'NULL',       1, '', '', #MailToAll
1901         'cgp_addmailtrailer', 'char', 'NULL',       1, '', '', #AddMailTrailer
1902         'cgp_archiveafter',    'int', 'NULL',      '', '', '', #ArchiveMessagesAfter
1903         #XXX mailing lists
1904         #preferences
1905         'cgp_deletemode',     'varchar', 'NULL', $char_d, '', '',#DeleteMode
1906         'cgp_emptytrash',     'varchar', 'NULL', $char_d, '', '',#EmptyTrash
1907         'cgp_language',       'varchar', 'NULL', $char_d, '', '',#Language
1908         'cgp_timezone',       'varchar', 'NULL', $char_d, '', '',#TimeZone
1909         'cgp_skinname',       'varchar', 'NULL', $char_d, '', '',#SkinName
1910         'cgp_prontoskinname', 'varchar', 'NULL', $char_d, '', '',#ProntoSkinName
1911         'cgp_sendmdnmode',    'varchar', 'NULL', $char_d, '', '',#SendMDNMode
1912         #mail
1913         #XXX RPOP settings
1914       ],
1915       'primary_key' => 'svcnum',
1916       #'unique' => [ [ 'username', 'domsvc' ] ],
1917       'unique' => [],
1918       'index' => [ ['username'], ['domsvc'], ['pbxsvc'] ],
1919     },
1920
1921     'acct_rt_transaction' => {
1922       'columns' => [
1923         'svcrtid',   'int',    '',   '', '', '',
1924         'svcnum',    'int',    '',   '', '', '',
1925         'transaction_id',       'int', '',   '', '', '',
1926         '_date',   @date_type, '', '',
1927         'seconds',   'int', '',   '', '', '', #uhhhh
1928         'support',   'int', '',   '', '', '',
1929       ],
1930       'primary_key' => 'svcrtid',
1931       'unique' => [],
1932       'index' => [ ['svcnum', 'transaction_id'] ],
1933     },
1934
1935     #'svc_charge' => {
1936     #  'columns' => [
1937     #    'svcnum',    'int',    '',   '',
1938     #    'amount',    @money_type,
1939     #  ],
1940     #  'primary_key' => 'svcnum',
1941     #  'unique' => [ [] ],
1942     #  'index' => [ [] ],
1943     #},
1944
1945     'svc_domain' => {
1946       'columns' => [
1947         'svcnum',           'int',    '',        '', '', '',
1948         'domain',       'varchar',    '',   $char_d, '', '',
1949         'suffix',       'varchar', 'NULL',  $char_d, '', '',
1950         'catchall',         'int', 'NULL',       '', '', '',
1951         'parent_svcnum',    'int', 'NULL',       '', '', '',
1952         'registrarnum',     'int', 'NULL',       '', '', '',
1953         'registrarkey', 'varchar', 'NULL',      512, '', '',
1954         'setup_date',      @date_type, '', '',
1955         'renewal_interval', 'int', 'NULL',       '', '', '',
1956         'expiration_date', @date_type, '', '',
1957         'au_registrant_name',       'varchar', 'NULL',  $char_d, '', '',
1958         'au_eligibility_type',      'varchar', 'NULL',  $char_d, '', '',
1959         #communigate pro fields (quota = MaxAccountSize)
1960         'max_accounts',     'int', 'NULL',       '', '', '',
1961         'trailer',         'text', 'NULL',       '', '', '',
1962         'cgp_aliases',  'varchar', 'NULL',      255, '', '',
1963         'cgp_accessmodes','varchar','NULL',     255, '', '', #DomainAccessModes
1964         'cgp_certificatetype','varchar','NULL', $char_d, '', '',
1965         #settings
1966         'acct_def_password_selfchange',   'char', 'NULL',       1,  '', '',
1967         'acct_def_password_recover',      'char', 'NULL',       1, 'Y', '',
1968         'acct_def_cgp_accessmodes',    'varchar', 'NULL',     255,  '', '',
1969         'acct_def_quota',              'varchar', 'NULL', $char_d,  '', '',
1970         'acct_def_file_quota',         'varchar', 'NULL', $char_d,  '', '',
1971         'acct_def_file_maxnum',        'varchar', 'NULL', $char_d,  '', '',
1972         'acct_def_file_maxsize',       'varchar', 'NULL', $char_d,  '', '',
1973         'acct_def_cgp_rulesallowed',   'varchar', 'NULL', $char_d,  '', '',
1974         'acct_def_cgp_rpopallowed',       'char', 'NULL',       1,  '', '',
1975         'acct_def_cgp_mailtoall',         'char', 'NULL',       1,  '', '',
1976         'acct_def_cgp_addmailtrailer',    'char', 'NULL',       1,  '', '',
1977         'acct_def_cgp_archiveafter',       'int', 'NULL',      '',  '', '',
1978         #preferences
1979         'acct_def_cgp_deletemode',     'varchar', 'NULL', $char_d,  '', '',
1980         'acct_def_cgp_emptytrash',     'varchar', 'NULL', $char_d,  '', '',
1981         'acct_def_cgp_language',       'varchar', 'NULL', $char_d,  '', '',
1982         'acct_def_cgp_timezone',       'varchar', 'NULL', $char_d,  '', '',
1983         'acct_def_cgp_skinname',       'varchar', 'NULL', $char_d,  '', '',
1984         'acct_def_cgp_prontoskinname', 'varchar', 'NULL', $char_d,  '', '',
1985         'acct_def_cgp_sendmdnmode',    'varchar', 'NULL', $char_d,  '', '',
1986       ],
1987       'primary_key' => 'svcnum',
1988       'unique' => [ ],
1989       'index' => [ ['domain'] ],
1990     },
1991
1992     'svc_dsl' => {
1993       'columns' => [
1994         'svcnum',           'int',    '',        '', '', '',
1995         'pushed',     'int', 'NULL',       '', '', '',
1996         'desired_due_date',     'int', 'NULL',       '', '', '',
1997         'due_date',     'int', 'NULL',       '', '', '',
1998         'vendor_order_id',              'varchar', 'NULL', $char_d,  '', '',
1999         'vendor_qual_id',              'varchar', 'NULL', $char_d,  '', '',
2000         'vendor_order_type',   'varchar', 'NULL', $char_d,  '', '',
2001         'vendor_order_status',   'varchar', 'NULL', $char_d,  '', '',
2002         'first',              'varchar', 'NULL', $char_d,  '', '',
2003         'last',              'varchar', 'NULL', $char_d,  '', '',
2004         'company',              'varchar', 'NULL', $char_d,  '', '',
2005         'phonenum',     'varchar', 'NULL',       24, '', '',
2006         'loop_type',   'char', 'NULL',       1,  '', '',
2007         'local_voice_provider', 'varchar', 'NULL', $char_d,  '', '',
2008         'circuitnum',              'varchar', 'NULL', $char_d,  '', '',
2009         'rate_band',              'varchar', 'NULL', $char_d,  '', '',
2010         'vpi',     'int', 'NULL',       '', '', '',
2011         'vci',     'int', 'NULL',       '', '', '',
2012         'isp_chg',   'char', 'NULL',       1,  '', '',
2013         'isp_prev',              'varchar', 'NULL', $char_d,  '', '',
2014         'username',              'varchar', 'NULL', $char_d,  '', '',
2015         'password',              'varchar', 'NULL', $char_d,  '', '',
2016         'staticips',             'text', 'NULL', '',  '', '',
2017         'monitored',    'char', 'NULL',       1,  '', '',
2018         'last_pull',     'int', 'NULL',       '', '', '',
2019       ],
2020       'primary_key' => 'svcnum',
2021       'unique' => [ ],
2022       'index' => [ ['phonenum'], ['vendor_order_id'] ],
2023     },
2024
2025     'dsl_note' => {
2026       'columns' => [
2027         'notenum',           'serial',    '',        '', '', '',
2028         'svcnum',     'int', '',       '', '', '',
2029         'author',     'varchar', 'NULL', $char_d,  '', '',
2030         'priority',   'char', 'NULL',       1,  '', '',
2031         '_date',     'int', 'NULL',       '', '', '',
2032         'note',     'text', '',       '', '', '',
2033       ],
2034       'primary_key' => 'notenum',
2035       'unique' => [ ],
2036       'index' => [ ['svcnum'] ],
2037     },
2038
2039     'svc_dish' => {
2040       'columns' => [
2041         'svcnum',   'int',     '',     '', '', '',
2042         'acctnum',  'varchar', '',     16, '', '',
2043         'installdate', @date_type,         '', '',
2044         'note',     'text',    'NULL', '', '', '',
2045       ],
2046       'primary_key' => 'svcnum',
2047       'unique' => [ ],
2048       'index' => [ ],
2049     },
2050
2051     'svc_hardware' => {
2052       'columns' => [
2053         'svcnum',   'int',     '',          '', '', '',
2054         'typenum',  'int',     '',          '', '', '',
2055         'serial',   'varchar', 'NULL', $char_d, '', '',
2056         'ip_addr',  'varchar', 'NULL',      40, '', '',
2057         'hw_addr',  'varchar', 'NULL',      12, '', '',
2058         'smartcard','varchar', 'NULL',      30, '', '',
2059         'statusnum','int',     'NULL',      '', '', '',
2060         'note',     'text',    'NULL',      '', '', '',
2061       ],
2062       'primary_key' => 'svcnum',
2063       'unique' => [ ],
2064       'index' => [ ],
2065     },
2066
2067     'hardware_class' => {
2068       'columns' => [
2069         'classnum',   'serial', '',      '', '', '',
2070         'classname', 'varchar', '', $char_d, '', '',
2071       ],
2072       'primary_key' => 'classnum',
2073       'unique' => [ ],
2074       'index'  => [ ],
2075     },
2076
2077     'hardware_type' => {
2078       'columns' => [
2079         'typenum',  'serial', '',      '', '', '',
2080         'classnum',    'int', '',      '', '', '',
2081         'model',   'varchar', '', $char_d, '', '',
2082       ],
2083       'primary_key' => 'typenum',
2084       'unique' => [ ],
2085       'index'  => [ ],
2086     },
2087
2088     'hardware_status' => {
2089       'columns' => [
2090         'statusnum', 'serial', '',      '', '', '',
2091         'label'    ,'varchar', '', $char_d, '', '',
2092         'disabled',    'char', 'NULL',   1, '', '',
2093       ],
2094       'primary_key' => 'statusnum',
2095       'unique' => [ ],
2096       'index'  => [ ],
2097     },
2098
2099     'domain_record' => {
2100       'columns' => [
2101         'recnum',    'serial',     '',  '', '', '',
2102         'svcnum',    'int',     '',  '', '', '',
2103         'reczone',   'varchar', '',  255, '', '',
2104         'recaf',     'char',    '',  2, '', '',
2105         'rectype',   'varchar',    '',  5, '', '',
2106         'recdata',   'varchar', '',  255, '', '',
2107         'ttl',       'int',     'NULL', '', '', '',
2108       ],
2109       'primary_key' => 'recnum',
2110       'unique'      => [],
2111       'index'       => [ ['svcnum'] ],
2112     },
2113
2114     'registrar' => {
2115       'columns' => [
2116         'registrarnum',   'serial', '',      '', '', '',
2117         'registrarname', 'varchar', '', $char_d, '', '',
2118       ],
2119       'primary_key' => 'registrarnum',
2120       'unique'      => [],
2121       'index'       => [],
2122     },
2123
2124     'cgp_rule' => {
2125       'columns' => [
2126         'rulenum',  'serial',     '',      '', '', '',
2127         'name',    'varchar',     '', $char_d, '', '',
2128         'comment', 'varchar', 'NULL', $char_d, '', '',
2129         'svcnum',      'int',     '',      '', '', '',
2130         'priority',    'int',     '',      '', '', '',
2131       ],
2132       'primary_key' => 'rulenum',
2133       'unique'      => [ [ 'svcnum', 'name' ] ],
2134       'index'       => [ [ 'svcnum' ] ],
2135     },
2136
2137     'cgp_rule_condition' => {
2138       'columns' => [
2139         'ruleconditionnum',  'serial',     '',      '', '', '',
2140         'conditionname',    'varchar',     '', $char_d, '', '',
2141         'op',               'varchar', 'NULL', $char_d, '', '',
2142         'params',           'varchar', 'NULL',     255, '', '',
2143         'rulenum',              'int',     '',      '', '', '',
2144       ],
2145       'primary_key' => 'ruleconditionnum',
2146       'unique'      => [],
2147       'index'       => [ [ 'rulenum' ] ],
2148     },
2149
2150     'cgp_rule_action' => {
2151        'columns' => [
2152         'ruleactionnum',  'serial',     '',      '', '', '',
2153         'action',        'varchar',     '', $char_d, '', '',
2154         'params',        'varchar', 'NULL',     255, '', '',
2155         'rulenum',           'int',     '',      '', '', '',
2156       ],
2157       'primary_key' => 'ruleactionnum',
2158       'unique'      => [],
2159       'index'       => [ [ 'rulenum' ] ],
2160    },
2161
2162     'svc_forward' => {
2163       'columns' => [
2164         'svcnum',   'int',            '',   '', '', '',
2165         'srcsvc',   'int',        'NULL',   '', '', '',
2166         'src',      'varchar',    'NULL',  255, '', '',
2167         'dstsvc',   'int',        'NULL',   '', '', '',
2168         'dst',      'varchar',    'NULL',  255, '', '',
2169       ],
2170       'primary_key' => 'svcnum',
2171       'unique'      => [],
2172       'index'       => [ ['srcsvc'], ['dstsvc'] ],
2173     },
2174
2175     'svc_www' => {
2176       'columns' => [
2177         'svcnum',   'int',      '',  '', '', '',
2178         'recnum',   'int',      '',  '', '', '',
2179         'usersvc',  'int',  'NULL',  '', '', '',
2180         'config',   'text', 'NULL',  '', '', '',
2181       ],
2182       'primary_key' => 'svcnum',
2183       'unique'      => [],
2184       'index'       => [],
2185     },
2186
2187     #'svc_wo' => {
2188     #  'columns' => [
2189     #    'svcnum',    'int',    '',   '',
2190     #    'svcnum',    'int',    '',   '',
2191     #    'svcnum',    'int',    '',   '',
2192     #    'worker',    'varchar',   '',   $char_d,
2193     #    '_date',     @date_type,
2194     #  ],
2195     #  'primary_key' => 'svcnum',
2196     #  'unique' => [ [] ],
2197     #  'index' => [ [] ],
2198     #},
2199
2200     'prepay_credit' => {
2201       'columns' => [
2202         'prepaynum',   'serial',     '',   '', '', '',
2203         'identifier',  'varchar', '', $char_d, '', '',
2204         'amount',      @money_type, '', '',
2205         'seconds',     'int',     'NULL', '', '', '',
2206         'upbytes',     'bigint',     'NULL', '', '', '',
2207         'downbytes',   'bigint',     'NULL', '', '', '',
2208         'totalbytes',  'bigint',     'NULL', '', '', '',
2209         'agentnum',    'int',     'NULL', '', '', '',
2210       ],
2211       'primary_key' => 'prepaynum',
2212       'unique'      => [ ['identifier'] ],
2213       'index'       => [],
2214     },
2215
2216     'port' => {
2217       'columns' => [
2218         'portnum',  'serial',     '',   '', '', '',
2219         'ip',       'varchar', 'NULL', 15, '', '',
2220         'nasport',  'int',     'NULL', '', '', '',
2221         'nasnum',   'int',     '',   '', '', '',
2222       ],
2223       'primary_key' => 'portnum',
2224       'unique'      => [],
2225       'index'       => [],
2226     },
2227
2228     'nas' => {
2229       'columns' => [
2230         'nasnum',   'serial',     '',    '', '', '',
2231         'nas',      'varchar', '',    $char_d, '', '',
2232         'nasip',    'varchar', '',    15, '', '',
2233         'nasfqdn',  'varchar', '',    $char_d, '', '',
2234         'last',     'int',     '',    '', '', '',
2235       ],
2236       'primary_key' => 'nasnum',
2237       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
2238       'index'       => [ [ 'last' ] ],
2239     },
2240
2241 #    'session' => {
2242 #      'columns' => [
2243 #        'sessionnum', 'serial',       '',   '', '', '',
2244 #        'portnum',    'int',       '',   '', '', '',
2245 #        'svcnum',     'int',       '',   '', '', '',
2246 #        'login',      @date_type, '', '',
2247 #        'logout',     @date_type, '', '',
2248 #      ],
2249 #      'primary_key' => 'sessionnum',
2250 #      'unique'      => [],
2251 #      'index'       => [ [ 'portnum' ] ],
2252 #    },
2253
2254     'queue' => {
2255       'columns' => [
2256         'jobnum',      'serial',     '',      '', '', '',
2257         'job',        'varchar',     '',     512, '', '',
2258         '_date',          'int',     '',      '', '', '',
2259         'status',     'varchar',     '', $char_d, '', '',
2260         'statustext',    'text', 'NULL',      '', '', '',
2261         'svcnum',         'int', 'NULL',      '', '', '',
2262         'custnum',        'int', 'NULL',      '', '', '',
2263         'secure',        'char', 'NULL',       1, '', '',
2264         'priority',       'int', 'NULL',      '', '', '',
2265       ],
2266       'primary_key' => 'jobnum',
2267       'unique'      => [],
2268       'index'       => [ [ 'secure' ], [ 'priority' ],
2269                          [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
2270                        ],
2271     },
2272
2273     'queue_arg' => {
2274       'columns' => [
2275         'argnum', 'serial', '', '', '', '',
2276         'jobnum', 'int', '', '', '', '',
2277         'frozen', 'char', 'NULL',       1, '', '',
2278         'arg', 'text', 'NULL', '', '', '',
2279       ],
2280       'primary_key' => 'argnum',
2281       'unique'      => [],
2282       'index'       => [ [ 'jobnum' ] ],
2283     },
2284
2285     'queue_depend' => {
2286       'columns' => [
2287         'dependnum', 'serial', '', '', '', '',
2288         'jobnum', 'int', '', '', '', '',
2289         'depend_jobnum', 'int', '', '', '', '',
2290       ],
2291       'primary_key' => 'dependnum',
2292       'unique'      => [],
2293       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
2294     },
2295
2296     'export_svc' => {
2297       'columns' => [
2298         'exportsvcnum' => 'serial', '', '', '', '',
2299         'exportnum'    => 'int', '', '', '', '',
2300         'svcpart'      => 'int', '', '', '', '',
2301       ],
2302       'primary_key' => 'exportsvcnum',
2303       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
2304       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
2305     },
2306
2307     'export_device' => {
2308       'columns' => [
2309         'exportdevicenum' => 'serial', '', '', '', '',
2310         'exportnum'    => 'int', '', '', '', '',
2311         'devicepart'      => 'int', '', '', '', '',
2312       ],
2313       'primary_key' => 'exportdevicenum',
2314       'unique'      => [ [ 'exportnum', 'devicepart' ] ],
2315       'index'       => [ [ 'exportnum' ], [ 'devicepart' ] ],
2316     },
2317
2318     'part_export' => {
2319       'columns' => [
2320         'exportnum', 'serial', '', '', '', '',
2321         'exportname', 'varchar', 'NULL', $char_d, '', '',
2322         'machine', 'varchar', '', $char_d, '', '',
2323         'exporttype', 'varchar', '', $char_d, '', '',
2324         'nodomain',     'char', 'NULL', 1, '', '',
2325       ],
2326       'primary_key' => 'exportnum',
2327       'unique'      => [],
2328       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
2329     },
2330
2331     'part_export_option' => {
2332       'columns' => [
2333         'optionnum', 'serial', '', '', '', '',
2334         'exportnum', 'int', '', '', '', '',
2335         'optionname', 'varchar', '', $char_d, '', '',
2336         'optionvalue', 'text', 'NULL', '', '', '',
2337       ],
2338       'primary_key' => 'optionnum',
2339       'unique'      => [],
2340       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
2341     },
2342
2343     'radius_usergroup' => {
2344       'columns' => [
2345         'usergroupnum', 'serial', '', '', '', '',
2346         'svcnum',       'int', '', '', '', '',
2347         'groupname',    'varchar', 'NULL', $char_d, '', '',
2348         'groupnum',     'int', 'NULL', '', '', '',
2349       ],
2350       'primary_key' => 'usergroupnum',
2351       'unique'      => [],
2352       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
2353     },
2354
2355     'radius_group' => {
2356       'columns' => [
2357         'groupnum', 'serial', '', '', '', '',
2358         'groupname',    'varchar', '', $char_d, '', '',
2359         'description',  'varchar', 'NULL', $char_d, '', '',
2360       ],
2361       'primary_key' => 'groupnum',
2362       'unique'      => [ ['groupname'] ],
2363       'index'       => [],
2364     },
2365
2366     'msgcat' => {
2367       'columns' => [
2368         'msgnum', 'serial', '', '', '', '',
2369         'msgcode', 'varchar', '', 255, '', '',
2370         'locale', 'varchar', '', 16, '', '',
2371         'msg', 'text', '', '', '', '',
2372       ],
2373       'primary_key' => 'msgnum',
2374       'unique'      => [ [ 'msgcode', 'locale' ] ],
2375       'index'       => [],
2376     },
2377
2378     'cust_tax_exempt' => {
2379       'columns' => [
2380         'exemptnum', 'serial', '', '', '', '',
2381         'custnum',   'int', '', '', '', '',
2382         'taxnum',    'int', '', '', '', '',
2383         'year',      'int', '', '', '', '',
2384         'month',     'int', '', '', '', '',
2385         'amount',   @money_type, '', '',
2386       ],
2387       'primary_key' => 'exemptnum',
2388       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
2389       'index'       => [],
2390     },
2391
2392     'cust_tax_exempt_pkg' => {
2393       'columns' => [
2394         'exemptpkgnum',  'serial', '', '', '', '',
2395         #'custnum',      'int', '', '', '', ''
2396         'billpkgnum',   'int', '', '', '', '',
2397         'taxnum',       'int', '', '', '', '',
2398         'year',         'int', '', '', '', '',
2399         'month',        'int', '', '', '', '',
2400         'creditbillpkgnum', 'int', 'NULL', '', '', '',
2401         'amount',       @money_type, '', '',
2402       ],
2403       'primary_key' => 'exemptpkgnum',
2404       'unique' => [],
2405       'index'  => [ [ 'taxnum', 'year', 'month' ],
2406                     [ 'billpkgnum' ],
2407                     [ 'taxnum' ],
2408                     [ 'creditbillpkgnum' ],
2409                   ],
2410     },
2411
2412     'router' => {
2413       'columns' => [
2414         'routernum', 'serial', '', '', '', '',
2415         'routername', 'varchar', '', $char_d, '', '',
2416         'svcnum', 'int', 'NULL', '', '', '',
2417         'agentnum',   'int', 'NULL', '', '', '',
2418       ],
2419       'primary_key' => 'routernum',
2420       'unique'      => [],
2421       'index'       => [],
2422     },
2423
2424     'part_svc_router' => {
2425       'columns' => [
2426         'svcrouternum', 'serial', '', '', '', '',
2427         'svcpart', 'int', '', '', '', '',
2428         'routernum', 'int', '', '', '', '',
2429       ],
2430       'primary_key' => 'svcrouternum',
2431       'unique'      => [],
2432       'index'       => [],
2433     },
2434
2435     'addr_block' => {
2436       'columns' => [
2437         'blocknum', 'serial', '', '', '', '',
2438         'routernum', 'int', '', '', '', '',
2439         'ip_gateway', 'varchar', '', 15, '', '',
2440         'ip_netmask', 'int', '', '', '', '',
2441         'agentnum',   'int', 'NULL', '', '', '',
2442         'manual_flag', 'char', 'NULL', 1, '', '',
2443       ],
2444       'primary_key' => 'blocknum',
2445       'unique'      => [ [ 'blocknum', 'routernum' ] ],
2446       'index'       => [],
2447     },
2448
2449     'svc_broadband' => {
2450       'columns' => [
2451         'svcnum', 'int', '', '', '', '',
2452         'description', 'varchar', 'NULL', $char_d, '', '',
2453         'blocknum', 'int', 'NULL', '', '', '',
2454         'speed_up', 'int', '', '', '', '',
2455         'speed_down', 'int', '', '', '', '',
2456         'ip_addr', 'varchar', 'NULL', 15, '', '',
2457         'mac_addr', 'varchar', 'NULL', 12, '', '',
2458         'authkey',  'varchar', 'NULL', 32, '', '',
2459         'latitude', 'decimal', 'NULL', '', '', '',
2460         'longitude', 'decimal', 'NULL', '', '', '',
2461         'altitude', 'decimal', 'NULL', '', '', '',
2462         'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
2463         'performance_profile', 'varchar', 'NULL', $char_d, '', '',
2464         'plan_id', 'varchar', 'NULL', $char_d, '', '',
2465       ],
2466       'primary_key' => 'svcnum',
2467       'unique'      => [ [ 'mac_addr' ] ],
2468       'index'       => [],
2469     },
2470
2471     'part_virtual_field' => {
2472       'columns' => [
2473         'vfieldpart', 'serial', '', '', '', '',
2474         'dbtable', 'varchar', '', 32, '', '',
2475         'name', 'varchar', '', 32, '', '',
2476         'length', 'int', 'NULL', '', '', '',
2477         'label', 'varchar', 'NULL', 80, '', '',
2478       ],
2479       'primary_key' => 'vfieldpart',
2480       'unique' => [],
2481       'index' => [],
2482     },
2483
2484     'virtual_field' => {
2485       'columns' => [
2486         'vfieldnum', 'serial', '', '', '', '',
2487         'recnum', 'int', '', '', '', '',
2488         'vfieldpart', 'int', '', '', '', '',
2489         'value', 'varchar', '', 128, '', '',
2490       ],
2491       'primary_key' => 'vfieldnum',
2492       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
2493       'index' => [],
2494     },
2495
2496     'acct_snarf' => {
2497       'columns' => [
2498         'snarfnum',    'serial',     '',      '', '', '',
2499         'snarfname',  'varchar', 'NULL', $char_d, '', '',
2500         'svcnum',         'int',     '',      '', '', '',
2501         'machine',    'varchar',     '',     255, '', '',
2502         'protocol',   'varchar',     '', $char_d, '', '',
2503         'username',   'varchar',     '', $char_d, '', '',
2504         '_password',  'varchar',     '', $char_d, '', '',
2505         'check_freq',     'int', 'NULL',      '', '', '',
2506         'leavemail',     'char', 'NULL',       1, '', '',
2507         'apop',          'char', 'NULL',       1, '', '',
2508         'tls',           'char', 'NULL',       1, '', '',
2509         'mailbox',    'varchar', 'NULL', $char_d, '', '',
2510       ],
2511       'primary_key' => 'snarfnum',
2512       'unique' => [],
2513       'index'  => [ [ 'svcnum' ] ],
2514     },
2515
2516     'svc_external' => {
2517       'columns' => [
2518         'svcnum',     'int',     '',      '', '', '',
2519         'id',      'bigint', 'NULL',      '', '', '',
2520         'title',  'varchar', 'NULL', $char_d, '', '',
2521       ],
2522       'primary_key' => 'svcnum',
2523       'unique'      => [],
2524       'index'       => [],
2525     },
2526
2527     'cust_pay_refund' => {
2528       'columns' => [
2529         'payrefundnum', 'serial', '', '', '', '',
2530         'paynum',  'int', '', '', '', '',
2531         'refundnum',  'int', '', '', '', '',
2532         '_date',    @date_type, '', '',
2533         'amount',   @money_type, '', '',
2534       ],
2535       'primary_key' => 'payrefundnum',
2536       'unique' => [],
2537       'index' => [ ['paynum'], ['refundnum'] ],
2538     },
2539
2540     'part_pkg_option' => {
2541       'columns' => [
2542         'optionnum', 'serial', '', '', '', '',
2543         'pkgpart', 'int', '', '', '', '',
2544         'optionname', 'varchar', '', $char_d, '', '',
2545         'optionvalue', 'text', 'NULL', '', '', '',
2546       ],
2547       'primary_key' => 'optionnum',
2548       'unique'      => [],
2549       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
2550     },
2551
2552     'part_pkg_vendor' => {
2553       'columns' => [
2554         'num', 'serial', '', '', '', '',
2555         'pkgpart', 'int', '', '', '', '',
2556         'exportnum', 'int', '', '', '', '',
2557         'vendor_pkg_id', 'varchar', '', $char_d, '', '',
2558       ],
2559       'primary_key' => 'num',
2560       'unique' => [ [ 'pkgpart', 'exportnum' ] ],
2561       'index'       => [ [ 'pkgpart' ] ],
2562     },
2563
2564     'part_pkg_report_option' => {
2565       'columns' => [
2566         'num',      'serial',   '',      '', '', '',
2567         'name',     'varchar',  '', $char_d, '', '',
2568         'disabled', 'char', 'NULL',       1, '', '',
2569       ],
2570       'primary_key' => 'num',
2571       'unique' => [ [ 'name' ] ],
2572       'index' => [ [ 'disabled' ] ],
2573     },
2574
2575     'rate' => {
2576       'columns' => [
2577         'ratenum',  'serial', '', '', '', '',
2578         'ratename', 'varchar', '', $char_d, '', '',
2579       ],
2580       'primary_key' => 'ratenum',
2581       'unique'      => [],
2582       'index'       => [],
2583     },
2584
2585     'rate_detail' => {
2586       'columns' => [
2587         'ratedetailnum',   'serial',  '',     '', '', '',
2588         'ratenum',         'int',     '',     '', '', '',
2589         'orig_regionnum',  'int', 'NULL',     '', '', '',
2590         'dest_regionnum',  'int',     '',     '', '', '',
2591         'min_included',    'int',     '',     '', '', '',
2592         'conn_charge',     'decimal', '', '10,4', '0', '',
2593         'conn_sec',        'int',     '',     '', '0', '',
2594         'min_charge',      'decimal', '', '10,5', '', '', #@money_type, '', '',
2595         'sec_granularity', 'int',     '',     '', '', '',
2596         'ratetimenum',     'int', 'NULL',     '', '', '',
2597         'classnum',        'int', 'NULL',     '', '', '',
2598         'cdrtypenum',      'int', 'NULL',     '', '', '',
2599         'region_group', 'char', 'NULL',       1, '', '',
2600       ],
2601       'primary_key' => 'ratedetailnum',
2602       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
2603       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
2604     },
2605
2606     'rate_region' => {
2607       'columns' => [
2608         'regionnum',   'serial',      '', '', '', '',
2609         'regionname',  'varchar',     '', $char_d, '', '',
2610       ],
2611       'primary_key' => 'regionnum',
2612       'unique'      => [],
2613       'index'       => [],
2614     },
2615
2616     'rate_prefix' => {
2617       'columns' => [
2618         'prefixnum',   'serial',      '', '', '', '',
2619         'regionnum',   'int',         '', '', '', '',
2620         'countrycode', 'varchar',     '',  3, '', '',
2621         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
2622         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
2623         'latanum',     'int',     'NULL',      '', '', '',
2624         'state',       'char',    'NULL',       2, '', '',
2625         'ocn',         'char',    'NULL',       4, '', '',
2626       ],
2627       'primary_key' => 'prefixnum',
2628       'unique'      => [],
2629       'index'       => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
2630     },
2631
2632     'rate_time' => {
2633       'columns' => [
2634         'ratetimenum', 'serial',      '',      '', '', '',
2635         'ratetimename',   'varchar',      '', $char_d, '', '',
2636       ],
2637       'primary_key' => 'ratetimenum',
2638       'unique'      => [],
2639       'index'       => [],
2640     },
2641
2642     'rate_time_interval' => {
2643       'columns' => [
2644         'intervalnum', 'serial', '', '', '', '',
2645         'stime',          'int', '', '', '', '',
2646         'etime',          'int', '', '', '', '',
2647         'ratetimenum',    'int', '', '', '', '',
2648       ],
2649       'primary_key' => 'intervalnum',
2650       'unique'      => [],
2651       'index'       => [],
2652     },
2653
2654     'usage_class' => {
2655       'columns' => [
2656         'classnum',    'serial',      '',      '', '', '',
2657         'weight',      'int',     'NULL',      '', '', '',
2658         'classname',   'varchar',     '', $char_d, '', '',
2659         'format',      'varchar', 'NULL', $char_d, '', '',
2660         'disabled',    'char',    'NULL',       1, '', '',
2661       ],
2662       'primary_key' => 'classnum',
2663       'unique' => [],
2664       'index' => [ ['disabled'] ],
2665     },
2666
2667     'reg_code' => {
2668       'columns' => [
2669         'codenum',   'serial',    '', '', '', '',
2670         'code',      'varchar',   '', $char_d, '', '',
2671         'agentnum',  'int',       '', '', '', '',
2672       ],
2673       'primary_key' => 'codenum',
2674       'unique'      => [ [ 'agentnum', 'code' ] ],
2675       'index'       => [ [ 'agentnum' ] ],
2676     },
2677
2678     'reg_code_pkg' => {
2679       'columns' => [
2680         'codepkgnum', 'serial', '', '', '', '',
2681         'codenum',   'int',    '', '', '', '',
2682         'pkgpart',   'int',    '', '', '', '',
2683       ],
2684       'primary_key' => 'codepkgnum',
2685       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
2686       'index'       => [ [ 'codenum' ] ],
2687     },
2688
2689     'clientapi_session' => {
2690       'columns' => [
2691         'sessionnum',  'serial',  '', '', '', '',
2692         'sessionid',  'varchar',  '', $char_d, '', '',
2693         'namespace',  'varchar',  '', $char_d, '', '',
2694       ],
2695       'primary_key' => 'sessionnum',
2696       'unique'      => [ [ 'sessionid', 'namespace' ] ],
2697       'index'       => [],
2698     },
2699
2700     'clientapi_session_field' => {
2701       'columns' => [
2702         'fieldnum',    'serial',     '', '', '', '',
2703         'sessionnum',     'int',     '', '', '', '',
2704         'fieldname',  'varchar',     '', $char_d, '', '',
2705         'fieldvalue',    'text', 'NULL', '', '', '',
2706       ],
2707       'primary_key' => 'fieldnum',
2708       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
2709       'index'       => [],
2710     },
2711
2712     'payment_gateway' => {
2713       'columns' => [
2714         'gatewaynum',       'serial',   '',     '', '', '',
2715         'gateway_namespace','varchar',  'NULL', $char_d, '', '',
2716         'gateway_module',   'varchar',  '',     $char_d, '', '',
2717         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
2718         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
2719         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
2720         'gateway_callback_url', 'varchar',  'NULL', $char_d, '', '',
2721         'disabled',   'char',  'NULL',   1, '', '',
2722       ],
2723       'primary_key' => 'gatewaynum',
2724       'unique' => [],
2725       'index'  => [ [ 'disabled' ] ],
2726     },
2727
2728     'payment_gateway_option' => {
2729       'columns' => [
2730         'optionnum',   'serial',  '',     '', '', '',
2731         'gatewaynum',  'int',     '',     '', '', '',
2732         'optionname',  'varchar', '',     $char_d, '', '',
2733         'optionvalue', 'text',    'NULL', '', '', '',
2734       ],
2735       'primary_key' => 'optionnum',
2736       'unique'      => [],
2737       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
2738     },
2739
2740     'agent_payment_gateway' => {
2741       'columns' => [
2742         'agentgatewaynum', 'serial', '', '', '', '',
2743         'agentnum',        'int', '', '', '', '',
2744         'gatewaynum',      'int', '', '', '', '',
2745         'cardtype',        'varchar', 'NULL', $char_d, '', '',
2746         'taxclass',        'varchar', 'NULL', $char_d, '', '',
2747       ],
2748       'primary_key' => 'agentgatewaynum',
2749       'unique'      => [],
2750       'index'       => [ [ 'agentnum', 'cardtype' ], ],
2751     },
2752
2753     'banned_pay' => {
2754       'columns' => [
2755         'bannum',  'serial',   '',     '', '', '',
2756         'payby',   'char',     '',       4, '', '',
2757         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
2758         #'paymask', 'varchar',  'NULL', $char_d, '', ''
2759         '_date',            @date_type,         '', '',
2760         'end_date',         @date_type,         '', '',
2761         'otaker',  'varchar',  'NULL',      32, '', '',
2762         'usernum',     'int',  'NULL',      '', '', '',
2763         'bantype', 'varchar',  'NULL', $char_d, '', '',
2764         'reason',  'varchar',  'NULL', $char_d, '', '',
2765       ],
2766       'primary_key' => 'bannum',
2767       'unique'      => [],
2768       'index'       => [ [ 'payby', 'payinfo' ], [ 'usernum' ], ],
2769     },
2770
2771     'pkg_category' => {
2772       'columns' => [
2773         'categorynum',   'serial',  '', '', '', '',
2774         'categoryname',  'varchar', '', $char_d, '', '',
2775         'weight',         'int', 'NULL',  '', '', '',
2776         'condense',      'char', 'NULL',   1, '', '',
2777         'disabled',      'char', 'NULL',   1, '', '',
2778       ],
2779       'primary_key' => 'categorynum',
2780       'unique' => [],
2781       'index' => [ ['disabled'] ],
2782     },
2783
2784     'pkg_class' => {
2785       'columns' => [
2786         'classnum',    'serial',   '',      '', '', '',
2787         'classname',   'varchar',  '', $char_d, '', '',
2788         'categorynum', 'int',  'NULL',      '', '', '',
2789         'disabled',    'char', 'NULL',       1, '', '',
2790         'fcc_ds0s',      'int',     'NULL', '', '', '',
2791       ],
2792       'primary_key' => 'classnum',
2793       'unique' => [],
2794       'index' => [ ['disabled'] ],
2795     },
2796
2797     'cdr' => {
2798       'columns' => [
2799         # qw( name type null length default local );
2800
2801         ###
2802         #asterisk fields
2803         ###
2804
2805         'acctid',   'bigserial',  '', '', '', '',
2806         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
2807         'calldate', 'timestamp',   '',      '', \'now()', '',
2808         'clid',        'varchar',  '', $char_d, \"''", '',
2809         'src',         'varchar',  '', $char_d, \"''", '',
2810         'dst',         'varchar',  '', $char_d, \"''", '',
2811         'dcontext',    'varchar',  '', $char_d, \"''", '',
2812         'channel',     'varchar',  '', $char_d, \"''", '',
2813         'dstchannel',  'varchar',  '', $char_d, \"''", '',
2814         'lastapp',     'varchar',  '', $char_d, \"''", '',
2815         'lastdata',    'varchar',  '', $char_d, \"''", '',
2816
2817         #these don't seem to be logged by most of the SQL cdr_* modules
2818         #except tds under sql-illegal names, so;
2819         # ... don't rely on them for rating?
2820         # and, what they hey, i went ahead and changed the names and data types
2821         # to freeside-style dates...
2822           #'start',  'timestamp', 'NULL',  '',    '', '',
2823           #'answer', 'timestamp', 'NULL',  '',    '', '',
2824           #'end',    'timestamp', 'NULL',  '',    '', '',
2825         'startdate',  @date_type, '', '',
2826         'answerdate', @date_type, '', '',
2827         'enddate',    @date_type, '', '',
2828         #
2829
2830         'duration',    'int',      '',      '',     0, '',
2831         'billsec',     'int',      '',      '',     0, '',
2832         'disposition', 'varchar',  '',      45, \"''", '',
2833         'amaflags',    'int',      '',      '',     0, '',
2834         'accountcode', 'varchar',  '',      20, \"''", '',
2835         'uniqueid',    'varchar',  '', $char_d, \"''", '',
2836         'userfield',   'varchar',  '',     255, \"''", '',
2837
2838         'max_callers', 'int',  'NULL',      '',    '', '',
2839
2840         ###
2841         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
2842         # defaults
2843         # though these are now used elsewhere:
2844         # charged_party, upstream_price, rated_price, carrierid, cdrtypenum
2845         ###
2846
2847         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
2848         'cdrtypenum',              'int', 'NULL',      '', '', '',
2849
2850         'charged_party',       'varchar', 'NULL', $char_d, '', '',
2851
2852         'upstream_currency',      'char', 'NULL',       3, '', '',
2853         'upstream_price',      'decimal', 'NULL',  '10,4', '', '',
2854         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
2855
2856         # how it was rated internally...
2857         'ratedetailnum',           'int', 'NULL',      '', '', '',
2858         'rated_price',         'decimal', 'NULL',  '10,4', '', '',
2859
2860         'distance',            'decimal', 'NULL',      '', '', '',
2861         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
2862
2863         #cdr_calltype: the big list in appendix 2
2864         'calltypenum',             'int', 'NULL',      '', '', '',
2865
2866         'description',         'varchar', 'NULL', $char_d, '', '',
2867         'quantity',                'int', 'NULL',      '', '', '',
2868
2869         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
2870         'carrierid',               'int', 'NULL',      '', '', '',
2871
2872         'upstream_rateid',         'int', 'NULL',      '', '', '',
2873
2874         ###
2875         #and now for our own fields
2876         ###
2877
2878         # a svcnum... right..?
2879         'svcnum',             'int',   'NULL',     '',   '', '',
2880
2881         #NULL, done (or something)
2882         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
2883
2884         #NULL, done (or something)
2885         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '',
2886
2887         #an indexed place to put big numbers
2888         'cdrid',         'bigint',     'NULL',     '',  '', '',
2889
2890         #for taqua accountcode rewriting, for starters
2891         'sessionnum',       'int',    'NULL',      '', '', '',
2892         'subscriber',   'varchar',    'NULL', $char_d, '', '',
2893
2894         #old
2895         'cdrbatch',     'varchar',    'NULL',     255, '', '',
2896         #new
2897         'cdrbatchnum',      'int',    'NULL',      '', '', '',
2898
2899       ],
2900       'primary_key' => 'acctid',
2901       'unique' => [],
2902       'index' => [ [ 'calldate' ],
2903                    [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
2904                    [ 'lastapp' ],
2905                    ['accountcode'], ['uniqueid'], ['carrierid'], ['cdrid'],
2906                    [ 'sessionnum' ], [ 'subscriber' ],
2907                    [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
2908                    [ 'cdrbatch' ], [ 'cdrbatchnum' ],
2909                  ],
2910     },
2911
2912     'cdr_batch' => {
2913       'columns' => [
2914         'cdrbatchnum',   'serial',    '',   '', '', '',
2915         'cdrbatch', 'varchar', 'NULL', 255, '', '',
2916         '_date',     @date_type, '', '',
2917       ],
2918       'primary_key' => 'cdrbatchnum',
2919       'unique' => [ [ 'cdrbatch' ] ],
2920       'index' => [],
2921     },
2922
2923     'cdr_termination' => {
2924       'columns' => [
2925         'cdrtermnum', 'bigserial',     '',      '', '', '',
2926         'acctid',        'bigint',     '',      '', '', '',
2927         'termpart',         'int',     '',      '', '', '',#future use see below
2928         'rated_price',  'decimal', 'NULL',  '10,4', '', '',
2929         'status',       'varchar', 'NULL',      32, '', '',
2930         'svcnum',           'int', 'NULL',      '', '', '',
2931       ],
2932       'primary_key' => 'cdrtermnum',
2933       'unique'      => [ [ 'acctid', 'termpart' ] ],
2934       'index'       => [ [ 'acctid' ], [ 'status' ], ],
2935     },
2936
2937     #to handle multiple termination/settlement passes...
2938    # 'part_termination' => {
2939    #   'columns' => [
2940    #     'termpart',       'int', '',      '', '', '',
2941    #     'termname',   'varchar', '', $char_d, '', '',
2942    #     'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
2943    #   ],
2944    #   'primary_key' => 'termpart',
2945    #   'unique' => [],
2946    #   'index'  => [],
2947    # },
2948
2949     #the remaining cdr_ tables are not really used
2950     'cdr_calltype' => {
2951       'columns' => [
2952         'calltypenum',   'serial',  '', '', '', '',
2953         'calltypename',  'varchar', '', $char_d, '', '',
2954       ],
2955       'primary_key' => 'calltypenum',
2956       'unique'      => [],
2957       'index'       => [],
2958     },
2959
2960     'cdr_type' => {
2961       'columns' => [
2962         'cdrtypenum'  => 'serial',  '', '', '', '',
2963         'cdrtypename' => 'varchar', '', $char_d, '', '',
2964       ],
2965       'primary_key' => 'cdrtypenum',
2966       'unique'      => [],
2967       'index'       => [],
2968     },
2969
2970     'cdr_carrier' => {
2971       'columns' => [
2972         'carrierid'   => 'serial',  '', '', '', '',
2973         'carriername' => 'varchar', '', $char_d, '', '',
2974       ],
2975       'primary_key' => 'carrierid',
2976       'unique'      => [],
2977       'index'       => [],
2978     },
2979
2980     #'cdr_file' => {
2981     #  'columns' => [
2982     #    'filenum',    'serial',     '', '', '', '',
2983     #    'filename',  'varchar',     '', '', '', '',
2984     #    'status',    'varchar', 'NULL', '', '', '',
2985     #  ],
2986     #  'primary_key' => 'filenum',
2987     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
2988     #                                   # agent-virtualize or have a customer
2989     #                                   # with dup-filename needs or something
2990     #                                   # (only used by cdr.http_and_import for
2991     #                                   #  chrissakes)
2992     #  'index'  => [],
2993     #},
2994
2995     'inventory_item' => {
2996       'columns' => [
2997         'itemnum',  'serial',      '',      '', '', '',
2998         'classnum', 'int',         '',      '', '', '',
2999         'agentnum', 'int',     'NULL',      '', '', '',
3000         'item',     'varchar',     '', $char_d, '', '',
3001         'svcnum',   'int',     'NULL',      '', '', '',
3002       ],
3003       'primary_key' => 'itemnum',
3004       'unique' => [ [ 'classnum', 'item' ] ],
3005       'index'  => [ [ 'classnum' ], [ 'agentnum' ], [ 'svcnum' ] ],
3006     },
3007
3008     'inventory_class' => {
3009       'columns' => [
3010         'classnum',  'serial',       '',      '', '', '',
3011         'classname', 'varchar',      '', $char_d, '', '',
3012       ],
3013       'primary_key' => 'classnum',
3014       'unique' => [],
3015       'index'  => [],
3016     },
3017
3018     'access_user' => {
3019       'columns' => [
3020         'usernum',   'serial',  '',      '', '', '',
3021         'username',  'varchar', '', $char_d, '', '',
3022         '_password', 'varchar', '', $char_d, '', '',
3023         'last',      'varchar', '', $char_d, '', '',
3024         'first',     'varchar', '', $char_d, '', '',
3025         'user_custnum',  'int', 'NULL',  '', '', '',
3026         'disabled',     'char', 'NULL',   1, '', '',
3027       ],
3028       'primary_key' => 'usernum',
3029       'unique' => [ [ 'username' ] ],
3030       'index'  => [ [ 'user_custnum' ] ],
3031     },
3032
3033     'access_user_pref' => {
3034       'columns' => [
3035         'prefnum',    'serial',       '', '', '', '',
3036         'usernum',     'int',       '', '', '', '',
3037         'prefname', 'varchar', '', $char_d, '', '',
3038         'prefvalue', 'text', 'NULL', '', '', '',
3039         'expiration', @date_type, '', '',
3040       ],
3041       'primary_key' => 'prefnum',
3042       'unique' => [],
3043       'index'  => [ [ 'usernum' ] ],
3044     },
3045
3046     'access_group' => {
3047       'columns' => [
3048         'groupnum',   'serial', '',      '', '', '',
3049         'groupname', 'varchar', '', $char_d, '', '',
3050       ],
3051       'primary_key' => 'groupnum',
3052       'unique' => [ [ 'groupname' ] ],
3053       'index'  => [],
3054     },
3055
3056     'access_usergroup' => {
3057       'columns' => [
3058         'usergroupnum', 'serial', '', '', '', '',
3059         'usernum',         'int', '', '', '', '',
3060         'groupnum',        'int', '', '', '', '',
3061       ],
3062       'primary_key' => 'usergroupnum',
3063       'unique' => [ [ 'usernum', 'groupnum' ] ],
3064       'index'  => [ [ 'usernum' ] ],
3065     },
3066
3067     'access_groupagent' => {
3068       'columns' => [
3069         'groupagentnum', 'serial', '', '', '', '',
3070         'groupnum',         'int', '', '', '', '',
3071         'agentnum',         'int', '', '', '', '',
3072       ],
3073       'primary_key' => 'groupagentnum',
3074       'unique' => [ [ 'groupnum', 'agentnum' ] ],
3075       'index'  => [ [ 'groupnum' ] ],
3076     },
3077
3078     'access_right' => {
3079       'columns' => [
3080         'rightnum',   'serial', '',      '', '', '',
3081         'righttype', 'varchar', '', $char_d, '', '',
3082         'rightobjnum',   'int', '',      '', '', '',
3083         'rightname', 'varchar', '', $char_d, '', '',
3084       ],
3085       'primary_key' => 'rightnum',
3086       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
3087       'index'  => [],
3088     },
3089
3090     'svc_phone' => {
3091       'columns' => [
3092         'svcnum',       'int',         '',      '', '', '',
3093         'countrycode',  'varchar',     '',       3, '', '',
3094         'phonenum',     'varchar',     '',      15, '', '',  #12 ?
3095         'pin',          'varchar', 'NULL', $char_d, '', '',
3096         'sip_password', 'varchar', 'NULL', $char_d, '', '',
3097         'phone_name',   'varchar', 'NULL', $char_d, '', '',
3098         'pbxsvc',           'int', 'NULL',      '', '', '',
3099         'domsvc',           'int', 'NULL',      '', '', '',
3100         'locationnum',      'int', 'NULL', '', '', '',
3101         'forwarddst',     'varchar',     'NULL',      15, '', '',
3102         'email',           'varchar', 'NULL',  255, '', '',
3103         'lnp_status',   'varchar', 'NULL', $char_d, '', '',
3104         'portable',     'char', 'NULL',       1,  '', '',
3105         'lrn',     'char',     'NULL',      10, '', '',
3106         'lnp_desired_due_date',     'int', 'NULL',       '', '', '',
3107         'lnp_due_date',     'int', 'NULL',       '', '', '',
3108         'lnp_other_provider', 'varchar', 'NULL', $char_d,  '', '',
3109         'lnp_other_provider_account', 'varchar', 'NULL', $char_d,  '', '',
3110         'lnp_reject_reason', 'varchar', 'NULL', $char_d,  '', '',
3111       ],
3112       'primary_key' => 'svcnum',
3113       'unique' => [],
3114       'index'  => [ ['countrycode', 'phonenum'], ['pbxsvc'], ['domsvc'],
3115                     ['locationnum'],
3116                   ],
3117     },
3118
3119     'phone_device' => {
3120       'columns' => [
3121         'devicenum', 'serial',     '', '', '', '',
3122         'devicepart',   'int',     '', '', '', '',
3123         'svcnum',       'int',     '', '', '', '',
3124         'mac_addr', 'varchar', 'NULL', 12, '', '',
3125       ],
3126       'primary_key' => 'devicenum',
3127       'unique' => [ [ 'mac_addr' ], ],
3128       'index'  => [ [ 'devicepart' ], [ 'svcnum' ], ],
3129     },
3130
3131     'part_device' => {
3132       'columns' => [
3133         'devicepart', 'serial',  '',      '', '', '',
3134         'devicename', 'varchar', '', $char_d, '', '',
3135         'inventory_classnum', 'int', 'NULL', '', '', '',
3136       ],
3137       'primary_key' => 'devicepart',
3138       'unique' => [ [ 'devicename' ] ], #?
3139       'index'  => [],
3140     },
3141
3142     'phone_avail' => {
3143       'columns' => [
3144         'availnum',    'serial',      '',      '', '', '',
3145         'exportnum',   'int',         '',      '', '', '',
3146         'countrycode', 'varchar',     '',       3, '', '',
3147         'state',       'char',    'NULL',       2, '', '',
3148         'npa',         'char',        '',       3, '', '',
3149         'nxx',         'char',    'NULL',       3, '', '',
3150         'station',     'char',    'NULL',       4, '', '',
3151         'name',        'varchar', 'NULL', $char_d, '', '',
3152         'rate_center_abbrev', 'varchar', 'NULL', $char_d, '', '',
3153         'latanum',      'int',     'NULL',      '', '', '',
3154         'msanum',       'int', 'NULL', '', '', '',
3155         'ordernum',      'int',     'NULL',      '', '', '',
3156         'svcnum',      'int',     'NULL',      '', '', '',
3157         'availbatch', 'varchar',  'NULL', $char_d, '', '',
3158       ],
3159       'primary_key' => 'availnum',
3160       'unique' => [],
3161       'index'  => [ [ 'exportnum', 'countrycode', 'state' ],     #npa search
3162                     [ 'exportnum', 'countrycode', 'npa' ],       #nxx search
3163                     [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
3164                     [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
3165                     [ 'svcnum' ],
3166                     [ 'availbatch' ],
3167                     [ 'latanum' ],
3168                   ],
3169     },
3170
3171     'lata' => {
3172       'columns' => [
3173         'latanum',    'int',      '',      '', '', '',
3174         'description',   'varchar',    '',      $char_d, '', '',
3175         'have_usage',   'int',    'NULL',      '', '', '',
3176       ],
3177       'primary_key' => 'latanum',
3178       'unique' => [],
3179       'index'  => [],
3180     },
3181
3182     'msa' => {
3183       'columns' => [
3184         'msanum',    'int',      '',      '', '', '',
3185         'description',   'varchar',    '',      $char_d, '', '',
3186       ],
3187       'primary_key' => 'msanum',
3188       'unique' => [],
3189       'index'  => [],
3190     },
3191
3192     'rate_center' => {
3193       'columns' => [
3194         'ratecenternum',    'serial',      '',      '', '', '',
3195         'description',   'varchar',    '',      $char_d, '', '',
3196       ],
3197       'primary_key' => 'ratecenternum',
3198       'unique' => [],
3199       'index'  => [],
3200     },
3201
3202     'did_vendor' => {
3203       'columns' => [
3204         'vendornum',    'serial',      '',      '', '', '',
3205         'vendorname',   'varchar',        '',     $char_d, '', '',
3206       ],
3207       'primary_key' => 'vendornum',
3208       'unique' => [],
3209       'index'  => [],
3210     },
3211
3212     'did_order_item' => {
3213       'columns' => [
3214         'orderitemnum',    'serial',      '',      '', '', '',
3215         'ordernum',    'int',      '',      '', '', '',
3216         'msanum',      'int',     'NULL',      '', '', '',
3217         'npa',      'int',     'NULL',      '', '', '',
3218         'latanum',      'int',     'NULL',      '', '', '',
3219         'ratecenternum',      'int',     'NULL',      '', '', '',
3220         'state',       'char',    'NULL',       2, '', '',
3221         'quantity',      'int',     '',      '', '', '',
3222         'custnum',   'int', 'NULL', '', '', '',
3223       ],
3224       'primary_key' => 'orderitemnum',
3225       'unique' => [],
3226       'index'  => [],
3227     },
3228
3229     'did_order' => {
3230       'columns' => [
3231         'ordernum',    'serial',      '',      '', '', '',
3232         'vendornum',   'int',       '',      '', '', '',
3233         'vendor_order_id',   'varchar',  'NULL',   $char_d, '', '',
3234         'custnum',   'int', 'NULL', '', '', '',
3235         'submitted',      'int',     '',      '', '', '',
3236         'confirmed',      'int',     'NULL',      '', '', '',
3237         'received',      'int',     'NULL',      '', '', '',
3238       ],
3239       'primary_key' => 'ordernum',
3240       'unique' => [ [ 'vendornum', 'vendor_order_id' ] ],
3241       'index'  => [],
3242     },
3243
3244     'reason_type' => {
3245       'columns' => [
3246         'typenum',   'serial',  '', '', '', '',
3247         'class',     'char', '', 1, '', '',
3248         'type',     'varchar', '', $char_d, '', '',
3249       ],
3250       'primary_key' => 'typenum',
3251       'unique' => [],
3252       'index' => [],
3253     },
3254
3255     'reason' => {
3256       'columns' => [
3257         'reasonnum',     'serial',  '', '', '', '',
3258         'reason_type',   'int',  '', '', '', '',
3259         'reason',        'text', '', '', '', '',
3260         'disabled',      'char',    'NULL', 1, '', '',
3261       ],
3262       'primary_key' => 'reasonnum',
3263       'unique' => [],
3264       'index' => [],
3265     },
3266
3267     'conf' => {
3268       'columns' => [
3269         'confnum',  'serial',     '',      '', '', '',
3270         'agentnum', 'int',    'NULL',      '', '', '',
3271         'locale',   'varchar','NULL',      16, '', '',
3272         'name',     'varchar',    '', $char_d, '', '',
3273         'value',    'text',   'NULL',      '', '', '',
3274       ],
3275       'primary_key' => 'confnum',
3276       'unique' => [ [ 'agentnum', 'locale', 'name' ] ],
3277       'index' => [],
3278     },
3279
3280     'pkg_referral' => {
3281       'columns' => [
3282         'pkgrefnum',     'serial', '', '', '', '',
3283         'pkgnum',        'int',    '', '', '', '',
3284         'refnum',        'int',    '', '', '', '',
3285       ],
3286       'primary_key' => 'pkgrefnum',
3287       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
3288       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
3289     },
3290
3291     'svc_pbx' => {
3292       'columns' => [
3293         'svcnum',           'int',     '',      '', '', '',
3294         'id',               'int', 'NULL',      '', '', '',
3295         'title',        'varchar', 'NULL', $char_d, '', '',
3296         'max_extensions',   'int', 'NULL',      '', '', '',
3297         'max_simultaneous', 'int', 'NULL',      '', '', '',
3298       ],
3299       'primary_key' => 'svcnum',
3300       'unique' => [],
3301       'index'  => [ [ 'id' ] ],
3302     },
3303
3304     'svc_mailinglist' => { #svc_group?
3305       'columns' => [
3306         'svcnum',            'int',     '',            '', '', '',
3307         'username',      'varchar',     '', $username_len, '', '',
3308         'domsvc',            'int',     '',            '', '', '',
3309         'listnum',           'int',     '',            '', '', '',
3310         'reply_to',         'char', 'NULL',             1, '', '',#SetReplyTo
3311         'remove_from',      'char', 'NULL',             1, '', '',#RemoveAuthor
3312         'reject_auto',      'char', 'NULL',             1, '', '',#RejectAuto
3313         'remove_to_and_cc', 'char', 'NULL',             1, '', '',#RemoveToAndCc
3314       ],
3315       'primary_key' => 'svcnum',
3316       'unique' => [],
3317       'index'  => [ ['username'], ['domsvc'], ['listnum'] ],
3318     },
3319
3320     'mailinglist' => {
3321       'columns' => [
3322         'listnum',   'serial', '',      '', '', '',
3323         'listname', 'varchar', '', $char_d, '', '',
3324       ],
3325       'primary_key' => 'listnum',
3326       'unique' => [],
3327       'index'  => [],
3328     },
3329
3330     'mailinglistmember' => {
3331       'columns' => [
3332         'membernum',        'serial',     '',   '', '', '',
3333         'listnum',             'int',     '',   '', '', '',
3334         'svcnum',              'int', 'NULL',   '', '', '',
3335         'contactemailnum',     'int', 'NULL',   '', '', '',
3336         'email',           'varchar', 'NULL',  255, '', '',
3337       ],
3338       'primary_key' => 'membernum',
3339       'unique'      => [],
3340       'index'       => [['listnum'],['svcnum'],['contactemailnum'],['email']],
3341     },
3342
3343     'bill_batch' => {
3344       'columns' => [
3345         'batchnum',         'serial',     '',  '', '', '',
3346         'agentnum',            'int', 'NULL',  '', '', '',
3347         'status',             'char', 'NULL', '1', '', '',
3348         'pdf',                'blob', 'NULL',  '', '', '',
3349       ],
3350       'primary_key' => 'batchnum',
3351       'unique'      => [],
3352       'index'       => [ ['agentnum'] ],
3353     },
3354
3355     'cust_bill_batch' => {
3356       'columns' => [
3357         'billbatchnum',     'serial',     '', '', '', '',
3358         'batchnum',            'int',     '', '', '', '',
3359         'invnum',              'int',     '', '', '', '',
3360       ],
3361       'primary_key' => 'billbatchnum',
3362       'unique'      => [],
3363       'index'       => [ [ 'batchnum' ], [ 'invnum' ] ],
3364     },
3365
3366     'cust_bill_batch_option' => {
3367       'columns' => [
3368         'optionnum', 'serial', '', '', '', '',
3369         'billbatchnum', 'int', '', '', '', '',
3370         'optionname', 'varchar', '', $char_d, '', '',
3371         'optionvalue', 'text', 'NULL', '', '', '',
3372       ],
3373       'primary_key' => 'optionnum',
3374       'unique'      => [],
3375       'index'       => [ [ 'billbatchnum' ], [ 'optionname' ] ],
3376     },
3377
3378     'msg_template' => {
3379       'columns' => [
3380         'msgnum',     'serial',     '',      '', '', '',
3381         'msgname',   'varchar',     '', $char_d, '', '',
3382         'agentnum',      'int', 'NULL',      '', '', '',
3383         'subject',   'varchar', 'NULL',     512, '', '',
3384         'mime_type', 'varchar',     '', $char_d, '', '',
3385         'body',         'blob', 'NULL',      '', '', '',
3386         'disabled',     'char', 'NULL',       1, '', '',
3387         'from_addr', 'varchar', 'NULL',     255, '', '',
3388         'bcc_addr',  'varchar', 'NULL',     255, '', '',
3389       ],
3390       'primary_key' => 'msgnum',
3391       'unique'      => [ ],
3392       'index'       => [ ['agentnum'], ],
3393     },
3394
3395     'template_content' => {
3396       'columns' => [
3397         'contentnum', 'serial',     '',      '', '', '',
3398         'msgnum',        'int',     '',      '', '', '',
3399         'locale',    'varchar', 'NULL',      16, '', '',
3400         'subject',   'varchar', 'NULL',     512, '', '',
3401         'body',         'text', 'NULL',      '', '', '',
3402       ],
3403       'primary_key' => 'contentnum',
3404       'unique'      => [ ['msgnum', 'locale'] ],
3405       'index'       => [ ],
3406     },
3407
3408     'cust_msg' => {
3409       'columns' => [
3410         'custmsgnum', 'serial',     '',     '', '', '',
3411         'custnum',       'int',     '',     '', '', '',
3412         'msgnum',        'int', 'NULL',     '', '', '',
3413         '_date',    @date_type,                 '', '',
3414         'env_from',  'varchar', 'NULL',    255, '', '',
3415         'env_to',    'varchar', 'NULL',    255, '', '',
3416         'header',       'blob', 'NULL',     '', '', '',
3417         'body',         'blob', 'NULL',     '', '', '',
3418         'error',     'varchar', 'NULL',    255, '', '',
3419         'status',    'varchar',     '',$char_d, '', '',
3420       ],
3421       'primary_key' => 'custmsgnum',
3422       'unique'      => [ ],
3423       'index'       => [ ['custnum'], ],
3424     },
3425
3426     'svc_cert' => {
3427       'columns' => [
3428         'svcnum',                'int',     '',      '', '', '',
3429         'recnum',                'int', 'NULL',      '', '', '',
3430         'privatekey',           'text', 'NULL',      '', '', '',
3431         'csr',                  'text', 'NULL',      '', '', '',
3432         'certificate',          'text', 'NULL',      '', '', '',
3433         'cacert',               'text', 'NULL',      '', '', '',
3434         'common_name',       'varchar', 'NULL', $char_d, '', '',
3435         'organization',      'varchar', 'NULL', $char_d, '', '',
3436         'organization_unit', 'varchar', 'NULL', $char_d, '', '',
3437         'city',              'varchar', 'NULL', $char_d, '', '',
3438         'state',             'varchar', 'NULL', $char_d, '', '',
3439         'country',              'char', 'NULL',       2, '', '',
3440         'cert_contact',      'varchar', 'NULL', $char_d, '', '',
3441       ],
3442       'primary_key' => 'svcnum',
3443       'unique' => [],
3444       'index'  => [], #recnum
3445     },
3446
3447     'svc_port' => {
3448       'columns' => [
3449         'svcnum',                'int',     '',      '', '', '',
3450         'serviceid', 'varchar', '', 64, '', '', #srvexport / reportfields
3451       ],
3452       'primary_key' => 'svcnum',
3453       'unique' => [],
3454       'index'  => [], #recnum
3455     },
3456
3457     'areacode'  => {
3458       'columns' => [
3459         'areanum',   'serial',        '',      '', '', '',
3460         'code',        'char',        '',       3, '', '',
3461         'country',     'char',    'NULL',       2, '', '',
3462         'state',       'char',    'NULL',       2, '', '',
3463         'description','varchar',  'NULL',     255, '', '',
3464       ],
3465       'primary_key' => 'areanum',
3466       'unique' => [ [ 'areanum' ] ],
3467       'index'  => [],
3468     },
3469
3470     %{ tables_hashref_torrus() },
3471
3472     # tables of ours for doing torrus virtual port combining
3473     'torrus_srvderive' => {
3474       'columns' => [
3475         'derivenum',     'serial',     '', '', '', '',
3476         'serviceid',    'varchar',     '', 64, '', '', #srvexport / reportfields
3477         'last_srv_date',   'date', 'NULL', '', '', '',
3478       ],
3479       'primary_key' => 'derivenum',
3480       'unique' => [ ['serviceid'] ],
3481       'index'  => [],
3482     },
3483
3484     'torrus_srvderive_component' => {
3485       'columns' => [
3486         'componentnum', 'serial', '', '', '', '',
3487         'derivenum',       'int', '', '', '', '',
3488         'serviceid',   'varchar', '', 64, '', '', #srvexport / reportfields
3489       ],
3490       'primary_key' => 'componentnum',
3491       'unique'      => [ [ 'derivenum', 'serviceid' ], ],
3492       'index'       => [ [ 'derivenum', ], ],
3493     },
3494
3495
3496     # name type nullability length default local
3497
3498     #'new_table' => {
3499     #  'columns' => [
3500     #    'num', 'serial',       '', '', '', '',
3501     #  ],
3502     #  'primary_key' => 'num',
3503     #  'unique' => [],
3504     #  'index'  => [],
3505     #},
3506
3507   };
3508
3509 }
3510
3511 =back
3512
3513 =head1 BUGS
3514
3515 =head1 SEE ALSO
3516
3517 L<DBIx::DBSchema>
3518
3519 =cut
3520
3521 1;
3522