Files
google-apis-rs/google_fusiontables2_cli/column_patch/index.html
2024-03-05 21:06:01 +01:00

378 lines
17 KiB
HTML

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<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-fusiontables2-cli/column_patch/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Patch - fusiontables v5.0.4+20171117</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 = "Patch";
var mkdocs_page_input_path = "column_patch.md";
var mkdocs_page_url = "/google-apis-rs/google-fusiontables2-cli/column_patch/";
</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"> fusiontables v5.0.4+20171117
</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="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Column</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../column_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../column_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../column_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../column_list/">List</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Patch</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../column_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Query</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../query_sql/">Sql</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../query_sql-get/">Sql Get</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Style</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../style_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../style_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../style_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../style_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../style_patch/">Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../style_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Table</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../table_copy/">Copy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../table_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../table_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../table_import-rows/">Import Rows</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../table_import-table/">Import Table</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../table_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../table_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../table_patch/">Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../table_refetch-sheet/">Refetch Sheet</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../table_replace-rows/">Replace Rows</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../table_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Task</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../task_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../task_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../task_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Template</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../template_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../template_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../template_insert/">Insert</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../template_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../template_patch/">Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../template_update/">Update</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<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="..">fusiontables v5.0.4+20171117</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=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Column &raquo;</li>
<li>Patch</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/fusiontables2-cli/edit/master/docs/column_patch.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<p>Updates the name or type of an existing column. This method supports patch semantics.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for the <em>https://www.googleapis.com/auth/fusiontables</em> scope to make a valid call.</p>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/fusiontables</em>.
You can set the scope for this method like this: <code>fusiontables2 --scope &lt;scope&gt; column patch ...</code></p>
<h1 id="required-scalar-arguments">Required Scalar Arguments</h1>
<ul>
<li><strong>&lt;table-id&gt;</strong> <em>(string)</em><ul>
<li>Table for which the column is being updated.</li>
</ul>
</li>
<li><strong>&lt;column-id&gt;</strong> <em>(string)</em><ul>
<li>Name or identifier for the column that is being updated.</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>Column:
base-column:
column-id: integer
table-index: integer
column-id: integer
column-json-schema: string
column-properties-json: string
description: string
format-pattern: string
graph-predicate: string
kind: string
name: string
type: string
valid-values: [string]
validate-data: 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 .base-column column-id=39</code><ul>
<li>The id of the column in the base table from which this column is derived.</li>
</ul>
</li>
<li>
<p><code>table-index=50</code></p>
<ul>
<li>Offset to the entry in the list of base tables in the table definition.</li>
</ul>
</li>
<li>
<p><code>.. column-id=89</code></p>
<ul>
<li>Identifier for the column.</li>
</ul>
</li>
<li><code>column-json-schema=eos</code><ul>
<li>JSON schema for interpreting JSON in this column.</li>
</ul>
</li>
<li><code>column-properties-json=dolor</code><ul>
<li>JSON object containing custom column properties.</li>
</ul>
</li>
<li><code>description=ea</code><ul>
<li>Column description.</li>
</ul>
</li>
<li><code>format-pattern=ipsum</code><ul>
<li>Format pattern.
Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail</li>
</ul>
</li>
<li><code>graph-predicate=invidunt</code><ul>
<li>Column graph predicate.
Used to map table to graph data model (subject,predicate,object)
See W3C Graph-based Data Model.</li>
</ul>
</li>
<li><code>kind=amet</code><ul>
<li>The kind of item this is. For a column, this is always fusiontables#column.</li>
</ul>
</li>
<li><code>name=duo</code><ul>
<li>Name of the column.</li>
</ul>
</li>
<li><code>type=ipsum</code><ul>
<li>Type of the column.</li>
</ul>
</li>
<li><code>valid-values=sed</code><ul>
<li>List of valid values used to validate data and supply a drop-down list of values in the web application.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>validate-data=true</code><ul>
<li>If true, data entered via the web application is validated.</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="../column_list/" class="btn btn-neutral float-left" title="List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../column_update/" class="btn btn-neutral float-right" title="Update">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
<p>Copyright &copy; 2015-2020, `Sebastian Thiel`</p>
</div>
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>
</section>
</div>
<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/fusiontables2-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../column_list/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../column_update/" 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>