Google Cloud BigQuery Migration V2 Client - Class SourceEnv (1.1.0)

Reference documentation and code samples for the Google Cloud BigQuery Migration V2 Client class SourceEnv.

Represents the default source environment values for the translation.

Generated from protobuf message google.cloud.bigquery.migration.v2.SourceEnv

Namespace

Google \ Cloud \ BigQuery \ Migration \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ default_database string

The default database name to fully qualify SQL objects when their database name is missing.

↳ schema_search_path array

The schema search path. When SQL objects are missing schema name, translation engine will search through this list to find the value.

↳ metadata_store_dataset string

Optional. Expects a valid BigQuery dataset ID that exists, e.g., project-123.metadata_store_123. If specified, translation will search and read the required schema information from a metadata store in this dataset. If metadata store doesn't exist, translation will parse the metadata file and upload the schema info to a temp table in the dataset to speed up future translation jobs.

getDefaultDatabase

The default database name to fully qualify SQL objects when their database name is missing.

Returns
Type Description
string

setDefaultDatabase

The default database name to fully qualify SQL objects when their database name is missing.

Parameter
Name Description
var string
Returns
Type Description
$this

getSchemaSearchPath

The schema search path. When SQL objects are missing schema name, translation engine will search through this list to find the value.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSchemaSearchPath

The schema search path. When SQL objects are missing schema name, translation engine will search through this list to find the value.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getMetadataStoreDataset

Optional. Expects a valid BigQuery dataset ID that exists, e.g., project-123.metadata_store_123. If specified, translation will search and read the required schema information from a metadata store in this dataset.

If metadata store doesn't exist, translation will parse the metadata file and upload the schema info to a temp table in the dataset to speed up future translation jobs.

Returns
Type Description
string

setMetadataStoreDataset

Optional. Expects a valid BigQuery dataset ID that exists, e.g., project-123.metadata_store_123. If specified, translation will search and read the required schema information from a metadata store in this dataset.

If metadata store doesn't exist, translation will parse the metadata file and upload the schema info to a temp table in the dataset to speed up future translation jobs.

Parameter
Name Description
var string
Returns
Type Description
$this