Package iceprod :: Package client :: Module commands :: Class retire
[hide private]
[frames] | no frames]

Class retire

source code

object --+    
         |    
   Command --+
             |
            retire

Command: retire <dataset_id>

Retire a dataset.  Send it to the archives.
Can retire multiple datasets at once.

Arguments:
  <dataset_id>  Specify the dataset to retire.
  
Returns:
  Returns the result of the mysql query (success or failure).
  Warning that if the dataset is wrong it will likely
  print success because there was no mysql error.
  
Examples:
  Retire single dataset  (dataset 1234)
     retire 1234
  
  Retire multiple datasets using commas
  (datasets 1234, 1243 and jobs 1, 3, and 5)
     retire 1234,1243
  
  Retire multile datasets using ranges
  (datasets 1234 - 1235, jobs 1 - 5)
     retire 1234-1235
 

Instance Methods [hide private]
 
Execute(self, shell) source code
 
_retire(self, shell, dataset) source code

Inherited from Command: CheckArgs

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  shortdoc = 'retire <dataset_id> : Retire a dataset.'
hash(x)
  numArgs = 1
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

Execute(self, shell)

source code 
Overrides: Command.Execute