Add --filter to many commands #3718

greg-1-anderson · 2018-10-04T04:33:39Z

$ drush9 pml --filter='id=bartik' 
 --------- ----------------- --------- --------- 
  Package   Name              Status    Version  
 --------- ----------------- --------- --------- 
  Core      Bartik (bartik)   Enabled   8.5.3    
 --------- ----------------- --------- ---------

Just one field:

$ drush9 pml --filter='id=bartik' --field=status
Enabled

greg-1-anderson · 2018-10-04T04:44:34Z

It might be possible to make the @filter-output implicit based on the return type of the command; however, if we did this, then there should be some other annotation to turn off the filter. If a command is already filtering the output rows, then it would be inefficient to pass it through the generic filter as well.

I don't think it would be too bad to have to add the annotation to commands that need it.

greg-1-anderson · 2018-10-04T13:09:54Z

I updated the documentation for filter-via-dot-access-data to illustrate how "contains" and "regex" searches are done.

… roll commands a bit (not perfect yet).

… complex expression now.

greg-1-anderson · 2018-10-04T20:06:12Z

The role:list command already took a --filter parameter that had different conventions than the filter added by this PR. To compensate, I added a feature to consolidation/filter-via-dot-access-data that allows role:list to specify that the default field to filter by is "perms". If someone uses --filter=value without providing a filter operator, then "perms contains value" is the operation that is performed. This allows both:

drush role:list --filter='edit terms in tags'
drush role:list --filter='perms*=edit terms in tags'
drush role:list --filter='id=editor'

…best guess; perhaps we should not define a default field unless the use-case for it is clear.

weitzman · 2018-10-05T04:23:25Z

docs/output-filters.md

@@ -0,0 +1,36 @@
+Output Filters


Thanks for writing this ... I have two thoughts. I don't know how to handle them though.

Output filters sounds a lot like output formats which is a related but different concept. Everyone is going to mix them up.

Might be worth saying how this feature differs from grep and when to use each.

src/Commands/core/UpdateDBCommands.php

…t-filter

greg-1-anderson · 2018-10-06T04:49:24Z

Output filters sounds a lot like output formats which is a related but different concept. Everyone is going to mix them up.

I resolved this by making one topic on adjusting command output. It covers output formats, output fields and output filters together. Since all of these options are related to the same concept, it should be clear if folks can read about them together.

Might be worth saying how this feature differs from grep and when to use each.

Haven't worked this in yet.

Output filters are like grep, but they match only the data within specific named fields. This makes it easier to avoid false matches.
Filters are also applied before data is formatted, so you don't need to worry about missing out on rows that should have matched, but that were missed because the matching data was word-wrapped.
Use grep directly if you need to match based on data that spans columns.

Something akin to that could go in the introduction, or maybe at the top of the "output filters" section.

…ation is present.

weitzman

I think the option help text --filter[=FILTER] Filter output based on provided expression would benefit from an example. It could be a generic example --filter=<fieldname>=foo or customized for that command <display_name*=Ctools>.

That brings up a question do the = and *= operators perform case insensitive comparisons? I think I would prefer that.

Also, I think the value is required for all these options, not just --field:

--format[=FORMAT]
--field=FIELD
--filter[=FILTER]

weitzman · 2018-10-06T11:24:54Z

src/Commands/generate/Generators/Drush/default-methods.twig

@@ -31,6 +31,7 @@
   * @command {{  machine_name }}:token
   * @aliases token
   *
+   * @filter-output


should declare a default field instead

How do we pick which field is the default field? Assume id and let the user change it?

In this case I would go with “name”. This is just an example method. It’s not dynamically adjusted or anything.

weitzman · 2018-10-06T11:42:54Z

docs/output-formats-filters.md

+glossary
+```
+
+Output Filters


I'm thinking that this topic should be offerred automatically in help for any command that shows the --fields option.

…d that defines field labels or filters.

greg-1-anderson · 2018-10-07T01:18:42Z

The = and *= are always case-insensitive. ~= is case-insensitive if you tack an i on at the end of the regex, e.g. foo~=#expr#i

Regarding --filter[=FILTER], it seems that the annotated command does not offer a good way to stipulate options with required values via annotations. We must fix add that to the library before we can enhance here.

…nsensitive.

greg-1-anderson · 2018-10-07T01:51:23Z

I think I've done about as much as I intend to do here for now. I recommend that we first release Drush 9.5.0, and then merge this PR to the master branch so that folks can try it out in the dev release for a while before calling it stable.

weitzman · 2018-10-06T21:42:12Z

src/Commands/generate/Generators/Drush/default-methods.twig

@@ -31,6 +31,7 @@
   * @command {{  machine_name }}:token
   * @aliases token
   *
+   * @filter-output


In this case I would go with “name”. This is just an example method. It’s not dynamically adjusted or anything.

weitzman · 2018-10-15T13:50:27Z

src/Commands/core/UpdateDBCommands.php

@@ -112,6 +112,7 @@ public function entityUpdates($options = ['cache-clear' => true])
     *   description: Description
     *   type: Type
     * @default-fields module,update_id,type,description
+     * @filter-default-field module


I think 'type' would be a better default field here.

greg-1-anderson · 2018-10-15T16:26:22Z

Before I merge here, I need to add an example to the --fields help for unstructured data, and I also need to make a stable release of the output-formatters project. The later is ready save only for the addition of another example or two in the documentation for the new features.

…. Fine-tune a couple default fields for the filter option.

greg-1-anderson · 2018-10-16T01:25:56Z

This should be ready to go after tests pass.

Add --filter to pm:list

5b35ff4

greg-1-anderson mentioned this pull request Oct 4, 2018

Restore deprecated pm:info command, or create a new command to quickly show information specific to a module #3717

Closed

Add filter-output to more commands

5dc6984

greg-1-anderson added 3 commits October 4, 2018 11:46

Add filter-output to example command and generated commands. Clean up…

db64208

… roll commands a bit (not perfect yet).

Turn off validation for 'filter' in RoleCommands, since it might be a…

0502032

… complex expression now.

Don't bother to install all of our dependencies; just install phpcs

0da8fb5

greg-1-anderson added 3 commits October 4, 2018 17:08

Add filter default fields for other filterable commands. These are a …

5f7d975

…best guess; perhaps we should not define a default field unless the use-case for it is clear.

Add a topic for output filters.

1c5f908

Merge branch 'master' into output-filter

6e3c273

weitzman reviewed Oct 5, 2018

View reviewed changes

greg-1-anderson added 2 commits October 5, 2018 21:42

Make a combined topic about output formats, fields and filters.

40774ad

Merge branch 'output-filter' of github.com:drush-ops/drush into outpu…

b5c0345

…t-filter

Make @filter-output annotaton implicit if @filter-default-field annot…

1bc647c

…ation is present.

weitzman approved these changes Oct 6, 2018

View reviewed changes

Automatically add '@topics docs:output-formats-filters' to any comman…

93283ad

…d that defines field labels or filters.

greg-1-anderson added 2 commits October 6, 2018 18:23

[ci skip] Clarify the filter comparison operators = and *= are case-i…

25e92dc

…nsensitive.

[ci skip] Add a comparison between filters and grep in the output topic.

0096318

Allow the 'site:alias' command to have selectable fields.

6bf87e1

greg-1-anderson mentioned this pull request Oct 12, 2018

Unstructured data fields #3724

Closed

weitzman mentioned this pull request Oct 15, 2018

drush entup --no-cache-clear is clearing cache #3586

Closed

weitzman approved these changes Oct 15, 2018

View reviewed changes

weitzman changed the title ~~Add --filter to pm:list~~ Add --filter to many commands Oct 15, 2018

Update scenarios

9dcf533

Use stable release of output-formatters with unstuctured data support…

86d9967

…. Fine-tune a couple default fields for the filter option.

greg-1-anderson force-pushed the output-filter branch from 2f29ac5 to 86d9967 Compare October 16, 2018 01:24

Merge branch 'master' into output-filter

9004ed9

greg-1-anderson merged commit 3e4d5ae into master Oct 16, 2018

weitzman deleted the output-filter branch December 13, 2019 15:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add --filter to many commands #3718

Add --filter to many commands #3718

greg-1-anderson commented Oct 4, 2018 •

edited

greg-1-anderson commented Oct 4, 2018

greg-1-anderson commented Oct 4, 2018

greg-1-anderson commented Oct 4, 2018

weitzman Oct 5, 2018

greg-1-anderson commented Oct 6, 2018

weitzman left a comment •

edited

weitzman Oct 6, 2018

greg-1-anderson Oct 6, 2018

weitzman Oct 6, 2018

weitzman Oct 6, 2018

greg-1-anderson Oct 7, 2018

greg-1-anderson commented Oct 7, 2018

greg-1-anderson commented Oct 7, 2018

weitzman Oct 6, 2018

weitzman Oct 15, 2018

greg-1-anderson commented Oct 15, 2018

greg-1-anderson commented Oct 16, 2018

Add --filter to many commands #3718

Add --filter to many commands #3718

Conversation

greg-1-anderson commented Oct 4, 2018 • edited

greg-1-anderson commented Oct 4, 2018

greg-1-anderson commented Oct 4, 2018

greg-1-anderson commented Oct 4, 2018

Choose a reason for hiding this comment

greg-1-anderson commented Oct 6, 2018

weitzman left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

greg-1-anderson commented Oct 7, 2018

greg-1-anderson commented Oct 7, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

greg-1-anderson commented Oct 15, 2018

greg-1-anderson commented Oct 16, 2018

greg-1-anderson commented Oct 4, 2018 •

edited

weitzman left a comment •

edited