Files
greptimedb/sqlness_runner/cmd/compat/index.html
2026-06-26 11:53:49 +00:00

6 lines
8.0 KiB
HTML

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `compat` mod in crate `sqlness_runner`."><title>sqlness_runner::cmd::compat - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="sqlness_runner" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../../static.files/storage-41dd4d93.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module compat</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../sqlness_runner/index.html">sqlness_<wbr>runner</a><span class="version">1.2.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module compat</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In sqlness_<wbr>runner::<wbr>cmd</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">sqlness_runner</a>::<wbr><a href="../index.html">cmd</a></div><h1>Module <span>compat</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../src/sqlness_runner/cmd/compat.rs.html#15-878">Source</a> </span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.CompatCommand.html" title="struct sqlness_runner::cmd::compat::CompatCommand">Compat<wbr>Command</a></dt><dd>Run compatibility tests in bare distributed mode.</dd><dt><a class="struct" href="struct.EtcdGuard.html" title="struct sqlness_runner::cmd::compat::EtcdGuard">Etcd<wbr>Guard</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Guard that stops/removes Docker etcd on drop (panic or early exit).
Disarm before normal cleanup to avoid double-cleanup.</dd><dt><a class="struct" href="struct.ParsedStatement.html" title="struct sqlness_runner::cmd::compat::ParsedStatement">Parsed<wbr>Statement</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>A parsed SQL statement with sqlness comments and interceptors.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.CompatPhase.html" title="enum sqlness_runner::cmd::compat::CompatPhase">Compat<wbr>Phase</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Phase of compat execution.</dd></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.COMMENT_PREFIX.html" title="constant sqlness_runner::cmd::compat::COMMENT_PREFIX">COMMENT_<wbr>PREFIX</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.COMPAT_TOPOLOGY.html" title="constant sqlness_runner::cmd::compat::COMPAT_TOPOLOGY">COMPAT_<wbr>TOPOLOGY</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.INTERCEPTOR_PREFIX.html" title="constant sqlness_runner::cmd::compat::INTERCEPTOR_PREFIX">INTERCEPTOR_<wbr>PREFIX</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.QUERY_DELIMITER.html" title="constant sqlness_runner::cmd::compat::QUERY_DELIMITER">QUERY_<wbr>DELIMITER</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.create_interceptor_registry.html" title="fn sqlness_runner::cmd::compat::create_interceptor_registry">create_<wbr>interceptor_<wbr>registry</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Create an interceptor registry matching the ordinary sqlness runner.</dd><dt><a class="fn" href="fn.default_compat_case_dir.html" title="fn sqlness_runner::cmd::compat::default_compat_case_dir">default_<wbr>compat_<wbr>case_<wbr>dir</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Default case directory: <code>tests/compatibility/cases</code> relative to workspace root.</dd><dt><a class="fn" href="fn.parse_sql_file.html" title="fn sqlness_runner::cmd::compat::parse_sql_file">parse_<wbr>sql_<wbr>file</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Parse a SQL file into statements using the same sqlness comment/interceptor
conventions as the ordinary runner.</dd><dt><a class="fn" href="fn.resolve_bins.html" title="fn sqlness_runner::cmd::compat::resolve_bins">resolve_<wbr>bins</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Resolve binary directory: explicit path takes priority, then version (pulls if needed),
otherwise default to current debug build.</dd><dt><a class="fn" href="fn.run_compat_phase.html" title="fn sqlness_runner::cmd::compat::run_compat_phase">run_<wbr>compat_<wbr>phase</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Run a single compat phase (setup or verify) for one case.</dd><dt><a class="fn" href="fn.run_namespace_prelude.html" title="fn sqlness_runner::cmd::compat::run_namespace_prelude">run_<wbr>namespace_<wbr>prelude</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Execute the namespace prelude (CREATE DATABASE IF NOT EXISTS + USE) for a case.
This is NOT written into verify.result.</dd><dt><a class="fn" href="fn.simple_diff.html" title="fn sqlness_runner::cmd::compat::simple_diff">simple_<wbr>diff</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Generate a simple line-based diff between expected and actual.</dd><dt><a class="fn" href="fn.trim_trailing_blank_lines.html" title="fn sqlness_runner::cmd::compat::trim_trailing_blank_lines">trim_<wbr>trailing_<wbr>blank_<wbr>lines</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Keep generated snapshots compatible with <code>git diff --check</code> by avoiding a
trailing blank line at EOF while preserving the final newline.</dd></dl></section></div></main></body></html>