Class: Google::Cloud::Sql::V1beta4::ExportContext

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb

Overview

Database instance export context.

Defined Under Namespace

Classes: SqlBakExportOptions, SqlCsvExportOptions, SqlExportOptions, SqlTdeExportOptions

Instance Attribute Summary collapse

Instance Attribute Details

#bak_export_options ⇒ ::Google::Cloud::Sql::V1beta4::ExportContext::SqlBakExportOptions

Returns Options for exporting data as BAK files.

Returns:



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
 
# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 1273

class ExportContext
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] select_query
  #   @return [::String]
  #     The select query used to extract the data.
  # @!attribute [rw] escape_character
  #   @return [::String]
  #     Specifies the character that should appear before a data character that
  #     needs to be escaped.
  # @!attribute [rw] quote_character
  #   @return [::String]
  #     Specifies the quoting character to be used when a data value is quoted.
  # @!attribute [rw] fields_terminated_by
  #   @return [::String]
  #     Specifies the character that separates columns within each row (line) of
  #     the file.
  # @!attribute [rw] lines_terminated_by
  #   @return [::String]
  #     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.
  class SqlCsvExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] tables
  #   @return [::Array<::String>]
  #     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.
  # @!attribute [rw] schema_only
  #   @return [::Google::Protobuf::BoolValue]
  #     Export only schemas.
  # @!attribute [rw] mysql_export_options
  #   @return [::Google::Cloud::Sql::V1beta4::ExportContext::SqlExportOptions::MysqlExportOptions]
  # @!attribute [rw] threads
  #   @return [::Google::Protobuf::Int32Value]
  #     Optional. The number of threads to use for parallel export.
  # @!attribute [rw] parallel
  #   @return [::Google::Protobuf::BoolValue]
  #     Optional. Whether or not the export should be parallel.
  # @!attribute [rw] postgres_export_options
  #   @return [::Google::Cloud::Sql::V1beta4::ExportContext::SqlExportOptions::PostgresExportOptions]
  #     Optional. Options for exporting from a Cloud SQL for PostgreSQL instance.
  class SqlExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Options for exporting from MySQL.
    # @!attribute [rw] master_data
    #   @return [::Google::Protobuf::Int32Value]
    #     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.
    class MysqlExportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Options for exporting from a Cloud SQL for PostgreSQL instance.
    # @!attribute [rw] clean
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Use this option to include DROP <code>&lt;object&gt;</code>
    #     SQL statements. Use these statements to delete database objects before
    #     running the import operation.
    # @!attribute [rw] if_exists
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Option to include an IF EXISTS SQL statement with each DROP
    #     statement produced by clean.
    class PostgresExportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Options for exporting BAK files (SQL Server-only)
  # @!attribute [rw] striped
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the export should be striped.
  # @!attribute [rw] stripe_count
  #   @return [::Google::Protobuf::Int32Value]
  #     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.
  # @!attribute [rw] bak_type
  #   @return [::Google::Cloud::Sql::V1beta4::BakType]
  #     Type of this bak file will be export, FULL or DIFF, SQL Server only
  # @!attribute [rw] copy_only
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::BoolValue]
  #     Deprecated: copy_only is deprecated. Use differential_base instead
  # @!attribute [rw] differential_base
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup can be used as a differential base
  #     copy_only backup can not be served as differential base
  # @!attribute [rw] export_log_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The begin timestamp when transaction log will be included in
  #     the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339)
  #     format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all
  #     available logs from the beginning of retention period will be included.
  #     Only applied to Cloud SQL for SQL Server.
  # @!attribute [rw] export_log_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The end timestamp when transaction log will be included in the
  #     export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format
  #     (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all
  #     available logs until current time will be included. Only applied to Cloud
  #     SQL for SQL Server.
  class SqlBakExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] certificate_path
  #   @return [::String]
  #     Required. Path to the TDE certificate public key
  #     in the form gs://bucketName/fileName.
  #     The instance must have write access to the location.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_path
  #   @return [::String]
  #     Required. Path to the TDE certificate private key
  #     in the form gs://bucketName/fileName.
  #     The instance must have write access to the location.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_password
  #   @return [::String]
  #     Required. Password that encrypts the private key.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Certificate name.
  #     Applicable only for SQL Server instances.
  class SqlTdeExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#csv_export_options ⇒ ::Google::Cloud::Sql::V1beta4::ExportContext::SqlCsvExportOptions

Returns Options for exporting data as CSV. MySQL and PostgreSQL instances only.

Returns:



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
 
# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 1273

class ExportContext
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] select_query
  #   @return [::String]
  #     The select query used to extract the data.
  # @!attribute [rw] escape_character
  #   @return [::String]
  #     Specifies the character that should appear before a data character that
  #     needs to be escaped.
  # @!attribute [rw] quote_character
  #   @return [::String]
  #     Specifies the quoting character to be used when a data value is quoted.
  # @!attribute [rw] fields_terminated_by
  #   @return [::String]
  #     Specifies the character that separates columns within each row (line) of
  #     the file.
  # @!attribute [rw] lines_terminated_by
  #   @return [::String]
  #     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.
  class SqlCsvExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] tables
  #   @return [::Array<::String>]
  #     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.
  # @!attribute [rw] schema_only
  #   @return [::Google::Protobuf::BoolValue]
  #     Export only schemas.
  # @!attribute [rw] mysql_export_options
  #   @return [::Google::Cloud::Sql::V1beta4::ExportContext::SqlExportOptions::MysqlExportOptions]
  # @!attribute [rw] threads
  #   @return [::Google::Protobuf::Int32Value]
  #     Optional. The number of threads to use for parallel export.
  # @!attribute [rw] parallel
  #   @return [::Google::Protobuf::BoolValue]
  #     Optional. Whether or not the export should be parallel.
  # @!attribute [rw] postgres_export_options
  #   @return [::Google::Cloud::Sql::V1beta4::ExportContext::SqlExportOptions::PostgresExportOptions]
  #     Optional. Options for exporting from a Cloud SQL for PostgreSQL instance.
  class SqlExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Options for exporting from MySQL.
    # @!attribute [rw] master_data
    #   @return [::Google::Protobuf::Int32Value]
    #     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.
    class MysqlExportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Options for exporting from a Cloud SQL for PostgreSQL instance.
    # @!attribute [rw] clean
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Use this option to include DROP <code>&lt;object&gt;</code>
    #     SQL statements. Use these statements to delete database objects before
    #     running the import operation.
    # @!attribute [rw] if_exists
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Option to include an IF EXISTS SQL statement with each DROP
    #     statement produced by clean.
    class PostgresExportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Options for exporting BAK files (SQL Server-only)
  # @!attribute [rw] striped
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the export should be striped.
  # @!attribute [rw] stripe_count
  #   @return [::Google::Protobuf::Int32Value]
  #     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.
  # @!attribute [rw] bak_type
  #   @return [::Google::Cloud::Sql::V1beta4::BakType]
  #     Type of this bak file will be export, FULL or DIFF, SQL Server only
  # @!attribute [rw] copy_only
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::BoolValue]
  #     Deprecated: copy_only is deprecated. Use differential_base instead
  # @!attribute [rw] differential_base
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup can be used as a differential base
  #     copy_only backup can not be served as differential base
  # @!attribute [rw] export_log_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The begin timestamp when transaction log will be included in
  #     the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339)
  #     format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all
  #     available logs from the beginning of retention period will be included.
  #     Only applied to Cloud SQL for SQL Server.
  # @!attribute [rw] export_log_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The end timestamp when transaction log will be included in the
  #     export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format
  #     (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all
  #     available logs until current time will be included. Only applied to Cloud
  #     SQL for SQL Server.
  class SqlBakExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] certificate_path
  #   @return [::String]
  #     Required. Path to the TDE certificate public key
  #     in the form gs://bucketName/fileName.
  #     The instance must have write access to the location.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_path
  #   @return [::String]
  #     Required. Path to the TDE certificate private key
  #     in the form gs://bucketName/fileName.
  #     The instance must have write access to the location.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_password
  #   @return [::String]
  #     Required. Password that encrypts the private key.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Certificate name.
  #     Applicable only for SQL Server instances.
  class SqlTdeExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#databases ⇒ ::Array<::String>

Returns 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: If you don't specify a database by name, all user databases in the instance are exported. This excludes system databases and Cloud SQL databases used to manage internal operations. Exporting all user databases is only available for directory-formatted parallel export. 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.

Returns:

  • (::Array<::String>) —

    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: If you don't specify a database by name, all user databases in the instance are exported. This excludes system databases and Cloud SQL databases used to manage internal operations. Exporting all user databases is only available for directory-formatted parallel export. 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.



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
 
# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 1273

class ExportContext
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] select_query
  #   @return [::String]
  #     The select query used to extract the data.
  # @!attribute [rw] escape_character
  #   @return [::String]
  #     Specifies the character that should appear before a data character that
  #     needs to be escaped.
  # @!attribute [rw] quote_character
  #   @return [::String]
  #     Specifies the quoting character to be used when a data value is quoted.
  # @!attribute [rw] fields_terminated_by
  #   @return [::String]
  #     Specifies the character that separates columns within each row (line) of
  #     the file.
  # @!attribute [rw] lines_terminated_by
  #   @return [::String]
  #     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.
  class SqlCsvExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] tables
  #   @return [::Array<::String>]
  #     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.
  # @!attribute [rw] schema_only
  #   @return [::Google::Protobuf::BoolValue]
  #     Export only schemas.
  # @!attribute [rw] mysql_export_options
  #   @return [::Google::Cloud::Sql::V1beta4::ExportContext::SqlExportOptions::MysqlExportOptions]
  # @!attribute [rw] threads
  #   @return [::Google::Protobuf::Int32Value]
  #     Optional. The number of threads to use for parallel export.
  # @!attribute [rw] parallel
  #   @return [::Google::Protobuf::BoolValue]
  #     Optional. Whether or not the export should be parallel.
  # @!attribute [rw] postgres_export_options
  #   @return [::Google::Cloud::Sql::V1beta4::ExportContext::SqlExportOptions::PostgresExportOptions]
  #     Optional. Options for exporting from a Cloud SQL for PostgreSQL instance.
  class SqlExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Options for exporting from MySQL.
    # @!attribute [rw] master_data
    #   @return [::Google::Protobuf::Int32Value]
    #     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.
    class MysqlExportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Options for exporting from a Cloud SQL for PostgreSQL instance.
    # @!attribute [rw] clean
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Use this option to include DROP <code>&lt;object&gt;</code>
    #     SQL statements. Use these statements to delete database objects before
    #     running the import operation.
    # @!attribute [rw] if_exists
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Option to include an IF EXISTS SQL statement with each DROP
    #     statement produced by clean.
    class PostgresExportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Options for exporting BAK files (SQL Server-only)
  # @!attribute [rw] striped
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the export should be striped.
  # @!attribute [rw] stripe_count
  #   @return [::Google::Protobuf::Int32Value]
  #     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.
  # @!attribute [rw] bak_type
  #   @return [::Google::Cloud::Sql::V1beta4::BakType]
  #     Type of this bak file will be export, FULL or DIFF, SQL Server only
  # @!attribute [rw] copy_only
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::BoolValue]
  #     Deprecated: copy_only is deprecated. Use differential_base instead
  # @!attribute [rw] differential_base
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup can be used as a differential base
  #     copy_only backup can not be served as differential base
  # @!attribute [rw] export_log_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The begin timestamp when transaction log will be included in
  #     the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339)
  #     format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all
  #     available logs from the beginning of retention period will be included.
  #     Only applied to Cloud SQL for SQL Server.
  # @!attribute [rw] export_log_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The end timestamp when transaction log will be included in the
  #     export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format
  #     (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all
  #     available logs until current time will be included. Only applied to Cloud
  #     SQL for SQL Server.
  class SqlBakExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] certificate_path
  #   @return [::String]
  #     Required. Path to the TDE certificate public key
  #     in the form gs://bucketName/fileName.
  #     The instance must have write access to the location.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_path
  #   @return [::String]
  #     Required. Path to the TDE certificate private key
  #     in the form gs://bucketName/fileName.
  #     The instance must have write access to the location.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_password
  #   @return [::String]
  #     Required. Password that encrypts the private key.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Certificate name.
  #     Applicable only for SQL Server instances.
  class SqlTdeExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#file_type ⇒ ::Google::Cloud::Sql::V1beta4::SqlFileType

Returns The file type for the specified uri.

Returns:



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
 
# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 1273

class ExportContext
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] select_query
  #   @return [::String]
  #     The select query used to extract the data.
  # @!attribute [rw] escape_character
  #   @return [::String]
  #     Specifies the character that should appear before a data character that
  #     needs to be escaped.
  # @!attribute [rw] quote_character
  #   @return [::String]
  #     Specifies the quoting character to be used when a data value is quoted.
  # @!attribute [rw] fields_terminated_by
  #   @return [::String]
  #     Specifies the character that separates columns within each row (line) of
  #     the file.
  # @!attribute [rw] lines_terminated_by
  #   @return [::String]
  #     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.
  class SqlCsvExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] tables
  #   @return [::Array<::String>]
  #     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.
  # @!attribute [rw] schema_only
  #   @return [::Google::Protobuf::BoolValue]
  #     Export only schemas.
  # @!attribute [rw] mysql_export_options
  #   @return [::Google::Cloud::Sql::V1beta4::ExportContext::SqlExportOptions::MysqlExportOptions]
  # @!attribute [rw] threads
  #   @return [::Google::Protobuf::Int32Value]
  #     Optional. The number of threads to use for parallel export.
  # @!attribute [rw] parallel
  #   @return [::Google::Protobuf::BoolValue]
  #     Optional. Whether or not the export should be parallel.
  # @!attribute [rw] postgres_export_options
  #   @return [::Google::Cloud::Sql::V1beta4::ExportContext::SqlExportOptions::PostgresExportOptions]
  #     Optional. Options for exporting from a Cloud SQL for PostgreSQL instance.
  class SqlExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Options for exporting from MySQL.
    # @!attribute [rw] master_data
    #   @return [::Google::Protobuf::Int32Value]
    #     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.
    class MysqlExportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Options for exporting from a Cloud SQL for PostgreSQL instance.
    # @!attribute [rw] clean
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Use this option to include DROP <code>&lt;object&gt;</code>
    #     SQL statements. Use these statements to delete database objects before
    #     running the import operation.
    # @!attribute [rw] if_exists
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Option to include an IF EXISTS SQL statement with each DROP
    #     statement produced by clean.
    class PostgresExportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Options for exporting BAK files (SQL Server-only)
  # @!attribute [rw] striped
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the export should be striped.
  # @!attribute [rw] stripe_count
  #   @return [::Google::Protobuf::Int32Value]
  #     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.
  # @!attribute [rw] bak_type
  #   @return [::Google::Cloud::Sql::V1beta4::BakType]
  #     Type of this bak file will be export, FULL or DIFF, SQL Server only
  # @!attribute [rw] copy_only
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::BoolValue]
  #     Deprecated: copy_only is deprecated. Use differential_base instead
  # @!attribute [rw] differential_base
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup can be used as a differential base
  #     copy_only backup can not be served as differential base
  # @!attribute [rw] export_log_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The begin timestamp when transaction log will be included in
  #     the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339)
  #     format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all
  #     available logs from the beginning of retention period will be included.
  #     Only applied to Cloud SQL for SQL Server.
  # @!attribute [rw] export_log_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The end timestamp when transaction log will be included in the
  #     export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format
  #     (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all
  #     available logs until current time will be included. Only applied to Cloud
  #     SQL for SQL Server.
  class SqlBakExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] certificate_path
  #   @return [::String]
  #     Required. Path to the TDE certificate public key
  #     in the form gs://bucketName/fileName.
  #     The instance must have write access to the location.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_path
  #   @return [::String]
  #     Required. Path to the TDE certificate private key
  #     in the form gs://bucketName/fileName.
  #     The instance must have write access to the location.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_password
  #   @return [::String]
  #     Required. Password that encrypts the private key.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Certificate name.
  #     Applicable only for SQL Server instances.
  class SqlTdeExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#kind ⇒ ::String

Returns This is always sql#exportContext.

Returns:

  • (::String) —

    This is always sql#exportContext.



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
 
# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 1273

class ExportContext
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] select_query
  #   @return [::String]
  #     The select query used to extract the data.
  # @!attribute [rw] escape_character
  #   @return [::String]
  #     Specifies the character that should appear before a data character that
  #     needs to be escaped.
  # @!attribute [rw] quote_character
  #   @return [::String]
  #     Specifies the quoting character to be used when a data value is quoted.
  # @!attribute [rw] fields_terminated_by
  #   @return [::String]
  #     Specifies the character that separates columns within each row (line) of
  #     the file.
  # @!attribute [rw] lines_terminated_by
  #   @return [::String]
  #     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.
  class SqlCsvExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] tables
  #   @return [::Array<::String>]
  #     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.
  # @!attribute [rw] schema_only
  #   @return [::Google::Protobuf::BoolValue]
  #     Export only schemas.
  # @!attribute [rw] mysql_export_options
  #   @return [::Google::Cloud::Sql::V1beta4::ExportContext::SqlExportOptions::MysqlExportOptions]
  # @!attribute [rw] threads
  #   @return [::Google::Protobuf::Int32Value]
  #     Optional. The number of threads to use for parallel export.
  # @!attribute [rw] parallel
  #   @return [::Google::Protobuf::BoolValue]
  #     Optional. Whether or not the export should be parallel.
  # @!attribute [rw] postgres_export_options
  #   @return [::Google::Cloud::Sql::V1beta4::ExportContext::SqlExportOptions::PostgresExportOptions]
  #     Optional. Options for exporting from a Cloud SQL for PostgreSQL instance.
  class SqlExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Options for exporting from MySQL.
    # @!attribute [rw] master_data
    #   @return [::Google::Protobuf::Int32Value]
    #     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.
    class MysqlExportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Options for exporting from a Cloud SQL for PostgreSQL instance.
    # @!attribute [rw] clean
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Use this option to include DROP <code>&lt;object&gt;</code>
    #     SQL statements. Use these statements to delete database objects before
    #     running the import operation.
    # @!attribute [rw] if_exists
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Option to include an IF EXISTS SQL statement with each DROP
    #     statement produced by clean.
    class PostgresExportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Options for exporting BAK files (SQL Server-only)
  # @!attribute [rw] striped
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the export should be striped.
  # @!attribute [rw] stripe_count
  #   @return [::Google::Protobuf::Int32Value]
  #     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.
  # @!attribute [rw] bak_type
  #   @return [::Google::Cloud::Sql::V1beta4::BakType]
  #     Type of this bak file will be export, FULL or DIFF, SQL Server only
  # @!attribute [rw] copy_only
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::BoolValue]
  #     Deprecated: copy_only is deprecated. Use differential_base instead
  # @!attribute [rw] differential_base
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup can be used as a differential base
  #     copy_only backup can not be served as differential base
  # @!attribute [rw] export_log_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The begin timestamp when transaction log will be included in
  #     the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339)
  #     format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all
  #     available logs from the beginning of retention period will be included.
  #     Only applied to Cloud SQL for SQL Server.
  # @!attribute [rw] export_log_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The end timestamp when transaction log will be included in the
  #     export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format
  #     (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all
  #     available logs until current time will be included. Only applied to Cloud
  #     SQL for SQL Server.
  class SqlBakExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] certificate_path
  #   @return [::String]
  #     Required. Path to the TDE certificate public key
  #     in the form gs://bucketName/fileName.
  #     The instance must have write access to the location.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_path
  #   @return [::String]
  #     Required. Path to the TDE certificate private key
  #     in the form gs://bucketName/fileName.
  #     The instance must have write access to the location.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_password
  #   @return [::String]
  #     Required. Password that encrypts the private key.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Certificate name.
  #     Applicable only for SQL Server instances.
  class SqlTdeExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#offload ⇒ ::Google::Protobuf::BoolValue

Returns Whether to perform a serverless export.

Returns:



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
 
# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 1273

class ExportContext
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] select_query
  #   @return [::String]
  #     The select query used to extract the data.
  # @!attribute [rw] escape_character
  #   @return [::String]
  #     Specifies the character that should appear before a data character that
  #     needs to be escaped.
  # @!attribute [rw] quote_character
  #   @return [::String]
  #     Specifies the quoting character to be used when a data value is quoted.
  # @!attribute [rw] fields_terminated_by
  #   @return [::String]
  #     Specifies the character that separates columns within each row (line) of
  #     the file.
  # @!attribute [rw] lines_terminated_by
  #   @return [::String]
  #     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.
  class SqlCsvExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] tables
  #   @return [::Array<::String>]
  #     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.
  # @!attribute [rw] schema_only
  #   @return [::Google::Protobuf::BoolValue]
  #     Export only schemas.
  # @!attribute [rw] mysql_export_options
  #   @return [::Google::Cloud::Sql::V1beta4::ExportContext::SqlExportOptions::MysqlExportOptions]
  # @!attribute [rw] threads
  #   @return [::Google::Protobuf::Int32Value]
  #     Optional. The number of threads to use for parallel export.
  # @!attribute [rw] parallel
  #   @return [::Google::Protobuf::BoolValue]
  #     Optional. Whether or not the export should be parallel.
  # @!attribute [rw] postgres_export_options
  #   @return [::Google::Cloud::Sql::V1beta4::ExportContext::SqlExportOptions::PostgresExportOptions]
  #     Optional. Options for exporting from a Cloud SQL for PostgreSQL instance.
  class SqlExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Options for exporting from MySQL.
    # @!attribute [rw] master_data
    #   @return [::Google::Protobuf::Int32Value]
    #     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.
    class MysqlExportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Options for exporting from a Cloud SQL for PostgreSQL instance.
    # @!attribute [rw] clean
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Use this option to include DROP <code>&lt;object&gt;</code>
    #     SQL statements. Use these statements to delete database objects before
    #     running the import operation.
    # @!attribute [rw] if_exists
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Option to include an IF EXISTS SQL statement with each DROP
    #     statement produced by clean.
    class PostgresExportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Options for exporting BAK files (SQL Server-only)
  # @!attribute [rw] striped
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the export should be striped.
  # @!attribute [rw] stripe_count
  #   @return [::Google::Protobuf::Int32Value]
  #     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.
  # @!attribute [rw] bak_type
  #   @return [::Google::Cloud::Sql::V1beta4::BakType]
  #     Type of this bak file will be export, FULL or DIFF, SQL Server only
  # @!attribute [rw] copy_only
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::BoolValue]
  #     Deprecated: copy_only is deprecated. Use differential_base instead
  # @!attribute [rw] differential_base
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup can be used as a differential base
  #     copy_only backup can not be served as differential base
  # @!attribute [rw] export_log_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The begin timestamp when transaction log will be included in
  #     the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339)
  #     format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all
  #     available logs from the beginning of retention period will be included.
  #     Only applied to Cloud SQL for SQL Server.
  # @!attribute [rw] export_log_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The end timestamp when transaction log will be included in the
  #     export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format
  #     (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all
  #     available logs until current time will be included. Only applied to Cloud
  #     SQL for SQL Server.
  class SqlBakExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] certificate_path
  #   @return [::String]
  #     Required. Path to the TDE certificate public key
  #     in the form gs://bucketName/fileName.
  #     The instance must have write access to the location.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_path
  #   @return [::String]
  #     Required. Path to the TDE certificate private key
  #     in the form gs://bucketName/fileName.
  #     The instance must have write access to the location.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_password
  #   @return [::String]
  #     Required. Password that encrypts the private key.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Certificate name.
  #     Applicable only for SQL Server instances.
  class SqlTdeExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#sql_export_options ⇒ ::Google::Cloud::Sql::V1beta4::ExportContext::SqlExportOptions

Returns Options for exporting data as SQL statements.

Returns:



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
 
# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 1273

class ExportContext
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] select_query
  #   @return [::String]
  #     The select query used to extract the data.
  # @!attribute [rw] escape_character
  #   @return [::String]
  #     Specifies the character that should appear before a data character that
  #     needs to be escaped.
  # @!attribute [rw] quote_character
  #   @return [::String]
  #     Specifies the quoting character to be used when a data value is quoted.
  # @!attribute [rw] fields_terminated_by
  #   @return [::String]
  #     Specifies the character that separates columns within each row (line) of
  #     the file.
  # @!attribute [rw] lines_terminated_by
  #   @return [::String]
  #     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.
  class SqlCsvExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] tables
  #   @return [::Array<::String>]
  #     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.
  # @!attribute [rw] schema_only
  #   @return [::Google::Protobuf::BoolValue]
  #     Export only schemas.
  # @!attribute [rw] mysql_export_options
  #   @return [::Google::Cloud::Sql::V1beta4::ExportContext::SqlExportOptions::MysqlExportOptions]
  # @!attribute [rw] threads
  #   @return [::Google::Protobuf::Int32Value]
  #     Optional. The number of threads to use for parallel export.
  # @!attribute [rw] parallel
  #   @return [::Google::Protobuf::BoolValue]
  #     Optional. Whether or not the export should be parallel.
  # @!attribute [rw] postgres_export_options
  #   @return [::Google::Cloud::Sql::V1beta4::ExportContext::SqlExportOptions::PostgresExportOptions]
  #     Optional. Options for exporting from a Cloud SQL for PostgreSQL instance.
  class SqlExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Options for exporting from MySQL.
    # @!attribute [rw] master_data
    #   @return [::Google::Protobuf::Int32Value]
    #     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.
    class MysqlExportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Options for exporting from a Cloud SQL for PostgreSQL instance.
    # @!attribute [rw] clean
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Use this option to include DROP <code>&lt;object&gt;</code>
    #     SQL statements. Use these statements to delete database objects before
    #     running the import operation.
    # @!attribute [rw] if_exists
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Option to include an IF EXISTS SQL statement with each DROP
    #     statement produced by clean.
    class PostgresExportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Options for exporting BAK files (SQL Server-only)
  # @!attribute [rw] striped
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the export should be striped.
  # @!attribute [rw] stripe_count
  #   @return [::Google::Protobuf::Int32Value]
  #     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.
  # @!attribute [rw] bak_type
  #   @return [::Google::Cloud::Sql::V1beta4::BakType]
  #     Type of this bak file will be export, FULL or DIFF, SQL Server only
  # @!attribute [rw] copy_only
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::BoolValue]
  #     Deprecated: copy_only is deprecated. Use differential_base instead
  # @!attribute [rw] differential_base
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup can be used as a differential base
  #     copy_only backup can not be served as differential base
  # @!attribute [rw] export_log_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The begin timestamp when transaction log will be included in
  #     the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339)
  #     format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all
  #     available logs from the beginning of retention period will be included.
  #     Only applied to Cloud SQL for SQL Server.
  # @!attribute [rw] export_log_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The end timestamp when transaction log will be included in the
  #     export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format
  #     (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all
  #     available logs until current time will be included. Only applied to Cloud
  #     SQL for SQL Server.
  class SqlBakExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] certificate_path
  #   @return [::String]
  #     Required. Path to the TDE certificate public key
  #     in the form gs://bucketName/fileName.
  #     The instance must have write access to the location.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_path
  #   @return [::String]
  #     Required. Path to the TDE certificate private key
  #     in the form gs://bucketName/fileName.
  #     The instance must have write access to the location.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_password
  #   @return [::String]
  #     Required. Password that encrypts the private key.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Certificate name.
  #     Applicable only for SQL Server instances.
  class SqlTdeExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#tde_export_options ⇒ ::Google::Cloud::Sql::V1beta4::ExportContext::SqlTdeExportOptions

Returns Optional. Export parameters specific to SQL Server TDE certificates.

Returns:



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
 
# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 1273

class ExportContext
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] select_query
  #   @return [::String]
  #     The select query used to extract the data.
  # @!attribute [rw] escape_character
  #   @return [::String]
  #     Specifies the character that should appear before a data character that
  #     needs to be escaped.
  # @!attribute [rw] quote_character
  #   @return [::String]
  #     Specifies the quoting character to be used when a data value is quoted.
  # @!attribute [rw] fields_terminated_by
  #   @return [::String]
  #     Specifies the character that separates columns within each row (line) of
  #     the file.
  # @!attribute [rw] lines_terminated_by
  #   @return [::String]
  #     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.
  class SqlCsvExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] tables
  #   @return [::Array<::String>]
  #     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.
  # @!attribute [rw] schema_only
  #   @return [::Google::Protobuf::BoolValue]
  #     Export only schemas.
  # @!attribute [rw] mysql_export_options
  #   @return [::Google::Cloud::Sql::V1beta4::ExportContext::SqlExportOptions::MysqlExportOptions]
  # @!attribute [rw] threads
  #   @return [::Google::Protobuf::Int32Value]
  #     Optional. The number of threads to use for parallel export.
  # @!attribute [rw] parallel
  #   @return [::Google::Protobuf::BoolValue]
  #     Optional. Whether or not the export should be parallel.
  # @!attribute [rw] postgres_export_options
  #   @return [::Google::Cloud::Sql::V1beta4::ExportContext::SqlExportOptions::PostgresExportOptions]
  #     Optional. Options for exporting from a Cloud SQL for PostgreSQL instance.
  class SqlExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Options for exporting from MySQL.
    # @!attribute [rw] master_data
    #   @return [::Google::Protobuf::Int32Value]
    #     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.
    class MysqlExportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Options for exporting from a Cloud SQL for PostgreSQL instance.
    # @!attribute [rw] clean
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Use this option to include DROP <code>&lt;object&gt;</code>
    #     SQL statements. Use these statements to delete database objects before
    #     running the import operation.
    # @!attribute [rw] if_exists
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Option to include an IF EXISTS SQL statement with each DROP
    #     statement produced by clean.
    class PostgresExportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Options for exporting BAK files (SQL Server-only)
  # @!attribute [rw] striped
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the export should be striped.
  # @!attribute [rw] stripe_count
  #   @return [::Google::Protobuf::Int32Value]
  #     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.
  # @!attribute [rw] bak_type
  #   @return [::Google::Cloud::Sql::V1beta4::BakType]
  #     Type of this bak file will be export, FULL or DIFF, SQL Server only
  # @!attribute [rw] copy_only
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::BoolValue]
  #     Deprecated: copy_only is deprecated. Use differential_base instead
  # @!attribute [rw] differential_base
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup can be used as a differential base
  #     copy_only backup can not be served as differential base
  # @!attribute [rw] export_log_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The begin timestamp when transaction log will be included in
  #     the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339)
  #     format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all
  #     available logs from the beginning of retention period will be included.
  #     Only applied to Cloud SQL for SQL Server.
  # @!attribute [rw] export_log_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The end timestamp when transaction log will be included in the
  #     export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format
  #     (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all
  #     available logs until current time will be included. Only applied to Cloud
  #     SQL for SQL Server.
  class SqlBakExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] certificate_path
  #   @return [::String]
  #     Required. Path to the TDE certificate public key
  #     in the form gs://bucketName/fileName.
  #     The instance must have write access to the location.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_path
  #   @return [::String]
  #     Required. Path to the TDE certificate private key
  #     in the form gs://bucketName/fileName.
  #     The instance must have write access to the location.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_password
  #   @return [::String]
  #     Required. Password that encrypts the private key.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Certificate name.
  #     Applicable only for SQL Server instances.
  class SqlTdeExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#uri ⇒ ::String

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

Returns:

  • (::String) —

    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.



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
 
# File 'proto_docs/google/cloud/sql/v1beta4/cloud_sql_resources.rb', line 1273

class ExportContext
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] select_query
  #   @return [::String]
  #     The select query used to extract the data.
  # @!attribute [rw] escape_character
  #   @return [::String]
  #     Specifies the character that should appear before a data character that
  #     needs to be escaped.
  # @!attribute [rw] quote_character
  #   @return [::String]
  #     Specifies the quoting character to be used when a data value is quoted.
  # @!attribute [rw] fields_terminated_by
  #   @return [::String]
  #     Specifies the character that separates columns within each row (line) of
  #     the file.
  # @!attribute [rw] lines_terminated_by
  #   @return [::String]
  #     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.
  class SqlCsvExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] tables
  #   @return [::Array<::String>]
  #     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.
  # @!attribute [rw] schema_only
  #   @return [::Google::Protobuf::BoolValue]
  #     Export only schemas.
  # @!attribute [rw] mysql_export_options
  #   @return [::Google::Cloud::Sql::V1beta4::ExportContext::SqlExportOptions::MysqlExportOptions]
  # @!attribute [rw] threads
  #   @return [::Google::Protobuf::Int32Value]
  #     Optional. The number of threads to use for parallel export.
  # @!attribute [rw] parallel
  #   @return [::Google::Protobuf::BoolValue]
  #     Optional. Whether or not the export should be parallel.
  # @!attribute [rw] postgres_export_options
  #   @return [::Google::Cloud::Sql::V1beta4::ExportContext::SqlExportOptions::PostgresExportOptions]
  #     Optional. Options for exporting from a Cloud SQL for PostgreSQL instance.
  class SqlExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Options for exporting from MySQL.
    # @!attribute [rw] master_data
    #   @return [::Google::Protobuf::Int32Value]
    #     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.
    class MysqlExportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Options for exporting from a Cloud SQL for PostgreSQL instance.
    # @!attribute [rw] clean
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Use this option to include DROP <code>&lt;object&gt;</code>
    #     SQL statements. Use these statements to delete database objects before
    #     running the import operation.
    # @!attribute [rw] if_exists
    #   @return [::Google::Protobuf::BoolValue]
    #     Optional. Option to include an IF EXISTS SQL statement with each DROP
    #     statement produced by clean.
    class PostgresExportOptions
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Options for exporting BAK files (SQL Server-only)
  # @!attribute [rw] striped
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the export should be striped.
  # @!attribute [rw] stripe_count
  #   @return [::Google::Protobuf::Int32Value]
  #     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.
  # @!attribute [rw] bak_type
  #   @return [::Google::Cloud::Sql::V1beta4::BakType]
  #     Type of this bak file will be export, FULL or DIFF, SQL Server only
  # @!attribute [rw] copy_only
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::BoolValue]
  #     Deprecated: copy_only is deprecated. Use differential_base instead
  # @!attribute [rw] differential_base
  #   @return [::Google::Protobuf::BoolValue]
  #     Whether or not the backup can be used as a differential base
  #     copy_only backup can not be served as differential base
  # @!attribute [rw] export_log_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The begin timestamp when transaction log will be included in
  #     the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339)
  #     format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all
  #     available logs from the beginning of retention period will be included.
  #     Only applied to Cloud SQL for SQL Server.
  # @!attribute [rw] export_log_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The end timestamp when transaction log will be included in the
  #     export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format
  #     (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all
  #     available logs until current time will be included. Only applied to Cloud
  #     SQL for SQL Server.
  class SqlBakExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] certificate_path
  #   @return [::String]
  #     Required. Path to the TDE certificate public key
  #     in the form gs://bucketName/fileName.
  #     The instance must have write access to the location.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_path
  #   @return [::String]
  #     Required. Path to the TDE certificate private key
  #     in the form gs://bucketName/fileName.
  #     The instance must have write access to the location.
  #     Applicable only for SQL Server instances.
  # @!attribute [rw] private_key_password
  #   @return [::String]
  #     Required. Password that encrypts the private key.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. Certificate name.
  #     Applicable only for SQL Server instances.
  class SqlTdeExportOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end