mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
444 lines
20 KiB
HTML
444 lines
20 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-sql1_beta4-cli/instances_export/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Export - SQL Admin v5.0.4+20200331</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 = "Export";
|
|
var mkdocs_page_input_path = "instances_export.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-sql1_beta4-cli/instances_export/";
|
|
</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"> SQL Admin v5.0.4+20200331
|
|
</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">Backup Runs</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../backup-runs_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../backup-runs_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../backup-runs_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../backup-runs_list/">List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Databases</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../databases_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../databases_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../databases_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../databases_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../databases_patch/">Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../databases_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Flags</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../flags_list/">List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Instances</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../instances_add-server-ca/">Add Server Ca</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../instances_clone/">Clone</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../instances_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../instances_demote-master/">Demote Master</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Export</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../instances_failover/">Failover</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../instances_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../instances_import/">Import</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../instances_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../instances_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../instances_list-server-cas/">List Server Cas</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../instances_patch/">Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../instances_promote-replica/">Promote Replica</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../instances_reset-ssl-config/">Reset Ssl Config</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../instances_restart/">Restart</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../instances_restore-backup/">Restore Backup</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../instances_rotate-server-ca/">Rotate Server Ca</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../instances_start-replica/">Start Replica</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../instances_stop-replica/">Stop Replica</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../instances_truncate-log/">Truncate Log</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../instances_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Operations</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../operations_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../operations_list/">List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Projects</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-reschedule-maintenance/">Instances Reschedule Maintenance</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-start-external-sync/">Instances Start External Sync</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-verify-external-sync-settings/">Instances Verify External Sync Settings</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Ssl Certs</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../ssl-certs_create-ephemeral/">Create Ephemeral</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../ssl-certs_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../ssl-certs_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../ssl-certs_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../ssl-certs_list/">List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Tiers</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../tiers_list/">List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Users</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../users_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../users_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../users_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../users_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="..">SQL Admin v5.0.4+20200331</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> »</li>
|
|
<li>Instances »</li>
|
|
<li>Export</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/sql1_beta4-cli/edit/master/docs/instances_export.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>Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL
|
|
dump or CSV file.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for the <em>https://www.googleapis.com/auth/cloud-platform</em> scope to make a valid call.</p>
|
|
<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>sql1-beta4 --scope <scope> instances export ...</code></p>
|
|
<h1 id="required-scalar-arguments">Required Scalar Arguments</h1>
|
|
<ul>
|
|
<li><strong><project></strong> <em>(string)</em><ul>
|
|
<li>Project ID of the project that contains the instance to be exported.</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong><instance></strong> <em>(string)</em><ul>
|
|
<li>Cloud SQL instance ID. This does not include the project ID.</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>InstancesExportRequest:
|
|
export-context:
|
|
csv-export-options:
|
|
select-query: string
|
|
databases: [string]
|
|
file-type: string
|
|
kind: string
|
|
sql-export-options:
|
|
mysql-export-options:
|
|
master-data: integer
|
|
schema-only: boolean
|
|
tables: [string]
|
|
uri: 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 .export-context.csv-export-options select-query=vero</code></p>
|
|
<ul>
|
|
<li>The select query used to extract the data.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. databases=invidunt</code></p>
|
|
<ul>
|
|
<li>Databases to be exported. <br /> <b>MySQL instances:</b> If
|
|
<code>fileType</code> is <code>SQL</code> and no database is specified, all
|
|
databases are exported, except for the <code>mysql</code> system database.
|
|
If <code>fileType</code> is <code>CSV</code>, you can specify one database,
|
|
either by using this property or by using the
|
|
<code>csvExportOptions.selectQuery</code> property, which takes precedence
|
|
over this property. <br /> <b>PostgreSQL instances:</b> You must specify
|
|
one database to be exported. If <code>fileType</code> is <code>CSV</code>,
|
|
this database must match the one specified in the
|
|
<code>csvExportOptions.selectQuery</code> property.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>file-type=stet</code><ul>
|
|
<li>The file type for the specified uri. <br><code>SQL</code>: The file
|
|
contains SQL statements. <br><code>CSV</code>: The file contains CSV data.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>kind=vero</code><ul>
|
|
<li>This is always <code>sql#exportContext</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>sql-export-options.mysql-export-options master-data=57</code></p>
|
|
<ul>
|
|
<li>Option to include SQL statement required to set up replication.
|
|
If set to <code>1</code>, the dump file includes
|
|
a CHANGE MASTER TO statement with the binary log coordinates.
|
|
If set to <code>2</code>, the CHANGE MASTER TO statement is written as
|
|
a SQL comment, and has no effect.
|
|
All other values are ignored.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. schema-only=true</code></p>
|
|
<ul>
|
|
<li>Export only schemas.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>tables=ipsum</code></p>
|
|
<ul>
|
|
<li>Tables to export, or that were exported, from the specified database. If
|
|
you specify tables, specify one and only one database. For PostgreSQL
|
|
instances, you can specify only one table.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. uri=accusam</code></p>
|
|
<ul>
|
|
<li>The path to the file in Google Cloud Storage where the export will be
|
|
stored. The URI is in the form <code>gs:
|
|
//bucketName/fileName</code>. If the file already exists, the requests
|
|
// succeeds, but the operation fails. If <code>fileType</code> is
|
|
// <code>SQL</code> and the filename ends with .gz, the contents are
|
|
// compressed.</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="../instances_demote-master/" class="btn btn-neutral float-left" title="Demote Master"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../instances_failover/" class="btn btn-neutral float-right" title="Failover">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
<p>Copyright © 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/sql1_beta4-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../instances_demote-master/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../instances_failover/" style="color: #fcfcfc">Next »</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>
|