Class: Google::Cloud::Sql::V1::ExportContext

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/sql/v1/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::V1::ExportContext::SqlBakExportOptions

Returns Options for exporting data as BAK files.

Returns:



456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'proto_docs/google/cloud/sql/v1/cloud_sql_resources.rb', line 456

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::V1::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::V1::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::V1::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 bucket.
  #     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::V1::ExportContext::SqlCsvExportOptions

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

Returns:



456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'proto_docs/google/cloud/sql/v1/cloud_sql_resources.rb', line 456

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::V1::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::V1::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::V1::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 bucket.
  #     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.



456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'proto_docs/google/cloud/sql/v1/cloud_sql_resources.rb', line 456

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::V1::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::V1::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::V1::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 bucket.
  #     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::V1::SqlFileType

Returns The file type for the specified uri.

Returns:



456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'proto_docs/google/cloud/sql/v1/cloud_sql_resources.rb', line 456

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::V1::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::V1::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::V1::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 bucket.
  #     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.



456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'proto_docs/google/cloud/sql/v1/cloud_sql_resources.rb', line 456

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::V1::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::V1::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::V1::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 bucket.
  #     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:



456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'proto_docs/google/cloud/sql/v1/cloud_sql_resources.rb', line 456

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::V1::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::V1::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::V1::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 bucket.
  #     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::V1::ExportContext::SqlExportOptions

Returns Options for exporting data as SQL statements.

Returns:



456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'proto_docs/google/cloud/sql/v1/cloud_sql_resources.rb', line 456

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::V1::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::V1::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::V1::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 bucket.
  #     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::V1::ExportContext::SqlTdeExportOptions

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

Returns:



456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'proto_docs/google/cloud/sql/v1/cloud_sql_resources.rb', line 456

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::V1::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::V1::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::V1::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 bucket.
  #     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.



456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'proto_docs/google/cloud/sql/v1/cloud_sql_resources.rb', line 456

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::V1::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::V1::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::V1::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 bucket.
  #     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