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       ],
 888       'primary_key' => 'custnum',
 889       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
 890       #'index' => [ ['last'], ['company'] ],
 891       'index' => [
 892                    [ 'agentnum' ], [ 'refnum' ], [ 'classnum' ], [ 'usernum' ],
 893                    [ 'custbatch' ],
 894                    [ 'referral_custnum' ],
 895                    [ 'payby' ], [ 'paydate' ],
 896                    [ 'archived' ],
 897                    #billing
 898                    [ 'last' ], [ 'company' ],
 899                    [ 'county' ], [ 'state' ], [ 'country' ],
 900                    [ 'zip' ],
 901                    [ 'daytime' ], [ 'night' ], [ 'fax' ],
 902                    #shipping
 903                    [ 'ship_last' ], [ 'ship_company' ],
 904                    [ 'ship_county' ], [ 'ship_state' ], [ 'ship_country' ],
 905                    [ 'ship_zip' ],
 906                    [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
 907                  ],
 908     },
 909
 910     'cust_recon' => {  # what purpose does this serve?
 911       'columns' => [
 912         'reconid',      'serial',  '',          '', '', '',
 913         'recondate',    @date_type,                 '', '',
 914         'custnum',      'int'   ,  '',          '', '', '',
 915         'agentnum',     'int',     '',          '', '', '',
 916         'last',         'varchar', '',     $char_d, '', '',
 917         'first',        'varchar', '',     $char_d, '', '',
 918         'address1',     'varchar', '',     $char_d, '', '',
 919         'address2',     'varchar', 'NULL', $char_d, '', '',
 920         'city',         'varchar', '',     $char_d, '', '',
 921         'state',        'varchar', 'NULL', $char_d, '', '',
 922         'zip',          'varchar', 'NULL',      10, '', '',
 923         'pkg',          'varchar', 'NULL', $char_d, '', '',
 924         'adjourn',      @date_type,                 '', '',
 925         'status',       'varchar', 'NULL',      10, '', '',
 926         'agent_custid', 'varchar',  '',    $char_d, '', '',
 927         'agent_pkg',    'varchar', 'NULL', $char_d, '', '',
 928         'agent_adjourn', @date_type,                '', '',
 929         'comments',     'text',    'NULL',      '', '', '',
 930       ],
 931       'primary_key' => 'reconid',
 932       'unique' => [],
 933       'index' => [],
 934     },
 935
 936     #eventually for cust_main too
 937     'contact' => {
 938       'columns' => [
 939         'contactnum', 'serial',     '',      '', '', '',
 940         'prospectnum',   'int', 'NULL',      '', '', '',
 941         'custnum',       'int', 'NULL',      '', '', '',
 942         'locationnum',   'int', 'NULL',      '', '', '', #not yet
 943 #        'titlenum',      'int', 'NULL',      '', '', '', #eg Mr. Mrs. Dr. Rev.
 944         'last',      'varchar',     '', $char_d, '', '',
 945 #        'middle',    'varchar', 'NULL', $char_d, '', '',
 946         'first',     'varchar',     '', $char_d, '', '',
 947         'title',     'varchar', 'NULL', $char_d, '', '', #eg Head Bottle Washer
 948         'comment',   'varchar', 'NULL', $char_d, '', '',
 949         'disabled',     'char', 'NULL',       1, '', '',
 950       ],
 951       'primary_key' => 'contactnum',
 952       'unique'      => [],
 953       'index'       => [ [ 'prospectnum' ], [ 'custnum' ], [ 'locationnum' ],
 954                          [ 'last' ], [ 'first' ],
 955                        ],
 956     },
 957
 958     'contact_phone' => {
 959       'columns' => [
 960         'contactphonenum', 'serial',     '', '', '', '',
 961         'contactnum',         'int',     '', '', '', '',
 962         'phonetypenum',       'int',     '', '', '', '',
 963         'countrycode',    'varchar',     '',  3, '', '',
 964         'phonenum',       'varchar',     '', 14, '', '',
 965         'extension',      'varchar', 'NULL',  7, '', '',
 966         #?#'comment',        'varchar',     '', $char_d, '', '',
 967       ],
 968       'primary_key' => 'contactphonenum',
 969       'unique'      => [],
 970       'index'       => [],
 971     },
 972
 973     'phone_type' => {
 974       'columns' => [
 975         'phonetypenum',  'serial', '',      '', '', '',
 976         'typename',     'varchar', '', $char_d, '', '',
 977         'weight',           'int', '',      '', '', '',
 978       ],
 979       'primary_key' => 'phonetypenum',
 980       'unique'      => [ [ 'typename' ], ],
 981       'index'       => [],
 982     },
 983
 984     'contact_email' => {
 985       'columns' => [
 986         'contactemailnum', 'serial', '',      '', '', '',
 987         'contactnum',         'int', '',      '', '', '',
 988         'emailaddress',   'varchar', '', $char_d, '', '',
 989       ],
 990       'primary_key' => 'contactemailnum',
 991       'unique'      => [ [ 'emailaddress' ], ],
 992       'index'       => [],
 993     },
 994
 995     'prospect_main' => {
 996       'columns' => [
 997         'prospectnum',  'serial',     '',      '', '', '',
 998         'agentnum',        'int',     '',      '', '', '',
 999         'company',     'varchar', 'NULL', $char_d, '', '',
1000         'add_date',   @date_type,                  '', '',
1001         'disabled',       'char', 'NULL',       1, '', '',
1002         'custnum',         'int', 'NULL',      '', '', '',
1003       ],
1004       'primary_key' => 'prospectnum',
1005       'unique'      => [],
1006       'index'       => [ [ 'company' ], [ 'agentnum' ], [ 'disabled' ] ],
1007     },
1008
1009     #eventually use for billing & ship from cust_main too
1010     #for now, just cust_pkg locations
1011     'cust_location' => { #'location' now that its prospects too, but...
1012       'columns' => [
1013         'locationnum',      'serial',     '',      '', '', '',
1014         'prospectnum',         'int', 'NULL',      '', '', '',
1015         'custnum',             'int', 'NULL',      '', '', '',
1016         'address1',        'varchar',     '', $char_d, '', '',
1017         'address2',        'varchar', 'NULL', $char_d, '', '',
1018         'city',            'varchar',     '', $char_d, '', '',
1019         'county',          'varchar', 'NULL', $char_d, '', '',
1020         'state',           'varchar', 'NULL', $char_d, '', '',
1021         'zip',             'varchar', 'NULL',      10, '', '',
1022         'country',            'char',     '',       2, '', '',
1023         'geocode',         'varchar', 'NULL',      20, '', '',
1024         'location_type',   'varchar', 'NULL',      20, '', '',
1025         'location_number', 'varchar', 'NULL',      20, '', '',
1026         'location_kind',      'char', 'NULL',       1, '', '',
1027         'disabled',           'char', 'NULL',       1, '', '',
1028       ],
1029       'primary_key' => 'locationnum',
1030       'unique'      => [],
1031       'index'       => [ [ 'prospectnum' ], [ 'custnum' ],
1032                          [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
1033                        ],
1034     },
1035
1036     'cust_main_invoice' => {
1037       'columns' => [
1038         'destnum',  'serial',  '',     '', '', '',
1039         'custnum',  'int',  '',     '', '', '',
1040         'dest',     'varchar', '',  $char_d, '', '',
1041       ],
1042       'primary_key' => 'destnum',
1043       'unique' => [],
1044       'index' => [ ['custnum'], ],
1045     },
1046
1047     'cust_main_note' => {
1048       'columns' => [
1049         'notenum',  'serial',  '',     '', '', '',
1050         'custnum',  'int',  '',     '', '', '',
1051         'classnum',      'int',     'NULL', '', '', '',
1052         '_date',    @date_type, '', '',
1053         'otaker',   'varchar', 'NULL',    32, '', '',
1054         'usernum',   'int', 'NULL', '', '', '',
1055         'comments', 'text', 'NULL', '', '', '',
1056       ],
1057       'primary_key' => 'notenum',
1058       'unique' => [],
1059       'index' => [ [ 'custnum' ], [ '_date' ], [ 'usernum' ], ],
1060     },
1061
1062     'cust_note_class' => {
1063       'columns' => [
1064         'classnum',    'serial',   '',      '', '', '',
1065         'classname',   'varchar',  '', $char_d, '', '',
1066         'disabled',    'char', 'NULL',       1, '', '',
1067       ],
1068       'primary_key' => 'classnum',
1069       'unique' => [],
1070       'index' => [ ['disabled'] ],
1071     },
1072
1073     'cust_category' => {
1074       'columns' => [
1075         'categorynum',   'serial',  '', '', '', '',
1076         'categoryname',  'varchar', '', $char_d, '', '',
1077         'weight',         'int', 'NULL',  '', '', '',
1078         'disabled',      'char', 'NULL',   1, '', '',
1079       ],
1080       'primary_key' => 'categorynum',
1081       'unique' => [],
1082       'index' => [ ['disabled'] ],
1083     },
1084
1085     'cust_class' => {
1086       'columns' => [
1087         'classnum',    'serial',   '',      '', '', '',
1088         'classname',   'varchar',  '', $char_d, '', '',
1089         'categorynum', 'int',  'NULL',      '', '', '',
1090         'disabled',    'char', 'NULL',       1, '', '',
1091       ],
1092       'primary_key' => 'classnum',
1093       'unique' => [],
1094       'index' => [ ['disabled'] ],
1095     },
1096
1097     'cust_tag' => {
1098       'columns' => [
1099         'custtagnum', 'serial', '', '', '', '',
1100         'custnum',       'int', '', '', '', '',
1101         'tagnum',        'int', '', '', '', '',
1102       ],
1103       'primary_key' => 'custtagnum',
1104       'unique'      => [ [ 'custnum', 'tagnum' ] ],
1105       'index'       => [ [ 'custnum' ] ],
1106     },
1107
1108     'part_tag' => {
1109       'columns' => [
1110         'tagnum',    'serial',     '',      '', '', '',
1111         'tagname',  'varchar',     '', $char_d, '', '',
1112         'tagdesc',  'varchar', 'NULL', $char_d, '', '',
1113         'tagcolor', 'varchar', 'NULL',       6, '', '',
1114         'disabled',    'char', 'NULL',       1, '', '',
1115       ],
1116       'primary_key' => 'tagnum',
1117       'unique'      => [], #[ [ 'tagname' ] ], #?
1118       'index'       => [ [ 'disabled' ] ],
1119     },
1120
1121     'cust_main_exemption' => {
1122       'columns' => [
1123         'exemptionnum', 'serial', '',      '', '', '',
1124         'custnum',         'int', '',      '', '', '',
1125         'taxname',     'varchar', '', $char_d, '', '',
1126         #start/end dates?  for reporting?
1127       ],
1128       'primary_key' => 'exemptionnum',
1129       'unique'      => [],
1130       'index'       => [ [ 'custnum' ] ],
1131     },
1132
1133     'cust_tax_adjustment' => {
1134       'columns' => [
1135         'adjustmentnum', 'serial',     '',      '', '', '',
1136         'custnum',          'int',     '',      '', '', '',
1137         'taxname',      'varchar',     '', $char_d, '', '',
1138         'amount',    @money_type,                   '', '',
1139         'comment',     'varchar',  'NULL', $char_d, '', '',
1140         'billpkgnum',       'int', 'NULL',      '', '', '',
1141         #more?  no cust_bill_pkg_tax_location?
1142       ],
1143       'primary_key' => 'adjustmentnum',
1144       'unique'      => [],
1145       'index'       => [ [ 'custnum' ], [ 'billpkgnum' ] ],
1146     },
1147
1148     'cust_main_county' => { #county+state+country are checked off the
1149                             #cust_main_county for validation and to provide
1150                             # a tax rate.
1151       'columns' => [
1152         'taxnum',   'serial',   '',    '', '', '',
1153         'city',     'varchar',  'NULL',    $char_d, '', '',
1154         'county',   'varchar',  'NULL',    $char_d, '', '',
1155         'state',    'varchar',  'NULL',    $char_d, '', '',
1156         'country',  'char',  '', 2, '', '',
1157         'taxclass',   'varchar', 'NULL', $char_d, '', '',
1158         'exempt_amount', @money_type, '', '',
1159         'tax',      'real',  '',    '', '', '', #tax %
1160         'taxname',  'varchar',  'NULL',    $char_d, '', '',
1161         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
1162         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
1163       ],
1164       'primary_key' => 'taxnum',
1165       'unique' => [],
1166   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
1167       'index' => [ [ 'city' ], [ 'county' ], [ 'state' ], [ 'country' ],
1168                    [ 'taxclass' ],
1169                  ],
1170     },
1171
1172     'tax_rate'    => {
1173       'columns' => [
1174         'taxnum',       'serial',     '',      '', '', '',
1175         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
1176         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
1177         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
1178         'taxclassnum', 'int',      '',      '', '', '',
1179         'effective_date', @date_type, '', '',
1180         'tax',        @taxrate_type,      '', '',        # tax %
1181         'excessrate', @taxrate_typen,     '', '',        # second tax %
1182         'taxbase',    @money_typen, '', '',              # amount at first tax rate
1183         'taxmax',     @money_typen, '', '',              # maximum about at both rates
1184         'usetax',        @taxrate_typen,     '', '',     # tax % when non-local
1185         'useexcessrate', @taxrate_typen,     '', '',     # second tax % when non-local
1186         'unittype',    'int',  'NULL', '', '', '',      # for fee
1187         'fee',         @taxrate_typen,     '', '',      # amount tax per unit
1188         'excessfee',   @taxrate_typen,     '', '',      # second amount tax per unit
1189         'feebase',     @taxrate_typen,     '', '',      # units taxed at first rate
1190         'feemax',      @taxrate_typen,     '', '',      # maximum number of unit taxed
1191         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
1192         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
1193         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
1194         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
1195         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
1196         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
1197         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
1198         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
1199         'inoutcity',   'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1200         'inoutlocal',  'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1201         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
1202         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
1203       ],
1204       'primary_key' => 'taxnum',
1205       'unique' => [],
1206       'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
1207     },
1208
1209     'tax_rate_location' => {
1210       'columns' => [
1211         'taxratelocationnum', 'serial',  '',     '', '', '',
1212         'data_vendor',        'varchar', 'NULL', $char_d, '', '',
1213         'geocode',            'varchar', '',     20,      '', '',
1214         'city',               'varchar', 'NULL', $char_d, '', '',
1215         'county',             'varchar', 'NULL', $char_d, '', '',
1216         'state',              'char',    'NULL',       2, '', '',
1217         'disabled',           'char',    'NULL', 1, '', '',
1218       ],
1219       'primary_key' => 'taxratelocationnum',
1220       'unique' => [],
1221       'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
1222     },
1223
1224     'cust_tax_location' => {
1225       'columns' => [
1226         'custlocationnum', 'serial',  '',     '', '', '',
1227         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
1228         'city',            'varchar', 'NULL', $char_d, '', '',
1229         'postalcity',      'varchar', 'NULL', $char_d, '', '',
1230         'county',          'varchar', 'NULL', $char_d, '', '',
1231         'zip',             'char',    '',     5,  '', '',
1232         'state',           'char',    '',     2,  '', '',
1233         'plus4hi',         'char',    'NULL', 4,  '', '',
1234         'plus4lo',         'char',    'NULL', 4,  '', '',
1235         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
1236         'cityflag',        'char',    'NULL', 1,  '', '', # I(n)/O(out)/B(oth)/NULL
1237         'geocode',         'varchar', '',    20,  '', '',
1238       ],
1239       'primary_key' => 'custlocationnum',
1240       'unique' => [],
1241       'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
1242     },
1243
1244     'tax_class' => {
1245       'columns' => [
1246         'taxclassnum',  'serial',  '',            '', '', '',
1247         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
1248         'taxclass',     'varchar', '',       $char_d, '', '',
1249         'description',  'varchar', '',     2*$char_d, '', '',
1250       ],
1251       'primary_key' => 'taxclassnum',
1252       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
1253       'index' => [],
1254     },
1255
1256     'cust_pay_pending' => {
1257       'columns' => [
1258         'paypendingnum','serial',      '',  '', '', '',
1259         'custnum',      'int',         '',  '', '', '',
1260         'paid',         @money_type,            '', '',
1261         '_date',        @date_type,             '', '',
1262         'payby',        'char',        '',   4, '', '', #CARD/BILL/COMP, should
1263                                                         # be index into payby
1264                                                         # table eventually
1265         'payinfo',      'varchar', 'NULL', 512, '', '', #see cust_main above
1266         'paymask',      'varchar', 'NULL', $char_d, '', '',
1267         'paydate',      'varchar', 'NULL', 10, '', '',
1268         'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
1269         #'paybatch',     'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1270         'payunique',    'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1271
1272         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1273         'status',       'varchar',     '', $char_d, '', '',
1274         'session_id',   'varchar', 'NULL', $char_d, '', '', #only need 32
1275         'statustext',   'text',    'NULL',  '', '', '',
1276         'gatewaynum',   'int',     'NULL',  '', '', '',
1277         #'cust_balance', @money_type,            '', '',
1278         'paynum',       'int',     'NULL',  '', '', '',
1279         'jobnum',       'int',     'NULL',  '', '', '',
1280       ],
1281       'primary_key' => 'paypendingnum',
1282       'unique'      => [ [ 'payunique' ] ],
1283       'index'       => [ [ 'custnum' ], [ 'status' ], ],
1284     },
1285
1286     'cust_pay' => {
1287       'columns' => [
1288         'paynum',   'serial',    '',   '', '', '',
1289         'custnum',  'int',    '',   '', '', '',
1290         '_date',    @date_type, '', '',
1291         'paid',     @money_type, '', '',
1292         'otaker',   'varchar', 'NULL', 32, '', '',
1293         'usernum',   'int', 'NULL', '', '', '',
1294         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1295                                                  # index into payby table
1296                                                  # eventually
1297         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
1298         'paymask', 'varchar', 'NULL', $char_d, '', '',
1299         'paydate',  'varchar', 'NULL', 10, '', '',
1300         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1301         'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1302         'closed',    'char', 'NULL', 1, '', '',
1303         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1304       ],
1305       'primary_key' => 'paynum',
1306       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
1307       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ], [ 'usernum' ] ],
1308     },
1309
1310     'cust_pay_void' => {
1311       'columns' => [
1312         'paynum',    'int',    '',   '', '', '',
1313         'custnum',   'int',    '',   '', '', '',
1314         'paid',      @money_type, '', '',
1315         '_date',     @date_type, '', '',
1316         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1317                                                   # index into payby table
1318                                                   # eventually
1319         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
1320         'paymask', 'varchar', 'NULL', $char_d, '', '',
1321         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1322         'closed',    'char', 'NULL', 1, '', '',
1323         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1324         'void_date', @date_type, '', '',
1325         'reason',    'varchar',   'NULL', $char_d, '', '',
1326         'otaker',   'varchar', 'NULL', 32, '', '',
1327         'usernum',   'int', 'NULL', '', '', '',
1328         'void_usernum',   'int', 'NULL', '', '', '',
1329       ],
1330       'primary_key' => 'paynum',
1331       'unique' => [],
1332       'index' => [ [ 'custnum' ], [ 'usernum' ], [ 'void_usernum' ] ],
1333     },
1334
1335     'cust_bill_pay' => {
1336       'columns' => [
1337         'billpaynum', 'serial',     '',   '', '', '',
1338         'invnum',  'int',     '',   '', '', '',
1339         'paynum',  'int',     '',   '', '', '',
1340         'amount',  @money_type, '', '',
1341         '_date',   @date_type, '', '',
1342         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1343       ],
1344       'primary_key' => 'billpaynum',
1345       'unique' => [],
1346       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
1347     },
1348
1349     'cust_bill_pay_batch' => {
1350       'columns' => [
1351         'billpaynum', 'serial',     '',   '', '', '',
1352         'invnum',  'int',     '',   '', '', '',
1353         'paybatchnum',  'int',     '',   '', '', '',
1354         'amount',  @money_type, '', '',
1355         '_date',   @date_type, '', '',
1356       ],
1357       'primary_key' => 'billpaynum',
1358       'unique' => [],
1359       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1360     },
1361
1362     'cust_bill_pay_pkg' => {
1363       'columns' => [
1364         'billpaypkgnum', 'serial', '', '', '', '',
1365         'billpaynum',       'int', '', '', '', '',
1366         'billpkgnum',       'int', '', '', '', '',
1367         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
1368         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
1369         'amount',         @money_type,     '', '',
1370         'setuprecur',      'varchar', '', $char_d, '', '',
1371         'sdate',   @date_type, '', '',
1372         'edate',   @date_type, '', '',
1373       ],
1374       'primary_key' => 'billpaypkgnum',
1375       'unique'      => [],
1376       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1377     },
1378
1379     'pay_batch' => { #batches of payments to an external processor
1380       'columns' => [
1381         'batchnum',   'serial',    '',   '', '', '',
1382         'payby',      'char',      '',    4, '', '', # CARD/CHEK
1383         'status',     'char', 'NULL',     1, '', '',
1384         'download',   @date_type, '', '',
1385         'upload',     @date_type, '', '',
1386       ],
1387       'primary_key' => 'batchnum',
1388       'unique' => [],
1389       'index' => [],
1390     },
1391
1392     'cust_pay_batch' => { #what's this used for again?  list of customers
1393                           #in current CARD batch? (necessarily CARD?)
1394       'columns' => [
1395         'paybatchnum',   'serial',    '',   '', '', '',
1396         'batchnum',   'int',    '',   '', '', '',
1397         'invnum',   'int',    '',   '', '', '',
1398         'custnum',   'int',    '',   '', '', '',
1399         'last',     'varchar', '',     $char_d, '', '',
1400         'first',    'varchar', '',     $char_d, '', '',
1401         'address1', 'varchar', '',     $char_d, '', '',
1402         'address2', 'varchar', 'NULL', $char_d, '', '',
1403         'city',     'varchar', '',     $char_d, '', '',
1404         'state',    'varchar', 'NULL', $char_d, '', '',
1405         'zip',      'varchar', 'NULL', 10, '', '',
1406         'country',  'char', '',     2, '', '',
1407         #        'trancode', 'int', '', '', '', ''
1408         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1409         'payinfo',  'varchar', '',     512, '', '',
1410         #'exp',      @date_type, '', ''
1411         'exp',      'varchar', 'NULL',     11, '', '',
1412         'payname',  'varchar', 'NULL', $char_d, '', '',
1413         'amount',   @money_type, '', '',
1414         'status',   'varchar', 'NULL',     $char_d, '', '',
1415       ],
1416       'primary_key' => 'paybatchnum',
1417       'unique' => [],
1418       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1419     },
1420
1421     'fcc477map' => {
1422       'columns' => [
1423         'formkey',   'varchar',     '', 255, '', '',
1424         'formvalue',    'text', 'NULL',  '', '', '',
1425       ],
1426       'primary_key' => 'formkey',
1427       'unique'      => [],
1428       'index'       => [],
1429     },
1430
1431     'cust_pkg' => {
1432       'columns' => [
1433         'pkgnum',           'serial',     '', '', '', '',
1434         'custnum',             'int',     '', '', '', '',
1435         'pkgpart',             'int',     '', '', '', '',
1436         'pkgbatch',        'varchar', 'NULL', $char_d, '', '',
1437         'locationnum',         'int', 'NULL', '', '', '',
1438         'otaker',          'varchar', 'NULL', 32, '', '',
1439         'usernum',             'int', 'NULL', '', '', '',
1440         'order_date',     @date_type,             '', '',
1441         'start_date',     @date_type,             '', '',
1442         'setup',          @date_type,             '', '',
1443         'bill',           @date_type,             '', '',
1444         'last_bill',      @date_type,             '', '',
1445         'susp',           @date_type,             '', '',
1446         'adjourn',        @date_type,             '', '',
1447         'cancel',         @date_type,             '', '',
1448         'expire',         @date_type,             '', '',
1449         'contract_end',   @date_type,             '', '',
1450         'dundate',        @date_type,             '', '',
1451         'change_date',    @date_type,             '', '',
1452         'change_pkgnum',       'int', 'NULL', '', '', '',
1453         'change_pkgpart',      'int', 'NULL', '', '', '',
1454         'change_locationnum',  'int', 'NULL', '', '', '',
1455         'manual_flag',        'char', 'NULL',  1, '', '',
1456         'no_auto',            'char', 'NULL',  1, '', '',
1457         'quantity',            'int', 'NULL', '', '', '',
1458         'agent_pkgid',         'int', 'NULL', '', '', '',
1459         'waive_setup',        'char', 'NULL',  1, '', '',
1460         'recur_show_zero',    'char', 'NULL',  1, '', '',
1461         'setup_show_zero',    'char', 'NULL',  1, '', '',
1462       ],
1463       'primary_key' => 'pkgnum',
1464       'unique' => [],
1465       'index' => [ ['custnum'], ['pkgpart'], [ 'pkgbatch' ], [ 'locationnum' ],
1466                    [ 'usernum' ], [ 'agent_pkgid' ],
1467                    ['order_date'], [ 'start_date' ], ['setup'], ['bill'],
1468                    ['last_bill'], ['susp'], ['adjourn'], ['cancel'],
1469                    ['expire'], ['contract_end'], ['change_date'], ['no_auto'],
1470                  ],
1471     },
1472
1473     'cust_pkg_option' => {
1474       'columns' => [
1475         'optionnum', 'serial', '', '', '', '',
1476         'pkgnum', 'int', '', '', '', '',
1477         'optionname', 'varchar', '', $char_d, '', '',
1478         'optionvalue', 'text', 'NULL', '', '', '',
1479       ],
1480       'primary_key' => 'optionnum',
1481       'unique'      => [],
1482       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
1483     },
1484
1485     'cust_pkg_detail' => {
1486       'columns' => [
1487         'pkgdetailnum', 'serial', '',      '', '', '',
1488         'pkgnum',          'int', '',      '', '', '',
1489         'detail',      'varchar', '', $char_d, '', '',
1490         'detailtype',     'char', '',       1, '', '', # "I"nvoice or "C"omment
1491         'weight',          'int', '',      '', '', '',
1492       ],
1493       'primary_key' => 'pkgdetailnum',
1494       'unique' => [],
1495       'index'  => [ [ 'pkgnum', 'detailtype' ] ],
1496     },
1497
1498     'cust_pkg_reason' => {
1499       'columns' => [
1500         'num',      'serial',    '',   '', '', '',
1501         'pkgnum',   'int',    '',   '', '', '',
1502         'reasonnum','int',    '',   '', '', '',
1503         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
1504         'otaker',   'varchar', 'NULL', 32, '', '',
1505         'usernum',   'int', 'NULL', '', '', '',
1506         'date',     @date_type, '', '',
1507       ],
1508       'primary_key' => 'num',
1509       'unique' => [],
1510       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], [ 'usernum' ], ],
1511     },
1512
1513     'cust_pkg_discount' => {
1514       'columns' => [
1515         'pkgdiscountnum', 'serial', '',     '', '', '',
1516         'pkgnum',            'int', '',     '', '', '',
1517         'discountnum',       'int', '',     '', '', '',
1518         'months_used',   'decimal', 'NULL', '', '', '',
1519         'end_date',     @date_type,             '', '',
1520         'otaker',        'varchar', 'NULL', 32, '', '',
1521         'usernum',           'int', 'NULL', '', '', '',
1522         'disabled',         'char', 'NULL',  1, '', '',
1523       ],
1524       'primary_key' => 'pkgdiscountnum',
1525       'unique' => [],
1526       'index'  => [ [ 'pkgnum' ], [ 'discountnum' ], [ 'usernum' ], ],
1527     },
1528
1529     'cust_bill_pkg_discount' => {
1530       'columns' => [
1531         'billpkgdiscountnum', 'serial',     '', '', '', '',
1532         'billpkgnum',            'int',     '', '', '', '',
1533         'pkgdiscountnum',        'int',     '', '', '', '',
1534         'amount',          @money_type,             '', '',
1535         'months',            'decimal', 'NULL', '', '', '',
1536       ],
1537       'primary_key' => 'billpkgdiscountnum',
1538       'unique' => [],
1539       'index' => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
1540     },
1541
1542     'discount' => {
1543       'columns' => [
1544         'discountnum', 'serial',     '',      '', '', '',
1545         #'agentnum',       'int', 'NULL',      '', '', '',
1546         'name',       'varchar', 'NULL', $char_d, '', '',
1547         'amount',   @money_type,                  '', '',
1548         'percent',    'decimal',     '',      '', '', '',
1549         'months',     'decimal', 'NULL',      '', '', '',
1550         'disabled',      'char', 'NULL',       1, '', '',
1551         'setup',      'char', 'NULL',       1, '', '',
1552       ],
1553       'primary_key' => 'discountnum',
1554       'unique' => [],
1555       'index'  => [], # [ 'agentnum' ], ],
1556     },
1557
1558     'cust_refund' => {
1559       'columns' => [
1560         'refundnum',    'serial',    '',   '', '', '',
1561         'custnum',  'int',    '',   '', '', '',
1562         '_date',        @date_type, '', '',
1563         'refund',       @money_type, '', '',
1564         'otaker',       'varchar',   'NULL',   32, '', '',
1565         'usernum',   'int', 'NULL', '', '', '',
1566         'reason',       'varchar',   '',   $char_d, '', '',
1567         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
1568                                                      # be index into payby
1569                                                      # table eventually
1570         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
1571         'paymask', 'varchar', 'NULL', $char_d, '', '',
1572         'paybatch',     'varchar',   'NULL', $char_d, '', '',
1573         'closed',    'char', 'NULL', 1, '', '',
1574       ],
1575       'primary_key' => 'refundnum',
1576       'unique' => [],
1577       'index' => [ ['custnum'], ['_date'], [ 'usernum' ], ],
1578     },
1579
1580     'cust_credit_refund' => {
1581       'columns' => [
1582         'creditrefundnum', 'serial',     '',   '', '', '',
1583         'crednum',  'int',     '',   '', '', '',
1584         'refundnum',  'int',     '',   '', '', '',
1585         'amount',  @money_type, '', '',
1586         '_date',   @date_type, '', '',
1587       ],
1588       'primary_key' => 'creditrefundnum',
1589       'unique' => [],
1590       'index' => [ ['crednum'], ['refundnum'] ],
1591     },
1592
1593
1594     'cust_svc' => {
1595       'columns' => [
1596         'svcnum',    'serial',    '',   '', '', '',
1597         'pkgnum',    'int',    'NULL',   '', '', '',
1598         'svcpart',   'int',    '',   '', '', '',
1599         'overlimit', @date_type, '', '',
1600       ],
1601       'primary_key' => 'svcnum',
1602       'unique' => [],
1603       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1604     },
1605
1606     'cust_svc_option' => {
1607       'columns' => [
1608         'optionnum',   'serial', '', '', '', '',
1609         'svcnum',      'int', '', '', '', '',
1610         'optionname',  'varchar', '', $char_d, '', '',
1611         'optionvalue', 'text', 'NULL', '', '', '',
1612       ],
1613       'primary_key' => 'optionnum',
1614       'unique'      => [],
1615       'index'       => [ [ 'svcnum' ], [ 'optionname' ] ],
1616     },
1617
1618    'part_pkg' => {
1619       'columns' => [
1620         'pkgpart',       'serial',    '',   '', '', '',
1621         'pkg',           'varchar',   '',   $char_d, '', '',
1622         'comment',       'varchar',   '', 2*$char_d, '', '',
1623         'promo_code',    'varchar', 'NULL', $char_d, '', '',
1624         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
1625         'setuptax',      'char', 'NULL', 1, '', '',
1626         'recurtax',      'char', 'NULL', 1, '', '',
1627         'plan',          'varchar', 'NULL', $char_d, '', '',
1628         'plandata',      'text', 'NULL', '', '', '',
1629         'disabled',      'char', 'NULL', 1, '', '',
1630         'custom',        'char', 'NULL', 1, '', '',
1631         'taxclass',      'varchar', 'NULL', $char_d, '', '',
1632         'classnum',      'int',     'NULL', '', '', '',
1633         'addon_classnum','int',     'NULL', '', '', '',
1634         'taxproductnum', 'int',     'NULL', '', '', '',
1635         'setup_cost',    @money_typen,          '', '',
1636         'recur_cost',    @money_typen,          '', '',
1637         'pay_weight',    'real',    'NULL', '', '', '',
1638         'credit_weight', 'real',    'NULL', '', '', '',
1639         'agentnum',      'int',     'NULL', '', '', '',
1640         'fcc_ds0s',      'int',     'NULL', '', '', '',
1641         'no_auto',          'char', 'NULL',  1, '', '',
1642         'recur_show_zero',  'char', 'NULL',  1, '', '',
1643         'setup_show_zero',  'char', 'NULL',  1, '', '',
1644       ],
1645       'primary_key' => 'pkgpart',
1646       'unique' => [],
1647       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'classnum' ],
1648                    [ 'agentnum' ], ['no_auto'],
1649                  ],
1650     },
1651
1652     'part_pkg_link' => {
1653       'columns' => [
1654         'pkglinknum',  'serial',   '',      '', '', '',
1655         'src_pkgpart', 'int',      '',      '', '', '',
1656         'dst_pkgpart', 'int',      '',      '', '', '',
1657         'link_type',   'varchar',  '', $char_d, '', '',
1658         'hidden',      'char', 'NULL',       1, '', '',
1659       ],
1660       'primary_key' => 'pkglinknum',
1661       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type', 'hidden' ] ],
1662       'index'  => [ [ 'src_pkgpart' ] ],
1663     },
1664     # XXX somewhat borked unique: we don't really want a hidden and unhidden
1665     # it turns out we'd prefer to use svc, bill, and invisibill (or something)
1666
1667     'part_pkg_discount' => {
1668       'columns' => [
1669         'pkgdiscountnum', 'serial',   '',      '', '', '',
1670         'pkgpart',        'int',      '',      '', '', '',
1671         'discountnum',    'int',      '',      '', '', '',
1672       ],
1673       'primary_key' => 'pkgdiscountnum',
1674       'unique' => [ [ 'pkgpart', 'discountnum' ] ],
1675       'index'  => [],
1676     },
1677
1678     'part_pkg_taxclass' => {
1679       'columns' => [
1680         'taxclassnum',  'serial', '',       '', '', '',
1681         'taxclass',     'varchar', '', $char_d, '', '',
1682         'disabled', 'char',   'NULL',         1, '', '',
1683       ],
1684       'primary_key' => 'taxclassnum',
1685       'unique'      => [ [ 'taxclass' ] ],
1686       'index'       => [ [ 'disabled' ] ],
1687     },
1688
1689     'part_pkg_taxproduct' => {
1690       'columns' => [
1691         'taxproductnum', 'serial',      '',        '', '', '',
1692         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
1693         'taxproduct',    'varchar',     '',   $char_d, '', '',
1694         'description',   'varchar',     '', 3*$char_d, '', '',
1695       ],
1696       'primary_key' => 'taxproductnum',
1697       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
1698       'index'       => [],
1699     },
1700
1701     'part_pkg_taxrate' => {
1702       'columns' => [
1703         'pkgtaxratenum', 'serial',  '',     '',      '', '',
1704         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
1705         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
1706         'taxproductnum', 'int',  '',     '',       '', '',
1707         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
1708         'county',           'varchar', 'NULL', $char_d, '', '',
1709         'state',            'varchar', 'NULL', $char_d, '', '',
1710         'local',            'varchar', 'NULL', $char_d, '', '',
1711         'country',          'char',    'NULL', 2,       '', '',
1712         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
1713         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
1714         'taxclassnum',      'int',     'NULL', '',      '', '',
1715         'effdate',          @date_type, '', '',
1716         'taxable',          'char',    'NULL', 1,       '', '',
1717       ],
1718       'primary_key' => 'pkgtaxratenum',
1719       'unique' => [],
1720       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1721     },
1722
1723     'part_pkg_taxoverride' => {
1724       'columns' => [
1725         'taxoverridenum', 'serial', '', '', '', '',
1726         'pkgpart',           'int', '', '', '', '',
1727         'taxclassnum',       'int', '', '', '', '',
1728         'usage_class',    'varchar', 'NULL', $char_d, '', '',
1729       ],
1730       'primary_key' => 'taxoverridenum',
1731       'unique' => [],
1732       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1733     },
1734
1735 #    'part_title' => {
1736 #      'columns' => [
1737 #        'titlenum',   'int',    '',   '',
1738 #        'title',      'varchar',   '',   $char_d,
1739 #      ],
1740 #      'primary_key' => 'titlenum',
1741 #      'unique' => [ [] ],
1742 #      'index' => [ [] ],
1743 #    },
1744
1745     'pkg_svc' => {
1746       'columns' => [
1747         'pkgsvcnum',  'serial', '',  '', '', '',
1748         'pkgpart',    'int',    '',   '', '', '',
1749         'svcpart',    'int',    '',   '', '', '',
1750         'quantity',   'int',    '',   '', '', '',
1751         'primary_svc','char', 'NULL',  1, '', '',
1752         'hidden',     'char', 'NULL',  1, '', '',
1753       ],
1754       'primary_key' => 'pkgsvcnum',
1755       'unique' => [ ['pkgpart', 'svcpart'] ],
1756       'index' => [ ['pkgpart'], ['quantity'] ],
1757     },
1758
1759     'part_referral' => {
1760       'columns' => [
1761         'refnum',   'serial',     '',        '', '', '',
1762         'referral', 'varchar',    '',   $char_d, '', '',
1763         'disabled', 'char',   'NULL',         1, '', '',
1764         'agentnum', 'int',    'NULL',        '', '', '',
1765       ],
1766       'primary_key' => 'refnum',
1767       'unique' => [],
1768       'index' => [ ['disabled'], ['agentnum'], ],
1769     },
1770
1771     'part_svc' => {
1772       'columns' => [
1773         'svcpart',    'serial',    '',   '', '', '',
1774         'svc',        'varchar',   '',   $char_d, '', '',
1775         'svcdb',      'varchar',   '',   $char_d, '', '',
1776         'disabled',   'char',  'NULL',   1, '', '',
1777         'preserve',   'char', 'NULL',  1, '', '',
1778       ],
1779       'primary_key' => 'svcpart',
1780       'unique' => [],
1781       'index' => [ [ 'disabled' ] ],
1782     },
1783
1784     'part_svc_column' => {
1785       'columns' => [
1786         'columnnum',   'serial',         '', '', '', '',
1787         'svcpart',     'int',         '', '', '', '',
1788         'columnname',  'varchar',     '', 64, '', '',
1789         'columnlabel', 'varchar', 'NULL', $char_d, '', '',
1790         'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1791         'columnflag',  'char',    'NULL', 1, '', '',
1792       ],
1793       'primary_key' => 'columnnum',
1794       'unique' => [ [ 'svcpart', 'columnname' ] ],
1795       'index' => [ [ 'svcpart' ] ],
1796     },
1797
1798     #(this should be renamed to part_pop)
1799     'svc_acct_pop' => {
1800       'columns' => [
1801         'popnum',    'serial',    '',   '', '', '',
1802         'city',      'varchar',   '',   $char_d, '', '',
1803         'state',     'varchar',   '',   $char_d, '', '',
1804         'ac',        'char',   '',   3, '', '',
1805         'exch',      'char',   '',   3, '', '',
1806         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
1807       ],
1808       'primary_key' => 'popnum',
1809       'unique' => [],
1810       'index' => [ [ 'state' ] ],
1811     },
1812
1813     'part_pop_local' => {
1814       'columns' => [
1815         'localnum',  'serial',     '',     '', '', '',
1816         'popnum',    'int',     '',     '', '', '',
1817         'city',      'varchar', 'NULL', $char_d, '', '',
1818         'state',     'char',    'NULL', 2, '', '',
1819         'npa',       'char',    '',     3, '', '',
1820         'nxx',       'char',    '',     3, '', '',
1821       ],
1822       'primary_key' => 'localnum',
1823       'unique' => [],
1824       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1825     },
1826
1827     'qual' => {
1828       'columns' => [
1829         'qualnum',  'serial',     '',     '', '', '',
1830         'custnum',    'int',     'NULL',     '', '', '',
1831         'prospectnum',    'int',     'NULL',     '', '', '',
1832         'locationnum',    'int',     'NULL',     '', '', '',
1833         'phonenum',     'varchar', 'NULL',       24, '', '',
1834         'exportnum',      'int', 'NULL', '', '', '',
1835         'vendor_qual_id',      'varchar', 'NULL', $char_d, '', '',
1836         'status',      'char', '', 1, '', '',
1837       ],
1838       'primary_key' => 'qualnum',
1839       'unique' => [],
1840       'index' => [ [ 'locationnum' ], ['custnum'], ['prospectnum'],
1841                     ['phonenum'], ['vendor_qual_id'] ],
1842     },
1843
1844     'qual_option' => {
1845       'columns' => [
1846         'optionnum', 'serial', '', '', '', '',
1847         'qualnum',  'int',     '',     '', '', '',
1848         'optionname', 'varchar', '', $char_d, '', '',
1849         'optionvalue', 'text', 'NULL', '', '', '',
1850       ],
1851       'primary_key' => 'optionnum',
1852       'unique' => [],
1853       'index' => [],
1854     },
1855
1856     'svc_acct' => {
1857       'columns' => [
1858         'svcnum',    'int',    '',   '', '', '',
1859         'username',  'varchar',   '',   $username_len, '', '',
1860         '_password', 'varchar',   'NULL',  512, '', '',
1861         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1862         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
1863         'popnum',    'int',    'NULL',   '', '', '',
1864         'uid',       'int', 'NULL',   '', '', '',
1865         'gid',       'int', 'NULL',   '', '', '',
1866         'finger',    'varchar',   'NULL',   $char_d, '', '',
1867         'dir',       'varchar',   'NULL',   $char_d, '', '',
1868         'shell',     'varchar',   'NULL',   $char_d, '', '',
1869         'quota',     'varchar',   'NULL',   $char_d, '', '',
1870         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
1871         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
1872         'seconds_threshold',   'int', 'NULL',   '', '', '',
1873         'upbytes',   'bigint', 'NULL',   '', '', '',
1874         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
1875         'downbytes', 'bigint', 'NULL',   '', '', '',
1876         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
1877         'totalbytes','bigint', 'NULL',   '', '', '',
1878         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
1879         'domsvc',    'int',     '', '', '', '',
1880         'pbxsvc',    'int', 'NULL', '', '', '',
1881         'last_login',  @date_type, '', '',
1882         'last_logout', @date_type, '', '',
1883         #cardfortress field(s)
1884         'cf_privatekey',      'text', 'NULL',      '', '', '',
1885         #communigate pro fields (quota = MaxAccountSize)
1886         'cgp_aliases',     'varchar', 'NULL',     255, '', '',
1887         #settings
1888         'cgp_type',        'varchar', 'NULL', $char_d, '', '', #AccountType
1889         'file_quota',      'varchar', 'NULL', $char_d, '', '', #MaxWebSize
1890         'file_maxnum',     'varchar', 'NULL', $char_d, '', '', #MaxWebFiles
1891         'file_maxsize',    'varchar', 'NULL', $char_d, '', '', #MaxFileSize
1892         'cgp_accessmodes', 'varchar', 'NULL',     255, '', '', #AccessModes
1893         'password_selfchange','char', 'NULL',       1, '', '', #PWDAllowed
1894         'password_recover',   'char', 'NULL',       1, 'Y','', #PasswordRecovery
1895         'cgp_rulesallowed','varchar', 'NULL', $char_d, '', '', #RulesAllowed
1896         'cgp_rpopallowed',    'char', 'NULL',       1, '', '', #RPOPAllowed
1897         'cgp_mailtoall',      'char', 'NULL',       1, '', '', #MailToAll
1898         'cgp_addmailtrailer', 'char', 'NULL',       1, '', '', #AddMailTrailer
1899         'cgp_archiveafter',    'int', 'NULL',      '', '', '', #ArchiveMessagesAfter
1900         #XXX mailing lists
1901         #preferences
1902         'cgp_deletemode',     'varchar', 'NULL', $char_d, '', '',#DeleteMode
1903         'cgp_emptytrash',     'varchar', 'NULL', $char_d, '', '',#EmptyTrash
1904         'cgp_language',       'varchar', 'NULL', $char_d, '', '',#Language
1905         'cgp_timezone',       'varchar', 'NULL', $char_d, '', '',#TimeZone
1906         'cgp_skinname',       'varchar', 'NULL', $char_d, '', '',#SkinName
1907         'cgp_prontoskinname', 'varchar', 'NULL', $char_d, '', '',#ProntoSkinName
1908         'cgp_sendmdnmode',    'varchar', 'NULL', $char_d, '', '',#SendMDNMode
1909         #mail
1910         #XXX RPOP settings
1911       ],
1912       'primary_key' => 'svcnum',
1913       #'unique' => [ [ 'username', 'domsvc' ] ],
1914       'unique' => [],
1915       'index' => [ ['username'], ['domsvc'], ['pbxsvc'] ],
1916     },
1917
1918     'acct_rt_transaction' => {
1919       'columns' => [
1920         'svcrtid',   'int',    '',   '', '', '',
1921         'svcnum',    'int',    '',   '', '', '',
1922         'transaction_id',       'int', '',   '', '', '',
1923         '_date',   @date_type, '', '',
1924         'seconds',   'int', '',   '', '', '', #uhhhh
1925         'support',   'int', '',   '', '', '',
1926       ],
1927       'primary_key' => 'svcrtid',
1928       'unique' => [],
1929       'index' => [ ['svcnum', 'transaction_id'] ],
1930     },
1931
1932     #'svc_charge' => {
1933     #  'columns' => [
1934     #    'svcnum',    'int',    '',   '',
1935     #    'amount',    @money_type,
1936     #  ],
1937     #  'primary_key' => 'svcnum',
1938     #  'unique' => [ [] ],
1939     #  'index' => [ [] ],
1940     #},
1941
1942     'svc_domain' => {
1943       'columns' => [
1944         'svcnum',           'int',    '',        '', '', '',
1945         'domain',       'varchar',    '',   $char_d, '', '',
1946         'suffix',       'varchar', 'NULL',  $char_d, '', '',
1947         'catchall',         'int', 'NULL',       '', '', '',
1948         'parent_svcnum',    'int', 'NULL',       '', '', '',
1949         'registrarnum',     'int', 'NULL',       '', '', '',
1950         'registrarkey', 'varchar', 'NULL',      512, '', '',
1951         'setup_date',      @date_type, '', '',
1952         'renewal_interval', 'int', 'NULL',       '', '', '',
1953         'expiration_date', @date_type, '', '',
1954         'au_registrant_name',       'varchar', 'NULL',  $char_d, '', '',
1955         'au_eligibility_type',      'varchar', 'NULL',  $char_d, '', '',
1956         #communigate pro fields (quota = MaxAccountSize)
1957         'max_accounts',     'int', 'NULL',       '', '', '',
1958         'trailer',         'text', 'NULL',       '', '', '',
1959         'cgp_aliases',  'varchar', 'NULL',      255, '', '',
1960         'cgp_accessmodes','varchar','NULL',     255, '', '', #DomainAccessModes
1961         'cgp_certificatetype','varchar','NULL', $char_d, '', '',
1962         #settings
1963         'acct_def_password_selfchange',   'char', 'NULL',       1,  '', '',
1964         'acct_def_password_recover',      'char', 'NULL',       1, 'Y', '',
1965         'acct_def_cgp_accessmodes',    'varchar', 'NULL',     255,  '', '',
1966         'acct_def_quota',              'varchar', 'NULL', $char_d,  '', '',
1967         'acct_def_file_quota',         'varchar', 'NULL', $char_d,  '', '',
1968         'acct_def_file_maxnum',        'varchar', 'NULL', $char_d,  '', '',
1969         'acct_def_file_maxsize',       'varchar', 'NULL', $char_d,  '', '',
1970         'acct_def_cgp_rulesallowed',   'varchar', 'NULL', $char_d,  '', '',
1971         'acct_def_cgp_rpopallowed',       'char', 'NULL',       1,  '', '',
1972         'acct_def_cgp_mailtoall',         'char', 'NULL',       1,  '', '',
1973         'acct_def_cgp_addmailtrailer',    'char', 'NULL',       1,  '', '',
1974         'acct_def_cgp_archiveafter',       'int', 'NULL',      '',  '', '',
1975         #preferences
1976         'acct_def_cgp_deletemode',     'varchar', 'NULL', $char_d,  '', '',
1977         'acct_def_cgp_emptytrash',     'varchar', 'NULL', $char_d,  '', '',
1978         'acct_def_cgp_language',       'varchar', 'NULL', $char_d,  '', '',
1979         'acct_def_cgp_timezone',       'varchar', 'NULL', $char_d,  '', '',
1980         'acct_def_cgp_skinname',       'varchar', 'NULL', $char_d,  '', '',
1981         'acct_def_cgp_prontoskinname', 'varchar', 'NULL', $char_d,  '', '',
1982         'acct_def_cgp_sendmdnmode',    'varchar', 'NULL', $char_d,  '', '',
1983       ],
1984       'primary_key' => 'svcnum',
1985       'unique' => [ ],
1986       'index' => [ ['domain'] ],
1987     },
1988
1989     'svc_dsl' => {
1990       'columns' => [
1991         'svcnum',           'int',    '',        '', '', '',
1992         'pushed',     'int', 'NULL',       '', '', '',
1993         'desired_due_date',     'int', 'NULL',       '', '', '',
1994         'due_date',     'int', 'NULL',       '', '', '',
1995         'vendor_order_id',              'varchar', 'NULL', $char_d,  '', '',
1996         'vendor_qual_id',              'varchar', 'NULL', $char_d,  '', '',
1997         'vendor_order_type',   'varchar', 'NULL', $char_d,  '', '',
1998         'vendor_order_status',   'varchar', 'NULL', $char_d,  '', '',
1999         'first',              'varchar', 'NULL', $char_d,  '', '',
2000         'last',              'varchar', 'NULL', $char_d,  '', '',
2001         'company',              'varchar', 'NULL', $char_d,  '', '',
2002         'phonenum',     'varchar', 'NULL',       24, '', '',
2003         'loop_type',   'char', 'NULL',       1,  '', '',
2004         'local_voice_provider', 'varchar', 'NULL', $char_d,  '', '',
2005         'circuitnum',              'varchar', 'NULL', $char_d,  '', '',
2006         'rate_band',              'varchar', 'NULL', $char_d,  '', '',
2007         'vpi',     'int', 'NULL',       '', '', '',
2008         'vci',     'int', 'NULL',       '', '', '',
2009         'isp_chg',   'char', 'NULL',       1,  '', '',
2010         'isp_prev',              'varchar', 'NULL', $char_d,  '', '',
2011         'username',              'varchar', 'NULL', $char_d,  '', '',
2012         'password',              'varchar', 'NULL', $char_d,  '', '',
2013         'staticips',             'text', 'NULL', '',  '', '',
2014         'monitored',    'char', 'NULL',       1,  '', '',
2015         'last_pull',     'int', 'NULL',       '', '', '',
2016       ],
2017       'primary_key' => 'svcnum',
2018       'unique' => [ ],
2019       'index' => [ ['phonenum'], ['vendor_order_id'] ],
2020     },
2021
2022     'dsl_note' => {
2023       'columns' => [
2024         'notenum',           'serial',    '',        '', '', '',
2025         'svcnum',     'int', '',       '', '', '',
2026         'author',     'varchar', 'NULL', $char_d,  '', '',
2027         'priority',   'char', 'NULL',       1,  '', '',
2028         '_date',     'int', 'NULL',       '', '', '',
2029         'note',     'text', '',       '', '', '',
2030       ],
2031       'primary_key' => 'notenum',
2032       'unique' => [ ],
2033       'index' => [ ['svcnum'] ],
2034     },
2035
2036     'svc_dish' => {
2037       'columns' => [
2038         'svcnum',   'int',     '',     '', '', '',
2039         'acctnum',  'varchar', '',     16, '', '',
2040         'installdate', @date_type,         '', '',
2041         'note',     'text',    'NULL', '', '', '',
2042       ],
2043       'primary_key' => 'svcnum',
2044       'unique' => [ ],
2045       'index' => [ ],
2046     },
2047
2048     'svc_hardware' => {
2049       'columns' => [
2050         'svcnum',   'int',     '',          '', '', '',
2051         'typenum',  'int',     '',          '', '', '',
2052         'serial',   'varchar', 'NULL', $char_d, '', '',
2053         'ip_addr',  'varchar', 'NULL',      40, '', '',
2054         'hw_addr',  'varchar', 'NULL',      12, '', '',
2055         'smartcard','varchar', 'NULL',      30, '', '',
2056         'statusnum','int',     'NULL',      '', '', '',
2057         'note',     'text',    'NULL',      '', '', '',
2058       ],
2059       'primary_key' => 'svcnum',
2060       'unique' => [ ],
2061       'index' => [ ],
2062     },
2063
2064     'hardware_class' => {
2065       'columns' => [
2066         'classnum',   'serial', '',      '', '', '',
2067         'classname', 'varchar', '', $char_d, '', '',
2068       ],
2069       'primary_key' => 'classnum',
2070       'unique' => [ ],
2071       'index'  => [ ],
2072     },
2073
2074     'hardware_type' => {
2075       'columns' => [
2076         'typenum',  'serial', '',      '', '', '',
2077         'classnum',    'int', '',      '', '', '',
2078         'model',   'varchar', '', $char_d, '', '',
2079       ],
2080       'primary_key' => 'typenum',
2081       'unique' => [ ],
2082       'index'  => [ ],
2083     },
2084
2085     'hardware_status' => {
2086       'columns' => [
2087         'statusnum', 'serial', '',      '', '', '',
2088         'label'    ,'varchar', '', $char_d, '', '',
2089         'disabled',    'char', 'NULL',   1, '', '',
2090       ],
2091       'primary_key' => 'statusnum',
2092       'unique' => [ ],
2093       'index'  => [ ],
2094     },
2095
2096     'domain_record' => {
2097       'columns' => [
2098         'recnum',    'serial',     '',  '', '', '',
2099         'svcnum',    'int',     '',  '', '', '',
2100         'reczone',   'varchar', '',  255, '', '',
2101         'recaf',     'char',    '',  2, '', '',
2102         'rectype',   'varchar',    '',  5, '', '',
2103         'recdata',   'varchar', '',  255, '', '',
2104         'ttl',       'int',     'NULL', '', '', '',
2105       ],
2106       'primary_key' => 'recnum',
2107       'unique'      => [],
2108       'index'       => [ ['svcnum'] ],
2109     },
2110
2111     'registrar' => {
2112       'columns' => [
2113         'registrarnum',   'serial', '',      '', '', '',
2114         'registrarname', 'varchar', '', $char_d, '', '',
2115       ],
2116       'primary_key' => 'registrarnum',
2117       'unique'      => [],
2118       'index'       => [],
2119     },
2120
2121     'cgp_rule' => {
2122       'columns' => [
2123         'rulenum',  'serial',     '',      '', '', '',
2124         'name',    'varchar',     '', $char_d, '', '',
2125         'comment', 'varchar', 'NULL', $char_d, '', '',
2126         'svcnum',      'int',     '',      '', '', '',
2127         'priority',    'int',     '',      '', '', '',
2128       ],
2129       'primary_key' => 'rulenum',
2130       'unique'      => [ [ 'svcnum', 'name' ] ],
2131       'index'       => [ [ 'svcnum' ] ],
2132     },
2133
2134     'cgp_rule_condition' => {
2135       'columns' => [
2136         'ruleconditionnum',  'serial',     '',      '', '', '',
2137         'conditionname',    'varchar',     '', $char_d, '', '',
2138         'op',               'varchar', 'NULL', $char_d, '', '',
2139         'params',           'varchar', 'NULL',     255, '', '',
2140         'rulenum',              'int',     '',      '', '', '',
2141       ],
2142       'primary_key' => 'ruleconditionnum',
2143       'unique'      => [],
2144       'index'       => [ [ 'rulenum' ] ],
2145     },
2146
2147     'cgp_rule_action' => {
2148        'columns' => [
2149         'ruleactionnum',  'serial',     '',      '', '', '',
2150         'action',        'varchar',     '', $char_d, '', '',
2151         'params',        'varchar', 'NULL',     255, '', '',
2152         'rulenum',           'int',     '',      '', '', '',
2153       ],
2154       'primary_key' => 'ruleactionnum',
2155       'unique'      => [],
2156       'index'       => [ [ 'rulenum' ] ],
2157    },
2158
2159     'svc_forward' => {
2160       'columns' => [
2161         'svcnum',   'int',            '',   '', '', '',
2162         'srcsvc',   'int',        'NULL',   '', '', '',
2163         'src',      'varchar',    'NULL',  255, '', '',
2164         'dstsvc',   'int',        'NULL',   '', '', '',
2165         'dst',      'varchar',    'NULL',  255, '', '',
2166       ],
2167       'primary_key' => 'svcnum',
2168       'unique'      => [],
2169       'index'       => [ ['srcsvc'], ['dstsvc'] ],
2170     },
2171
2172     'svc_www' => {
2173       'columns' => [
2174         'svcnum',   'int',      '',  '', '', '',
2175         'recnum',   'int',      '',  '', '', '',
2176         'usersvc',  'int',  'NULL',  '', '', '',
2177         'config',   'text', 'NULL',  '', '', '',
2178       ],
2179       'primary_key' => 'svcnum',
2180       'unique'      => [],
2181       'index'       => [],
2182     },
2183
2184     #'svc_wo' => {
2185     #  'columns' => [
2186     #    'svcnum',    'int',    '',   '',
2187     #    'svcnum',    'int',    '',   '',
2188     #    'svcnum',    'int',    '',   '',
2189     #    'worker',    'varchar',   '',   $char_d,
2190     #    '_date',     @date_type,
2191     #  ],
2192     #  'primary_key' => 'svcnum',
2193     #  'unique' => [ [] ],
2194     #  'index' => [ [] ],
2195     #},
2196
2197     'prepay_credit' => {
2198       'columns' => [
2199         'prepaynum',   'serial',     '',   '', '', '',
2200         'identifier',  'varchar', '', $char_d, '', '',
2201         'amount',      @money_type, '', '',
2202         'seconds',     'int',     'NULL', '', '', '',
2203         'upbytes',     'bigint',     'NULL', '', '', '',
2204         'downbytes',   'bigint',     'NULL', '', '', '',
2205         'totalbytes',  'bigint',     'NULL', '', '', '',
2206         'agentnum',    'int',     'NULL', '', '', '',
2207       ],
2208       'primary_key' => 'prepaynum',
2209       'unique'      => [ ['identifier'] ],
2210       'index'       => [],
2211     },
2212
2213     'port' => {
2214       'columns' => [
2215         'portnum',  'serial',     '',   '', '', '',
2216         'ip',       'varchar', 'NULL', 15, '', '',
2217         'nasport',  'int',     'NULL', '', '', '',
2218         'nasnum',   'int',     '',   '', '', '',
2219       ],
2220       'primary_key' => 'portnum',
2221       'unique'      => [],
2222       'index'       => [],
2223     },
2224
2225     'nas' => {
2226       'columns' => [
2227         'nasnum',   'serial',     '',    '', '', '',
2228         'nas',      'varchar', '',    $char_d, '', '',
2229         'nasip',    'varchar', '',    15, '', '',
2230         'nasfqdn',  'varchar', '',    $char_d, '', '',
2231         'last',     'int',     '',    '', '', '',
2232       ],
2233       'primary_key' => 'nasnum',
2234       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
2235       'index'       => [ [ 'last' ] ],
2236     },
2237
2238 #    'session' => {
2239 #      'columns' => [
2240 #        'sessionnum', 'serial',       '',   '', '', '',
2241 #        'portnum',    'int',       '',   '', '', '',
2242 #        'svcnum',     'int',       '',   '', '', '',
2243 #        'login',      @date_type, '', '',
2244 #        'logout',     @date_type, '', '',
2245 #      ],
2246 #      'primary_key' => 'sessionnum',
2247 #      'unique'      => [],
2248 #      'index'       => [ [ 'portnum' ] ],
2249 #    },
2250
2251     'queue' => {
2252       'columns' => [
2253         'jobnum',      'serial',     '',      '', '', '',
2254         'job',        'varchar',     '',     512, '', '',
2255         '_date',          'int',     '',      '', '', '',
2256         'status',     'varchar',     '', $char_d, '', '',
2257         'statustext',    'text', 'NULL',      '', '', '',
2258         'svcnum',         'int', 'NULL',      '', '', '',
2259         'custnum',        'int', 'NULL',      '', '', '',
2260         'secure',        'char', 'NULL',       1, '', '',
2261         'priority',       'int', 'NULL',      '', '', '',
2262       ],
2263       'primary_key' => 'jobnum',
2264       'unique'      => [],
2265       'index'       => [ [ 'secure' ], [ 'priority' ],
2266                          [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
2267                        ],
2268     },
2269
2270     'queue_arg' => {
2271       'columns' => [
2272         'argnum', 'serial', '', '', '', '',
2273         'jobnum', 'int', '', '', '', '',
2274         'frozen', 'char', 'NULL',       1, '', '',
2275         'arg', 'text', 'NULL', '', '', '',
2276       ],
2277       'primary_key' => 'argnum',
2278       'unique'      => [],
2279       'index'       => [ [ 'jobnum' ] ],
2280     },
2281
2282     'queue_depend' => {
2283       'columns' => [
2284         'dependnum', 'serial', '', '', '', '',
2285         'jobnum', 'int', '', '', '', '',
2286         'depend_jobnum', 'int', '', '', '', '',
2287       ],
2288       'primary_key' => 'dependnum',
2289       'unique'      => [],
2290       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
2291     },
2292
2293     'export_svc' => {
2294       'columns' => [
2295         'exportsvcnum' => 'serial', '', '', '', '',
2296         'exportnum'    => 'int', '', '', '', '',
2297         'svcpart'      => 'int', '', '', '', '',
2298       ],
2299       'primary_key' => 'exportsvcnum',
2300       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
2301       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
2302     },
2303
2304     'export_device' => {
2305       'columns' => [
2306         'exportdevicenum' => 'serial', '', '', '', '',
2307         'exportnum'    => 'int', '', '', '', '',
2308         'devicepart'      => 'int', '', '', '', '',
2309       ],
2310       'primary_key' => 'exportdevicenum',
2311       'unique'      => [ [ 'exportnum', 'devicepart' ] ],
2312       'index'       => [ [ 'exportnum' ], [ 'devicepart' ] ],
2313     },
2314
2315     'part_export' => {
2316       'columns' => [
2317         'exportnum', 'serial', '', '', '', '',
2318         'exportname', 'varchar', 'NULL', $char_d, '', '',
2319         'machine', 'varchar', '', $char_d, '', '',
2320         'exporttype', 'varchar', '', $char_d, '', '',
2321         'nodomain',     'char', 'NULL', 1, '', '',
2322       ],
2323       'primary_key' => 'exportnum',
2324       'unique'      => [],
2325       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
2326     },
2327
2328     'part_export_option' => {
2329       'columns' => [
2330         'optionnum', 'serial', '', '', '', '',
2331         'exportnum', 'int', '', '', '', '',
2332         'optionname', 'varchar', '', $char_d, '', '',
2333         'optionvalue', 'text', 'NULL', '', '', '',
2334       ],
2335       'primary_key' => 'optionnum',
2336       'unique'      => [],
2337       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
2338     },
2339
2340     'radius_usergroup' => {
2341       'columns' => [
2342         'usergroupnum', 'serial', '', '', '', '',
2343         'svcnum',       'int', '', '', '', '',
2344         'groupname',    'varchar', 'NULL', $char_d, '', '',
2345         'groupnum',     'int', 'NULL', '', '', '',
2346       ],
2347       'primary_key' => 'usergroupnum',
2348       'unique'      => [],
2349       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
2350     },
2351
2352     'radius_group' => {
2353       'columns' => [
2354         'groupnum', 'serial', '', '', '', '',
2355         'groupname',    'varchar', '', $char_d, '', '',
2356         'description',  'varchar', 'NULL', $char_d, '', '',
2357       ],
2358       'primary_key' => 'groupnum',
2359       'unique'      => [ ['groupname'] ],
2360       'index'       => [],
2361     },
2362
2363     'msgcat' => {
2364       'columns' => [
2365         'msgnum', 'serial', '', '', '', '',
2366         'msgcode', 'varchar', '', 255, '', '',
2367         'locale', 'varchar', '', 16, '', '',
2368         'msg', 'text', '', '', '', '',
2369       ],
2370       'primary_key' => 'msgnum',
2371       'unique'      => [ [ 'msgcode', 'locale' ] ],
2372       'index'       => [],
2373     },
2374
2375     'cust_tax_exempt' => {
2376       'columns' => [
2377         'exemptnum', 'serial', '', '', '', '',
2378         'custnum',   'int', '', '', '', '',
2379         'taxnum',    'int', '', '', '', '',
2380         'year',      'int', '', '', '', '',
2381         'month',     'int', '', '', '', '',
2382         'amount',   @money_type, '', '',
2383       ],
2384       'primary_key' => 'exemptnum',
2385       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
2386       'index'       => [],
2387     },
2388
2389     'cust_tax_exempt_pkg' => {
2390       'columns' => [
2391         'exemptpkgnum',  'serial', '', '', '', '',
2392         #'custnum',      'int', '', '', '', ''
2393         'billpkgnum',   'int', '', '', '', '',
2394         'taxnum',       'int', '', '', '', '',
2395         'year',         'int', '', '', '', '',
2396         'month',        'int', '', '', '', '',
2397         'creditbillpkgnum', 'int', 'NULL', '', '', '',
2398         'amount',       @money_type, '', '',
2399       ],
2400       'primary_key' => 'exemptpkgnum',
2401       'unique' => [],
2402       'index'  => [ [ 'taxnum', 'year', 'month' ],
2403                     [ 'billpkgnum' ],
2404                     [ 'taxnum' ],
2405                     [ 'creditbillpkgnum' ],
2406                   ],
2407     },
2408
2409     'router' => {
2410       'columns' => [
2411         'routernum', 'serial', '', '', '', '',
2412         'routername', 'varchar', '', $char_d, '', '',
2413         'svcnum', 'int', 'NULL', '', '', '',
2414         'agentnum',   'int', 'NULL', '', '', '',
2415       ],
2416       'primary_key' => 'routernum',
2417       'unique'      => [],
2418       'index'       => [],
2419     },
2420
2421     'part_svc_router' => {
2422       'columns' => [
2423         'svcrouternum', 'serial', '', '', '', '',
2424         'svcpart', 'int', '', '', '', '',
2425         'routernum', 'int', '', '', '', '',
2426       ],
2427       'primary_key' => 'svcrouternum',
2428       'unique'      => [],
2429       'index'       => [],
2430     },
2431
2432     'addr_block' => {
2433       'columns' => [
2434         'blocknum', 'serial', '', '', '', '',
2435         'routernum', 'int', '', '', '', '',
2436         'ip_gateway', 'varchar', '', 15, '', '',
2437         'ip_netmask', 'int', '', '', '', '',
2438         'agentnum',   'int', 'NULL', '', '', '',
2439         'manual_flag', 'char', 'NULL', 1, '', '',
2440       ],
2441       'primary_key' => 'blocknum',
2442       'unique'      => [ [ 'blocknum', 'routernum' ] ],
2443       'index'       => [],
2444     },
2445
2446     'svc_broadband' => {
2447       'columns' => [
2448         'svcnum', 'int', '', '', '', '',
2449         'description', 'varchar', 'NULL', $char_d, '', '',
2450         'blocknum', 'int', 'NULL', '', '', '',
2451         'speed_up', 'int', '', '', '', '',
2452         'speed_down', 'int', '', '', '', '',
2453         'ip_addr', 'varchar', 'NULL', 15, '', '',
2454         'mac_addr', 'varchar', 'NULL', 12, '', '',
2455         'authkey',  'varchar', 'NULL', 32, '', '',
2456         'latitude', 'decimal', 'NULL', '', '', '',
2457         'longitude', 'decimal', 'NULL', '', '', '',
2458         'altitude', 'decimal', 'NULL', '', '', '',
2459         'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
2460         'performance_profile', 'varchar', 'NULL', $char_d, '', '',
2461         'plan_id', 'varchar', 'NULL', $char_d, '', '',
2462       ],
2463       'primary_key' => 'svcnum',
2464       'unique'      => [ [ 'mac_addr' ] ],
2465       'index'       => [],
2466     },
2467
2468     'part_virtual_field' => {
2469       'columns' => [
2470         'vfieldpart', 'serial', '', '', '', '',
2471         'dbtable', 'varchar', '', 32, '', '',
2472         'name', 'varchar', '', 32, '', '',
2473         'length', 'int', 'NULL', '', '', '',
2474         'label', 'varchar', 'NULL', 80, '', '',
2475       ],
2476       'primary_key' => 'vfieldpart',
2477       'unique' => [],
2478       'index' => [],
2479     },
2480
2481     'virtual_field' => {
2482       'columns' => [
2483         'vfieldnum', 'serial', '', '', '', '',
2484         'recnum', 'int', '', '', '', '',
2485         'vfieldpart', 'int', '', '', '', '',
2486         'value', 'varchar', '', 128, '', '',
2487       ],
2488       'primary_key' => 'vfieldnum',
2489       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
2490       'index' => [],
2491     },
2492
2493     'acct_snarf' => {
2494       'columns' => [
2495         'snarfnum',    'serial',     '',      '', '', '',
2496         'snarfname',  'varchar', 'NULL', $char_d, '', '',
2497         'svcnum',         'int',     '',      '', '', '',
2498         'machine',    'varchar',     '',     255, '', '',
2499         'protocol',   'varchar',     '', $char_d, '', '',
2500         'username',   'varchar',     '', $char_d, '', '',
2501         '_password',  'varchar',     '', $char_d, '', '',
2502         'check_freq',     'int', 'NULL',      '', '', '',
2503         'leavemail',     'char', 'NULL',       1, '', '',
2504         'apop',          'char', 'NULL',       1, '', '',
2505         'tls',           'char', 'NULL',       1, '', '',
2506         'mailbox',    'varchar', 'NULL', $char_d, '', '',
2507       ],
2508       'primary_key' => 'snarfnum',
2509       'unique' => [],
2510       'index'  => [ [ 'svcnum' ] ],
2511     },
2512
2513     'svc_external' => {
2514       'columns' => [
2515         'svcnum',     'int',     '',      '', '', '',
2516         'id',      'bigint', 'NULL',      '', '', '',
2517         'title',  'varchar', 'NULL', $char_d, '', '',
2518       ],
2519       'primary_key' => 'svcnum',
2520       'unique'      => [],
2521       'index'       => [],
2522     },
2523
2524     'cust_pay_refund' => {
2525       'columns' => [
2526         'payrefundnum', 'serial', '', '', '', '',
2527         'paynum',  'int', '', '', '', '',
2528         'refundnum',  'int', '', '', '', '',
2529         '_date',    @date_type, '', '',
2530         'amount',   @money_type, '', '',
2531       ],
2532       'primary_key' => 'payrefundnum',
2533       'unique' => [],
2534       'index' => [ ['paynum'], ['refundnum'] ],
2535     },
2536
2537     'part_pkg_option' => {
2538       'columns' => [
2539         'optionnum', 'serial', '', '', '', '',
2540         'pkgpart', 'int', '', '', '', '',
2541         'optionname', 'varchar', '', $char_d, '', '',
2542         'optionvalue', 'text', 'NULL', '', '', '',
2543       ],
2544       'primary_key' => 'optionnum',
2545       'unique'      => [],
2546       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
2547     },
2548
2549     'part_pkg_vendor' => {
2550       'columns' => [
2551         'num', 'serial', '', '', '', '',
2552         'pkgpart', 'int', '', '', '', '',
2553         'exportnum', 'int', '', '', '', '',
2554         'vendor_pkg_id', 'varchar', '', $char_d, '', '',
2555       ],
2556       'primary_key' => 'num',
2557       'unique' => [ [ 'pkgpart', 'exportnum' ] ],
2558       'index'       => [ [ 'pkgpart' ] ],
2559     },
2560
2561     'part_pkg_report_option' => {
2562       'columns' => [
2563         'num',      'serial',   '',      '', '', '',
2564         'name',     'varchar',  '', $char_d, '', '',
2565         'disabled', 'char', 'NULL',       1, '', '',
2566       ],
2567       'primary_key' => 'num',
2568       'unique' => [ [ 'name' ] ],
2569       'index' => [ [ 'disabled' ] ],
2570     },
2571
2572     'rate' => {
2573       'columns' => [
2574         'ratenum',  'serial', '', '', '', '',
2575         'ratename', 'varchar', '', $char_d, '', '',
2576       ],
2577       'primary_key' => 'ratenum',
2578       'unique'      => [],
2579       'index'       => [],
2580     },
2581
2582     'rate_detail' => {
2583       'columns' => [
2584         'ratedetailnum',   'serial',  '',     '', '', '',
2585         'ratenum',         'int',     '',     '', '', '',
2586         'orig_regionnum',  'int', 'NULL',     '', '', '',
2587         'dest_regionnum',  'int',     '',     '', '', '',
2588         'min_included',    'int',     '',     '', '', '',
2589         'conn_charge',     'decimal', '', '10,4', '0', '',
2590         'conn_sec',        'int',     '',     '', '0', '',
2591         'min_charge',      'decimal', '', '10,5', '', '', #@money_type, '', '',
2592         'sec_granularity', 'int',     '',     '', '', '',
2593         'ratetimenum',     'int', 'NULL',     '', '', '',
2594         'classnum',        'int', 'NULL',     '', '', '',
2595         'cdrtypenum',      'int', 'NULL',     '', '', '',
2596         'region_group', 'char', 'NULL',       1, '', '',
2597       ],
2598       'primary_key' => 'ratedetailnum',
2599       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
2600       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
2601     },
2602
2603     'rate_region' => {
2604       'columns' => [
2605         'regionnum',   'serial',      '', '', '', '',
2606         'regionname',  'varchar',     '', $char_d, '', '',
2607       ],
2608       'primary_key' => 'regionnum',
2609       'unique'      => [],
2610       'index'       => [],
2611     },
2612
2613     'rate_prefix' => {
2614       'columns' => [
2615         'prefixnum',   'serial',      '', '', '', '',
2616         'regionnum',   'int',         '', '', '', '',
2617         'countrycode', 'varchar',     '',  3, '', '',
2618         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
2619         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
2620         'latanum',     'int',     'NULL',      '', '', '',
2621         'state',       'char',    'NULL',       2, '', '',
2622         'ocn',         'char',    'NULL',       4, '', '',
2623       ],
2624       'primary_key' => 'prefixnum',
2625       'unique'      => [],
2626       'index'       => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
2627     },
2628
2629     'rate_time' => {
2630       'columns' => [
2631         'ratetimenum', 'serial',      '',      '', '', '',
2632         'ratetimename',   'varchar',      '', $char_d, '', '',
2633       ],
2634       'primary_key' => 'ratetimenum',
2635       'unique'      => [],
2636       'index'       => [],
2637     },
2638
2639     'rate_time_interval' => {
2640       'columns' => [
2641         'intervalnum', 'serial', '', '', '', '',
2642         'stime',          'int', '', '', '', '',
2643         'etime',          'int', '', '', '', '',
2644         'ratetimenum',    'int', '', '', '', '',
2645       ],
2646       'primary_key' => 'intervalnum',
2647       'unique'      => [],
2648       'index'       => [],
2649     },
2650
2651     'usage_class' => {
2652       'columns' => [
2653         'classnum',    'serial',      '',      '', '', '',
2654         'weight',      'int',     'NULL',      '', '', '',
2655         'classname',   'varchar',     '', $char_d, '', '',
2656         'format',      'varchar', 'NULL', $char_d, '', '',
2657         'disabled',    'char',    'NULL',       1, '', '',
2658       ],
2659       'primary_key' => 'classnum',
2660       'unique' => [],
2661       'index' => [ ['disabled'] ],
2662     },
2663
2664     'reg_code' => {
2665       'columns' => [
2666         'codenum',   'serial',    '', '', '', '',
2667         'code',      'varchar',   '', $char_d, '', '',
2668         'agentnum',  'int',       '', '', '', '',
2669       ],
2670       'primary_key' => 'codenum',
2671       'unique'      => [ [ 'agentnum', 'code' ] ],
2672       'index'       => [ [ 'agentnum' ] ],
2673     },
2674
2675     'reg_code_pkg' => {
2676       'columns' => [
2677         'codepkgnum', 'serial', '', '', '', '',
2678         'codenum',   'int',    '', '', '', '',
2679         'pkgpart',   'int',    '', '', '', '',
2680       ],
2681       'primary_key' => 'codepkgnum',
2682       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
2683       'index'       => [ [ 'codenum' ] ],
2684     },
2685
2686     'clientapi_session' => {
2687       'columns' => [
2688         'sessionnum',  'serial',  '', '', '', '',
2689         'sessionid',  'varchar',  '', $char_d, '', '',
2690         'namespace',  'varchar',  '', $char_d, '', '',
2691       ],
2692       'primary_key' => 'sessionnum',
2693       'unique'      => [ [ 'sessionid', 'namespace' ] ],
2694       'index'       => [],
2695     },
2696
2697     'clientapi_session_field' => {
2698       'columns' => [
2699         'fieldnum',    'serial',     '', '', '', '',
2700         'sessionnum',     'int',     '', '', '', '',
2701         'fieldname',  'varchar',     '', $char_d, '', '',
2702         'fieldvalue',    'text', 'NULL', '', '', '',
2703       ],
2704       'primary_key' => 'fieldnum',
2705       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
2706       'index'       => [],
2707     },
2708
2709     'payment_gateway' => {
2710       'columns' => [
2711         'gatewaynum',       'serial',   '',     '', '', '',
2712         'gateway_namespace','varchar',  'NULL', $char_d, '', '',
2713         'gateway_module',   'varchar',  '',     $char_d, '', '',
2714         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
2715         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
2716         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
2717         'gateway_callback_url', 'varchar',  'NULL', $char_d, '', '',
2718         'disabled',   'char',  'NULL',   1, '', '',
2719       ],
2720       'primary_key' => 'gatewaynum',
2721       'unique' => [],
2722       'index'  => [ [ 'disabled' ] ],
2723     },
2724
2725     'payment_gateway_option' => {
2726       'columns' => [
2727         'optionnum',   'serial',  '',     '', '', '',
2728         'gatewaynum',  'int',     '',     '', '', '',
2729         'optionname',  'varchar', '',     $char_d, '', '',
2730         'optionvalue', 'text',    'NULL', '', '', '',
2731       ],
2732       'primary_key' => 'optionnum',
2733       'unique'      => [],
2734       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
2735     },
2736
2737     'agent_payment_gateway' => {
2738       'columns' => [
2739         'agentgatewaynum', 'serial', '', '', '', '',
2740         'agentnum',        'int', '', '', '', '',
2741         'gatewaynum',      'int', '', '', '', '',
2742         'cardtype',        'varchar', 'NULL', $char_d, '', '',
2743         'taxclass',        'varchar', 'NULL', $char_d, '', '',
2744       ],
2745       'primary_key' => 'agentgatewaynum',
2746       'unique'      => [],
2747       'index'       => [ [ 'agentnum', 'cardtype' ], ],
2748     },
2749
2750     'banned_pay' => {
2751       'columns' => [
2752         'bannum',  'serial',   '',     '', '', '',
2753         'payby',   'char',     '',       4, '', '',
2754         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
2755         #'paymask', 'varchar',  'NULL', $char_d, '', ''
2756         '_date',            @date_type,         '', '',
2757         'end_date',         @date_type,         '', '',
2758         'otaker',  'varchar',  'NULL',      32, '', '',
2759         'usernum',     'int',  'NULL',      '', '', '',
2760         'bantype', 'varchar',  'NULL', $char_d, '', '',
2761         'reason',  'varchar',  'NULL', $char_d, '', '',
2762       ],
2763       'primary_key' => 'bannum',
2764       'unique'      => [],
2765       'index'       => [ [ 'payby', 'payinfo' ], [ 'usernum' ], ],
2766     },
2767
2768     'pkg_category' => {
2769       'columns' => [
2770         'categorynum',   'serial',  '', '', '', '',
2771         'categoryname',  'varchar', '', $char_d, '', '',
2772         'weight',         'int', 'NULL',  '', '', '',
2773         'condense',      'char', 'NULL',   1, '', '',
2774         'disabled',      'char', 'NULL',   1, '', '',
2775       ],
2776       'primary_key' => 'categorynum',
2777       'unique' => [],
2778       'index' => [ ['disabled'] ],
2779     },
2780
2781     'pkg_class' => {
2782       'columns' => [
2783         'classnum',    'serial',   '',      '', '', '',
2784         'classname',   'varchar',  '', $char_d, '', '',
2785         'categorynum', 'int',  'NULL',      '', '', '',
2786         'disabled',    'char', 'NULL',       1, '', '',
2787         'fcc_ds0s',      'int',     'NULL', '', '', '',
2788       ],
2789       'primary_key' => 'classnum',
2790       'unique' => [],
2791       'index' => [ ['disabled'] ],
2792     },
2793
2794     'cdr' => {
2795       'columns' => [
2796         # qw( name type null length default local );
2797
2798         ###
2799         #asterisk fields
2800         ###
2801
2802         'acctid',   'bigserial',  '', '', '', '',
2803         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
2804         'calldate', 'timestamp',   '',      '', \'now()', '',
2805         'clid',        'varchar',  '', $char_d, \"''", '',
2806         'src',         'varchar',  '', $char_d, \"''", '',
2807         'dst',         'varchar',  '', $char_d, \"''", '',
2808         'dcontext',    'varchar',  '', $char_d, \"''", '',
2809         'channel',     'varchar',  '', $char_d, \"''", '',
2810         'dstchannel',  'varchar',  '', $char_d, \"''", '',
2811         'lastapp',     'varchar',  '', $char_d, \"''", '',
2812         'lastdata',    'varchar',  '', $char_d, \"''", '',
2813
2814         #these don't seem to be logged by most of the SQL cdr_* modules
2815         #except tds under sql-illegal names, so;
2816         # ... don't rely on them for rating?
2817         # and, what they hey, i went ahead and changed the names and data types
2818         # to freeside-style dates...
2819           #'start',  'timestamp', 'NULL',  '',    '', '',
2820           #'answer', 'timestamp', 'NULL',  '',    '', '',
2821           #'end',    'timestamp', 'NULL',  '',    '', '',
2822         'startdate',  @date_type, '', '',
2823         'answerdate', @date_type, '', '',
2824         'enddate',    @date_type, '', '',
2825         #
2826
2827         'duration',    'int',      '',      '',     0, '',
2828         'billsec',     'int',      '',      '',     0, '',
2829         'disposition', 'varchar',  '',      45, \"''", '',
2830         'amaflags',    'int',      '',      '',     0, '',
2831         'accountcode', 'varchar',  '',      20, \"''", '',
2832         'uniqueid',    'varchar',  '', $char_d, \"''", '',
2833         'userfield',   'varchar',  '',     255, \"''", '',
2834
2835         'max_callers', 'int',  'NULL',      '',    '', '',
2836
2837         ###
2838         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
2839         # defaults
2840         # though these are now used elsewhere:
2841         # charged_party, upstream_price, rated_price, carrierid, cdrtypenum
2842         ###
2843
2844         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
2845         'cdrtypenum',              'int', 'NULL',      '', '', '',
2846
2847         'charged_party',       'varchar', 'NULL', $char_d, '', '',
2848
2849         'upstream_currency',      'char', 'NULL',       3, '', '',
2850         'upstream_price',      'decimal', 'NULL',  '10,4', '', '',
2851         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
2852
2853         # how it was rated internally...
2854         'ratedetailnum',           'int', 'NULL',      '', '', '',
2855         'rated_price',         'decimal', 'NULL',  '10,4', '', '',
2856
2857         'distance',            'decimal', 'NULL',      '', '', '',
2858         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
2859
2860         #cdr_calltype: the big list in appendix 2
2861         'calltypenum',             'int', 'NULL',      '', '', '',
2862
2863         'description',         'varchar', 'NULL', $char_d, '', '',
2864         'quantity',                'int', 'NULL',      '', '', '',
2865
2866         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
2867         'carrierid',               'int', 'NULL',      '', '', '',
2868
2869         'upstream_rateid',         'int', 'NULL',      '', '', '',
2870
2871         ###
2872         #and now for our own fields
2873         ###
2874
2875         # a svcnum... right..?
2876         'svcnum',             'int',   'NULL',     '',   '', '',
2877
2878         #NULL, done (or something)
2879         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
2880
2881         #NULL, done (or something)
2882         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '',
2883
2884         #an indexed place to put big numbers
2885         'cdrid',         'bigint',     'NULL',     '',  '', '',
2886
2887         #for taqua accountcode rewriting, for starters
2888         'sessionnum',       'int',    'NULL',      '', '', '',
2889         'subscriber',   'varchar',    'NULL', $char_d, '', '',
2890
2891         #old
2892         'cdrbatch',     'varchar',    'NULL',     255, '', '',
2893         #new
2894         'cdrbatchnum',      'int',    'NULL',      '', '', '',
2895
2896       ],
2897       'primary_key' => 'acctid',
2898       'unique' => [],
2899       'index' => [ [ 'calldate' ],
2900                    [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
2901                    [ 'lastapp' ],
2902                    ['accountcode'], ['uniqueid'], ['carrierid'], ['cdrid'],
2903                    [ 'sessionnum' ], [ 'subscriber' ],
2904                    [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
2905                    [ 'cdrbatch' ], [ 'cdrbatchnum' ],
2906                  ],
2907     },
2908
2909     'cdr_batch' => {
2910       'columns' => [
2911         'cdrbatchnum',   'serial',    '',   '', '', '',
2912         'cdrbatch', 'varchar', 'NULL', 255, '', '',
2913         '_date',     @date_type, '', '',
2914       ],
2915       'primary_key' => 'cdrbatchnum',
2916       'unique' => [ [ 'cdrbatch' ] ],
2917       'index' => [],
2918     },
2919
2920     'cdr_termination' => {
2921       'columns' => [
2922         'cdrtermnum', 'bigserial',     '',      '', '', '',
2923         'acctid',        'bigint',     '',      '', '', '',
2924         'termpart',         'int',     '',      '', '', '',#future use see below
2925         'rated_price',  'decimal', 'NULL',  '10,4', '', '',
2926         'status',       'varchar', 'NULL',      32, '', '',
2927         'svcnum',           'int', 'NULL',      '', '', '',
2928       ],
2929       'primary_key' => 'cdrtermnum',
2930       'unique'      => [ [ 'acctid', 'termpart' ] ],
2931       'index'       => [ [ 'acctid' ], [ 'status' ], ],
2932     },
2933
2934     #to handle multiple termination/settlement passes...
2935    # 'part_termination' => {
2936    #   'columns' => [
2937    #     'termpart',       'int', '',      '', '', '',
2938    #     'termname',   'varchar', '', $char_d, '', '',
2939    #     'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
2940    #   ],
2941    #   'primary_key' => 'termpart',
2942    #   'unique' => [],
2943    #   'index'  => [],
2944    # },
2945
2946     #the remaining cdr_ tables are not really used
2947     'cdr_calltype' => {
2948       'columns' => [
2949         'calltypenum',   'serial',  '', '', '', '',
2950         'calltypename',  'varchar', '', $char_d, '', '',
2951       ],
2952       'primary_key' => 'calltypenum',
2953       'unique'      => [],
2954       'index'       => [],
2955     },
2956
2957     'cdr_type' => {
2958       'columns' => [
2959         'cdrtypenum'  => 'serial',  '', '', '', '',
2960         'cdrtypename' => 'varchar', '', $char_d, '', '',
2961       ],
2962       'primary_key' => 'cdrtypenum',
2963       'unique'      => [],
2964       'index'       => [],
2965     },
2966
2967     'cdr_carrier' => {
2968       'columns' => [
2969         'carrierid'   => 'serial',  '', '', '', '',
2970         'carriername' => 'varchar', '', $char_d, '', '',
2971       ],
2972       'primary_key' => 'carrierid',
2973       'unique'      => [],
2974       'index'       => [],
2975     },
2976
2977     #'cdr_file' => {
2978     #  'columns' => [
2979     #    'filenum',    'serial',     '', '', '', '',
2980     #    'filename',  'varchar',     '', '', '', '',
2981     #    'status',    'varchar', 'NULL', '', '', '',
2982     #  ],
2983     #  'primary_key' => 'filenum',
2984     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
2985     #                                   # agent-virtualize or have a customer
2986     #                                   # with dup-filename needs or something
2987     #                                   # (only used by cdr.http_and_import for
2988     #                                   #  chrissakes)
2989     #  'index'  => [],
2990     #},
2991
2992     'inventory_item' => {
2993       'columns' => [
2994         'itemnum',  'serial',      '',      '', '', '',
2995         'classnum', 'int',         '',      '', '', '',
2996         'agentnum', 'int',     'NULL',      '', '', '',
2997         'item',     'varchar',     '', $char_d, '', '',
2998         'svcnum',   'int',     'NULL',      '', '', '',
2999       ],
3000       'primary_key' => 'itemnum',
3001       'unique' => [ [ 'classnum', 'item' ] ],
3002       'index'  => [ [ 'classnum' ], [ 'agentnum' ], [ 'svcnum' ] ],
3003     },
3004
3005     'inventory_class' => {
3006       'columns' => [
3007         'classnum',  'serial',       '',      '', '', '',
3008         'classname', 'varchar',      '', $char_d, '', '',
3009       ],
3010       'primary_key' => 'classnum',
3011       'unique' => [],
3012       'index'  => [],
3013     },
3014
3015     'access_user' => {
3016       'columns' => [
3017         'usernum',   'serial',  '',      '', '', '',
3018         'username',  'varchar', '', $char_d, '', '',
3019         '_password', 'varchar', '', $char_d, '', '',
3020         'last',      'varchar', '', $char_d, '', '',
3021         'first',     'varchar', '', $char_d, '', '',
3022         'user_custnum',  'int', 'NULL',  '', '', '',
3023         'disabled',     'char', 'NULL',   1, '', '',
3024       ],
3025       'primary_key' => 'usernum',
3026       'unique' => [ [ 'username' ] ],
3027       'index'  => [ [ 'user_custnum' ] ],
3028     },
3029
3030     'access_user_pref' => {
3031       'columns' => [
3032         'prefnum',    'serial',       '', '', '', '',
3033         'usernum',     'int',       '', '', '', '',
3034         'prefname', 'varchar', '', $char_d, '', '',
3035         'prefvalue', 'text', 'NULL', '', '', '',
3036         'expiration', @date_type, '', '',
3037       ],
3038       'primary_key' => 'prefnum',
3039       'unique' => [],
3040       'index'  => [ [ 'usernum' ] ],
3041     },
3042
3043     'access_group' => {
3044       'columns' => [
3045         'groupnum',   'serial', '',      '', '', '',
3046         'groupname', 'varchar', '', $char_d, '', '',
3047       ],
3048       'primary_key' => 'groupnum',
3049       'unique' => [ [ 'groupname' ] ],
3050       'index'  => [],
3051     },
3052
3053     'access_usergroup' => {
3054       'columns' => [
3055         'usergroupnum', 'serial', '', '', '', '',
3056         'usernum',         'int', '', '', '', '',
3057         'groupnum',        'int', '', '', '', '',
3058       ],
3059       'primary_key' => 'usergroupnum',
3060       'unique' => [ [ 'usernum', 'groupnum' ] ],
3061       'index'  => [ [ 'usernum' ] ],
3062     },
3063
3064     'access_groupagent' => {
3065       'columns' => [
3066         'groupagentnum', 'serial', '', '', '', '',
3067         'groupnum',         'int', '', '', '', '',
3068         'agentnum',         'int', '', '', '', '',
3069       ],
3070       'primary_key' => 'groupagentnum',
3071       'unique' => [ [ 'groupnum', 'agentnum' ] ],
3072       'index'  => [ [ 'groupnum' ] ],
3073     },
3074
3075     'access_right' => {
3076       'columns' => [
3077         'rightnum',   'serial', '',      '', '', '',
3078         'righttype', 'varchar', '', $char_d, '', '',
3079         'rightobjnum',   'int', '',      '', '', '',
3080         'rightname', 'varchar', '', $char_d, '', '',
3081       ],
3082       'primary_key' => 'rightnum',
3083       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
3084       'index'  => [],
3085     },
3086
3087     'svc_phone' => {
3088       'columns' => [
3089         'svcnum',       'int',         '',      '', '', '',
3090         'countrycode',  'varchar',     '',       3, '', '',
3091         'phonenum',     'varchar',     '',      15, '', '',  #12 ?
3092         'pin',          'varchar', 'NULL', $char_d, '', '',
3093         'sip_password', 'varchar', 'NULL', $char_d, '', '',
3094         'phone_name',   'varchar', 'NULL', $char_d, '', '',
3095         'pbxsvc',           'int', 'NULL',      '', '', '',
3096         'domsvc',           'int', 'NULL',      '', '', '',
3097         'locationnum',      'int', 'NULL', '', '', '',
3098         'forwarddst',     'varchar',     'NULL',      15, '', '',
3099         'email',           'varchar', 'NULL',  255, '', '',
3100         'lnp_status',   'varchar', 'NULL', $char_d, '', '',
3101         'portable',     'char', 'NULL',       1,  '', '',
3102         'lrn',     'char',     'NULL',      10, '', '',
3103         'lnp_desired_due_date',     'int', 'NULL',       '', '', '',
3104         'lnp_due_date',     'int', 'NULL',       '', '', '',
3105         'lnp_other_provider', 'varchar', 'NULL', $char_d,  '', '',
3106         'lnp_other_provider_account', 'varchar', 'NULL', $char_d,  '', '',
3107         'lnp_reject_reason', 'varchar', 'NULL', $char_d,  '', '',
3108       ],
3109       'primary_key' => 'svcnum',
3110       'unique' => [],
3111       'index'  => [ ['countrycode', 'phonenum'], ['pbxsvc'], ['domsvc'],
3112                     ['locationnum'],
3113                   ],
3114     },
3115
3116     'phone_device' => {
3117       'columns' => [
3118         'devicenum', 'serial',     '', '', '', '',
3119         'devicepart',   'int',     '', '', '', '',
3120         'svcnum',       'int',     '', '', '', '',
3121         'mac_addr', 'varchar', 'NULL', 12, '', '',
3122       ],
3123       'primary_key' => 'devicenum',
3124       'unique' => [ [ 'mac_addr' ], ],
3125       'index'  => [ [ 'devicepart' ], [ 'svcnum' ], ],
3126     },
3127
3128     'part_device' => {
3129       'columns' => [
3130         'devicepart', 'serial',  '',      '', '', '',
3131         'devicename', 'varchar', '', $char_d, '', '',
3132         'inventory_classnum', 'int', 'NULL', '', '', '',
3133       ],
3134       'primary_key' => 'devicepart',
3135       'unique' => [ [ 'devicename' ] ], #?
3136       'index'  => [],
3137     },
3138
3139     'phone_avail' => {
3140       'columns' => [
3141         'availnum',    'serial',      '',      '', '', '',
3142         'exportnum',   'int',         '',      '', '', '',
3143         'countrycode', 'varchar',     '',       3, '', '',
3144         'state',       'char',    'NULL',       2, '', '',
3145         'npa',         'char',        '',       3, '', '',
3146         'nxx',         'char',    'NULL',       3, '', '',
3147         'station',     'char',    'NULL',       4, '', '',
3148         'name',        'varchar', 'NULL', $char_d, '', '',
3149         'rate_center_abbrev', 'varchar', 'NULL', $char_d, '', '',
3150         'latanum',      'int',     'NULL',      '', '', '',
3151         'msanum',       'int', 'NULL', '', '', '',
3152         'ordernum',      'int',     'NULL',      '', '', '',
3153         'svcnum',      'int',     'NULL',      '', '', '',
3154         'availbatch', 'varchar',  'NULL', $char_d, '', '',
3155       ],
3156       'primary_key' => 'availnum',
3157       'unique' => [],
3158       'index'  => [ [ 'exportnum', 'countrycode', 'state' ],     #npa search
3159                     [ 'exportnum', 'countrycode', 'npa' ],       #nxx search
3160                     [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
3161                     [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
3162                     [ 'svcnum' ],
3163                     [ 'availbatch' ],
3164                     [ 'latanum' ],
3165                   ],
3166     },
3167
3168     'lata' => {
3169       'columns' => [
3170         'latanum',    'int',      '',      '', '', '',
3171         'description',   'varchar',    '',      $char_d, '', '',
3172         'have_usage',   'int',    'NULL',      '', '', '',
3173       ],
3174       'primary_key' => 'latanum',
3175       'unique' => [],
3176       'index'  => [],
3177     },
3178
3179     'msa' => {
3180       'columns' => [
3181         'msanum',    'int',      '',      '', '', '',
3182         'description',   'varchar',    '',      $char_d, '', '',
3183       ],
3184       'primary_key' => 'msanum',
3185       'unique' => [],
3186       'index'  => [],
3187     },
3188
3189     'rate_center' => {
3190       'columns' => [
3191         'ratecenternum',    'serial',      '',      '', '', '',
3192         'description',   'varchar',    '',      $char_d, '', '',
3193       ],
3194       'primary_key' => 'ratecenternum',
3195       'unique' => [],
3196       'index'  => [],
3197     },
3198
3199     'did_vendor' => {
3200       'columns' => [
3201         'vendornum',    'serial',      '',      '', '', '',
3202         'vendorname',   'varchar',        '',     $char_d, '', '',
3203       ],
3204       'primary_key' => 'vendornum',
3205       'unique' => [],
3206       'index'  => [],
3207     },
3208
3209     'did_order_item' => {
3210       'columns' => [
3211         'orderitemnum',    'serial',      '',      '', '', '',
3212         'ordernum',    'int',      '',      '', '', '',
3213         'msanum',      'int',     'NULL',      '', '', '',
3214         'npa',      'int',     'NULL',      '', '', '',
3215         'latanum',      'int',     'NULL',      '', '', '',
3216         'ratecenternum',      'int',     'NULL',      '', '', '',
3217         'state',       'char',    'NULL',       2, '', '',
3218         'quantity',      'int',     '',      '', '', '',
3219         'custnum',   'int', 'NULL', '', '', '',
3220       ],
3221       'primary_key' => 'orderitemnum',
3222       'unique' => [],
3223       'index'  => [],
3224     },
3225
3226     'did_order' => {
3227       'columns' => [
3228         'ordernum',    'serial',      '',      '', '', '',
3229         'vendornum',   'int',       '',      '', '', '',
3230         'vendor_order_id',   'varchar',  'NULL',   $char_d, '', '',
3231         'custnum',   'int', 'NULL', '', '', '',
3232         'submitted',      'int',     '',      '', '', '',
3233         'confirmed',      'int',     'NULL',      '', '', '',
3234         'received',      'int',     'NULL',      '', '', '',
3235       ],
3236       'primary_key' => 'ordernum',
3237       'unique' => [ [ 'vendornum', 'vendor_order_id' ] ],
3238       'index'  => [],
3239     },
3240
3241     'reason_type' => {
3242       'columns' => [
3243         'typenum',   'serial',  '', '', '', '',
3244         'class',     'char', '', 1, '', '',
3245         'type',     'varchar', '', $char_d, '', '',
3246       ],
3247       'primary_key' => 'typenum',
3248       'unique' => [],
3249       'index' => [],
3250     },
3251
3252     'reason' => {
3253       'columns' => [
3254         'reasonnum',     'serial',  '', '', '', '',
3255         'reason_type',   'int',  '', '', '', '',
3256         'reason',        'text', '', '', '', '',
3257         'disabled',      'char',    'NULL', 1, '', '',
3258       ],
3259       'primary_key' => 'reasonnum',
3260       'unique' => [],
3261       'index' => [],
3262     },
3263
3264     'conf' => {
3265       'columns' => [
3266         'confnum',  'serial',  '', '', '', '',
3267         'agentnum', 'int',  'NULL', '', '', '',
3268         'name',     'varchar', '', $char_d, '', '',
3269         'value',    'text', 'NULL', '', '', '',
3270       ],
3271       'primary_key' => 'confnum',
3272       'unique' => [ [ 'agentnum', 'name' ]],
3273       'index' => [],
3274     },
3275
3276     'pkg_referral' => {
3277       'columns' => [
3278         'pkgrefnum',     'serial', '', '', '', '',
3279         'pkgnum',        'int',    '', '', '', '',
3280         'refnum',        'int',    '', '', '', '',
3281       ],
3282       'primary_key' => 'pkgrefnum',
3283       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
3284       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
3285     },
3286
3287     'svc_pbx' => {
3288       'columns' => [
3289         'svcnum',           'int',     '',      '', '', '',
3290         'id',               'int', 'NULL',      '', '', '',
3291         'title',        'varchar', 'NULL', $char_d, '', '',
3292         'max_extensions',   'int', 'NULL',      '', '', '',
3293         'max_simultaneous', 'int', 'NULL',      '', '', '',
3294       ],
3295       'primary_key' => 'svcnum',
3296       'unique' => [],
3297       'index'  => [ [ 'id' ] ],
3298     },
3299
3300     'svc_mailinglist' => { #svc_group?
3301       'columns' => [
3302         'svcnum',            'int',     '',            '', '', '',
3303         'username',      'varchar',     '', $username_len, '', '',
3304         'domsvc',            'int',     '',            '', '', '',
3305         'listnum',           'int',     '',            '', '', '',
3306         'reply_to',         'char', 'NULL',             1, '', '',#SetReplyTo
3307         'remove_from',      'char', 'NULL',             1, '', '',#RemoveAuthor
3308         'reject_auto',      'char', 'NULL',             1, '', '',#RejectAuto
3309         'remove_to_and_cc', 'char', 'NULL',             1, '', '',#RemoveToAndCc
3310       ],
3311       'primary_key' => 'svcnum',
3312       'unique' => [],
3313       'index'  => [ ['username'], ['domsvc'], ['listnum'] ],
3314     },
3315
3316     'mailinglist' => {
3317       'columns' => [
3318         'listnum',   'serial', '',      '', '', '',
3319         'listname', 'varchar', '', $char_d, '', '',
3320       ],
3321       'primary_key' => 'listnum',
3322       'unique' => [],
3323       'index'  => [],
3324     },
3325
3326     'mailinglistmember' => {
3327       'columns' => [
3328         'membernum',        'serial',     '',   '', '', '',
3329         'listnum',             'int',     '',   '', '', '',
3330         'svcnum',              'int', 'NULL',   '', '', '',
3331         'contactemailnum',     'int', 'NULL',   '', '', '',
3332         'email',           'varchar', 'NULL',  255, '', '',
3333       ],
3334       'primary_key' => 'membernum',
3335       'unique'      => [],
3336       'index'       => [['listnum'],['svcnum'],['contactemailnum'],['email']],
3337     },
3338
3339     'bill_batch' => {
3340       'columns' => [
3341         'batchnum',         'serial',     '',  '', '', '',
3342         'agentnum',            'int', 'NULL',  '', '', '',
3343         'status',             'char', 'NULL', '1', '', '',
3344         'pdf',                'blob', 'NULL',  '', '', '',
3345       ],
3346       'primary_key' => 'batchnum',
3347       'unique'      => [],
3348       'index'       => [ ['agentnum'] ],
3349     },
3350
3351     'cust_bill_batch' => {
3352       'columns' => [
3353         'billbatchnum',     'serial',     '', '', '', '',
3354         'batchnum',            'int',     '', '', '', '',
3355         'invnum',              'int',     '', '', '', '',
3356       ],
3357       'primary_key' => 'billbatchnum',
3358       'unique'      => [],
3359       'index'       => [ [ 'batchnum' ], [ 'invnum' ] ],
3360     },
3361
3362     'cust_bill_batch_option' => {
3363       'columns' => [
3364         'optionnum', 'serial', '', '', '', '',
3365         'billbatchnum', 'int', '', '', '', '',
3366         'optionname', 'varchar', '', $char_d, '', '',
3367         'optionvalue', 'text', 'NULL', '', '', '',
3368       ],
3369       'primary_key' => 'optionnum',
3370       'unique'      => [],
3371       'index'       => [ [ 'billbatchnum' ], [ 'optionname' ] ],
3372     },
3373
3374     'msg_template' => {
3375       'columns' => [
3376         'msgnum',     'serial',     '',      '', '', '',
3377         'msgname',   'varchar',     '', $char_d, '', '',
3378         'agentnum',      'int', 'NULL',      '', '', '',
3379         'subject',   'varchar', 'NULL',     512, '', '',
3380         'mime_type', 'varchar',     '', $char_d, '', '',
3381         'body',         'blob', 'NULL',      '', '', '',
3382         'disabled',     'char', 'NULL',       1, '', '',
3383         'from_addr', 'varchar', 'NULL',     255, '', '',
3384         'bcc_addr',  'varchar', 'NULL',     255, '', '',
3385       ],
3386       'primary_key' => 'msgnum',
3387       'unique'      => [ ],
3388       'index'       => [ ['agentnum'], ],
3389     },
3390
3391     'template_content' => {
3392       'columns' => [
3393         'contentnum', 'serial',     '',      '', '', '',
3394         'msgnum',        'int',     '',      '', '', '',
3395         'locale',    'varchar', 'NULL',      16, '', '',
3396         'subject',   'varchar', 'NULL',     512, '', '',
3397         'body',         'text', 'NULL',      '', '', '',
3398       ],
3399       'primary_key' => 'contentnum',
3400       'unique'      => [ ['msgnum', 'locale'] ],
3401       'index'       => [ ],
3402     },
3403
3404     'cust_msg' => {
3405       'columns' => [
3406         'custmsgnum', 'serial',     '',     '', '', '',
3407         'custnum',       'int',     '',     '', '', '',
3408         'msgnum',        'int', 'NULL',     '', '', '',
3409         '_date',    @date_type,                 '', '',
3410         'env_from',  'varchar', 'NULL',    255, '', '',
3411         'env_to',    'varchar', 'NULL',    255, '', '',
3412         'header',       'blob', 'NULL',     '', '', '',
3413         'body',         'blob', 'NULL',     '', '', '',
3414         'error',     'varchar', 'NULL',    255, '', '',
3415         'status',    'varchar',     '',$char_d, '', '',
3416       ],
3417       'primary_key' => 'custmsgnum',
3418       'unique'      => [ ],
3419       'index'       => [ ['custnum'], ],
3420     },
3421
3422     'svc_cert' => {
3423       'columns' => [
3424         'svcnum',                'int',     '',      '', '', '',
3425         'recnum',                'int', 'NULL',      '', '', '',
3426         'privatekey',           'text', 'NULL',      '', '', '',
3427         'csr',                  'text', 'NULL',      '', '', '',
3428         'certificate',          'text', 'NULL',      '', '', '',
3429         'cacert',               'text', 'NULL',      '', '', '',
3430         'common_name',       'varchar', 'NULL', $char_d, '', '',
3431         'organization',      'varchar', 'NULL', $char_d, '', '',
3432         'organization_unit', 'varchar', 'NULL', $char_d, '', '',
3433         'city',              'varchar', 'NULL', $char_d, '', '',
3434         'state',             'varchar', 'NULL', $char_d, '', '',
3435         'country',              'char', 'NULL',       2, '', '',
3436         'cert_contact',      'varchar', 'NULL', $char_d, '', '',
3437       ],
3438       'primary_key' => 'svcnum',
3439       'unique' => [],
3440       'index'  => [], #recnum
3441     },
3442
3443     'svc_port' => {
3444       'columns' => [
3445         'svcnum',                'int',     '',      '', '', '',
3446         'serviceid', 'varchar', '', 64, '', '', #srvexport / reportfields
3447       ],
3448       'primary_key' => 'svcnum',
3449       'unique' => [],
3450       'index'  => [], #recnum
3451     },
3452
3453     'areacode'  => {
3454       'columns' => [
3455         'areanum',   'serial',        '',      '', '', '',
3456         'code',        'char',        '',       3, '', '',
3457         'country',     'char',    'NULL',       2, '', '',
3458         'state',       'char',    'NULL',       2, '', '',
3459         'description','varchar',  'NULL',     255, '', '',
3460       ],
3461       'primary_key' => 'areanum',
3462       'unique' => [ [ 'areanum' ] ],
3463       'index'  => [],
3464     },
3465
3466     %{ tables_hashref_torrus() },
3467
3468     # tables of ours for doing torrus virtual port combining
3469     'torrus_srvderive' => {
3470       'columns' => [
3471         'derivenum',     'serial',     '', '', '', '',
3472         'serviceid',    'varchar',     '', 64, '', '', #srvexport / reportfields
3473         'last_srv_date',   'date', 'NULL', '', '', '',
3474       ],
3475       'primary_key' => 'derivenum',
3476       'unique' => [ ['serviceid'] ],
3477       'index'  => [],
3478     },
3479
3480     'torrus_srvderive_component' => {
3481       'columns' => [
3482         'componentnum', 'serial', '', '', '', '',
3483         'derivenum',       'int', '', '', '', '',
3484         'serviceid',   'varchar', '', 64, '', '', #srvexport / reportfields
3485       ],
3486       'primary_key' => 'componentnum',
3487       'unique'      => [ [ 'derivenum', 'serviceid' ], ],
3488       'index'       => [ [ 'derivenum', ], ],
3489     },
3490
3491
3492     # name type nullability length default local
3493
3494     #'new_table' => {
3495     #  'columns' => [
3496     #    'num', 'serial',       '', '', '', '',
3497     #  ],
3498     #  'primary_key' => 'num',
3499     #  'unique' => [],
3500     #  'index'  => [],
3501     #},
3502
3503   };
3504
3505 }
3506
3507 =back
3508
3509 =head1 BUGS
3510
3511 =head1 SEE ALSO
3512
3513 L<DBIx::DBSchema>
3514
3515 =cut
3516
3517 1;
3518