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_bigquery2_cli/routines_insert/index.html
Sebastian Thiel a20241b241 Update documentation
2022-03-08 15:36:16 +08:00

561 lines
19 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>Insert - bigquery v3.0.0+20220222</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"> bigquery v3.0.0+20220222</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Datasets</span>
<li class="toctree-l1 ">
<a class="" href="../datasets_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../datasets_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../datasets_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../datasets_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../datasets_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../datasets_update">Update</a>
</li>
<span>Jobs</span>
<li class="toctree-l1 ">
<a class="" href="../jobs_cancel">Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../jobs_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../jobs_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../jobs_get-query-results">Get Query Results</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../jobs_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../jobs_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../jobs_query">Query</a>
</li>
<span>Models</span>
<li class="toctree-l1 ">
<a class="" href="../models_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../models_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../models_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../models_patch">Patch</a>
</li>
<span>Projects</span>
<li class="toctree-l1 ">
<a class="" href="../projects_get-service-account">Get Service Account</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_list">List</a>
</li>
<span>Routines</span>
<li class="toctree-l1 ">
<a class="" href="../routines_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../routines_get">Get</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Insert</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
<li class="toctree-l2"><a href="#required-scalar-arguments">Required Scalar Arguments</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="../routines_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../routines_update">Update</a>
</li>
<span>Row Access Policies</span>
<li class="toctree-l1 ">
<a class="" href="../row-access-policies_get-iam-policy">Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../row-access-policies_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../row-access-policies_set-iam-policy">Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../row-access-policies_test-iam-permissions">Test Iam Permissions</a>
</li>
<span>Tabledata</span>
<li class="toctree-l1 ">
<a class="" href="../tabledata_insert-all">Insert All</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tabledata_list">List</a>
</li>
<span>Tables</span>
<li class="toctree-l1 ">
<a class="" href="../tables_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tables_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tables_get-iam-policy">Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tables_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tables_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tables_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tables_set-iam-policy">Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tables_test-iam-permissions">Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tables_update">Update</a>
</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>Insert</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/bigquery2-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Creates a new routine in the dataset.</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/bigquery</em></li>
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
</ul>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery</em>.
You can set the scope for this method like this: <code>bigquery2 --scope &lt;scope&gt; routines insert ...</code></p>
<h1 id="required-scalar-arguments">Required Scalar Arguments</h1>
<ul>
<li><strong>&lt;project-id&gt;</strong> <em>(string)</em><ul>
<li>Required. Project ID of the new routine</li>
</ul>
</li>
<li><strong>&lt;dataset-id&gt;</strong> <em>(string)</em><ul>
<li>Required. Dataset ID of the new routine</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>Routine:
creation-time: string
definition-body: string
description: string
determinism-level: string
etag: string
imported-libraries: [string]
language: string
last-modified-time: string
return-type:
type-kind: string
routine-reference:
dataset-id: string
project-id: string
routine-id: string
routine-type: string
strict-mode: boolean
</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 . creation-time=accusam</code><ul>
<li>Output only. The time when this routine was created, in milliseconds since the epoch.</li>
</ul>
</li>
<li><code>definition-body=dolores</code><ul>
<li>Required. The body of the routine. For functions, this is the expression in the AS clause. If language=SQL, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: <code>CREATE FUNCTION JoinLines(x string, y string) as (concat(x, &amp;#34;\n&amp;#34;, y))</code> The definition_body is <code>concat(x, &amp;#34;\n&amp;#34;, y)</code> (\n is not replaced with linebreak). If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement: <code>CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS &amp;#39;return &amp;#34;\n&amp;#34;;\n&amp;#39;</code> The definition_body is <code>return &amp;#34;\n&amp;#34;;\n</code> Note that both \n are replaced with linebreaks.</li>
</ul>
</li>
<li><code>description=consetetur</code><ul>
<li>Optional. The description of the routine, if defined.</li>
</ul>
</li>
<li><code>determinism-level=no</code><ul>
<li>Optional. The determinism level of the JavaScript UDF, if defined.</li>
</ul>
</li>
<li><code>etag=justo</code><ul>
<li>Output only. A hash of this resource.</li>
</ul>
</li>
<li><code>imported-libraries=sadipscing</code><ul>
<li>Optional. If language = &#34;JAVASCRIPT&#34;, this field stores the path of the imported JAVASCRIPT libraries.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>language=diam</code><ul>
<li>Optional. Defaults to &#34;SQL&#34;.</li>
</ul>
</li>
<li><code>last-modified-time=sea</code><ul>
<li>Output only. The time when this routine was last modified, in milliseconds since the epoch.</li>
</ul>
</li>
<li>
<p><code>return-type type-kind=ipsum</code></p>
<ul>
<li>Required. The top level type of this field. Can be any standard SQL data type (e.g., &#34;INT64&#34;, &#34;DATE&#34;, &#34;ARRAY&#34;).</li>
</ul>
</li>
<li>
<p><code>..routine-reference dataset-id=stet</code></p>
<ul>
<li>[Required] The ID of the dataset containing this routine.</li>
</ul>
</li>
<li><code>project-id=gubergren</code><ul>
<li>[Required] The ID of the project containing this routine.</li>
</ul>
</li>
<li>
<p><code>routine-id=ipsum</code></p>
<ul>
<li>[Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.</li>
</ul>
</li>
<li>
<p><code>.. routine-type=no</code></p>
<ul>
<li>Required. The type of routine.</li>
</ul>
</li>
<li><code>strict-mode=false</code><ul>
<li>Optional. Can be set for procedures only. If true (default), the definition body will be validated in the creation and the updates of the procedure. For procedures with an argument of ANY TYPE, the definition body validtion is not supported at creation/update time, and thus this field must be set to false explicitly.</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 alt=string</strong></p>
<ul>
<li>Data format for the response.</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>An opaque string that represents a user for quota purposes. Must not exceed 40 characters.</li>
</ul>
</li>
<li>
<p><strong>-p user-ip=string</strong></p>
<ul>
<li>Deprecated. Please use quotaUser instead.</li>
</ul>
</li>
</ul>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../routines_list" class="btn btn-neutral float-right" title="List"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../routines_get" class="btn btn-neutral" title="Get"><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="../routines_get" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../routines_list" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink