{"action":"created","comment":{"url":"https://api.github.com/repos/tikv/rfcs/pulls/comments/233550656","pull_request_review_id":174991858,"id":233550656,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDIzMzU1MDY1Ng==","diff_hunk":"@@ -0,0 +1,93 @@\n+# Summary\n+\n+This RFC proposes a new unified and human readable format for keys. All TiDB software stack\n+components (e.g. TiDB, TiKV, pd-ctl, tikv-ctl, ...) *must* follow this new format when printing out\n+keys and accepting keys from user input like command line parameters.\n+\n+# Motivation\n+\n+Currently we have multiple human readable formats for keys:\n+\n+- Hex format, like `74000000000000001C5F7200000000000000FA`\n+\n+- Protobuffer format, like `t\\000\\000\\000\\000\\000\\000\\000\\034_r\\000\\000\\000\\000\\000\\000\\000\\372`\n+\n+- Go format, like `t\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x1c_r\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\xfa`\n+\n+Defects:\n+\n+- Bad interoperability: These different formats are pain points when working with different tools\n+  together. For example, pd-ctl produces keys in Go format while tikv-ctl accepts keys in\n+  Protobuffer format.\n+\n+- Hard to implement: Actually there are some attempts to support different kind of formats, like\n+  https://github.com/tikv/tikv/pull/3182 and https://github.com/pingcap/pd/pull/474. However it\n+  turns out that these implementations won't work in real world scenario. For example, it is\n+  not sufficient to decode the Golang format by only dealing with hex escapes `\\x..` [\\[1\\]][1]","path":"text/2018-11-12-unified-key-format.md","position":26,"original_position":26,"commit_id":"5562849f400ee582261235517905354559c9382a","original_commit_id":"5562849f400ee582261235517905354559c9382a","user":{"login":"Hoverbear","id":130903,"node_id":"MDQ6VXNlcjEzMDkwMw==","avatar_url":"https://avatars3.githubusercontent.com/u/130903?v=4","gravatar_id":"","url":"https://api.github.com/users/Hoverbear","html_url":"https://github.com/Hoverbear","followers_url":"https://api.github.com/users/Hoverbear/followers","following_url":"https://api.github.com/users/Hoverbear/following{/other_user}","gists_url":"https://api.github.com/users/Hoverbear/gists{/gist_id}","starred_url":"https://api.github.com/users/Hoverbear/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Hoverbear/subscriptions","organizations_url":"https://api.github.com/users/Hoverbear/orgs","repos_url":"https://api.github.com/users/Hoverbear/repos","events_url":"https://api.github.com/users/Hoverbear/events{/privacy}","received_events_url":"https://api.github.com/users/Hoverbear/received_events","type":"User","site_admin":false},"body":"I actually realized later this was a reference link and forgot to delete it. Thanks for pointing it out. :)","created_at":"2018-11-14T17:44:44Z","updated_at":"2018-11-14T17:44:44Z","html_url":"https://github.com/tikv/rfcs/pull/12#discussion_r233550656","pull_request_url":"https://api.github.com/repos/tikv/rfcs/pulls/12","author_association":"MEMBER","_links":{"self":{"href":"https://api.github.com/repos/tikv/rfcs/pulls/comments/233550656"},"html":{"href":"https://github.com/tikv/rfcs/pull/12#discussion_r233550656"},"pull_request":{"href":"https://api.github.com/repos/tikv/rfcs/pulls/12"}},"in_reply_to_id":233508665},"pull_request":{"url":"https://api.github.com/repos/tikv/rfcs/pulls/12","id":230110768,"node_id":"MDExOlB1bGxSZXF1ZXN0MjMwMTEwNzY4","html_url":"https://github.com/tikv/rfcs/pull/12","diff_url":"https://github.com/tikv/rfcs/pull/12.diff","patch_url":"https://github.com/tikv/rfcs/pull/12.patch","issue_url":"https://api.github.com/repos/tikv/rfcs/issues/12","number":12,"state":"open","locked":false,"title":"Unified Key Format","user":{"login":"breeswish","id":1916485,"node_id":"MDQ6VXNlcjE5MTY0ODU=","avatar_url":"https://avatars3.githubusercontent.com/u/1916485?v=4","gravatar_id":"","url":"https://api.github.com/users/breeswish","html_url":"https://github.com/breeswish","followers_url":"https://api.github.com/users/breeswish/followers","following_url":"https://api.github.com/users/breeswish/following{/other_user}","gists_url":"https://api.github.com/users/breeswish/gists{/gist_id}","starred_url":"https://api.github.com/users/breeswish/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/breeswish/subscriptions","organizations_url":"https://api.github.com/users/breeswish/orgs","repos_url":"https://api.github.com/users/breeswish/repos","events_url":"https://api.github.com/users/breeswish/events{/privacy}","received_events_url":"https://api.github.com/users/breeswish/received_events","type":"User","site_admin":false},"body":"RFC for a unified key format.","created_at":"2018-11-12T12:00:39Z","updated_at":"2018-11-14T17:44:44Z","closed_at":null,"merged_at":null,"merge_commit_sha":"5f92f860ef2e5e7f11eb9a0cc04fc3a34c30bad7","assignee":{"login":"breeswish","id":1916485,"node_id":"MDQ6VXNlcjE5MTY0ODU=","avatar_url":"https://avatars3.githubusercontent.com/u/1916485?v=4","gravatar_id":"","url":"https://api.github.com/users/breeswish","html_url":"https://github.com/breeswish","followers_url":"https://api.github.com/users/breeswish/followers","following_url":"https://api.github.com/users/breeswish/following{/other_user}","gists_url":"https://api.github.com/users/breeswish/gists{/gist_id}","starred_url":"https://api.github.com/users/breeswish/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/breeswish/subscriptions","organizations_url":"https://api.github.com/users/breeswish/orgs","repos_url":"https://api.github.com/users/breeswish/repos","events_url":"https://api.github.com/users/breeswish/events{/privacy}","received_events_url":"https://api.github.com/users/breeswish/received_events","type":"User","site_admin":false},"assignees":[{"login":"breeswish","id":1916485,"node_id":"MDQ6VXNlcjE5MTY0ODU=","avatar_url":"https://avatars3.githubusercontent.com/u/1916485?v=4","gravatar_id":"","url":"https://api.github.com/users/breeswish","html_url":"https://github.com/breeswish","followers_url":"https://api.github.com/users/breeswish/followers","following_url":"https://api.github.com/users/breeswish/following{/other_user}","gists_url":"https://api.github.com/users/breeswish/gists{/gist_id}","starred_url":"https://api.github.com/users/breeswish/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/breeswish/subscriptions","organizations_url":"https://api.github.com/users/breeswish/orgs","repos_url":"https://api.github.com/users/breeswish/repos","events_url":"https://api.github.com/users/breeswish/events{/privacy}","received_events_url":"https://api.github.com/users/breeswish/received_events","type":"User","site_admin":false}],"requested_reviewers":[],"requested_teams":[],"labels":[{"id":1127577606,"node_id":"MDU6TGFiZWwxMTI3NTc3NjA2","url":"https://api.github.com/repos/tikv/rfcs/labels/Initial%20Comment%20Period","name":"Initial Comment Period","color":"5319e7","default":false}],"milestone":null,"commits_url":"https://api.github.com/repos/tikv/rfcs/pulls/12/commits","review_comments_url":"https://api.github.com/repos/tikv/rfcs/pulls/12/comments","review_comment_url":"https://api.github.com/repos/tikv/rfcs/pulls/comments{/number}","comments_url":"https://api.github.com/repos/tikv/rfcs/issues/12/comments","statuses_url":"https://api.github.com/repos/tikv/rfcs/statuses/5562849f400ee582261235517905354559c9382a","head":{"label":"tikv:unified-key-format","ref":"unified-key-format","sha":"5562849f400ee582261235517905354559c9382a","user":{"login":"tikv","id":41004122,"node_id":"MDEyOk9yZ2FuaXphdGlvbjQxMDA0MTIy","avatar_url":"https://avatars2.githubusercontent.com/u/41004122?v=4","gravatar_id":"","url":"https://api.github.com/users/tikv","html_url":"https://github.com/tikv","followers_url":"https://api.github.com/users/tikv/followers","following_url":"https://api.github.com/users/tikv/following{/other_user}","gists_url":"https://api.github.com/users/tikv/gists{/gist_id}","starred_url":"https://api.github.com/users/tikv/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tikv/subscriptions","organizations_url":"https://api.github.com/users/tikv/orgs","repos_url":"https://api.github.com/users/tikv/repos","events_url":"https://api.github.com/users/tikv/events{/privacy}","received_events_url":"https://api.github.com/users/tikv/received_events","type":"Organization","site_admin":false},"repo":{"id":145156191,"node_id":"MDEwOlJlcG9zaXRvcnkxNDUxNTYxOTE=","name":"rfcs","full_name":"tikv/rfcs","private":false,"owner":{"login":"tikv","id":41004122,"node_id":"MDEyOk9yZ2FuaXphdGlvbjQxMDA0MTIy","avatar_url":"https://avatars2.githubusercontent.com/u/41004122?v=4","gravatar_id":"","url":"https://api.github.com/users/tikv","html_url":"https://github.com/tikv","followers_url":"https://api.github.com/users/tikv/followers","following_url":"https://api.github.com/users/tikv/following{/other_user}","gists_url":"https://api.github.com/users/tikv/gists{/gist_id}","starred_url":"https://api.github.com/users/tikv/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tikv/subscriptions","organizations_url":"https://api.github.com/users/tikv/orgs","repos_url":"https://api.github.com/users/tikv/repos","events_url":"https://api.github.com/users/tikv/events{/privacy}","received_events_url":"https://api.github.com/users/tikv/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/tikv/rfcs","description":"RFCs for changes to TiKV and its ecosystem","fork":false,"url":"https://api.github.com/repos/tikv/rfcs","forks_url":"https://api.github.com/repos/tikv/rfcs/forks","keys_url":"https://api.github.com/repos/tikv/rfcs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/tikv/rfcs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/tikv/rfcs/teams","hooks_url":"https://api.github.com/repos/tikv/rfcs/hooks","issue_events_url":"https://api.github.com/repos/tikv/rfcs/issues/events{/number}","events_url":"https://api.github.com/repos/tikv/rfcs/events","assignees_url":"https://api.github.com/repos/tikv/rfcs/assignees{/user}","branches_url":"https://api.github.com/repos/tikv/rfcs/branches{/branch}","tags_url":"https://api.github.com/repos/tikv/rfcs/tags","blobs_url":"https://api.github.com/repos/tikv/rfcs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/tikv/rfcs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/tikv/rfcs/git/refs{/sha}","trees_url":"https://api.github.com/repos/tikv/rfcs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/tikv/rfcs/statuses/{sha}","languages_url":"https://api.github.com/repos/tikv/rfcs/languages","stargazers_url":"https://api.github.com/repos/tikv/rfcs/stargazers","contributors_url":"https://api.github.com/repos/tikv/rfcs/contributors","subscribers_url":"https://api.github.com/repos/tikv/rfcs/subscribers","subscription_url":"https://api.github.com/repos/tikv/rfcs/subscription","commits_url":"https://api.github.com/repos/tikv/rfcs/commits{/sha}","git_commits_url":"https://api.github.com/repos/tikv/rfcs/git/commits{/sha}","comments_url":"https://api.github.com/repos/tikv/rfcs/comments{/number}","issue_comment_url":"https://api.github.com/repos/tikv/rfcs/issues/comments{/number}","contents_url":"https://api.github.com/repos/tikv/rfcs/contents/{+path}","compare_url":"https://api.github.com/repos/tikv/rfcs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/tikv/rfcs/merges","archive_url":"https://api.github.com/repos/tikv/rfcs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/tikv/rfcs/downloads","issues_url":"https://api.github.com/repos/tikv/rfcs/issues{/number}","pulls_url":"https://api.github.com/repos/tikv/rfcs/pulls{/number}","milestones_url":"https://api.github.com/repos/tikv/rfcs/milestones{/number}","notifications_url":"https://api.github.com/repos/tikv/rfcs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/tikv/rfcs/labels{/name}","releases_url":"https://api.github.com/repos/tikv/rfcs/releases{/id}","deployments_url":"https://api.github.com/repos/tikv/rfcs/deployments","created_at":"2018-08-17T18:55:29Z","updated_at":"2018-11-14T09:21:27Z","pushed_at":"2018-11-14T12:10:32Z","git_url":"git://github.com/tikv/rfcs.git","ssh_url":"git@github.com:tikv/rfcs.git","clone_url":"https://github.com/tikv/rfcs.git","svn_url":"https://github.com/tikv/rfcs","homepage":"","size":30,"stargazers_count":4,"watchers_count":4,"language":null,"has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":6,"mirror_url":null,"archived":false,"open_issues_count":7,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0","node_id":"MDc6TGljZW5zZTI="},"forks":6,"open_issues":7,"watchers":4,"default_branch":"master"}},"base":{"label":"tikv:master","ref":"master","sha":"b8de55bb7517ed040bddff0abc96b3f57499d3b6","user":{"login":"tikv","id":41004122,"node_id":"MDEyOk9yZ2FuaXphdGlvbjQxMDA0MTIy","avatar_url":"https://avatars2.githubusercontent.com/u/41004122?v=4","gravatar_id":"","url":"https://api.github.com/users/tikv","html_url":"https://github.com/tikv","followers_url":"https://api.github.com/users/tikv/followers","following_url":"https://api.github.com/users/tikv/following{/other_user}","gists_url":"https://api.github.com/users/tikv/gists{/gist_id}","starred_url":"https://api.github.com/users/tikv/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tikv/subscriptions","organizations_url":"https://api.github.com/users/tikv/orgs","repos_url":"https://api.github.com/users/tikv/repos","events_url":"https://api.github.com/users/tikv/events{/privacy}","received_events_url":"https://api.github.com/users/tikv/received_events","type":"Organization","site_admin":false},"repo":{"id":145156191,"node_id":"MDEwOlJlcG9zaXRvcnkxNDUxNTYxOTE=","name":"rfcs","full_name":"tikv/rfcs","private":false,"owner":{"login":"tikv","id":41004122,"node_id":"MDEyOk9yZ2FuaXphdGlvbjQxMDA0MTIy","avatar_url":"https://avatars2.githubusercontent.com/u/41004122?v=4","gravatar_id":"","url":"https://api.github.com/users/tikv","html_url":"https://github.com/tikv","followers_url":"https://api.github.com/users/tikv/followers","following_url":"https://api.github.com/users/tikv/following{/other_user}","gists_url":"https://api.github.com/users/tikv/gists{/gist_id}","starred_url":"https://api.github.com/users/tikv/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tikv/subscriptions","organizations_url":"https://api.github.com/users/tikv/orgs","repos_url":"https://api.github.com/users/tikv/repos","events_url":"https://api.github.com/users/tikv/events{/privacy}","received_events_url":"https://api.github.com/users/tikv/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/tikv/rfcs","description":"RFCs for changes to TiKV and its ecosystem","fork":false,"url":"https://api.github.com/repos/tikv/rfcs","forks_url":"https://api.github.com/repos/tikv/rfcs/forks","keys_url":"https://api.github.com/repos/tikv/rfcs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/tikv/rfcs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/tikv/rfcs/teams","hooks_url":"https://api.github.com/repos/tikv/rfcs/hooks","issue_events_url":"https://api.github.com/repos/tikv/rfcs/issues/events{/number}","events_url":"https://api.github.com/repos/tikv/rfcs/events","assignees_url":"https://api.github.com/repos/tikv/rfcs/assignees{/user}","branches_url":"https://api.github.com/repos/tikv/rfcs/branches{/branch}","tags_url":"https://api.github.com/repos/tikv/rfcs/tags","blobs_url":"https://api.github.com/repos/tikv/rfcs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/tikv/rfcs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/tikv/rfcs/git/refs{/sha}","trees_url":"https://api.github.com/repos/tikv/rfcs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/tikv/rfcs/statuses/{sha}","languages_url":"https://api.github.com/repos/tikv/rfcs/languages","stargazers_url":"https://api.github.com/repos/tikv/rfcs/stargazers","contributors_url":"https://api.github.com/repos/tikv/rfcs/contributors","subscribers_url":"https://api.github.com/repos/tikv/rfcs/subscribers","subscription_url":"https://api.github.com/repos/tikv/rfcs/subscription","commits_url":"https://api.github.com/repos/tikv/rfcs/commits{/sha}","git_commits_url":"https://api.github.com/repos/tikv/rfcs/git/commits{/sha}","comments_url":"https://api.github.com/repos/tikv/rfcs/comments{/number}","issue_comment_url":"https://api.github.com/repos/tikv/rfcs/issues/comments{/number}","contents_url":"https://api.github.com/repos/tikv/rfcs/contents/{+path}","compare_url":"https://api.github.com/repos/tikv/rfcs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/tikv/rfcs/merges","archive_url":"https://api.github.com/repos/tikv/rfcs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/tikv/rfcs/downloads","issues_url":"https://api.github.com/repos/tikv/rfcs/issues{/number}","pulls_url":"https://api.github.com/repos/tikv/rfcs/pulls{/number}","milestones_url":"https://api.github.com/repos/tikv/rfcs/milestones{/number}","notifications_url":"https://api.github.com/repos/tikv/rfcs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/tikv/rfcs/labels{/name}","releases_url":"https://api.github.com/repos/tikv/rfcs/releases{/id}","deployments_url":"https://api.github.com/repos/tikv/rfcs/deployments","created_at":"2018-08-17T18:55:29Z","updated_at":"2018-11-14T09:21:27Z","pushed_at":"2018-11-14T12:10:32Z","git_url":"git://github.com/tikv/rfcs.git","ssh_url":"git@github.com:tikv/rfcs.git","clone_url":"https://github.com/tikv/rfcs.git","svn_url":"https://github.com/tikv/rfcs","homepage":"","size":30,"stargazers_count":4,"watchers_count":4,"language":null,"has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":6,"mirror_url":null,"archived":false,"open_issues_count":7,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0","node_id":"MDc6TGljZW5zZTI="},"forks":6,"open_issues":7,"watchers":4,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/tikv/rfcs/pulls/12"},"html":{"href":"https://github.com/tikv/rfcs/pull/12"},"issue":{"href":"https://api.github.com/repos/tikv/rfcs/issues/12"},"comments":{"href":"https://api.github.com/repos/tikv/rfcs/issues/12/comments"},"review_comments":{"href":"https://api.github.com/repos/tikv/rfcs/pulls/12/comments"},"review_comment":{"href":"https://api.github.com/repos/tikv/rfcs/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/tikv/rfcs/pulls/12/commits"},"statuses":{"href":"https://api.github.com/repos/tikv/rfcs/statuses/5562849f400ee582261235517905354559c9382a"}},"author_association":"MEMBER"}}
{"actor":{"display_login":"Hoverbear"}}