Update documentation

This commit is contained in:
Sebastian Thiel
2024-03-05 21:06:01 +01:00
parent a20241b241
commit f4bb79d2d6
47205 changed files with 10667990 additions and 8269099 deletions

View File

@@ -1,212 +1,127 @@
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Databases Documents Write - Firestore v3.0.0+20220221</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="../css/highlight.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
<script type="text/javascript" src="../js/highlight.pack.js"></script>
<script src="../js/theme.js"></script>
<style>
body {font-size: 90%;}
pre, code {font-size: 100%;}
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
</style>
<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_beta1-cli/projects_databases-documents-write/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Databases Documents Write - 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 Documents Write";
var mkdocs_page_input_path = "projects_databases-documents-write.md";
var mkdocs_page_url = "/google-apis-rs/google-firestore1_beta1-cli/projects_databases-documents-write/";
</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 v3.0.0+20220221</a>
<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="main navigation">
<ul class="current">
<span>Projects</span>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-batch-get">Databases Documents Batch Get</a>
<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>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-batch-write">Databases Documents Batch Write</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-begin-transaction">Databases Documents Begin Transaction</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-commit">Databases Documents Commit</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-create-document">Databases Documents Create Document</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-delete">Databases Documents Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-get">Databases Documents Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-list">Databases Documents List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-list-collection-ids">Databases Documents List Collection Ids</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-listen">Databases Documents Listen</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-partition-query">Databases Documents Partition Query</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-patch">Databases Documents Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-rollback">Databases Documents Rollback</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-run-query">Databases Documents Run Query</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Databases Documents Write</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
<li class="toctree-l2"><a href="#required-scalar-argument">Required Scalar Argument</a></li>
<li class="toctree-l2"><a href="#required-request-value">Required Request Value</a></li>
<li><a class="toctree-l3" href="#about-cursors">About Cursors</a></li>
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
</ul>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-export-documents">Databases Export Documents</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-import-documents">Databases Import Documents</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-indexes-create">Databases Indexes Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-indexes-delete">Databases Indexes Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-indexes-get">Databases Indexes Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-indexes-list">Databases Indexes List</a>
</li>
</ul>
</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-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 current"><a class="reference internal current" href="./">Databases Documents Write</a>
<ul class="current">
</ul>
</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-import-documents/">Databases Import Documents</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-indexes-create/">Databases Indexes Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-indexes-delete/">Databases Indexes Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-indexes-get/">Databases Indexes Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_databases-indexes-list/">Databases Indexes List</a>
</li>
</ul>
</div>
&nbsp;
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
<a href=".."></a>
<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">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="..">Docs</a> &raquo;</li>
<li>Databases Documents Write</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/firestore1_beta1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Projects &raquo;</li>
<li>Databases Documents Write</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/firestore1_beta1-cli/edit/master/docs/projects_databases-documents-write.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Streams batches of document updates and deletes, in order.</p>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<p>Streams batches of document updates and deletes, in order. This method is only available via gRPC or WebChannel (not REST).</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>
@@ -232,15 +147,14 @@ In the latter case it is advised to set the field-cursor to the data-structure's
stream-token: string
</code></pre>
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
<ul>
<li><code>-r . labels=key=sanctus</code><ul>
<li><code>-r . labels=key=consetetur</code><ul>
<li>Labels associated with this write request.</li>
<li>the value will be associated with the given <code>key</code></li>
</ul>
</li>
<li><code>stream-id=lorem</code><ul>
<li><code>stream-id=stet</code><ul>
<li>The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created.</li>
</ul>
</li>
@@ -338,32 +252,24 @@ In the latter case it is advised to set the field-cursor to the data-structure's
</ul>
</li>
</ul>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../projects_databases-export-documents" class="btn btn-neutral float-right" title="Databases Export Documents"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../projects_databases-documents-run-query" class="btn btn-neutral" title="Databases Documents Run Query"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../projects_databases-documents-run-query/" class="btn btn-neutral float-left" title="Databases Documents Run Query"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../projects_databases-export-documents/" class="btn btn-neutral float-right" title="Databases Export Documents">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
<!-- Copyright etc -->
</p>
<p>Copyright &copy; 2015-2020, `Sebastian Thiel`</p>
</div>
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
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>
@@ -371,14 +277,30 @@ In the latter case it is advised to set the field-cursor to the data-structure's
</div>
<div class="rst-versions" role="note" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
<span><a href="../projects_databases-documents-run-query" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../projects_databases-export-documents" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
<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_beta1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../projects_databases-documents-run-query/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../projects_databases-export-documents/" 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>
</html>