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 messagegoogle.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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud BigQuery Migration V2 Client - Class SourceEnv (1.1.5)\n\nVersion latestkeyboard_arrow_down\n\n- [1.1.5 (latest)](/php/docs/reference/cloud-bigquery-migration/latest/V2.SourceEnv)\n- [1.1.4](/php/docs/reference/cloud-bigquery-migration/1.1.4/V2.SourceEnv)\n- [1.0.0](/php/docs/reference/cloud-bigquery-migration/1.0.0/V2.SourceEnv)\n- [0.4.5](/php/docs/reference/cloud-bigquery-migration/0.4.5/V2.SourceEnv)\n- [0.3.3](/php/docs/reference/cloud-bigquery-migration/0.3.3/V2.SourceEnv)\n- [0.2.2](/php/docs/reference/cloud-bigquery-migration/0.2.2/V2.SourceEnv)\n- [0.1.4](/php/docs/reference/cloud-bigquery-migration/0.1.4/V2.SourceEnv) \nReference documentation and code samples for the Google Cloud BigQuery Migration V2 Client class SourceEnv.\n\nRepresents the default source environment values for the translation.\n\nGenerated from protobuf message `google.cloud.bigquery.migration.v2.SourceEnv`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ BigQuery \\\\ Migration \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getDefaultDatabase\n\nThe default database name to fully qualify SQL objects when their database\nname is missing.\n\n### setDefaultDatabase\n\nThe default database name to fully qualify SQL objects when their database\nname is missing.\n\n### getSchemaSearchPath\n\nThe schema search path. When SQL objects are missing schema name,\ntranslation engine will search through this list to find the value.\n\n### setSchemaSearchPath\n\nThe schema search path. When SQL objects are missing schema name,\ntranslation engine will search through this list to find the value.\n\n### getMetadataStoreDataset\n\nOptional. Expects a valid BigQuery dataset ID that exists, e.g.,\nproject-123.metadata_store_123. If specified, translation will search and\nread the required schema information from a metadata store in this dataset.\n\nIf metadata store doesn't exist, translation will parse the metadata file\nand upload the schema info to a temp table in the dataset to speed up\nfuture translation jobs.\n\n### setMetadataStoreDataset\n\nOptional. Expects a valid BigQuery dataset ID that exists, e.g.,\nproject-123.metadata_store_123. If specified, translation will search and\nread the required schema information from a metadata store in this dataset.\n\nIf metadata store doesn't exist, translation will parse the metadata file\nand upload the schema info to a temp table in the dataset to speed up\nfuture translation jobs."]]
