Skip to content

Enable all options in example.drush.yml and make sql:dump work #6383

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: 13.x
Choose a base branch
from
Open

Enable all options in example.drush.yml and make sql:dump work #6383

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
94ed856
Streamline example.drush.yml, enable all options
gitressa Oct 4, 2025
d67d393
Add user:login options in Using Drush as well
gitressa Oct 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions docs/using-drush-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ drush:
```yml
options:
# Specify the base_url that should be used when generating links.
uri: 'http://example.com/subdir'
uri: 'https://example.com/subdir'

# Load Drush config from a non-standard location
config: '/home/USER/workspace/drupal'
Expand All @@ -104,6 +104,13 @@ options:
#### Command-specific options
```yml
command:
# Disabling the admin super user account (uid #1) is recommended.
# Use this to specify another admin account for the uli command.
# See https://www.drupal.org/docs/administering-a-drupal-site/security-in-drupal/securing-the-admin-super-user-1
user:
login:
options:
name: newadmin
sql:
cli:
options:
Expand All @@ -123,7 +130,6 @@ command:
options:
# Ensure all rsync commands use verbose output.
verbose: true

site:
install:
options:
Expand Down
18 changes: 14 additions & 4 deletions examples/example.drush.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ drush:
# Global options.
options:
# Specify the base_url that should be used when generating links.
# uri: 'http://example.com/subdir'
uri: 'https://example.com/subdir'

# Command-specific options.
command:
Expand All @@ -29,14 +29,24 @@ command:
user:
login:
options:
name: newadminuser
name: newadmin
sql:
dump:
options:
# Uncomment to omit cache and similar tables (including during a sql:sync).
# structure-tables-key: common
# Omit cache and similar tables (including during a sql:sync).
# Define tables to exclude under sql section.
structure-tables-key: common

# Non-options.
sql:
# List of tables whose *data* is skipped by the 'sql:dump' and 'sql:sync'
# commands when the "--structure-tables-key=common" option is provided.
structure-tables:
common:
- cache
- 'cache_*'
- 'watchdog'

ssh:
# Specify options to pass to ssh. The default is to prohibit
# password authentication, and is included here, so you may add additional
Expand Down