Server side fixes

.gitignore

@@ -4,6 +4,10 @@ report/
 
 sql/proprietary/
 
+# macOS specific
+.DS_Store
+*.dylib
+
 # GitHub generated ignores
 # Byte-compiled / optimized / DLL files
 __pycache__/

README.md

@@ -164,7 +164,8 @@ substrings of `pg_hints`can be mentioned there:
 -- accept: a b c
 -- reject: NestLoop
 -- max_timeout: 5s
--- tags: muted_nlj, 5s_max
+-- tags: muted_nlj, 5s_max, skip_consistency_check
+-- debug_hints: set (yb_enable_optimizer_statistics false)
 
 select a.c1,
        a.c2, ...
@@ -177,6 +178,12 @@ After optimizations are generated, the framework evaluates all of them with maxi
 equal to current minimum execution time (starts with original optimization timeout) so do not spend
 time on worst cases.
 
+#### Result validation
+
+TAQO implements consistency checks, which are reflected in the collect and report logs.
+In the event that certain optimizations yield varying results, these discrepancies will be brought to attention.
+To disable this feature, you can add the skip_consistency_check tag.
+
 ----
 
 ## Report
@@ -251,7 +258,7 @@ session-props = [
 skip-percentage-delta = 0.15
 
 # query execution related options
-ddl-query-timeout = 3600 # skip DDL if they evaluated in more than 1200 seconds
+ddl-query-timeout = 3600 # skip DDL if they evaluated in more than 3600 seconds
 test-query-timeout = 1200 # skip queries if they evaluated in more than 1200 seconds
 
 # optimization generation
@@ -333,8 +340,6 @@ options:
   --username USERNAME   Username for connection
   --password PASSWORD   Password for user for connection
   --database DATABASE   Target database in postgres compatible database
-  --enable-statistics, --no-enable-statistics
-                        Evaluate yb_enable_optimizer_statistics before running queries (default: False)
   --explain-clause EXPLAIN_CLAUSE
                         Explain clause that will be placed before query. Default "EXPLAIN"
   --num-queries NUM_QUERIES
@@ -355,19 +360,19 @@ See prepared scenarios in `bin/` directory
 Collect queries results for basic model for localhost cluster
 
 ```
-src/runner.py
+python3 src/runner.py
 collect
 --optimizations
 --model=basic
---config=config/qo.conf
---output=taqo_complex_yb
+--config=config/default.conf
+--output=taqo_basic_yb
 --database=taqo
 ```
 
 Generate comparison report for 2 previous collect runs
 
 ```
-src/runner.py
+python3 src/runner.py
 report
 --type=regression
 --config=config/qo.conf
@@ -378,10 +383,10 @@ report
 Generate score report which contains taqo analysis and comparison with postgres
 
 ```
-src/runner.py
+python3 src/runner.py
 report
 --type=score
 --config=config/qo.conf
 --results=report/basic_taqo_yb.json
 --pg-results=report/basic_taqo_pg.json
-```
+```

css/adoc.css → adoc/adoc.css

@@ -1,6 +1,14 @@
 /* Based on Cosmo from Bootswatch (https://bootswatch.com/cosmo/) */
 @import url("//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,700");
 
+/* table cell alignment attribute definitions from Asciidoctor default css */
+th.halign-left,td.halign-left{text-align:left}
+th.halign-right,td.halign-right{text-align:right}
+th.halign-center,td.halign-center{text-align:center}
+th.valign-top,td.valign-top{vertical-align:top}
+th.valign-bottom,td.valign-bottom{vertical-align:bottom}
+th.valign-middle,td.valign-middle{vertical-align:middle}
+
 /* document body (contains all content) */
 body {
     font-family: "Source Sans Pro", Calibri, Candara, Arial, sans-serif;
@@ -356,4 +364,4 @@ video {
 .black {color: #000000}
 .red {color: #911717}
 .blue {color: #3a3aac}
-.green {color:#080}
+.green {color:#080}

adoc/copy-to-clipboard-docinfo-processor.rb

@@ -0,0 +1,7 @@
+RUBY_ENGINE == 'opal' ? (require 'copy-to-clipboard-docinfo-processor/extension') : (require_relative 'copy-to-clipboard-docinfo-processor/extension')
+
+Asciidoctor::Extensions.register do
+  tree_processor CopyToClipboardTreeProcessor
+  docinfo_processor CopyToClipboardStylesDocinfoProcessor
+  docinfo_processor CopyToClipboardBehaviorDocinfoProcessor
+end

adoc/copy-to-clipboard-docinfo-processor/behavior.js

@@ -0,0 +1,83 @@
+/*! https://gitlab.com/antora/antora-ui-default/-/blob/master/src/js/06-copy-to-clipboard.js | License: MPL-2.0 */
+;(function () {
+  'use strict'
+
+  var CMD_RX = /^\$ (\S[^\\\n]*(\\\n(?!\$ )[^\\\n]*)*)(?=\n|$)/gm
+  var LINE_CONTINUATION_RX = /( ) *\\\n *|\\\n( ?) */g
+  var TRAILING_SPACE_RX = / +$/gm
+  var LEADING_SPACE_NUMBER_RX = /^ ?\d+/gm;
+
+  var config = (document.getElementById('site-script') || { dataset: {} }).dataset
+  var supportsCopy = window.navigator.clipboard
+  var svgAs = config.svgAs
+  var uiRootPath = (config.uiRootPath == null ? window.uiRootPath : config.uiRootPath) || '.'
+
+  ;[].slice.call(document.querySelectorAll('.doc pre.highlight, .doc .literalblock pre')).forEach(function (pre) {
+    var code, language, lang, copy, toast, toolbox
+    if (pre.classList.contains('highlight')) {
+      code = pre.querySelector('code')
+      if ((language = code.dataset.lang) && language !== 'console') {
+        ;(lang = document.createElement('span')).className = 'source-lang'
+        lang.appendChild(document.createTextNode(language))
+      }
+    } else if (pre.innerText.startsWith('$ ')) {
+      var block = pre.parentNode.parentNode
+      block.classList.remove('literalblock')
+      block.classList.add('listingblock')
+      pre.classList.add('highlightjs', 'highlight')
+      ;(code = document.createElement('code')).className = 'language-console hljs'
+      code.dataset.lang = 'console'
+      code.appendChild(pre.firstChild)
+      pre.appendChild(code)
+    } else {
+      return
+    }
+    ;(toolbox = document.createElement('div')).className = 'source-toolbox'
+    if (lang) toolbox.appendChild(lang)
+    // TODO not the best solution?
+    // if (supportsCopy) {
+      ;(copy = document.createElement('button')).className = 'copy-button'
+      copy.setAttribute('title', 'Copy to clipboard')
+      if (svgAs === 'svg') {
+        var svg = document.createElementNS('http://www.w3.org/2000/svg', 'svg')
+        svg.setAttribute('class', 'copy-icon')
+        var use = document.createElementNS('http://www.w3.org/2000/svg', 'use')
+        use.setAttribute('href', uiRootPath + '/img/octicons-16.svg#icon-clippy')
+        svg.appendChild(use)
+        copy.appendChild(svg)
+      } else {
+        var img = document.createElement('img')
+        img.src = uiRootPath + '/img/octicons-16.svg#view-clippy'
+        img.alt = 'copy icon'
+        img.className = 'copy-icon'
+        copy.appendChild(img)
+      }
+      ;(toast = document.createElement('span')).className = 'copy-toast'
+      toast.appendChild(document.createTextNode('Copied!'))
+      copy.appendChild(toast)
+      toolbox.appendChild(copy)
+    // }
+    pre.parentNode.appendChild(toolbox)
+    if (copy) copy.addEventListener('click', writeToClipboard.bind(copy, code))
+  })
+
+  function extractCommands (text) {
+    var cmds = []
+    var m
+    while ((m = CMD_RX.exec(text))) cmds.push(m[1].replace(LINE_CONTINUATION_RX, '$1$2'))
+    return cmds.join(' && ')
+  }
+
+  function writeToClipboard (code) {
+    var text = code.innerText.replace(TRAILING_SPACE_RX, '').replace(/''/g, "'").replace(LEADING_SPACE_NUMBER_RX, '')
+    if (code.dataset.lang === 'console' && text.startsWith('$ ')) text = extractCommands(text)
+    window.navigator.clipboard.writeText(text).then(
+      function () {
+        this.classList.add('clicked')
+        this.offsetHeight // eslint-disable-line no-unused-expressions
+        this.classList.remove('clicked')
+      }.bind(this),
+      function () {}
+    )
+  }
+})()

adoc/copy-to-clipboard-docinfo-processor/extension.rb

@@ -0,0 +1,34 @@
+class CopyToClipboardTreeProcessor < Asciidoctor::Extensions::TreeProcessor
+  def process doc
+    doc.add_role 'doc' unless doc.has_role? 'doc'
+    nil
+  end
+end
+
+class CopyToClipboardStylesDocinfoProcessor < Asciidoctor::Extensions::DocinfoProcessor
+  use_dsl
+  at_location :head
+
+  def process doc
+    extdir = ::File.join ::File.dirname __FILE__
+    <<-EOS
+<style>
+#{doc.read_asset %(#{extdir}/styles.css)}
+</style>
+    EOS
+  end
+end
+
+class CopyToClipboardBehaviorDocinfoProcessor < Asciidoctor::Extensions::DocinfoProcessor
+  use_dsl
+  at_location :footer
+
+  def process doc
+    extdir = ::File.join ::File.dirname __FILE__
+    <<-EOS
+<script id="site-script">
+#{doc.read_asset %(#{extdir}/behavior.js)}
+</script>
+    EOS
+  end
+end

adoc/copy-to-clipboard-docinfo-processor/sample.adoc

@@ -0,0 +1,16 @@
+= Sample
+:source-highlighter: highlight.js
+
+[,ruby]
+----
+Asciidoctor::Extensions.register do
+  block do
+    named :sample
+    on_context :open
+
+    process do |parent, reader, attrs|
+      create_paragraph parent, reader.lines, attrs
+    end
+  end
+end
+----

adoc/copy-to-clipboard-docinfo-processor/styles.css

@@ -0,0 +1,92 @@
+/*! derived from https://gitlab.com/antora/antora-ui-default/-/blob/master/src/css/doc.css | License: MPL-2.0 */
+.doc .listingblock > .content {
+  position: relative;
+}
+
+.doc .listingblock code[data-lang]::before {
+  content: none;
+}
+
+.doc .source-toolbox {
+  display: flex;
+  position: absolute;
+  visibility: hidden;
+  top: 0.25rem;
+  right: 0.5rem;
+  color: #808080;
+  white-space: nowrap;
+  font-size: 0.85em;
+}
+
+.doc .listingblock:hover .source-toolbox {
+  visibility: visible;
+}
+
+.doc .source-toolbox .source-lang {
+  font-family: "Droid Sans Mono", "DejaVu Sans Mono", monospace;
+  text-transform: uppercase;
+  letter-spacing: 0.075em;
+}
+
+.doc .source-toolbox > :not(:last-child)::after {
+  content: "|";
+  letter-spacing: 0;
+  padding: 0 1ch;
+}
+
+.doc .source-toolbox .copy-button {
+  cursor: pointer;
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  background: none;
+  border: none;
+  color: inherit;
+  outline: none;
+  padding: 0;
+  font-family: inherit;
+  font-size: inherit;
+  line-height: inherit;
+  width: 1em;
+  height: 1em;
+}
+
+.doc .source-toolbox .copy-icon {
+  flex: none;
+  width: inherit;
+  height: inherit;
+  filter: invert(50.2%);
+  margin-top: 0.05em;
+}
+
+.doc .source-toolbox .copy-toast {
+  flex: none;
+  position: relative;
+  display: inline-flex;
+  justify-content: center;
+  margin-top: 1em;
+  border-radius: 0.25em;
+  padding: 0.5em;
+  cursor: auto;
+  opacity: 0;
+  transition: opacity 0.5s ease 0.75s;
+  background: rgba(0, 0, 0, 0.8);
+  color: #fff;
+}
+
+.doc .source-toolbox .copy-toast::after {
+  content: "";
+  position: absolute;
+  top: 0;
+  width: 1em;
+  height: 1em;
+  border: 0.55em solid transparent;
+  border-left-color: rgba(0, 0, 0, 0.8);
+  transform: rotate(-90deg) translateX(50%) translateY(50%);
+  transform-origin: left;
+}
+
+.doc .source-toolbox .copy-button.clicked .copy-toast {
+  opacity: 1;
+  transition: none;
+}