minio/minio-cpp
1
0
Fork 0
mirror of https://github.com/minio/minio-cpp.git synced 2025-08-05 01:42:08 +03:00
Code Activity
Files
gh-pages
minio-cpp/index.html
Bala FA f6ffd5fb10 Add docs (#17) 
Signed-off-by: Bala.FA <bala@minio.io>
2022-05-23 10:43:48 -07:00

169 lines
8.3 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MinIO C++ SDK: Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MinIO C++ SDK
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">MinIO C++ SDK Documentation</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><a class="anchor" id="md__home_bala_devel_github_com_minio_minio_cpp_docs_README"></a></p><blockquote class="doxtable">
<p>NOTE: This project is work in progress. </p>
</blockquote>
<p>MinIO C++ SDK is Simple Storage Service (aka S3) client to perform bucket and object operations to any Amazon S3 compatible object storage service.</p>
<p>For a complete list of APIs and examples, please take a look at the <a href="https://minio-cpp.min.io/">MinIO C++ Client API Reference</a></p>
<h2><a class="anchor" id="autotoc_md0"></a>
Build requirements</h2>
<ul>
<li>A working C++ development environment supporting C++17 standards.</li>
<li>CMake 3.10 or higher.</li>
<li><a href="https://vcpkg.io/en/index.html">vcpkg</a>.</li>
</ul>
<h2><a class="anchor" id="autotoc_md1"></a>
Install from vcpkg</h2>
<div class="fragment"><div class="line">vcpkg install minio-cpp</div>
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md2"></a>
Building source</h2>
<div class="fragment"><div class="line">$ git clone https://github.com/minio/minio-cpp</div>
<div class="line">$ cd minio-cpp</div>
<div class="line">$ wget --quiet -O vcpkg-master.zip https://github.com/microsoft/vcpkg/archive/refs/heads/master.zip</div>
<div class="line">$ unzip -qq vcpkg-master.zip</div>
<div class="line">$ ./vcpkg-master/bootstrap-vcpkg.sh</div>
<div class="line">$ ./vcpkg-master/vcpkg integrate install</div>
<div class="line">$ cmake -B ./build -DCMAKE_BUILD_TYPE=Debug -DCMAKE_TOOLCHAIN_FILE=./vcpkg-master/scripts/buildsystems/vcpkg.cmake</div>
<div class="line">$ cmake --build ./build --config Debug</div>
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md3"></a>
Example:: file-uploader.cc</h2>
<div class="fragment"><div class="line">#include &lt;client.h&gt;</div>
<div class="line"> </div>
<div class="line">int main(int argc, char* argv[]) {</div>
<div class="line"> // Create S3 base URL.</div>
<div class="line"> minio::http::BaseUrl base_url;</div>
<div class="line"> base_url.SetHost(&quot;play.min.io&quot;);</div>
<div class="line"> </div>
<div class="line"> // Create credential provider.</div>
<div class="line"> minio::creds::StaticProvider provider(</div>
<div class="line"> &quot;Q3AM3UQ867SPQQA43P2F&quot;, &quot;zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG&quot;);</div>
<div class="line"> </div>
<div class="line"> // Create S3 client.</div>
<div class="line"> minio::s3::Client client(base_url, &amp;provider);</div>
<div class="line"> </div>
<div class="line"> std::string bucket_name = &quot;asiatrip&quot;;</div>
<div class="line"> </div>
<div class="line"> // Check &#39;asiatrip&#39; bucket exist or not.</div>
<div class="line"> bool exist;</div>
<div class="line"> {</div>
<div class="line"> minio::s3::BucketExistsArgs args;</div>
<div class="line"> args.bucket_ = bucket_name;</div>
<div class="line"> </div>
<div class="line"> minio::s3::BucketExistsResponse resp = client.BucketExists(args);</div>
<div class="line"> if (!resp) {</div>
<div class="line"> std::cout &lt;&lt; &quot;unable to do bucket existence check; &quot; &lt;&lt; resp.GetError()</div>
<div class="line"> &lt;&lt; std::endl;</div>
<div class="line"> return EXIT_FAILURE;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> exist = resp.exist_;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> // Make &#39;asiatrip&#39; bucket if not exist.</div>
<div class="line"> if (!exist) {</div>
<div class="line"> minio::s3::MakeBucketArgs args;</div>
<div class="line"> args.bucket_ = bucket_name;</div>
<div class="line"> </div>
<div class="line"> minio::s3::MakeBucketResponse resp = client.MakeBucket(args);</div>
<div class="line"> if (!resp) {</div>
<div class="line"> std::cout &lt;&lt; &quot;unable to create bucket; &quot; &lt;&lt; resp.GetError() &lt;&lt; std::endl;</div>
<div class="line"> return EXIT_FAILURE;</div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> // Upload &#39;/home/user/Photos/asiaphotos.zip&#39; as object name</div>
<div class="line"> // &#39;asiaphotos-2015.zip&#39; to bucket &#39;asiatrip&#39;.</div>
<div class="line"> minio::s3::UploadObjectArgs args;</div>
<div class="line"> args.bucket_ = bucket_name;</div>
<div class="line"> args.object_ = &quot;asiaphotos-2015.zip&quot;;</div>
<div class="line"> args.filename_ = &quot;/home/user/Photos/asiaphotos.zip&quot;;</div>
<div class="line"> </div>
<div class="line"> minio::s3::UploadObjectResponse resp = client.UploadObject(args);</div>
<div class="line"> if (!resp) {</div>
<div class="line"> std::cout &lt;&lt; &quot;unable to upload object; &quot; &lt;&lt; resp.GetError() &lt;&lt; std::endl;</div>
<div class="line"> return EXIT_FAILURE;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> std::cout &lt;&lt; &quot;&#39;/home/user/Photos/asiaphotos.zip&#39; is successfully uploaded as &quot;</div>
<div class="line"> &lt;&lt; &quot;object &#39;asiaphotos-2015.zip&#39; to bucket &#39;asiatrip&#39;.&quot;</div>
<div class="line"> &lt;&lt; std::endl;</div>
<div class="line"> </div>
<div class="line"> return EXIT_SUCCESS;</div>
<div class="line">}</div>
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md4"></a>
License</h2>
<p>This SDK is distributed under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>, see <a href="https://github.com/minio/minio-cpp/blob/master/LICENSE">LICENSE</a> for more information. </p>
</div></div><!-- PageDoc -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
View Git Blame Copy Permalink