greptimedb/common_meta/kv_backend/util/fn.sanitize_connection_string.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="Removes sensitive information (passwords) from a connection string before it is logged."><title>sanitize_connection_string in common_meta::kv_backend::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-1ed95124.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="common_meta" data-themes="" data-resource-suffix="" data-rustdoc-version="1.98.1 (48a229cea 2026-09-01)" data-channel="1.98.1" data-search-js="search-9944d736.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-417ebf0a.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 fn"><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="#">sanitize_connection_string</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../common_meta/index.html">common_<wbr>meta</a><span class="version">1.4.0-alpha.0</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In common_<wbr>meta::<wbr>kv_<wbr>backend::<wbr>util</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">common_meta</a>::<wbr><a href="../index.html">kv_backend</a>::<wbr><a href="index.html">util</a></div><h1>Function <span class="fn">sanitize_<wbr>connection_<wbr>string</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/common_meta/kv_backend/util.rs.html#41-67">Source</a> </span></div><pre class="rust item-decl"><code>pub fn sanitize_connection_string(conn_str: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.98.1/std/primitive.str.html">str</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Removes sensitive information (passwords) from a connection string before it
is logged.</p>
<p><code>store_addrs</code> entries can be a PostgreSQL DSN (a <code>postgres(ql)://</code> URL or a
libpq keyword string), a MySQL/etcd URL, or an etcd host list.</p>
<p>The function fails closed: it never returns a URI-shaped input verbatim. In
order:</p>
<ol>
<li>PostgreSQL DSNs are parsed with <code>tokio_postgres::Config</code> — the backend’s
own parser — and logged via its <code>Debug</code>, which redacts the password. This
matches the grammar exactly (multi-host URIs, <code>\</code>-escapes, any Unicode
whitespace, percent-encoded query keys, <code>&amp;</code>/<code>;</code>/<code>://</code> inside values).</li>
<li>Any other URL is redacted with the <code>url</code> crate.</li>
<li>A URI-shaped input that neither parser accepted (e.g. a malformed
multi-host Postgres URI, with or without leading whitespace) is redacted
in full — credentials in an unparsable authority or query cannot be split
out reliably, so the whole string is replaced rather than reparsed.</li>
<li>Anything else is treated as a keyword string and best-effort redacted.</li>
</ol>
</div></details></section></div></main></body></html>