Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: sqladmin1 --scope <scope> instances export ...

Required Scalar Arguments

  • <project> (string)
    • Project ID of the project that contains the instance to be exported.
  • <instance> (string)
    • Cloud SQL instance ID. This does not include the project ID.

Required Request Value

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.

For example, a structure like this:

InstancesExportRequest:
  export-context:
    bak-export-options:
      bak-type: string
      copy-only: boolean
      differential-base: boolean
      stripe-count: integer
      striped: boolean
    csv-export-options:
      escape-character: string
      fields-terminated-by: string
      lines-terminated-by: string
      quote-character: string
      select-query: string
    databases: [string]
    file-type: string
    kind: string
    offload: boolean
    sql-export-options:
      mysql-export-options:
        master-data: integer
      parallel: boolean
      schema-only: boolean
      tables: [string]
      threads: integer
    uri: string

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.

  • -r .export-context.bak-export-options bak-type=voluptua.
    • Type of this bak file will be export, FULL or DIFF, SQL Server only
  • copy-only=false
    • Deprecated: copy_only is deprecated. Use differential_base instead
  • differential-base=false
    • Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base
  • stripe-count=99
    • Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen.

  • striped=true

    • Whether or not the export should be striped.

  • ..csv-export-options escape-character=et

    • Specifies the character that should appear before a data character that needs to be escaped.
  • fields-terminated-by=accusam
    • Specifies the character that separates columns within each row (line) of the file.
  • lines-terminated-by=voluptua.
    • This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
  • quote-character=dolore
    • Specifies the quoting character to be used when a data value is quoted.

  • select-query=dolore

    • The select query used to extract the data.

  • .. databases=dolore

    • Databases to be exported. MySQL instances: If fileType is SQL and no database is specified, all databases are exported, except for the mysql system database. If fileType is CSV, you can specify one database, either by using this property or by using the csvExportOptions.selectQuery property, which takes precedence over this property. PostgreSQL instances: You must specify one database to be exported. If fileType is CSV, this database must match the one specified in the csvExportOptions.selectQuery property. SQL Server instances: You must specify one database to be exported, and the fileType must be BAK.
    • Each invocation of this argument appends the given value to the array.
  • file-type=voluptua.
    • The file type for the specified uri.
  • kind=amet.
    • This is always sql#exportContext.
  • offload=false
    • Option for export offload.

  • sql-export-options.mysql-export-options master-data=95

    • Option to include SQL statement required to set up replication. If set to 1, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to 2, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than 1, --set-gtid-purged is set to OFF.

  • .. parallel=true

    • Optional. Whether or not the export should be parallel.
  • schema-only=true
    • Export only schemas.
  • tables=sit
    • 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.
    • Each invocation of this argument appends the given value to the array.

  • threads=66

    • Optional. The number of threads to use for parallel export.

  • .. uri=tempor

    • The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the request succeeds, but the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • 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 -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • 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.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • 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.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").