Google Cloud Sql Admin V1 Client - Class ImportContext (0.4.1)

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

Database instance import context.

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

Namespace

Google \ Cloud \ Sql \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ uri`	`string` Path to the import file in Cloud Storage, in the form `gs://bucketName/fileName`. Compressed gzip files (.gz) are supported when `fileType` is `SQL`. The instance must have write permissions to the bucket and read access to the file.
`↳ database`	`string` The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If `fileType` is `CSV`, one database must be specified.
`↳ kind`	`string` This is always `sql#importContext`.
`↳ file_type`	`int` The file type for the specified uri.`SQL`: The file contains SQL statements. \`CSV`: The file contains CSV data.
`↳ csv_import_options`	`Google\Cloud\Sql\V1\ImportContext\SqlCsvImportOptions` Options for importing data as CSV.
`↳ import_user`	`string` The PostgreSQL user for this import operation. PostgreSQL instances only.
`↳ bak_import_options`	`Google\Cloud\Sql\V1\ImportContext\SqlBakImportOptions` Import parameters specific to SQL Server .BAK files

getUri

Path to the import file in Cloud Storage, in the form gs://bucketName/fileName. Compressed gzip files (.gz) are supported when fileType is SQL. The instance must have write permissions to the bucket and read access to the file.

Returns
Type	Description
`string`

setUri

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDatabase

The target database for the import. If fileType is SQL, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If fileType is CSV, one database must be specified.

Returns
Type	Description
`string`

setDatabase

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getKind

This is always sql#importContext.

Returns
Type	Description
`string`

setKind

This is always sql#importContext.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFileType

The file type for the specified uri.`SQL: The file contains SQL statements. \CSV`: The file contains CSV data.

Returns
Type	Description
`int`

setFileType

The file type for the specified uri.`SQL: The file contains SQL statements. \CSV`: The file contains CSV data.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getCsvImportOptions

Options for importing data as CSV.

Returns
Type	Description
`Google\Cloud\Sql\V1\ImportContext\SqlCsvImportOptions\|null`

hasCsvImportOptions

clearCsvImportOptions

setCsvImportOptions

Options for importing data as CSV.

Parameter
Name	Description
`var`	`Google\Cloud\Sql\V1\ImportContext\SqlCsvImportOptions`

Returns
Type	Description
`$this`

getImportUser

The PostgreSQL user for this import operation. PostgreSQL instances only.

Returns
Type	Description
`string`

setImportUser

The PostgreSQL user for this import operation. PostgreSQL instances only.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getBakImportOptions

Import parameters specific to SQL Server .BAK files

Returns
Type	Description
`Google\Cloud\Sql\V1\ImportContext\SqlBakImportOptions\|null`

hasBakImportOptions

clearBakImportOptions

setBakImportOptions

Import parameters specific to SQL Server .BAK files

Parameter
Name	Description
`var`	`Google\Cloud\Sql\V1\ImportContext\SqlBakImportOptions`

Returns
Type	Description
`$this`