Cloud SQL Admin V1 API - Class Google::Cloud::Sql::V1::ExportContext (v0.1.0)

Reference documentation and code samples for the Cloud SQL Admin V1 API class Google::Cloud::Sql::V1::ExportContext.

Database instance export context.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#bak_export_options

def bak_export_options() -> ::Google::Cloud::Sql::V1::ExportContext::SqlBakExportOptions

Returns

• (::Google::Cloud::Sql::V1::ExportContext::SqlBakExportOptions) — Options for exporting data as BAK files.

#bak_export_options=

def bak_export_options=(value) -> ::Google::Cloud::Sql::V1::ExportContext::SqlBakExportOptions

Parameter

• value (::Google::Cloud::Sql::V1::ExportContext::SqlBakExportOptions) — Options for exporting data as BAK files.

Returns

• (::Google::Cloud::Sql::V1::ExportContext::SqlBakExportOptions) — Options for exporting data as BAK files.

#csv_export_options

def csv_export_options() -> ::Google::Cloud::Sql::V1::ExportContext::SqlCsvExportOptions

Returns

• (::Google::Cloud::Sql::V1::ExportContext::SqlCsvExportOptions) — Options for exporting data as CSV. MySQL and PostgreSQL instances only.

#csv_export_options=

def csv_export_options=(value) -> ::Google::Cloud::Sql::V1::ExportContext::SqlCsvExportOptions

Parameter

• value (::Google::Cloud::Sql::V1::ExportContext::SqlCsvExportOptions) — Options for exporting data as CSV. MySQL and PostgreSQL instances only.

Returns

• (::Google::Cloud::Sql::V1::ExportContext::SqlCsvExportOptions) — Options for exporting data as CSV. MySQL and PostgreSQL instances only.

#databases

def databases() -> ::Array<::String>

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.

#databases=

def databases=(value) -> ::Array<::String>

Parameter

• value (::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.

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.

#file_type

def file_type() -> ::Google::Cloud::Sql::V1::SqlFileType

Returns

• (::Google::Cloud::Sql::V1::SqlFileType) — The file type for the specified uri.

#file_type=

def file_type=(value) -> ::Google::Cloud::Sql::V1::SqlFileType

Parameter

• value (::Google::Cloud::Sql::V1::SqlFileType) — The file type for the specified uri.

Returns

• (::Google::Cloud::Sql::V1::SqlFileType) — The file type for the specified uri.

#kind

def kind() -> ::String

Returns

• (::String) — This is always sql#exportContext.

#kind=

def kind=(value) -> ::String

Parameter

• value (::String) — This is always sql#exportContext.

Returns

• (::String) — This is always sql#exportContext.

#offload

def offload() -> ::Google::Protobuf::BoolValue

Returns

• (::Google::Protobuf::BoolValue) — Whether to perform a serverless export.

#offload=

def offload=(value) -> ::Google::Protobuf::BoolValue

Parameter

• value (::Google::Protobuf::BoolValue) — Whether to perform a serverless export.

Returns

• (::Google::Protobuf::BoolValue) — Whether to perform a serverless export.

#sql_export_options

def sql_export_options() -> ::Google::Cloud::Sql::V1::ExportContext::SqlExportOptions

Returns

• (::Google::Cloud::Sql::V1::ExportContext::SqlExportOptions) — Options for exporting data as SQL statements.

#sql_export_options=

def sql_export_options=(value) -> ::Google::Cloud::Sql::V1::ExportContext::SqlExportOptions

Parameter

• value (::Google::Cloud::Sql::V1::ExportContext::SqlExportOptions) — Options for exporting data as SQL statements.

Returns

• (::Google::Cloud::Sql::V1::ExportContext::SqlExportOptions) — Options for exporting data as SQL statements.

#tde_export_options

def tde_export_options() -> ::Google::Cloud::Sql::V1::ExportContext::SqlTdeExportOptions

Returns

• (::Google::Cloud::Sql::V1::ExportContext::SqlTdeExportOptions) — Optional. Export parameters specific to SQL Server TDE certificates

#tde_export_options=

def tde_export_options=(value) -> ::Google::Cloud::Sql::V1::ExportContext::SqlTdeExportOptions

Parameter

• value (::Google::Cloud::Sql::V1::ExportContext::SqlTdeExportOptions) — Optional. Export parameters specific to SQL Server TDE certificates

Returns

• (::Google::Cloud::Sql::V1::ExportContext::SqlTdeExportOptions) — Optional. Export parameters specific to SQL Server TDE certificates

#uri

def uri() -> ::String

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.

#uri=

def uri=(value) -> ::String

Parameter

• value (::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.

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.