mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2025-12-27 08:29:59 +00:00
11 lines
11 KiB
HTML
11 lines
11 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="Trait for storage backends that can be used for data export."><title>StorageExport in cli::data::storage_export - 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="cli" 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 trait"><!--[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="#">StorageExport</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../cli/index.html">cli</a><span class="version">1.0.0-beta.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Storage<wbr>Export</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.format_output_path" title="format_output_path">format_output_path</a></li><li><a href="#tymethod.get_storage_path" title="get_storage_path">get_storage_path</a></li><li><a href="#tymethod.mask_sensitive_info" title="mask_sensitive_info">mask_sensitive_info</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In cli::<wbr>data::<wbr>storage_<wbr>export</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">cli</a>::<wbr><a href="../index.html">data</a>::<wbr><a href="index.html">storage_export</a></div><h1>Trait <span class="trait">Storage<wbr>Export</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/cli/data/storage_export.rs.html#59-69">Source</a> </span></div><pre class="rust item-decl"><code>pub trait StorageExport: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> {
|
|
// Required methods
|
|
fn <a href="#tymethod.get_storage_path" class="fn">get_storage_path</a>(&self, catalog: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, schema: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> (<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>);
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.format_output_path" class="fn">format_output_path</a>(&self, file_path: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.mask_sensitive_info" class="fn">mask_sensitive_info</a>(&self, sql: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/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>Trait for storage backends that can be used for data export.</p>
|
|
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.get_storage_path" class="method"><a class="src rightside" href="../../../src/cli/data/storage_export.rs.html#62">Source</a><h4 class="code-header">fn <a href="#tymethod.get_storage_path" class="fn">get_storage_path</a>(&self, catalog: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, schema: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> (<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</h4></section></summary><div class="docblock"><p>Generate the storage path for COPY DATABASE command.
|
|
Returns (path, connection_string) where connection_string includes CONNECTION clause.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.format_output_path" class="method"><a class="src rightside" href="../../../src/cli/data/storage_export.rs.html#65">Source</a><h4 class="code-header">fn <a href="#tymethod.format_output_path" class="fn">format_output_path</a>(&self, file_path: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section></summary><div class="docblock"><p>Format the output path for logging purposes.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.mask_sensitive_info" class="method"><a class="src rightside" href="../../../src/cli/data/storage_export.rs.html#68">Source</a><h4 class="code-header">fn <a href="#tymethod.mask_sensitive_info" class="fn">mask_sensitive_info</a>(&self, sql: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section></summary><div class="docblock"><p>Mask sensitive information in SQL commands for safe logging.</p>
|
|
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-StorageExport-for-StorageType" class="impl"><a class="src rightside" href="../../../src/cli/data/storage_export.rs.html#336-366">Source</a><a href="#impl-StorageExport-for-StorageType" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.StorageExport.html" title="trait cli::data::storage_export::StorageExport">StorageExport</a> for <a class="enum" href="enum.StorageType.html" title="enum cli::data::storage_export::StorageType">StorageType</a></h3></section><section id="impl-StorageExport-for-AzblobBackend" class="impl"><a class="src rightside" href="../../../src/cli/data/storage_export.rs.html#279-325">Source</a><a href="#impl-StorageExport-for-AzblobBackend" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.StorageExport.html" title="trait cli::data::storage_export::StorageExport">StorageExport</a> for <a class="struct" href="struct.AzblobBackend.html" title="struct cli::data::storage_export::AzblobBackend">AzblobBackend</a></h3></section><section id="impl-StorageExport-for-FsBackend" class="impl"><a class="src rightside" href="../../../src/cli/data/storage_export.rs.html#99-119">Source</a><a href="#impl-StorageExport-for-FsBackend" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.StorageExport.html" title="trait cli::data::storage_export::StorageExport">StorageExport</a> for <a class="struct" href="struct.FsBackend.html" title="struct cli::data::storage_export::FsBackend">FsBackend</a></h3></section><section id="impl-StorageExport-for-GcsBackend" class="impl"><a class="src rightside" href="../../../src/cli/data/storage_export.rs.html#223-275">Source</a><a href="#impl-StorageExport-for-GcsBackend" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.StorageExport.html" title="trait cli::data::storage_export::StorageExport">StorageExport</a> for <a class="struct" href="struct.GcsBackend.html" title="struct cli::data::storage_export::GcsBackend">GcsBackend</a></h3></section><section id="impl-StorageExport-for-OssBackend" class="impl"><a class="src rightside" href="../../../src/cli/data/storage_export.rs.html#177-219">Source</a><a href="#impl-StorageExport-for-OssBackend" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.StorageExport.html" title="trait cli::data::storage_export::StorageExport">StorageExport</a> for <a class="struct" href="struct.OssBackend.html" title="struct cli::data::storage_export::OssBackend">OssBackend</a></h3></section><section id="impl-StorageExport-for-S3Backend" class="impl"><a class="src rightside" href="../../../src/cli/data/storage_export.rs.html#123-173">Source</a><a href="#impl-StorageExport-for-S3Backend" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.StorageExport.html" title="trait cli::data::storage_export::StorageExport">StorageExport</a> for <a class="struct" href="struct.S3Backend.html" title="struct cli::data::storage_export::S3Backend">S3Backend</a></h3></section></div><script src="../../../trait.impl/cli/data/storage_export/trait.StorageExport.js" async></script></section></div></main></body></html> |