sql:query¶
Execute a query against a database.
Table names in {braces} are prefixed with the connection's prefix. Rows print tab-separated without a header, as the database clients do in silent mode; --format=json or yaml prints them as records. The query is one statement; to run a file of SQL, use $(dr sql:connect) < example.sql.
Examples¶
sql:query "SELECT * FROM {users} WHERE uid = 1"sql:query "SELECT uid, name FROM {users}" --format=jsonsql:query $(dr sql:connect) < example.sqlsql:query dr php:eval --format=json "return \Drupal::service('database')->query('SELECT * FROM users LIMIT 5')->fetchAll()"
Arguments¶
- query. An SQL statement.
Options¶
- --result-file=RESULT-FILE. Save the result to a file instead of printing it.
- --format=FORMAT. Print the rows as json or yaml. [possible values: yaml, json]
- --database=DATABASE. The DB connection key if using multiple connections in settings.php. [default: default]
- --target=TARGET. The name of a target within the specified database connection. [default: default]
- --db-url=DB-URL. A database URL such as mysql://root:pass@localhost:3306/dbname, used instead of the site's settings.
Global Options¶
- -h, --help. Display help for the given command. When no command is given display help for the list command
- --silent. Do not output any message
- -q, --quiet. Only errors are displayed. All other output is suppressed
- -v|vv|vvv, --verbose. Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
- -V, --version. Display this application version
- --ansi. Force (or disable --no-ansi) ANSI output
- --no-ansi. Negate the --ansi option.
- -n, --no-interaction. Do not ask any interactive question
- --url=URL. A base URL (e.g. example.com). Used for building links, selecting a multi-site, etc.
- -e, --env=ENV. The Environment name. [default: prod]
- --no-debug. Switches off debug mode.
Aliases¶
- sqlq
- sql-query
Legend
- An argument or option with square brackets is optional.
- Any default value is listed at end of arg/option description.
- An ellipsis indicates that an argument accepts multiple values separated by a space.