mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
587 lines
20 KiB
HTML
587 lines
20 KiB
HTML
<!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>Databases Documents Run Query - 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>
|
|
</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"> Firestore 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_databases-collection-groups-fields-get">Databases Collection Groups Fields Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_databases-collection-groups-fields-list">Databases Collection Groups Fields List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_databases-collection-groups-fields-patch">Databases Collection Groups Fields Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_databases-collection-groups-indexes-create">Databases Collection Groups Indexes Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_databases-collection-groups-indexes-delete">Databases Collection Groups Indexes Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_databases-collection-groups-indexes-get">Databases Collection Groups Indexes Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_databases-collection-groups-indexes-list">Databases Collection Groups Indexes List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_databases-documents-batch-get">Databases Documents Batch Get</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 current">
|
|
<a class="current" href=".">Databases Documents 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>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_databases-documents-write">Databases Documents Write</a>
|
|
|
|
</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-get">Databases Get</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-list">Databases List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_databases-operations-cancel">Databases Operations Cancel</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_databases-operations-delete">Databases Operations Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_databases-operations-get">Databases Operations Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_databases-operations-list">Databases Operations List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_databases-patch">Databases Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-get">Locations Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-list">Locations List</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</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>
|
|
|
|
|
|
<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> »</li>
|
|
<li>Databases Documents Run Query</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/firestore1-cli" class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
<p>Runs a query.</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 <scope> projects databases-documents-run-query ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><parent></strong> <em>(string)</em><ul>
|
|
<li>Required. The parent resource name. In the format: <code>projects/{project_id}/databases/{database_id}/documents</code> or <code>projects/{project_id}/databases/{database_id}/documents/{document_path}</code>. For example: <code>projects/my-project/databases/my-database/documents</code> or <code>projects/my-project/databases/my-database/documents/chatrooms/my-chatroom</code></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:
|
|
new-transaction:
|
|
read-only:
|
|
read-time: string
|
|
read-write:
|
|
retry-transaction: string
|
|
read-time: string
|
|
structured-query:
|
|
end-at:
|
|
before: boolean
|
|
limit: integer
|
|
offset: integer
|
|
start-at:
|
|
before: boolean
|
|
where:
|
|
composite-filter:
|
|
op: string
|
|
field-filter:
|
|
field:
|
|
field-path: string
|
|
op: string
|
|
value:
|
|
boolean-value: boolean
|
|
bytes-value: string
|
|
double-value: number
|
|
geo-point-value:
|
|
latitude: number
|
|
longitude: number
|
|
integer-value: string
|
|
null-value: string
|
|
reference-value: string
|
|
string-value: string
|
|
timestamp-value: string
|
|
unary-filter:
|
|
field:
|
|
field-path: string
|
|
op: 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>
|
|
<p><code>-r .new-transaction.read-only read-time=sed</code></p>
|
|
<ul>
|
|
<li>Reads documents at the given time. This may not be older than 60 seconds.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..read-write retry-transaction=takimata</code></p>
|
|
<ul>
|
|
<li>An optional transaction to retry.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>... read-time=dolores</code></p>
|
|
<ul>
|
|
<li>Reads documents as they were at the given time. This may not be older than 270 seconds.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>structured-query.end-at before=true</code></p>
|
|
<ul>
|
|
<li>If the position is just before or just after the given values, relative to the sort order defined by the query.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. limit=27</code></p>
|
|
<ul>
|
|
<li>The maximum number of results to return. Applies after all other constraints. Must be >= 0 if specified.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>offset=78</code><ul>
|
|
<li>The number of results to skip. Applies before limit, but after all other constraints. Must be >= 0 if specified.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>start-at before=false</code></p>
|
|
<ul>
|
|
<li>If the position is just before or just after the given values, relative to the sort order defined by the query.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..where.composite-filter op=dolore</code></p>
|
|
<ul>
|
|
<li>The operator for combining multiple filters.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..field-filter.field field-path=dolore</code></p>
|
|
<ul>
|
|
<li>No description provided.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. op=dolore</code></p>
|
|
<ul>
|
|
<li>The operator to filter by.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>value boolean-value=false</code><ul>
|
|
<li>A boolean value.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>bytes-value=amet.</code><ul>
|
|
<li>A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>double-value=0.6626374874296354</code><ul>
|
|
<li>A double value.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>geo-point-value latitude=0.7463638372321394</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.7036393712200139</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=at</code></p>
|
|
<ul>
|
|
<li>An integer value.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>null-value=sed</code><ul>
|
|
<li>A null value.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>reference-value=sit</code><ul>
|
|
<li>A reference to a document. For example: <code>projects/{project_id}/databases/{database_id}/documents/{document_path}</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>string-value=et</code><ul>
|
|
<li>A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>timestamp-value=tempor</code></p>
|
|
<ul>
|
|
<li>A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>...unary-filter.field field-path=aliquyam</code></p>
|
|
<ul>
|
|
<li>No description provided.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. op=ipsum</code></p>
|
|
<ul>
|
|
<li>The unary operator to apply.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.... transaction=et</code></p>
|
|
<ul>
|
|
<li>Run the query within an already active transaction. The value here is the opaque transaction ID to execute the query in.</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. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="../projects_databases-documents-write" class="btn btn-neutral float-right" title="Databases Documents Write"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href="../projects_databases-documents-rollback" class="btn btn-neutral" title="Databases Documents 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_databases-documents-rollback" style="color: #fcfcfc;">« Previous</a></span>
|
|
<span style="margin-left: 15px"><a href="../projects_databases-documents-write" style="color: #fcfcfc">Next »</a></span>
|
|
</span>
|
|
</div>
|
|
</body>
|
|
</html> |