[
https://issues.apache.org/jira/browse/AIRFLOW-5731?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16958450#comment-16958450
]
ASF GitHub Bot commented on AIRFLOW-5731:
-----------------------------------------
sekikn commented on pull request #6400: [AIRFLOW-5731] Make output format from
list commands configurable
URL: https://github.com/apache/airflow/pull/6400
Make sure you have checked _all_ steps below.
### Jira
- [x] My PR addresses the following [Airflow
Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references
them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- https://issues.apache.org/jira/browse/AIRFLOW-5731
- In case you are fixing a typo in the documentation you can prepend your
commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
- In case you are proposing a fundamental code change, you need to create
an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
- In case you are adding a dependency, check if the license complies with
the [ASF 3rd Party License
Policy](https://www.apache.org/legal/resolved.html#category-x).
### Description
- [x] Here are some details about my PR, including screenshots of any UI
changes:
Currently, list commands such as `airflow connections list` and `airflow
users list` display prettily formatted tables, but they are not so suitable for
parsing and processing. With this PR, users can get easier-to-parse output, as
follows:
```
$ airflow connections list --tablefmt=simple 2>/dev/null | head
Conn Id Conn Type Host
Port Is Encrypted Is Extra Encrypted Extra
------------------------------ ---------------------------
------------------------- ------ -------------- --------------------
------------------------------
'airflow_db' 'mysql' 'mysql'
None False False None
'local_mysql' 'mysql' 'localhost'
None True False None
'presto_default' 'presto' 'localhost'
3400 False False None
'google_cloud_default' 'google_cloud_platform' None
None False False None
'hive_cli_default' 'hive_cli' 'localhost'
10000 False True
'gAAAAABdrxCP...jMAQ6LknDM8pc'
'pig_cli_default' 'pig_cli' None
None False False None
'hiveserver2_default' 'hiveserver2' 'localhost'
10000 False False None
'metastore_default' 'hive_metastore' 'localhost'
9083 False True
'gAAAAABdrxCP...ABWevIJL-Dto='
$ airflow connections list --tablefmt=tsv 2>/dev/null | head
Conn Id Conn Type Host
Port Is Encrypted Is Extra Encrypted Extra
'airflow_db' 'mysql' 'mysql'
None False False None
'local_mysql' 'mysql'
'localhost' None True False
None
'presto_default' 'presto'
'localhost' 3400 False False
None
'google_cloud_default' 'google_cloud_platform' None
None False False None
'hive_cli_default' 'hive_cli'
'localhost' 10000 False True
'gAAAAABdrxCP...jMAQ6LknDM8pc'
'pig_cli_default' 'pig_cli' None
None False False None
'hiveserver2_default' 'hiveserver2'
'localhost' 10000 False False
None
'metastore_default' 'hive_metastore'
'localhost' 9083 False True
'gAAAAABdrxCP...ABWevIJL-Dto='
'mongo_default' 'mongo' 'mongo'
27017 False False None
```
### Tests
- [x] My PR adds the following unit tests __OR__ does not need testing for
this extremely good reason:
test_cli_list_users_with_args
test_cli_list_roles_with_args
test_cli_list_jobs_with_args (added arguments to the existing test)
test_cli_connections_list_with_args
test_pool_list
test_pool_list_with_args
### Commits
- [x] My commits all reference Jira issues in their subject lines, and I
have squashed multiple commits if they address the same issue. In addition, my
commits follow the guidelines from "[How to write a good git commit
message](http://chris.beams.io/posts/git-commit/)":
1. Subject is separated from body by a blank line
1. Subject is limited to 50 characters (not including Jira issue reference)
1. Subject does not end with a period
1. Subject uses the imperative mood ("add", not "adding")
1. Body wraps at 72 characters
1. Body explains "what" and "why", not "how"
### Documentation
- [x] In case of new functionality, my PR adds documentation that describes
how to use it.
- All the public functions and the classes in the PR contain docstrings
that explain what it does
- If you implement backwards incompatible changes, please leave a note in
the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so
we can assign it to a appropriate release
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
> Make output format from list commands configurable
> --------------------------------------------------
>
> Key: AIRFLOW-5731
> URL: https://issues.apache.org/jira/browse/AIRFLOW-5731
> Project: Apache Airflow
> Issue Type: Improvement
> Components: cli
> Affects Versions: 1.10.5
> Reporter: Kengo Seki
> Assignee: Kengo Seki
> Priority: Major
>
> Currently, list commands such as {{airflow connections list}} and {{airflow
> users list}} display prettily formatted tables, but they are not so suitable
> for parsing and processing. It'd be useful if users can specify output
> format, e.g. csv or tsv.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
