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