Difference between revisions of "Freeside:3:Documentation:Developer/bin/freeside-upgrade"

From Freeside
Jump to: navigation, search
m (Edit via perl MediaWiki framework (1.13))
 
m (Edit via perl MediaWiki framework (1.13))
Line 4: Line 4:
 
==SYNOPSIS==
 
==SYNOPSIS==
 
<code>
 
<code>
   freeside-upgrade [ -d ] [ -r ] [ -s ] [ -q | -v ]
+
   freeside-upgrade [ -d ] [ -q | -v ] [ -r ] [ -c ] [ -s ] [ -j ] [ -a ]
 
</code>
 
</code>
 
==DESCRIPTION==
 
==DESCRIPTION==
Line 17: Line 17:
 
   
 
   
 
   [ -q ]: Run quietly.  This may become the default at some point.
 
   [ -q ]: Run quietly.  This may become the default at some point.
 +
 +
  [ -v ]: Run verbosely, sending debugging information to STDERR.  This is the
 +
          current default.
 +
 +
  [ -s ]: Schema changes only.  Useful for Pg/slony slaves where the data
 
   
 
   
 
   [ -r ]: Skip sqlradius updates.  Useful for occassions where the sqlradius
 
   [ -r ]: Skip sqlradius updates.  Useful for occassions where the sqlradius
 
           databases may be inaccessible.
 
           databases may be inaccessible.
 
   
 
   
   [ -v ]: Run verbosely, sending debugging information to STDERR.  This is the
+
   [ -c ]: Skip cdr and h_cdr updates.
          current default.
 
 
   
 
   
  [ -s ]: Schema changes only.  Useful for Pg/slony slaves where the data
 
 
           changes will be replicated from the Pg/slony master.
 
           changes will be replicated from the Pg/slony master.
 +
 +
  [ -j ]: Run certain upgrades asychronously from the job queue.  Currently
 +
          used only for the 2.x -> 3.x cust_location, cust_pay and part_pkg
 +
          upgrades.  This may cause odd behavior before the upgrade is
 +
          complete, so it's recommended only for very large cust_main, cust_pay
 +
          and/or part_pkg tables that take too long to upgrade.
 +
 +
  [ -a ]: Run schema changes in parallel (Pg only).  DBIx::DBSchema minimum
 +
          version 0.41 recommended.  Recommended only for large databases and
 +
          powerful database servers, to reduce upgrade time.
 
</code>
 
</code>
 
==SEE ALSO==
 
==SEE ALSO==

Revision as of 13:48, 27 June 2014

NAME

freeside-upgrade - Upgrades database schema for new freeside verisons.

SYNOPSIS

 freeside-upgrade [ -d ] [ -q | -v ] [ -r ] [ -c ] [ -s ] [ -j ] [ -a ]

DESCRIPTION

Reads your existing database schema and updates it to match the current schema, adding any columns or tables necessary.

Also performs other upgrade functions:

Calls FS:: Misc::prune::prune_applications (probably unnecessary every upgrade, but simply won't find any records to change); If necessary, moves your configuration information from the filesystem in /usr/local/etc/freeside/conf.<datasrc> to the database.

 [ -d ]: Dry run; output SQL statements (to STDOUT) only, but do not execute
         them.

 [ -q ]: Run quietly.  This may become the default at some point.

 [ -v ]: Run verbosely, sending debugging information to STDERR.  This is the
         current default.

 [ -s ]: Schema changes only.  Useful for Pg/slony slaves where the data

 [ -r ]: Skip sqlradius updates.  Useful for occassions where the sqlradius
         databases may be inaccessible.

 [ -c ]: Skip cdr and h_cdr updates.

         changes will be replicated from the Pg/slony master.

 [ -j ]: Run certain upgrades asychronously from the job queue.  Currently 
         used only for the 2.x -> 3.x cust_location, cust_pay and part_pkg
         upgrades.  This may cause odd behavior before the upgrade is
         complete, so it's recommended only for very large cust_main, cust_pay
         and/or part_pkg tables that take too long to upgrade.

 [ -a ]: Run schema changes in parallel (Pg only).  DBIx::DBSchema minimum 
         version 0.41 recommended.  Recommended only for large databases and
         powerful database servers, to reduce upgrade time.

SEE ALSO