{"action":"closed","number":12992,"pull_request":{"url":"https://api.github.com/repos/apache/spark/pulls/12992","id":69279758,"html_url":"https://github.com/apache/spark/pull/12992","diff_url":"https://github.com/apache/spark/pull/12992.diff","patch_url":"https://github.com/apache/spark/pull/12992.patch","issue_url":"https://api.github.com/repos/apache/spark/issues/12992","number":12992,"state":"closed","locked":false,"title":"[SPARK-15216] [SQL] Add a new Dataset API explainCodegen","user":{"login":"gatorsmile","id":11567269,"avatar_url":"https://avatars.githubusercontent.com/u/11567269?v=3","gravatar_id":"","url":"https://api.github.com/users/gatorsmile","html_url":"https://github.com/gatorsmile","followers_url":"https://api.github.com/users/gatorsmile/followers","following_url":"https://api.github.com/users/gatorsmile/following{/other_user}","gists_url":"https://api.github.com/users/gatorsmile/gists{/gist_id}","starred_url":"https://api.github.com/users/gatorsmile/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gatorsmile/subscriptions","organizations_url":"https://api.github.com/users/gatorsmile/orgs","repos_url":"https://api.github.com/users/gatorsmile/repos","events_url":"https://api.github.com/users/gatorsmile/events{/privacy}","received_events_url":"https://api.github.com/users/gatorsmile/received_events","type":"User","site_admin":false},"body":"#### What changes were proposed in this pull request?\r\nReading codegen output is important for developers to debug. So far, outputting codegen results is available in the SQL interface by `EXPLAIN CODEGEN`. However, in the Dataset/DataFrame APIs, we face the same issue. \r\n\r\nThis PR is to add a new Dataset API `explainCodegen` for achieving the same purpose. \r\n\r\nBTW, I also tried another way, i.e., adding a new boolean parameter into the existing `explain` API. However, if users set both `extended` and `codegen` to `true`, we only output the `codegen` results to the console. Basically, that is not allowed. We need to issue an exception in that case? Or change the behavior? Output both results in this case? Anyway, I am also fine if this is preferred. \r\n\r\n#### How was this patch tested?\r\nSince `explainCodegen` is writing the result to the console, I only do the manual testing in my local environment. For example, the test case:\r\n```scala\r\n  test(\"explainCodegen\") {\r\n    val ds = Seq(\"a\" -> 1, \"a\" -> 3, \"b\" -> 3).toDS().groupByKey(_._1).agg(\r\n      expr(\"avg(_2)\").as[Double],\r\n      ComplexResultAgg.toColumn)\r\n    ds.explainCodegen()\r\n  }\r\n```\r\n","created_at":"2016-05-08T21:09:13Z","updated_at":"2016-05-09T19:54:59Z","closed_at":"2016-05-09T19:54:59Z","merged_at":null,"merge_commit_sha":"24b0ddf6eb0e6e4f559c196b7e03d54f4bf95257","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/apache/spark/pulls/12992/commits","review_comments_url":"https://api.github.com/repos/apache/spark/pulls/12992/comments","review_comment_url":"https://api.github.com/repos/apache/spark/pulls/comments{/number}","comments_url":"https://api.github.com/repos/apache/spark/issues/12992/comments","statuses_url":"https://api.github.com/repos/apache/spark/statuses/f716b106ede5f090c12e261d64ac5fb4ae0af8a4","head":{"label":"gatorsmile:explainCodeGen","ref":"explainCodeGen","sha":"f716b106ede5f090c12e261d64ac5fb4ae0af8a4","user":{"login":"gatorsmile","id":11567269,"avatar_url":"https://avatars.githubusercontent.com/u/11567269?v=3","gravatar_id":"","url":"https://api.github.com/users/gatorsmile","html_url":"https://github.com/gatorsmile","followers_url":"https://api.github.com/users/gatorsmile/followers","following_url":"https://api.github.com/users/gatorsmile/following{/other_user}","gists_url":"https://api.github.com/users/gatorsmile/gists{/gist_id}","starred_url":"https://api.github.com/users/gatorsmile/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gatorsmile/subscriptions","organizations_url":"https://api.github.com/users/gatorsmile/orgs","repos_url":"https://api.github.com/users/gatorsmile/repos","events_url":"https://api.github.com/users/gatorsmile/events{/privacy}","received_events_url":"https://api.github.com/users/gatorsmile/received_events","type":"User","site_admin":false},"repo":{"id":44710950,"name":"spark","full_name":"gatorsmile/spark","owner":{"login":"gatorsmile","id":11567269,"avatar_url":"https://avatars.githubusercontent.com/u/11567269?v=3","gravatar_id":"","url":"https://api.github.com/users/gatorsmile","html_url":"https://github.com/gatorsmile","followers_url":"https://api.github.com/users/gatorsmile/followers","following_url":"https://api.github.com/users/gatorsmile/following{/other_user}","gists_url":"https://api.github.com/users/gatorsmile/gists{/gist_id}","starred_url":"https://api.github.com/users/gatorsmile/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gatorsmile/subscriptions","organizations_url":"https://api.github.com/users/gatorsmile/orgs","repos_url":"https://api.github.com/users/gatorsmile/repos","events_url":"https://api.github.com/users/gatorsmile/events{/privacy}","received_events_url":"https://api.github.com/users/gatorsmile/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/gatorsmile/spark","description":"Mirror of Apache Spark","fork":true,"url":"https://api.github.com/repos/gatorsmile/spark","forks_url":"https://api.github.com/repos/gatorsmile/spark/forks","keys_url":"https://api.github.com/repos/gatorsmile/spark/keys{/key_id}","collaborators_url":"https://api.github.com/repos/gatorsmile/spark/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/gatorsmile/spark/teams","hooks_url":"https://api.github.com/repos/gatorsmile/spark/hooks","issue_events_url":"https://api.github.com/repos/gatorsmile/spark/issues/events{/number}","events_url":"https://api.github.com/repos/gatorsmile/spark/events","assignees_url":"https://api.github.com/repos/gatorsmile/spark/assignees{/user}","branches_url":"https://api.github.com/repos/gatorsmile/spark/branches{/branch}","tags_url":"https://api.github.com/repos/gatorsmile/spark/tags","blobs_url":"https://api.github.com/repos/gatorsmile/spark/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/gatorsmile/spark/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/gatorsmile/spark/git/refs{/sha}","trees_url":"https://api.github.com/repos/gatorsmile/spark/git/trees{/sha}","statuses_url":"https://api.github.com/repos/gatorsmile/spark/statuses/{sha}","languages_url":"https://api.github.com/repos/gatorsmile/spark/languages","stargazers_url":"https://api.github.com/repos/gatorsmile/spark/stargazers","contributors_url":"https://api.github.com/repos/gatorsmile/spark/contributors","subscribers_url":"https://api.github.com/repos/gatorsmile/spark/subscribers","subscription_url":"https://api.github.com/repos/gatorsmile/spark/subscription","commits_url":"https://api.github.com/repos/gatorsmile/spark/commits{/sha}","git_commits_url":"https://api.github.com/repos/gatorsmile/spark/git/commits{/sha}","comments_url":"https://api.github.com/repos/gatorsmile/spark/comments{/number}","issue_comment_url":"https://api.github.com/repos/gatorsmile/spark/issues/comments{/number}","contents_url":"https://api.github.com/repos/gatorsmile/spark/contents/{+path}","compare_url":"https://api.github.com/repos/gatorsmile/spark/compare/{base}...{head}","merges_url":"https://api.github.com/repos/gatorsmile/spark/merges","archive_url":"https://api.github.com/repos/gatorsmile/spark/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/gatorsmile/spark/downloads","issues_url":"https://api.github.com/repos/gatorsmile/spark/issues{/number}","pulls_url":"https://api.github.com/repos/gatorsmile/spark/pulls{/number}","milestones_url":"https://api.github.com/repos/gatorsmile/spark/milestones{/number}","notifications_url":"https://api.github.com/repos/gatorsmile/spark/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/gatorsmile/spark/labels{/name}","releases_url":"https://api.github.com/repos/gatorsmile/spark/releases{/id}","deployments_url":"https://api.github.com/repos/gatorsmile/spark/deployments","created_at":"2015-10-21T23:48:23Z","updated_at":"2015-10-21T23:48:54Z","pushed_at":"2016-05-09T00:50:56Z","git_url":"git://github.com/gatorsmile/spark.git","ssh_url":"git@github.com:gatorsmile/spark.git","clone_url":"https://github.com/gatorsmile/spark.git","svn_url":"https://github.com/gatorsmile/spark","homepage":null,"size":177211,"stargazers_count":0,"watchers_count":0,"language":"Scala","has_issues":false,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"binaryOutput"}},"base":{"label":"apache:master","ref":"master","sha":"454ba4d67e782369627dfe60261e6648a27b91a0","user":{"login":"apache","id":47359,"avatar_url":"https://avatars.githubusercontent.com/u/47359?v=3","gravatar_id":"","url":"https://api.github.com/users/apache","html_url":"https://github.com/apache","followers_url":"https://api.github.com/users/apache/followers","following_url":"https://api.github.com/users/apache/following{/other_user}","gists_url":"https://api.github.com/users/apache/gists{/gist_id}","starred_url":"https://api.github.com/users/apache/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/apache/subscriptions","organizations_url":"https://api.github.com/users/apache/orgs","repos_url":"https://api.github.com/users/apache/repos","events_url":"https://api.github.com/users/apache/events{/privacy}","received_events_url":"https://api.github.com/users/apache/received_events","type":"Organization","site_admin":false},"repo":{"id":17165658,"name":"spark","full_name":"apache/spark","owner":{"login":"apache","id":47359,"avatar_url":"https://avatars.githubusercontent.com/u/47359?v=3","gravatar_id":"","url":"https://api.github.com/users/apache","html_url":"https://github.com/apache","followers_url":"https://api.github.com/users/apache/followers","following_url":"https://api.github.com/users/apache/following{/other_user}","gists_url":"https://api.github.com/users/apache/gists{/gist_id}","starred_url":"https://api.github.com/users/apache/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/apache/subscriptions","organizations_url":"https://api.github.com/users/apache/orgs","repos_url":"https://api.github.com/users/apache/repos","events_url":"https://api.github.com/users/apache/events{/privacy}","received_events_url":"https://api.github.com/users/apache/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/apache/spark","description":"Mirror of Apache Spark","fork":false,"url":"https://api.github.com/repos/apache/spark","forks_url":"https://api.github.com/repos/apache/spark/forks","keys_url":"https://api.github.com/repos/apache/spark/keys{/key_id}","collaborators_url":"https://api.github.com/repos/apache/spark/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/apache/spark/teams","hooks_url":"https://api.github.com/repos/apache/spark/hooks","issue_events_url":"https://api.github.com/repos/apache/spark/issues/events{/number}","events_url":"https://api.github.com/repos/apache/spark/events","assignees_url":"https://api.github.com/repos/apache/spark/assignees{/user}","branches_url":"https://api.github.com/repos/apache/spark/branches{/branch}","tags_url":"https://api.github.com/repos/apache/spark/tags","blobs_url":"https://api.github.com/repos/apache/spark/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/apache/spark/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/apache/spark/git/refs{/sha}","trees_url":"https://api.github.com/repos/apache/spark/git/trees{/sha}","statuses_url":"https://api.github.com/repos/apache/spark/statuses/{sha}","languages_url":"https://api.github.com/repos/apache/spark/languages","stargazers_url":"https://api.github.com/repos/apache/spark/stargazers","contributors_url":"https://api.github.com/repos/apache/spark/contributors","subscribers_url":"https://api.github.com/repos/apache/spark/subscribers","subscription_url":"https://api.github.com/repos/apache/spark/subscription","commits_url":"https://api.github.com/repos/apache/spark/commits{/sha}","git_commits_url":"https://api.github.com/repos/apache/spark/git/commits{/sha}","comments_url":"https://api.github.com/repos/apache/spark/comments{/number}","issue_comment_url":"https://api.github.com/repos/apache/spark/issues/comments{/number}","contents_url":"https://api.github.com/repos/apache/spark/contents/{+path}","compare_url":"https://api.github.com/repos/apache/spark/compare/{base}...{head}","merges_url":"https://api.github.com/repos/apache/spark/merges","archive_url":"https://api.github.com/repos/apache/spark/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/apache/spark/downloads","issues_url":"https://api.github.com/repos/apache/spark/issues{/number}","pulls_url":"https://api.github.com/repos/apache/spark/pulls{/number}","milestones_url":"https://api.github.com/repos/apache/spark/milestones{/number}","notifications_url":"https://api.github.com/repos/apache/spark/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/apache/spark/labels{/name}","releases_url":"https://api.github.com/repos/apache/spark/releases{/id}","deployments_url":"https://api.github.com/repos/apache/spark/deployments","created_at":"2014-02-25T08:00:08Z","updated_at":"2016-05-09T19:16:29Z","pushed_at":"2016-05-09T19:54:21Z","git_url":"git://github.com/apache/spark.git","ssh_url":"git@github.com:apache/spark.git","clone_url":"https://github.com/apache/spark.git","svn_url":"https://github.com/apache/spark","homepage":null,"size":490295,"stargazers_count":8444,"watchers_count":8444,"language":"Scala","has_issues":false,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":7837,"mirror_url":"git://git.apache.org/spark.git","open_issues_count":439,"forks":7837,"open_issues":439,"watchers":8444,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/apache/spark/pulls/12992"},"html":{"href":"https://github.com/apache/spark/pull/12992"},"issue":{"href":"https://api.github.com/repos/apache/spark/issues/12992"},"comments":{"href":"https://api.github.com/repos/apache/spark/issues/12992/comments"},"review_comments":{"href":"https://api.github.com/repos/apache/spark/pulls/12992/comments"},"review_comment":{"href":"https://api.github.com/repos/apache/spark/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/apache/spark/pulls/12992/commits"},"statuses":{"href":"https://api.github.com/repos/apache/spark/statuses/f716b106ede5f090c12e261d64ac5fb4ae0af8a4"}},"merged":false,"mergeable":true,"mergeable_state":"clean","merged_by":null,"comments":6,"review_comments":0,"commits":1,"additions":15,"deletions":0,"changed_files":1}}