Google Cloud Sql Admin V1 Client - Class ExportContext (0.19.0)

Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class ExportContext.

Database instance export context.

Generated from protobuf message google.cloud.sql.v1.ExportContext

Namespace

Google \ Cloud \ Sql \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ uri`	`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.
`↳ databases`	`array` Databases to be exported. `MySQL instances:` If `fileType` is `SQL` and no database is specified, all databases are exported, except for the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over this property. `PostgreSQL instances:` You must specify one database to be exported. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`.
`↳ kind`	`string` This is always `sql#exportContext`.
`↳ sql_export_options`	`Google\Cloud\Sql\V1\ExportContext\SqlExportOptions` Options for exporting data as SQL statements.
`↳ csv_export_options`	`Google\Cloud\Sql\V1\ExportContext\SqlCsvExportOptions` Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only.
`↳ file_type`	`int` The file type for the specified uri.
`↳ offload`	`Google\Protobuf\BoolValue` Option for export offload.
`↳ bak_export_options`	`Google\Cloud\Sql\V1\ExportContext\SqlBakExportOptions` Options for exporting data as BAK files.

getUri

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
Type	Description
`string`

setUri

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDatabases

Databases to be exported.
MySQL instances: If fileType is SQL and no database is specified, all databases are exported, except for the mysql system database.

If fileType is CSV, you can specify one database, either by using this property or by using the csvExportOptions.selectQuery property, which takes precedence over this property.
PostgreSQL instances: You must specify one database to be exported. If fileType is CSV, this database must match the one specified in the csvExportOptions.selectQuery property.
SQL Server instances: You must specify one database to be exported, and the fileType must be BAK.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setDatabases

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.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getKind

This is always sql#exportContext.

Returns
Type	Description
`string`

setKind

This is always sql#exportContext.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSqlExportOptions

Options for exporting data as SQL statements.

Returns
Type	Description
`Google\Cloud\Sql\V1\ExportContext\SqlExportOptions\|null`

hasSqlExportOptions

clearSqlExportOptions

setSqlExportOptions

Options for exporting data as SQL statements.

Parameter
Name	Description
`var`	`Google\Cloud\Sql\V1\ExportContext\SqlExportOptions`

Returns
Type	Description
`$this`

getCsvExportOptions

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

Returns
Type	Description
`Google\Cloud\Sql\V1\ExportContext\SqlCsvExportOptions\|null`

hasCsvExportOptions

clearCsvExportOptions

setCsvExportOptions

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

Parameter
Name	Description
`var`	`Google\Cloud\Sql\V1\ExportContext\SqlCsvExportOptions`

Returns
Type	Description
`$this`

getFileType

The file type for the specified uri.

Returns
Type	Description
`int`

setFileType

The file type for the specified uri.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getOffload

Option for export offload.

Returns
Type	Description
`Google\Protobuf\BoolValue\|null`

hasOffload

clearOffload

getOffloadValue

Returns the unboxed value from getOffload()

Option for export offload.

Returns
Type	Description
`bool\|null`

setOffload

Option for export offload.

Parameter
Name	Description
`var`	`Google\Protobuf\BoolValue`

Returns
Type	Description
`$this`

setOffloadValue

Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.

Option for export offload.

Parameter
Name	Description
`var`	`bool\|null`

Returns
Type	Description
`$this`

getBakExportOptions

Options for exporting data as BAK files.

Returns
Type	Description
`Google\Cloud\Sql\V1\ExportContext\SqlBakExportOptions\|null`

hasBakExportOptions

clearBakExportOptions

setBakExportOptions

Options for exporting data as BAK files.

Parameter
Name	Description
`var`	`Google\Cloud\Sql\V1\ExportContext\SqlBakExportOptions`

Returns
Type	Description
`$this`