Reference documentation and code samples for the Google Cloud Sql Admin V1beta4 Client class ImportContext.
Database instance import context.
Generated from protobuf message google.cloud.sql.v1beta4.ImportContext
Namespace
Google \ Cloud \ Sql \ V1beta4Methods
__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 |
↳ database |
string
The target database for the import. If |
↳ kind |
string
This is always |
↳ file_type |
int
The file type for the specified uri. * |
↳ csv_import_options |
Google\Cloud\Sql\V1beta4\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\V1beta4\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
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.
| 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
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.
| 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.BAK: The file contains backup data for a SQL Server instance.
| Returns | |
|---|---|
| Type | Description |
int | |
setFileType
The file type for the specified uri.
SQL: The file contains SQL statements.CSV: The file contains CSV data.BAK: The file contains backup data for a SQL Server instance.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCsvImportOptions
Options for importing data as CSV.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Sql\V1beta4\ImportContext\SqlCsvImportOptions|null | |
hasCsvImportOptions
clearCsvImportOptions
setCsvImportOptions
Options for importing data as CSV.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Sql\V1beta4\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\V1beta4\ImportContext\SqlBakImportOptions|null | |
hasBakImportOptions
clearBakImportOptions
setBakImportOptions
Import parameters specific to SQL Server .BAK files
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Sql\V1beta4\ImportContext\SqlBakImportOptions
|
| Returns | |
|---|---|
| Type | Description |
$this | |