OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-23 15:49:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

346
google_datastore1_cli/projects_commit/index.html
View File

@@ -1,192 +1,117 @@
<!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>Commit - datastore 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-datastore1-cli/projects_commit/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Commit - datastore 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 = "Commit";
var mkdocs_page_input_path = "projects_commit.md";
var mkdocs_page_url = "/google-apis-rs/google-datastore1-cli/projects_commit/";
</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"> datastore v3.0.0+20220221</a>
<a href=".." class="icon icon-home"> datastore 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_allocate-ids">Allocate Ids</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_begin-transaction">Begin Transaction</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Commit</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_export">Export</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_import">Import</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_indexes-create">Indexes Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_indexes-delete">Indexes Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_indexes-get">Indexes Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_indexes-list">Indexes List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_lookup">Lookup</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_operations-cancel">Operations Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_operations-delete">Operations Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_operations-get">Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_operations-list">Operations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_reserve-ids">Reserve Ids</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_rollback">Rollback</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_run-query">Run Query</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_allocate-ids/">Allocate Ids</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_begin-transaction/">Begin Transaction</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Commit</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_export/">Export</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_import/">Import</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_indexes-create/">Indexes Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_indexes-delete/">Indexes Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_indexes-get/">Indexes Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_indexes-list/">Indexes List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_lookup/">Lookup</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_operations-cancel/">Operations Cancel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_operations-delete/">Operations Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_operations-get/">Operations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_operations-list/">Operations List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_reserve-ids/">Reserve Ids</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_rollback/">Rollback</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_run-aggregation-query/">Run Aggregation Query</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_run-query/">Run Query</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="..">datastore 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>Commit</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/datastore1-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>Commit</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/datastore1-cli/edit/master/docs/projects_commit.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Commits a transaction, optionally creating, deleting or modifying some entities.</p>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<p>Commits a transaction, optionally creating, deleting or modifying some entities.</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>
@@ -207,18 +132,41 @@ You can set the scope for this method like this: <code>datastore1 --scope &lt;sc
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
<p>For example, a structure like this:</p>
<pre><code>CommitRequest:
database-id: string
mode: string
single-use-transaction:
read-only:
read-time: string
read-write:
previous-transaction: string
transaction: 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 . mode=magna</code><ul>
<li><code>-r . database-id=voluptua.</code><ul>
<li>The ID of the database against which to make the request. &#39;(default)&#39; is not allowed; please use empty string &#39;&#39; to refer the default database.</li>
</ul>
</li>
<li><code>mode=at</code><ul>
<li>The type of commit to perform. Defaults to <code>TRANSACTIONAL</code>.</li>
</ul>
</li>
<li><code>transaction=no</code><ul>
<li>
<p><code>single-use-transaction.read-only read-time=sanctus</code></p>
<ul>
<li>Reads entities at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.</li>
</ul>
</li>
<li>
<p><code>..read-write previous-transaction=sed</code></p>
<ul>
<li>The transaction identifier of the transaction being retried.</li>
</ul>
</li>
<li>
<p><code>... transaction=amet.</code></p>
<ul>
<li>The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction.</li>
</ul>
</li>
@@ -312,32 +260,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_export" class="btn btn-neutral float-right" title="Export"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../projects_begin-transaction" class="btn btn-neutral" title="Begin Transaction"><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_begin-transaction/" class="btn btn-neutral float-left" title="Begin Transaction"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../projects_export/" class="btn btn-neutral float-right" title="Export">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>
@@ -345,14 +285,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_begin-transaction" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../projects_export" 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/datastore1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../projects_begin-transaction/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../projects_export/" 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>