Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

differenciate between AQL Queries and AQL Explain in generated headlines and buttons (#6311)

This commit is contained in:
Wilfried Goesgens 2018-08-31 20:09:46 +02:00 committed by Jan
parent e2f72f7a68
commit 1a4ccf9de8
1 changed files with 33 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
Documentation/Scripts/codeBlockReader.py
View File

@ -149,12 +149,16 @@ def example_content(filepath, fh, tag, blockType, placeIntoFilePath):
else: else:
shortable = True shortable = True
if blockType == "AQL": if blockType == "AQL" or blockType == "EXPLAIN":
if line.startswith("@Q"): # query part if line.startswith("@Q"): # query part
blockCount = 0 blockCount = 0
aqlState = AQL_STATE_QUERY aqlState = AQL_STATE_QUERY
short += "<strong>Query:</strong>\n<pre>\n" if blockType == "EXPLAIN":
longText += "<strong>Query:</strong>\n<pre>\n" short += "<strong>Explain Query:</strong>\n<pre>\n"
longText += "<strong>Explain Query:</strong>\n<pre>\n"
else:
short += "<strong>Query:</strong>\n<pre>\n"
longText += "<strong>Query:</strong>\n<pre>\n"
continue # skip this line - it is only here for this. continue # skip this line - it is only here for this.
elif line.startswith("@B"): # bind values part elif line.startswith("@B"): # bind values part
short += "</pre>\n<strong>Bind Values:</strong>\n<pre>\n" short += "</pre>\n<strong>Bind Values:</strong>\n<pre>\n"
@ -164,7 +168,10 @@ def example_content(filepath, fh, tag, blockType, placeIntoFilePath):
continue # skip this line - it is only here for this. continue # skip this line - it is only here for this.
elif line.startswith("@R"): # result part elif line.startswith("@R"): # result part
shortable = True shortable = True
longText += "</pre>\n<strong>Results:</strong>\n<pre>\n" if blockType == "EXPLAIN":
longText += "</pre>\n<strong>Explain output:</strong>\n<pre>\n"
else:
longText += "</pre>\n<strong>Query results:</strong>\n<pre>\n"
blockCount = 0 blockCount = 0
aqlState = AQL_STATE_RESULT aqlState = AQL_STATE_RESULT
continue # skip this line - it is only here for this. continue # skip this line - it is only here for this.
@ -209,20 +216,22 @@ def example_content(filepath, fh, tag, blockType, placeIntoFilePath):
else: else:
fh.write(unicode("<div id=\"%s\">\n" % longTag)) fh.write(unicode("<div id=\"%s\">\n" % longTag))
if blockType != "AQL": if blockType != "AQL" and blockType != "EXPLAIN":
fh.write(unicode("<pre>\n")) fh.write(unicode("<pre>\n"))
fh.write(unicode("%s" % longText)) fh.write(unicode("%s" % longText))
fh.write(unicode("</pre>\n")) fh.write(unicode("</pre>\n"))
if shortable: if shortable:
hideText="" hideText=""
if blockType == "arangosh": if blockType == "arangosh":
hideText = u"hide execution results" hideText = u"Hide execution results"
elif blockType == "curl": elif blockType == "curl":
hideText = u"hide response body" hideText = u"Hide response body"
elif blockType == "AQL": elif blockType == "AQL":
hideText = u"hide query result" hideText = u"Hide query result"
elif blockType == "EXPLAIN":
hideText = u"Hide explain output"
else: else:
hideText = u"hide" hideText = u"Hide"
fh.write(unicode('<div id="%s_collapse" onclick="%s" class="example_show_button">%s</div>' % ( fh.write(unicode('<div id="%s_collapse" onclick="%s" class="example_show_button">%s</div>' % (
utag, utag,
longToggle, longToggle,
@ -232,18 +241,20 @@ def example_content(filepath, fh, tag, blockType, placeIntoFilePath):
if shortable: if shortable:
fh.write(unicode("<div id=\"%s\" onclick=\"%s\">\n" % (shortTag, shortToggle))) fh.write(unicode("<div id=\"%s\" onclick=\"%s\">\n" % (shortTag, shortToggle)))
if blockType != "AQL": if blockType != "AQL" and blockType != "EXPLAIN":
fh.write(unicode("<pre>\n")) fh.write(unicode("<pre>\n"))
fh.write(unicode("%s" % short)) fh.write(unicode("%s" % short))
if blockType == "arangosh": if blockType == "arangosh":
fh.write(unicode("</pre><div class=\"example_show_button\">show execution results</div>\n")) fh.write(unicode("</pre><div class=\"example_show_button\">Show execution results</div>\n"))
elif blockType == "curl": elif blockType == "curl":
fh.write(unicode("</pre><div class=\"example_show_button\">show response body</div>\n")) fh.write(unicode("</pre><div class=\"example_show_button\">Show response body</div>\n"))
elif blockType == "AQL": elif blockType == "AQL":
fh.write(unicode("</pre><div class=\"example_show_button\">show query result</div>\n")) fh.write(unicode("</pre><div class=\"example_show_button\">Show query result</div>\n"))
elif blockType == "EXPLAIN":
fh.write(unicode("</pre><div class=\"example_show_button\">Show explain output</div>\n"))
else: else:
fh.write(unicode("</pre><div class=\"example_show_button\">show</div>\n")) fh.write(unicode("</pre><div class=\"example_show_button\">Show</div>\n"))
fh.write(unicode("</div>\n")) fh.write(unicode("</div>\n"))
@ -268,6 +279,10 @@ def fetch_comments(dirpath, forceDokuBlockContent):
file_comments = file_content(filepath, forceDokuBlockContent) file_comments = file_content(filepath, forceDokuBlockContent)
for comment in file_comments: for comment in file_comments:
fh.write(unicode("\n<!-- filename: %s -->\n" % filepath)) fh.write(unicode("\n<!-- filename: %s -->\n" % filepath))
explain = False
for _com in comment:
if "@EXPLAIN{TRUE}" in _com:
explain = True
for _com in comment: for _com in comment:
_text = re.sub(r"//(/)+\s*\n", "<br />\n", _com) # place in temporary brs... _text = re.sub(r"//(/)+\s*\n", "<br />\n", _com) # place in temporary brs...
_text = re.sub(r"///+(\s+\s+)([-\*\d])", r" \2", _text) _text = re.sub(r"///+(\s+\s+)([-\*\d])", r" \2", _text)
@ -287,7 +302,10 @@ def fetch_comments(dirpath, forceDokuBlockContent):
elif "@EXAMPLE_ARANGOSH_RUN" in _text: elif "@EXAMPLE_ARANGOSH_RUN" in _text:
blockType = "curl" blockType = "curl"
elif "@EXAMPLE_AQL" in _text: elif "@EXAMPLE_AQL" in _text:
blockType = "AQL" if explain:
blockType = "EXPLAIN"
else:
blockType = "AQL"
shouldIgnoreLine = True shouldIgnoreLine = True
try: try: