tBigQueryOutput Standard properties

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.

• Built-In: You create and store the schema locally for this component only.

• Repository: You have already created the schema and stored it in the Repository. You can reuse it in various projects and Job designs.

Click Edit schema to make changes to the schema. If you make changes, the schema automatically becomes built-in.

• View schema: choose this option to view the schema only.

• Change to built-in property: choose this option to change the schema to Built-in for local changes.

• Update repository connection: choose this option to change the schema stored in the repository and decide whether to propagate the changes to all the Jobs upon completion.

  If you just want to propagate the changes to the current Job, you can select No upon completion and choose this schema metadata again in the Repository Content window.

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.

• The Record type of BigQuery is not supported.
• The columns for table metadata such as the Description column or the Mode column cannot be retrieved.
• The Timestamp data from your BigQuery system is formatted to be String data.
• The numeric data of BigQuery is converted to BigDecimal.

Property type

Built-In: You create and store the schema locally for this component only.

Repository: You have already created the schema and stored it in the Repository. You can reuse it in various projects and Job designs.

Local filename

Browse to, or enter the path to the file you want to write the received data in.

Append

Select this check box to add rows to the existing data in the file specified in Local filename.

• Service account: authenticate using a Google account that is associated with your Google Cloud Platform project. When selecting this mode, the parameter to be defined is Service account credentials file.
• Application Default Credentials: authenticate using the Application Default Credentials. When selecting this mode, no additional parameters need to be defined as credentials are automatically found based on the application environment.
• OAuth 2.0: authenticate using OAuth credentials. When selecting this mode, the parameters to be defined are Client ID, Client secret and Authorization code.
• OAuth Access Token: authenticate using an OAuth access token. When selecting this mode, the parameter to be defined is OAuth Access Token.

To know more about the Google Cloud authentication process, read the Google Cloud documentation.

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.

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.

Dataset

Enter the name of the dataset you need to transfer data to.

Table

Enter the name of the table you need to transfer data to.

If this table does not exist, select the Create the table if it doesn't exist check box.

Action on data

Select the action to be performed from the drop-down list when transferring data to the target table. The action may be:

• Truncate: it empties the contents of the table and repopulates it with the transferred data.

• Append: it adds rows to the existing data in the table.

• Empty: it populates the empty table.

• Service account: when selecting this credential type, the parameter to be defined in the Basic settings view is Service account key.
• Application Default Credentials: when selecting this credential type, the parameter to be defined in the Basic settings view is Application Default Credentials.
• OAuth Access Token: when selecting this credential type, the parameter to be defined in the Basic settings view is OAuth Access Token.

By default, Service account is selected. The Credential type field is available only if you do not select the Bulk file already exists in Google storage check box.

Click the [...] button next to the service account key field to browse for the JSON file that contains your service account key.

This property is only available when you authenticate using Service account.

Access key and Secret key

Paste the authentication information obtained from Google for making requests to Google Cloud Storage.

To enter the secret key, click the [...] button next to the secret key field, and then in the pop-up dialog box enter the password between double quotes and click OK to save the settings.

These keys can be consulted on the Interoperable Access tab view under the Google Cloud Storage tab of the project.

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.

Bucket

Enter the name of the bucket, the Google Cloud Storage container, which holds the data to be transferred to Google BigQuery.

File

Enter the directory of the data stored on Google Cloud Storage and to be transferred to Google BigQuery.

If the data is not on Google Cloud Storage, this directory is used as the intermediate destination before the data is transferred to Google BigQuery.

Note that this file name must be identical with the name of the file specified in the Local filename field.

Set values to ignore the header of the transferred data. For example, enter 0 to ignore no rows for the data without header and set 1 for the data with header at the first row.

Die on error

This check box is cleared by default, meaning to skip the row on error and to complete the process for error-free rows.

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.

Field Separator

Enter a character, a string, or a regular expression to separate fields for the transferred data.

Select the Drop table if exists check box to remove the table specified in the Table field, if this table already exists.

Select this check box to create the directory you defined in the File field for Google Cloud Storage, if it does not exist.

Custom the flush buffer size

Enter the number of rows to be processed before the memory is freed.

Check disk space

Select this check box to throw an exception during execution if the disk is full.

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.

tStatCatcher Statistics

Select this check box to collect the log data at the component level.

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

STATISTICS

Usage rule

This is an output component used at the end of a Job. It receives data from its preceding component such as tFileInputDelimited, tMap or tMysqlInput.

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.