OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-25 12:44:07 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
google-apis-rs/google_firestore1_cli/projects_databases-delete/index.html
Sebastian Thiel f4bb79d2d6 Update documentation
2024-03-05 21:06:01 +01:00

329 lines
16 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-firestore1-cli/projects_databases-delete/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Databases Delete - Firestore v5.0.4+20240226</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Databases Delete";
var mkdocs_page_input_path = "projects_databases-delete.md";
var mkdocs_page_url = "/google-apis-rs/google-firestore1-cli/projects_databases-delete/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> Firestore v5.0.4+20240226
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Projects</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-backup-schedules-create/">Databases Backup Schedules Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-backup-schedules-delete/">Databases Backup Schedules Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-backup-schedules-get/">Databases Backup Schedules Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-backup-schedules-list/">Databases Backup Schedules List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-backup-schedules-patch/">Databases Backup Schedules Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-collection-groups-fields-get/">Databases Collection Groups Fields Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-collection-groups-fields-list/">Databases Collection Groups Fields List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-collection-groups-fields-patch/">Databases Collection Groups Fields Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-collection-groups-indexes-create/">Databases Collection Groups Indexes Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-collection-groups-indexes-delete/">Databases Collection Groups Indexes Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-collection-groups-indexes-get/">Databases Collection Groups Indexes Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-collection-groups-indexes-list/">Databases Collection Groups Indexes List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-create/">Databases Create</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Databases Delete</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-documents-batch-get/">Databases Documents Batch Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-documents-batch-write/">Databases Documents Batch Write</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-documents-begin-transaction/">Databases Documents Begin Transaction</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-documents-commit/">Databases Documents Commit</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-documents-create-document/">Databases Documents Create Document</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-documents-delete/">Databases Documents Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-documents-get/">Databases Documents Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-documents-list/">Databases Documents List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-documents-list-collection-ids/">Databases Documents List Collection Ids</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-documents-list-documents/">Databases Documents List Documents</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-documents-listen/">Databases Documents Listen</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-documents-partition-query/">Databases Documents Partition Query</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-documents-patch/">Databases Documents Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-documents-rollback/">Databases Documents Rollback</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-documents-run-aggregation-query/">Databases Documents Run Aggregation Query</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-documents-run-query/">Databases Documents Run Query</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-documents-write/">Databases Documents Write</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-export-documents/">Databases Export Documents</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-get/">Databases Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-import-documents/">Databases Import Documents</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-list/">Databases List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-operations-cancel/">Databases Operations Cancel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-operations-delete/">Databases Operations Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-operations-get/">Databases Operations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-operations-list/">Databases Operations List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-patch/">Databases Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-restore/">Databases Restore</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-backups-delete/">Locations Backups Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-backups-get/">Locations Backups Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-backups-list/">Locations Backups List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-get/">Locations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-list/">Locations List</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">Firestore v5.0.4+20240226</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Projects &raquo;</li>
<li>Databases Delete</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/firestore1-cli/edit/master/docs/projects_databases-delete.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<p>Deletes a database.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
<ul>
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
<li><em>https://www.googleapis.com/auth/datastore</em></li>
</ul>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
You can set the scope for this method like this: <code>firestore1 --scope &lt;scope&gt; projects databases-delete ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;name&gt;</strong> <em>(string)</em><ul>
<li>Required. A name of the form <code>projects/{project_id}/databases/{database_id}</code></li>
</ul>
</li>
</ul>
<h1 id="optional-output-flags">Optional Output Flags</h1>
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
<ul>
<li><strong>-o out</strong><ul>
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
It will be a JSON-encoded structure.
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
If unset, it defaults to standard output.</li>
</ul>
</li>
</ul>
<h1 id="optional-method-properties">Optional Method Properties</h1>
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
<code>-p</code> for completeness.</p>
<ul>
<li><strong>-p etag=string</strong><ul>
<li>The current etag of the Database. If an etag is provided and does not match the current etag of the database, deletion will be blocked and a FAILED_PRECONDITION error will be returned.</li>
</ul>
</li>
</ul>
<h1 id="optional-general-properties">Optional General Properties</h1>
<p>The following properties can configure any call, and are not specific to this method.</p>
<ul>
<li>
<p><strong>-p $-xgafv=string</strong></p>
<ul>
<li>V1 error format.</li>
</ul>
</li>
<li>
<p><strong>-p access-token=string</strong></p>
<ul>
<li>OAuth access token.</li>
</ul>
</li>
<li>
<p><strong>-p alt=string</strong></p>
<ul>
<li>Data format for response.</li>
</ul>
</li>
<li>
<p><strong>-p callback=string</strong></p>
<ul>
<li>JSONP</li>
</ul>
</li>
<li>
<p><strong>-p fields=string</strong></p>
<ul>
<li>Selector specifying which fields to include in a partial response.</li>
</ul>
</li>
<li>
<p><strong>-p key=string</strong></p>
<ul>
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
</ul>
</li>
<li>
<p><strong>-p oauth-token=string</strong></p>
<ul>
<li>OAuth 2.0 token for the current user.</li>
</ul>
</li>
<li>
<p><strong>-p pretty-print=boolean</strong></p>
<ul>
<li>Returns response with indentations and line breaks.</li>
</ul>
</li>
<li>
<p><strong>-p quota-user=string</strong></p>
<ul>
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
</ul>
</li>
<li>
<p><strong>-p upload-type=string</strong></p>
<ul>
<li>Legacy upload protocol for media (e.g. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../projects_databases-create/" class="btn btn-neutral float-left" title="Databases Create"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../projects_databases-documents-batch-get/" class="btn btn-neutral float-right" title="Databases Documents Batch Get">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
<p>Copyright &copy; 2015-2020, `Sebastian Thiel`</p>
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/firestore1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../projects_databases-create/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../projects_databases-documents-batch-get/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink