Copy all files in one container of one backend to another. More...
Public Member Functions | |
| __construct () | |
| Default constructor. More... | |
| execute () | |
| Do the actual work. More... | |
 Public Member Functions inherited from Maintenance | |
| cleanupChanneled () | |
| Clean up channeled output. More... | |
| clearParamsAndArgs () | |
| Clear all params and arguments. More... | |
| finalSetup () | |
| Handle some last-minute setup here. More... | |
| getDbType () | |
| Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB. More... | |
| getName () | |
| Get the script's name. More... | |
| globals () | |
| Potentially debug globals. More... | |
| isQuiet () | |
| loadParamsAndArgs ( $self=null, $opts=null, $args=null) | |
| Process command line arguments $mOptions becomes an array with keys set to the option names $mArgs becomes a zero-based array containing the non-option arguments. More... | |
| loadSettings () | |
| Generic setup for most installs. More... | |
| memoryLimit () | |
| Normally we disable the memory_limit when running admin scripts. More... | |
| outputChanneled ( $msg, $channel=null) | |
| Message outputter with channeled message support. More... | |
| purgeRedundantText ( $delete=true) | |
| Support function for cleaning up redundant text records. More... | |
| runChild ( $maintClass, $classFile=null) | |
| Run a child maintenance script. More... | |
| setDB (&$db) | |
| Sets database object to be returned by getDB(). More... | |
| setup () | |
| Do some sanity checking and basic setup. More... | |
| updateSearchIndex ( $maxLockTime, $callback, $dbw, $results) | |
| Perform a search index update with locking. More... | |
| updateSearchIndexForPage ( $dbw, $pageId) | |
| Update the searchindex table for a given pageid. More... | |
Protected Member Functions | |
| copyFileBatch (array $srcPathsRel, $backendRel, FileBackend $src, FileBackend $dst) | |
| delFileBatch (array $dstPathsRel, $backendRel, FileBackend $dst) | |
| filesAreSame (FileBackend $src, FileBackend $dst, $sPath, $dPath) | |
| getListingDiffRel (FileBackend $src, FileBackend $dst, $backendRel) | |
| Protected Member Functions inherited from Maintenance | |
| addArg ( $arg, $description, $required=true) | |
| Add some args that are needed. More... | |
| addDefaultParams () | |
| Add the default parameters to the scripts. More... | |
| addDescription ( $text) | |
| Set the description text. More... | |
| addOption ( $name, $description, $required=false, $withArg=false, $shortName=false) | |
| Add a parameter to the script. More... | |
| adjustMemoryLimit () | |
| Adjusts PHP's memory limit to better suit our needs, if needed. More... | |
| afterFinalSetup () | |
| Execute a callback function at the end of initialisation. More... | |
| deleteOption ( $name) | |
| Remove an option. More... | |
| error ( $err, $die=0) | |
| Throw an error to the user. More... | |
| getArg ( $argId=0, $default=null) | |
| Get an argument. More... | |
| & | getDB ( $db, $groups=array(), $wiki=false) |
| Returns a database to be used by current maintenance script. More... | |
| getDir () | |
| Get the maintenance directory. More... | |
| getOption ( $name, $default=null) | |
| Get an option, or return the default. More... | |
| getStdin ( $len=null) | |
| Return input from stdin. More... | |
| hasArg ( $argId=0) | |
| Does a given argument exist? More... | |
| hasOption ( $name) | |
| Checks to see if a particular param exists. More... | |
| loadSpecialVars () | |
| Handle the special variables that are global to all scripts. More... | |
| maybeHelp ( $force=false) | |
| Maybe show the help. More... | |
| output ( $out, $channel=null) | |
| Throw some output to the user. More... | |
| setBatchSize ( $s=0) | |
| Set the batch size. More... | |
| validateParamsAndArgs () | |
| Run some validation checks on the params, etc. More... | |
Protected Attributes | |
| Array null | $statCache = null |
| (path sha1 => stat) Pre-computed dst stat entries from listings * More... | |
| Protected Attributes inherited from Maintenance | |
| $mArgList = array() | |
| $mArgs = array() | |
| int | $mBatchSize = null |
| Batch size. More... | |
| $mDbUser | |
| $mDescription = '' | |
| $mInputLoaded = false | |
| $mOptions = array() | |
| $mParams = array() | |
| $mQuiet = false | |
| $mSelf | |
| $mShortParamsMap = array() | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Maintenance | |
| static | posix_isatty ( $fd) |
| Wrapper for posix_isatty() We default as considering stdin a tty (for nice readline methods) but treating stout as not a tty to avoid color codes. More... | |
| static | readconsole ( $prompt='> ') |
| Prompt the console for input. More... | |
| static | shouldExecute () |
| Should we execute the maintenance script, or just allow it to be included as a standalone class? It checks that the call stack only includes this function and "requires" (meaning was called from the file scope) More... | |
| Public Attributes inherited from Maintenance | |
| resource | $fileHandle |
| Used when creating separate schema files. More... | |
| $mDbPass | |
| const | DB_ADMIN = 2 |
| const | DB_NONE = 0 |
| Constants for DB access type. More... | |
| const | DB_STD = 1 |
| const | STDIN_ALL = 'all' |
Detailed Description
Copy all files in one container of one backend to another.
This can also be used to re-shard the files for one backend using the config of second backend. The second backend should have the same config as the first, except for it having a different name and different sharding configuration. The backend should be made read-only while this runs. After this script finishes, the old files in the containers can be deleted.
Definition at line 37 of file copyFileBackend.php.
Constructor & Destructor Documentation
◆ __construct()
| CopyFileBackend::__construct | ( | ) |
Default constructor.
Children should call this first if implementing their own constructors
Reimplemented from Maintenance.
Definition at line 40 of file copyFileBackend.php.
References Maintenance\addOption(), and Maintenance\setBatchSize().
Member Function Documentation
◆ copyFileBatch()
|
protected |
- Parameters
-
array $srcPathsRel string $backendRel FileBackend $src FileBackend $dst
- Returns
- void
Definition at line 212 of file copyFileBackend.php.
References array(), as, FileBackend\clearCache(), FileBackend\doQuickOperations(), Maintenance\error(), false, FileBackend\fileExists(), filesAreSame(), FileBackend\getLocalReference(), FileBackend\getLocalReferenceMulti(), FileBackend\getRootStoragePath(), FileBackend\getWikiId(), Maintenance\hasOption(), Maintenance\output(), FileBackend\prepare(), and true.
Referenced by execute().
◆ delFileBatch()
|
protected |
- Parameters
-
array $dstPathsRel string $backendRel FileBackend $dst
- Returns
- void
Definition at line 299 of file copyFileBackend.php.
References array(), as, FileBackend\doQuickOperations(), Maintenance\error(), FileBackend\getRootStoragePath(), FileBackend\getWikiId(), Maintenance\output(), and true.
Referenced by execute().
◆ execute()
| CopyFileBackend::execute | ( | ) |
Do the actual work.
All child classes will need to implement this
Reimplemented from Maintenance.
Definition at line 56 of file copyFileBackend.php.
References $count, $path, array(), as, copyFileBatch(), delFileBatch(), Maintenance\error(), getListingDiffRel(), Maintenance\getOption(), Maintenance\hasOption(), Maintenance\output(), and FileBackendGroup\singleton().
◆ filesAreSame()
|
protected |
- Parameters
-
FileBackend $src FileBackend $dst string $sPath string $dPath
- Returns
- bool
Definition at line 337 of file copyFileBackend.php.
References array(), FileBackend\getFileSha1Base36(), FileBackend\getFileStat(), and Maintenance\hasOption().
Referenced by copyFileBatch().
◆ getListingDiffRel()
|
protected |
- Parameters
-
FileBackend $src FileBackend $dst string $backendRel
- Returns
- array (rel paths in $src minus those in $dst)
Definition at line 176 of file copyFileBackend.php.
References array(), as, Maintenance\error(), FileBackend\getFileList(), and FileBackend\getRootStoragePath().
Referenced by execute().
Member Data Documentation
◆ $statCache
|
protected |
(path sha1 => stat) Pre-computed dst stat entries from listings *
Definition at line 38 of file copyFileBackend.php.
The documentation for this class was generated from the following file:
- maintenance/copyFileBackend.php
