Till Westmann has posted comments on this change. Change subject: Add documentation for query parameters. ......................................................................
Patch Set 2: (19 comments) https://asterix-gerrit.ics.uci.edu/#/c/1586/2/asterixdb/asterix-doc/src/main/markdown/sqlpp/0_toc.md File asterixdb/asterix-doc/src/main/markdown/sqlpp/0_toc.md: PS2, Line 76: Tuning I think that these parameters are not part of the language, but rather a part of the system implementing the language. So I think that we should put this section to the end - probably as an appendix. We can decide, if we want to put the SET statement into the language or into the same section as the parameters themselves, but I would propose to keep the statement and the parameters together for now. https://asterix-gerrit.ics.uci.edu/#/c/1586/2/asterixdb/asterix-doc/src/main/markdown/sqlpp/4_parameter.md File asterixdb/asterix-doc/src/main/markdown/sqlpp/4_parameter.md: PS2, Line 4: configuration file I think that the SQL++ documentation does contain system specific information like e.g. the configuration file. I think that we should keep this more generic. e.g.: The SET statement can be used to override some cluster-wide configuration parameters for a specific request: PS2, Line 8: Since each parameter described as follows : is a fully qualified name, we have to use a backtick (\`\`) to make it a delimited identifier. As parameter identifier are qualified names (containing a '.') they have to be escaped using backticks (\`\`). PS2, Line 10: According to the syntax, the value part of each parameter has to always be a string. I think that we don't need this sentence, as we already say that it's a STRING_LITERAL further up. PS2, Line 15: multiple s/multiple/multiple cores on multiple/ PS2, Line 15: Since the s/Since the/The/ PS2, Line 15: individual query s/individual query/request/ PS2, Line 16: , a s/, a/. A/ PS2, Line 16: query request PS2, Line 16: , : based on on her/his own need, s/, based on on her/his own need,// PS2, Line 33: memory footprint s/memory footprint/fixed memory/ PS2, Line 33: even s/even// PS2, Line 34: much s/much// PS2, Line 34: given s/given// PS2, Line 35: Using the `SET` statement, a s/Using the `SET` statement, a/A/ PS2, Line 36: listed as follows a/ listed as follows// PS2, Line 52: Just one space? PS2, Line 60: Just one space? PS2, Line 68: Just one space? -- To view, visit https://asterix-gerrit.ics.uci.edu/1586 To unsubscribe, visit https://asterix-gerrit.ics.uci.edu/settings Gerrit-MessageType: comment Gerrit-Change-Id: I80dcd668bea3b2b3fff0c0778548ffad63505d99 Gerrit-PatchSet: 2 Gerrit-Project: asterixdb Gerrit-Branch: master Gerrit-Owner: Yingyi Bu <[email protected]> Gerrit-Reviewer: Jenkins <[email protected]> Gerrit-Reviewer: Michael Blow <[email protected]> Gerrit-Reviewer: Till Westmann <[email protected]> Gerrit-Reviewer: Yingyi Bu <[email protected]> Gerrit-HasComments: Yes
