Public Member Functions | |
| runJobs ($options=['username'=> NULL, 'job_id'=> NULL, 'parallel'=> FALSE, 'max_jobs'=> -1, 'single'=> 0]) | |
| rerunJob ($options=['username'=> NULL, 'job_id'=> NULL, 'parallel'=> FALSE, 'max_jobs'=> -1, 'single'=> 0]) | |
| tripalVersion () | |
| tripalImportContentTypes ($options=['username'=> NULL, 'collection_id'=> NULL]) | |
Protected Member Functions | |
| switchUser ($uname) | |
Detailed Description
Drush commands
Member Function Documentation
◆ rerunJob()
| Drupal\tripal\Commands\TripalCommands::rerunJob | ( | $options = ['username' =, |
|
| NULL | , | ||
| 'job_id' | , | ||
| NULL | , | ||
| 'parallel' | , | ||
| FALSE | , | ||
| 'max_jobs' | , | ||
| - | 1, | ||
| 'single' | , | ||
| 0] | |||
| ) |
Reruns a jobs in the Tripal Jobs Queue.
@command tripal:trp-rerun-job @aliases trp-rerun-job @options parallel Set to 1 if the job is allowed to run in parallel with other Tripal jobs. @options job_id The numeric ID of the job. If no job ID is provided then all of the jobs waiting in the queue will be run. @options max_jobs The maximum number of jobs that should be run concurrently. If -1 then unlimited. @options single Ensures only a single job is run rather then the entire queue. @options username The name of the user for whom the job run is associated. @usage drush trp-run-job –job_id=[JOB_ID] –username=[USERNAME] Re-runs a job by first resubmitting it then executing it.
◆ runJobs()
| Drupal\tripal\Commands\TripalCommands::runJobs | ( | $options = ['username' =, |
|
| NULL | , | ||
| 'job_id' | , | ||
| NULL | , | ||
| 'parallel' | , | ||
| FALSE | , | ||
| 'max_jobs' | , | ||
| - | 1, | ||
| 'single' | , | ||
| 0] | |||
| ) |
Executes one or more jobs in the Tripal Jobs Queue.
@command tripal:trp-run-jobs @aliases trp-run-jobs @options parallel Set to 1 if the job is allowed to run in parallel with other Tripal jobs. @options job_id The numeric ID of the job. If no job ID is provided then all of the jobs waiting in the queue will be run. @options max_jobs The maximum number of jobs that should be run concurrently. If -1 then unlimited. @options single Ensures only a single job is run rather then the entire queue. @options username The name of the user for whom the job run is associated. @usage drush trp-run-jobs –username=[USERNAME] Executes all jobs waiting in the queue and associates the runs with the provided user. @usage drush trp-run-jobs –job_id=[JOB_ID] –username=[USERNAME] Executes a job, using the provided job ID and associates the run with the provided user.
◆ switchUser()
|
protected |
Makes sure the proper user is set when running the drush command.
◆ tripalImportContentTypes()
| Drupal\tripal\Commands\TripalCommands::tripalImportContentTypes | ( | $options = ['username' =, |
|
| NULL | , | ||
| 'collection_id' | , | ||
| NULL] | |||
| ) |
Imports a collection of Tripal Content Types and associated fields for a specific collection id.
@command tripal:trp-import-types @aliases trp-import-types @options collection_id The id specified in the YAML file for the particular TripalEntityType-Collection you would like to import. Note: fields will also be added automatically if the TripalField-Collection YAML file has the same id. @options username The name of the user for whom the content types created are associated. @usage drush trp-import-types –username=[USERNAME] –collection_id=genomic_chado Runs a job importing the genomic content types focused on a Chado backend.
◆ tripalVersion()
| Drupal\tripal\Commands\TripalCommands::tripalVersion | ( | ) |
Returns the current version of Tripal that is installed
@command tripal:version @aliases trp-version @usage drush trp-version Returns the current Tripal version string.
The documentation for this class was generated from the following file:
- tripal/src/Commands/TripalCommands.php
