Gain productivity with Drush (Drupal Camp, Montreal 2013)

Gain productivity with Drush

Gain productivity with Drush - Emmanuel Milou

1

Introduction


2

introduction

Emmanuel Milou
@manumilou
emmanuel.milou@savoirfairelinux.com
Drupal Technical Leader at Savoir-faire Linux
Based in Montreal
http://sflx.ca/love

3

What is drush ?


4

what is drush ?

“ Drush (DRUpal Shell) is a command
line shell and scripting interface for
Drupal “


5

what is drush ?



Running Drupal commands through the shell



3 main parts:
●

The drush project manager:
Manage modules and themes
Drush core:
•

●

Manage site configuration
Drush SQL
•

●

•

Issue query to database


6

what is drush ?

$ drush [options] command ...


7

what is drush ?



Short and long version for every command
●
●
●
●
●
●

site-install (si)
variable-get (vget)
variable-set (vset)
pm-download (dl)
enable (en)
...


8

what is drush ?



Example:
$ drush yes vset maintenance_mode 1
$ drush vset yes maintenance_mode 1
$ drush yes variableset
maintenance_mode 1


9

what is drush ?



The help command
$ drush help
$ drush help [command]


10

what is drush ?



Examples:
●
●
●
●
●
●
●

Installing sites
Updating sites
Downloading and enabling modules / themes
Clearing caches
Administring sites configuration
Archiving sites
...


11

Do I need to use drush ?


12

Yes :-)


13

why do I need to use drush



Swiss-knife



Work faster



Automate tasks



Handle multiple sites



Create your own command


14

Installing drush


15

installing drush

https://github.com/drush-ops/drush


16

installing drush



Multi plateform:
●
●

Unix-like OS
Windows

Specific instructions on different platforms:
https://drupal.org/node/1791676


17

installing drush



Example on Ubuntu (need php-pear library)
pear channeldiscover
pear.drush.org
pear install drush/drush
drush version


18

Installing a site and
introspection


19

site installation and instrospection



Download the latest stable release:
$ drush pmdownload drupal7.x



Run installation procedure:
$ drush siteinstall
dburl=mysql://user:pass@localho
st:port/dbname


20




More on site-install command:
$ drush siteinstall [profile]
dburl=mysql://user:pass@hostname
[:port]/database
sitename=”Dev site”
accountmail=admin@mysite.com
accountname=admin
accountpass=admin


21




After a successful bootstrap
$ drush status



General view of the current installation:
●
●
●
●

Database credentials
Drupal root
Files directory path
Admin theme


22

Downloading and
managing modules


23

downloading and managing modules



Available commands to:
●

●

●

List all modules:
$ drush pmlist
Download a module / theme:
$ drush pmdownload <modulename>
Enable a module / theme:
$ drush pmenable <modulename>


24


Installing and enabling a module used to look
like this:


25

1. Find the module's exact name
2. Look up for the module on drupal.org
3. Download the archive module from project page
4. Go on your disk and extract the archive
5. Copy the module directory in the drupal installation
6. Go to module admin page
7. Realize the module needs an other module to be
enabled
8. Repeat from step 2

26


Now with drush, it is:


27




Find the module's exact name



Run:
$ drush dl <modulename>
$ drush enable <modulename>


28




Download modules in sites/all/modules
destination=<path> to override



Specify specific version to download:
●

●

●

Latest dev release:
$ drush dl views dev
List of recent releases:
$ drush dl views select
Specific version:
$ drush dl 7.x3.xdev


29


$ drush en views


Handles module's dependencies by:
●
●

Downloading the required modules
Enabling them


30




Disable a module:
$ drush pmdisable <modulename>



Uninstall a module:
$ drush pmuninstall <modulename>


31

Updating a site


32

updating a site



One of the most tedious task ever ...



Gets a lot easier with drush:
$ drush pmupdate



Core, non-core, modules, security, ...


33

Database management


34

database management



Open a SQL cli, using Drupal's credentials
$ drush sqlcli



Database synchronisation between sites



Run a custom query





$ drush sqlquery “SELECT title from
node where nid=1”
Import SQL statements from a file
$ drush sqlquery –file=example.sql


35

database management



Database backup
$ drush sqldump
–resultfile=dbname.sql –gzip
●
●

Save to a file
Compress the dump


36

database management



Shortcut for accessing variables table:
$ drush variableget clean_url



Write is supported:
$ drush variableset clean_url 0


37

Controlling the cache
and cron


38

controlling the cache and cron



Clear database cache tables
$ drush cc all



Clear a specific cache
views, menu, block, theme-registry, ...
$ drush cc views
●


39

controlling the cache and cron



Run cron
$ drush cron


40

Archiving and restoring site


41

archiving and restoring site



Backup the code, files and database in a
single archive
$ drush archivedump
–taroptions="exclude=.git
–exclude=sites/default/files"


42

archiving and restoring site



Restore an archive
$ drush archiverestore file


43

Drush aliases


44

drush aliases





Run drush commands on other local or
remote Drupal installations
Site aliases:
●
●

@self: current installation
Custom:
•
@dev
•
@staging
•
@prod


45

drush aliases



Shortcut:
$ drush
uri=”camp2013.drushdemo.staging”
root=”/home/manu/dev/drupal/camp
2013/staging/src/drupal” status
becomes:
$ drush @dev status


46

drush aliases
<?php
/**
* Drush aliases definition
*/
$aliases['staging'] = array(
'root' => '/var/www/staging',
'uri' => 'staging.bibliopoly.sfl.net',
'remote-host' =>'staging.bibliopoly.sfl.net',
'remote-user' => 'webmaster',
'path-aliases' => array(
'%files' => 'sites/default/files',
),
);
$aliases['prod'] = array(
'root' => '/var/www/prod',
'uri' => 'live.bibliopoly.sfl.net',
'remote-host' =>'live.bibliopoly.sfl.net',
'remote-user' => 'webmaster',
'path-aliases' => array(
'%files' => 'sites/default/files',
),
);

47

drush aliases

drush status == drush @self status


The simplest example:
$ drush @prod status



More advanced:
$ drush sqlsync @prod @dev
$ drush rsync @staging @prod
$ drush rsync @prod:%files
@staging:%files


48

drush aliases

Documentation:
http://drupalcontrib.org/api/drupal/contribu
tions!drush!examples!example.aliases.drushrc
.php/7


49

Third-party integration


50




3 easy steps to create a custom drush
command:
●

●

●

Create a command file called
COMMANDFILE.drush.inc
Implement the function
COMMANDFILE_drush_command()
Implement the functions that your
command will call


51




Drush searches for commandfiles in the
following location:
●

The “/path/to/drush/command” folder

●

Folders listed in the “include” folder

●

●

●

●

The system-wide drush commands folder, e.g.
/usr/share/drush/commands
The ".drush" folder in the user's HOME folder
/drush and /sites/all/drush in the current Drupal
installation
All enabled modules in the current Drupal installation


52




Complete documentation:
$ drush topic docscommands


53




Custom module integration
●

●

●

Create a file called
MODULENAME.drush.inc in the module
directory
Add the reference in MODULENAME.info
•
files[] = MODULENAME.drush.inc
Implement hook_drush_command()
•
MODULENAME_drush_command()


54




devel_generate module
●



views module
●



Enable, disable, list, revert views, ...

features module
●



Generate content, users, terms, ...

Create, export, revert features, ...

coder_review module
●

Run code reviews


55

Example: deploying a site


56


(1) Put production site in maintenance
(2) Sync files from the staging env to
production
(3) Run any pending database updates on the
production site
(4) Clear the cache on production
(5) Put production site back online

57




The perfect setup:






Continuous-integration server: Jenkins
Source code management: git
A development environment
A staging environment
A production environment


58






Source code changes are pushed from dev
into git repository
Jenkins polls the git repository for new
commits



Jenkins checkout latest revision



Jenkins runs automatic tests



Jenkins deploys latest revision to the staging
environment if tests passed


59


$ drush yes @prod vset maintenance_mode 1
$ drush yes rsync –verbose @staging @prod
$ drush yes @prod updatedb
$ drush @prod clearcache all
$ drush yes @prod vset maintenance_mode 0


60




Code synchronisation:
✗

@prod -> @staging

✔

@staging -> @prod Files synchronisation:
✗



Database
synchronisation:
✗

✔

@prod -> @staging

@staging -> @prod

✔

@staging -> @prod

@prod -> @staging


61

Thank you :-)
And don't forget to get a badge ...


62


63

Gain productivity with Drush (Drupal Camp, Montreal 2013)

Recommended

Recommended

More Related Content

Similar to Gain productivity with Drush (Drupal Camp, Montreal 2013)

Similar to Gain productivity with Drush (Drupal Camp, Montreal 2013) (20)

Recently uploaded

Recently uploaded (20)

Gain productivity with Drush (Drupal Camp, Montreal 2013)