mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-07-04 21:10:37 +00:00
6 lines
7.4 KiB
HTML
6 lines
7.4 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_case` mod in crate `sqlness_runner`."><title>sqlness_runner::cmd::compat_case - 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_case</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_<wbr>case</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="#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_<wbr>case</span> <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_case.rs.html#15-822">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.CaseMetadata.html" title="struct sqlness_runner::cmd::compat_case::CaseMetadata">Case<wbr>Metadata</a></dt><dd>Metadata for a compatibility test case, parsed from <code>case.toml</code>.</dd><dt><a class="struct" href="struct.CompatCase.html" title="struct sqlness_runner::cmd::compat_case::CompatCase">Compat<wbr>Case</a></dt><dd>A loaded compatibility case (metadata + file paths).</dd><dt><a class="struct" href="struct.Version.html" title="struct sqlness_runner::cmd::compat_case::Version">Version</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>A simple 3-component version: <code>major.minor.patch</code>.</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.VersionConstraint.html" title="enum sqlness_runner::cmd::compat_case::VersionConstraint">Version<wbr>Constraint</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>A version constraint used in <code>from_range</code> / <code>to_range</code>.</dd></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.discover_cases.html" title="fn sqlness_runner::cmd::compat_case::discover_cases">discover_<wbr>cases</a></dt><dd>Discover all compat cases under <code>case_root</code>.
|
||
Each case is a directory containing <code>case.toml</code>, <code>setup.sql</code>, and <code>verify.sql</code>.
|
||
<code>verify.result</code> is optional at discovery — if missing, the verify phase
|
||
generates it from actual output and fails so the author must review/commit.</dd><dt><a class="fn" href="fn.is_valid_namespace.html" title="fn sqlness_runner::cmd::compat_case::is_valid_namespace">is_<wbr>valid_<wbr>namespace</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Check whether a string is a valid namespace: starts with lowercase letter,
|
||
contains only lowercase alphanumeric + underscores.</dd><dt><a class="fn" href="fn.parse_version_constraint.html" title="fn sqlness_runner::cmd::compat_case::parse_version_constraint">parse_<wbr>version_<wbr>constraint</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Parse a single range entry (e.g. <code>*</code>, <code><=v1.1.0</code>, <code>>=v1.1.1</code>, <code>v1.0.0</code>).</dd><dt><a class="fn" href="fn.sanitize_namespace.html" title="fn sqlness_runner::cmd::compat_case::sanitize_namespace">sanitize_<wbr>namespace</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Sanitize a name into a valid GreptimeDB namespace: lowercase alphanumeric + underscores.</dd><dt><a class="fn" href="fn.try_infer_version.html" title="fn sqlness_runner::cmd::compat_case::try_infer_version">try_<wbr>infer_<wbr>version</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Try to infer a version string by running <code><bins_dir>/greptime --version</code>.
|
||
Returns <code>None</code> if the binary cannot be executed or the output isn’t parseable.</dd><dt><a class="fn" href="fn.validate_case_namespaces.html" title="fn sqlness_runner::cmd::compat_case::validate_case_namespaces">validate_<wbr>case_<wbr>namespaces</a></dt><dd>Check for duplicate namespaces.</dd><dt><a class="fn" href="fn.validate_cases_metadata.html" title="fn sqlness_runner::cmd::compat_case::validate_cases_metadata">validate_<wbr>cases_<wbr>metadata</a></dt><dd>Validate per-case metadata for all discovered cases.</dd><dt><a class="fn" href="fn.validate_version_constraints.html" title="fn sqlness_runner::cmd::compat_case::validate_version_constraints">validate_<wbr>version_<wbr>constraints</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.version_matches_range.html" title="fn sqlness_runner::cmd::compat_case::version_matches_range">version_<wbr>matches_<wbr>range</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Check whether a version matches a list of OR-ed constraints.</dd></dl></section></div></main></body></html> |