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
a20241b2412723b0062d1c19a8ec792837b145a4
google-apis-rs/google_datastore1_beta3_cli/projects_run-query/index.html
Sebastian Thiel a20241b241 Update documentation
2022-03-08 15:36:16 +08:00

487 lines
16 KiB
HTML
Raw Blame History

<!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]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Run Query - 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>
</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-nav-search">
<a href=".." class="icon icon-home"> datastore v3.0.0+20220221</a>
</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>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_begin-transaction">Begin Transaction</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_commit">Commit</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_lookup">Lookup</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 current">
<a class="current" href=".">Run Query</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>
</ul>
</div>
&nbsp;
</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>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="..">Docs</a> &raquo;</li>
<li>Run Query</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/datastore1_beta3-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Queries for 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>
<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>datastore1-beta3 --scope &lt;scope&gt; projects run-query ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;project-id&gt;</strong> <em>(string)</em><ul>
<li>Required. The ID of the project against which to make the request.</li>
</ul>
</li>
</ul>
<h1 id="required-request-value">Required Request Value</h1>
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
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>RunQueryRequest:
gql-query:
allow-literals: boolean
query-string: string
partition-id:
namespace-id: string
project-id: string
query:
end-cursor: string
filter:
composite-filter:
op: string
property-filter:
op: string
property:
name: string
value:
blob-value: string
boolean-value: boolean
double-value: number
entity-value:
key:
partition-id:
namespace-id: string
project-id: string
exclude-from-indexes: boolean
geo-point-value:
latitude: number
longitude: number
integer-value: string
key-value:
partition-id:
namespace-id: string
project-id: string
meaning: integer
null-value: string
string-value: string
timestamp-value: string
limit: integer
offset: integer
start-cursor: string
read-options:
read-consistency: 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 .gql-query allow-literals=false</code><ul>
<li>When false, the query string must not contain any literals and instead must bind all values. For example, <code>SELECT * FROM Kind WHERE a = &amp;#39;string literal&amp;#39;</code> is not allowed, while <code>SELECT * FROM Kind WHERE a = @value</code> is.</li>
</ul>
</li>
<li>
<p><code>query-string=amet.</code></p>
<ul>
<li>A string of the format described <a href="https://cloud.google.com/datastore/docs/apis/gql/gql_reference">here</a>.</li>
</ul>
</li>
<li>
<p><code>..partition-id namespace-id=takimata</code></p>
<ul>
<li>If not empty, the ID of the namespace to which the entities belong.</li>
</ul>
</li>
<li>
<p><code>project-id=amet.</code></p>
<ul>
<li>The ID of the project to which the entities belong.</li>
</ul>
</li>
<li>
<p><code>..query end-cursor=duo</code></p>
<ul>
<li>An ending point for the query results. Query cursors are returned in query result batches and <a href="https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets">can only be used to limit the same query</a>.</li>
</ul>
</li>
<li>
<p><code>filter.composite-filter op=ipsum</code></p>
<ul>
<li>The operator for combining multiple filters.</li>
</ul>
</li>
<li>
<p><code>..property-filter op=gubergren</code></p>
<ul>
<li>The operator to filter by.</li>
</ul>
</li>
<li>
<p><code>property name=lorem</code></p>
<ul>
<li>The name of the property. If name includes &#34;.&#34;s, it may be interpreted as a property name path.</li>
</ul>
</li>
<li>
<p><code>..value blob-value=gubergren</code></p>
<ul>
<li>A blob value. May have at most 1,000,000 bytes. When <code>exclude_from_indexes</code> is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.</li>
</ul>
</li>
<li><code>boolean-value=false</code><ul>
<li>A boolean value.</li>
</ul>
</li>
<li><code>double-value=0.7615363125225725</code><ul>
<li>A double value.</li>
</ul>
</li>
<li><code>entity-value.key.partition-id namespace-id=ipsum</code><ul>
<li>If not empty, the ID of the namespace to which the entities belong.</li>
</ul>
</li>
<li>
<p><code>project-id=invidunt</code></p>
<ul>
<li>The ID of the project to which the entities belong.</li>
</ul>
</li>
<li>
<p><code>.... exclude-from-indexes=true</code></p>
<ul>
<li>If the value should be excluded from all indexes including those defined explicitly.</li>
</ul>
</li>
<li><code>geo-point-value latitude=0.8204376297831348</code><ul>
<li>The latitude in degrees. It must be in the range [-90.0, +90.0].</li>
</ul>
</li>
<li>
<p><code>longitude=0.39873905405496446</code></p>
<ul>
<li>The longitude in degrees. It must be in the range [-180.0, +180.0].</li>
</ul>
</li>
<li>
<p><code>.. integer-value=sed</code></p>
<ul>
<li>An integer value.</li>
</ul>
</li>
<li><code>key-value.partition-id namespace-id=ut</code><ul>
<li>If not empty, the ID of the namespace to which the entities belong.</li>
</ul>
</li>
<li>
<p><code>project-id=gubergren</code></p>
<ul>
<li>The ID of the project to which the entities belong.</li>
</ul>
</li>
<li>
<p><code>... meaning=85</code></p>
<ul>
<li>The <code>meaning</code> field should only be populated for backwards compatibility.</li>
</ul>
</li>
<li><code>null-value=est</code><ul>
<li>A null value.</li>
</ul>
</li>
<li><code>string-value=ipsum</code><ul>
<li>A UTF-8 encoded string value. When <code>exclude_from_indexes</code> is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.</li>
</ul>
</li>
<li>
<p><code>timestamp-value=ipsum</code></p>
<ul>
<li>A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.</li>
</ul>
</li>
<li>
<p><code>.... limit=94</code></p>
<ul>
<li>The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be &gt;= 0 if specified.</li>
</ul>
</li>
<li><code>offset=39</code><ul>
<li>The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be &gt;= 0 if specified.</li>
</ul>
</li>
<li>
<p><code>start-cursor=ea</code></p>
<ul>
<li>A starting point for the query results. Query cursors are returned in query result batches and <a href="https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets">can only be used to continue the same query</a>.</li>
</ul>
</li>
<li>
<p><code>..read-options read-consistency=dolor</code></p>
<ul>
<li>The non-transactional read consistency to use. Cannot be set to <code>STRONG</code> for global queries.</li>
</ul>
</li>
<li><code>transaction=lorem</code><ul>
<li>The identifier of the transaction in which to read. A transaction identifier is returned by a call to Datastore.BeginTransaction.</li>
</ul>
</li>
</ul>
<h3 id="about-cursors">About Cursors</h3>
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
<ul>
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</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-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_rollback" class="btn btn-neutral" title="Rollback"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
<!-- Copyright etc -->
</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>.
</footer>
</div>
</div>
</section>
</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_rollback" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink