mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-01-09 06:42:57 +00:00
3 lines
7.2 KiB
HTML
3 lines
7.2 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 `util` mod in crate `sqlness_runner`."><title>sqlness_runner::util - 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-e56847b5.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.92.0-nightly (fa3155a64 2025-09-30)" data-channel="nightly" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-828709d0.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.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"><!--[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 util</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.0.0-beta.4</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module util</a></h2><h3><a href="#constants">Module Items</a></h3><ul class="block"><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 class="in-crate"><a href="../index.html">In crate sqlness_<wbr>runner</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"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">sqlness_runner</a></div><h1>Module <span>util</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/util.rs.html#15-560">Source</a> </span></div><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.PORT_CHECK_INTERVAL.html" title="constant sqlness_runner::util::PORT_CHECK_INTERVAL">PORT_<wbr>CHECK_<wbr>INTERVAL</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Check port every 0.1 second.</dd><dt><a class="constant" href="constant.PROGRAM.html" title="constant sqlness_runner::util::PROGRAM">PROGRAM</a></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.check_port.html" title="fn sqlness_runner::util::check_port">check_<wbr>port</a></dt><dd>Spin-waiting a socket address is available, or timeout.
|
||
Returns whether the addr is up.</dd><dt><a class="fn" href="fn.decompress.html" title="fn sqlness_runner::util::decompress">decompress</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.download_files.html" title="fn sqlness_runner::util::download_files">download_<wbr>files</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.get_binary_dir.html" title="fn sqlness_runner::util::get_binary_dir">get_<wbr>binary_<wbr>dir</a></dt><dt><a class="fn" href="fn.get_case_dir.html" title="fn sqlness_runner::util::get_case_dir">get_<wbr>case_<wbr>dir</a></dt><dd>Get the dir of test cases. This function only works when the runner is run
|
||
under the project’s dir because it depends on some envs set by cargo.</dd><dt><a class="fn" href="fn.get_random_port.html" title="fn sqlness_runner::util::get_random_port">get_<wbr>random_<wbr>port</a></dt><dd>Get a random available port by binding to port 0</dd><dt><a class="fn" href="fn.get_workspace_root.html" title="fn sqlness_runner::util::get_workspace_root">get_<wbr>workspace_<wbr>root</a></dt><dd>Get the dir that contains workspace manifest (the top-level Cargo.toml).</dd><dt><a class="fn" href="fn.http_proxy.html" title="fn sqlness_runner::util::http_proxy">http_<wbr>proxy</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.https_proxy.html" title="fn sqlness_runner::util::https_proxy">https_<wbr>proxy</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.maybe_pull_binary.html" title="fn sqlness_runner::util::maybe_pull_binary">maybe_<wbr>pull_<wbr>binary</a></dt><dd>Pull the binary if it does not exist and <code>pull_version_on_need</code> is true.</dd><dt><a class="fn" href="fn.pull_binary.html" title="fn sqlness_runner::util::pull_binary">pull_<wbr>binary</a></dt><dd>Use curl to download the binary from the release page.</dd><dt><a class="fn" href="fn.retry_with_backoff.html" title="fn sqlness_runner::util::retry_with_backoff">retry_<wbr>with_<wbr>backoff</a></dt><dd>Retry to execute the function until success or the maximum number of retries is reached.</dd><dt><a class="fn" href="fn.setup_etcd.html" title="fn sqlness_runner::util::setup_etcd">setup_<wbr>etcd</a></dt><dd>Set up a standalone etcd in docker.</dd><dt><a class="fn" href="fn.setup_mysql.html" title="fn sqlness_runner::util::setup_mysql">setup_<wbr>mysql</a></dt><dd>Set up a MySql server in docker.</dd><dt><a class="fn" href="fn.setup_pg.html" title="fn sqlness_runner::util::setup_pg">setup_<wbr>pg</a></dt><dd>Set up a PostgreSQL server in docker.</dd><dt><a class="fn" href="fn.setup_wal.html" title="fn sqlness_runner::util::setup_wal">setup_<wbr>wal</a></dt><dd>Start kafka cluster if needed. Config file is <code>conf/kafka-cluster.yml</code>.</dd><dt><a class="fn" href="fn.sqlness_conf_path.html" title="fn sqlness_runner::util::sqlness_conf_path">sqlness_<wbr>conf_<wbr>path</a></dt><dd>Get the path of sqlness config dir <code>tests/conf</code>.</dd><dt><a class="fn" href="fn.stop_rm_etcd.html" title="fn sqlness_runner::util::stop_rm_etcd">stop_<wbr>rm_<wbr>etcd</a></dt><dd>Stop and remove the etcd container</dd><dt><a class="fn" href="fn.teardown_wal.html" title="fn sqlness_runner::util::teardown_wal">teardown_<wbr>wal</a></dt><dd>Stop kafka cluster if needed. Config file is <code>conf/kafka-cluster.yml</code>.</dd></dl></section></div></main></body></html> |