tBigQueryInput Standard properties
These properties are used to configure tBigQueryInput running in the Standard Job framework.
The Standard tBigQueryInput component belongs to the Big Data family.
The component in this framework is available in all Talend products.
Basic settings
Schema and Edit schema |
A schema is a row description. It defines the number of fields (columns) to be processed and passed on to the next component. When you create a Spark Job, avoid the reserved word line when naming the fields.
Click Edit schema to make changes to the schema. If you make changes, the schema automatically becomes built-in.
This component offers the advantage of the dynamic schema feature. This allows you to retrieve unknown columns from source files or to copy batches of columns from a source without mapping each column individually. For further information about dynamic schemas, see Dynamic schema. This dynamic schema feature is designed for the purpose of retrieving unknown columns of a table and is recommended to be used for this purpose only; it is not recommended for the use of creating tables. |
Guess schema | Click the button to retrieve the schema from the table. This option is available when you have installed the R2023-02 Talend Studio Monthly update or a later one delivered by Talend. |
|
|
Authentication mode | Select the mode to be used to authenticate to your project.
To know more about the Google Cloud authentication process, read the Google Cloud documentation. |
Service account credentials file | Enter the path to the credentials file created for the service account to be
used. This file must be stored in the machine in which your Talend
Job is actually launched and executed. This property is only available when you authenticate using Service account. |
Client ID and Client secret |
Paste the client ID and the client secret, both created and viewable on the API Access tab view of the project hosting the Google BigQuery service and the Cloud Storage service you need to use. To enter the client secret, click the [...] button next to the client secret field, and then in the pop-up dialog box enter the client secret between double quotes and click OK to save the settings. This property is only available when you authenticate using OAuth 2.0. |
OAuth Access Token | Enter an access token. The lifetime of the token is one hour. The component does not perform the token refresh operation but will fetch the new access token to operate beyond the one-hour limit. This property is only available when you authenticate using OAuth Access Token. |
Project ID |
Paste the ID of the project hosting the Google BigQuery service you need to use. The ID of your project can be found in the URL of the Google API Console, or by hovering your mouse pointer over the name of the project in the BigQuery Browser Tool. |
Authorization code |
Paste the authorization code provided by Google for the access you are building. To obtain the authorization code, you need to execute the Job using this component and when this Job pauses execution to print out an URL address, you navigate to this address to copy the authorization code displayed. |
Use legacy SQL and Query |
Enter the query you need to use. If the query to be used is the legacy SQL of BigQuery, select this Use legacy SQL check box. For further information about this legacy SQL, see Legacy SQL query reference in the Google Cloud documentation. |
Result size |
Select the option depending on the volume of the query result. By default, the Small option is used, but when the query result is larger than the maximum response size, you need to select the Large option. If the volume of the result is not certain, select Auto. |
Advanced settings
Use a custom endpoint | Select this check box to use a private endpoint rather than the default one.
When selected, enter the URL in the Google BigQuery Private API URL property, by respecting the following format: "https://bigquery.googleapis.com". For more information, see Access Google APIs through endpoints in the Google Cloud documentation. This property is only available when you authenticate using Service account. |
token properties File Name |
Enter the path to, or browse to the refresh token file you need to use. At the first Job execution using the Authorization code you have obtained from Google BigQuery, the value in this field is the directory and the name of that refresh token file to be created and used; if that token file has been created and you need to reuse it, you have to specify its directory and file name in this field. With only the token file name entered, Talend Studio considers the directory of that token file to be the root of the Talend Studio folder. For further information about the refresh token, see the manual of Google BigQuery. |
Advanced Separator for numbers |
Select this check box to change the separator used for the numbers. |
Encoding |
Select the encoding from the list or select Custom and define it manually. This field is compulsory for database data handling. The supported encodings depend on the JVM that you are using. For more information, see https://docs.oracle.com. |
Force single query execution |
Select this check box to let the component return the result of the whole query. If you clear this check box, the component executes each sub-query separately and returns the result of each query sequentially. |
Use custom temporary Dataset name |
Select this check box to use an existing dataset to which you have access, instead of creating one, and in the field that is displayed, enter the name of this dataset. This way, you avoid rights and permissions issues related to dataset creation. This check box is available only when you have selected Large from the Result size drop-down list in the Basic settings tab. |
tStatCatcher Statistics |
Select this check box to collect the log data at the component level. |
Global Variables
ERROR_MESSAGE |
The error message generated by the component when an error occurs. This is an After variable and it returns a string. This variable functions only if the Die on error check box is selected. |
JOBID |
The ID of the Job. This is an After variable and it returns a string. |
STATISTICS |
The statistics of the Job. This is an After variable and it returns a string. |
STATISTICS_CHILD |
The statistics of the child Job. This is an After variable and it returns a string. |
Usage
Usage rule |
This is an input component. It sends the extracted data to the component that follows it. This component automatically detects and supports both multi-regional locations and regional locations. When using the regional locations, the buckets and the datasets to be used must be in the same locations. |