Contents x
Box Extract
  • Dark
    Light
Contents

Box Extract

  • Dark
    Light
This article is specific to the following platforms - Snowflake - Redshift - BigQuery.

Box Extract

The Box Extract component calls the Box API to retrieve and store data to be either referenced by an external table or loaded into a table, depending on the user's cloud data warehouse. Users can then transform their data with the Matillion ETL library of transformation components.

Using this component may return structured data that requires flattening. For help with flattening such data, we recommend using the Nested Data Load Component for Amazon Redshift and the Extract Nested Data Component for Snowflake or Google BigQuery.

Properties

Snowflake Properties
Property Setting Description
Name String A human-readable name for the component.
Data Source Select Select a Box data source.
OAuth Select Select the OAuth entry. An OAuth entry should be set up in advance and can be created by first clicking the Manage button. To learn how to configure an OAuth entry, read Box Authentication Guide.
Page Limit Integer Set the page limit for the amount of records to be returned and staged.
Location Storage Location Provide an S3 bucket path, GCS bucket path, or Azure Blob Storage path that will be used to store the data. Once on an S3 bucket, GCS bucket or Azure Blob, the data can be referenced by an external table. A folder will be created at this location with the same name as the Target Table.
Integration Select (GCP only) Choose your Google Cloud Storage Integration. Integrations are required to permit Snowflake to read data from and write to a Google Cloud Storage bucket. Integrations must be set up in advance of selecting them in Matillion ETL. To learn more about setting up a storage integration, read our Storage Integration Setup Guide.
Warehouse Select Choose a Snowflake warehouse that will run the load.
Database Select Choose a database to create the new table in.
Schema Select Select the table schema. For more information on using multiple schemas, please refer to this article.
Target Table String Provide a new table name.
Warning: Upon running the job, this table will be recreated and will drop any existing table of the same name.
Shared Link String Input the Box shared link. This property is only available when the Data Sources property is set to "Shared Items".
Shared Link Password String Input the password of the shared link. This property is only available when the Data Sources property is set to "Shared Items"

Redshift Properties
Property Setting Description
Name String A human-readable name for the component.
Data Source Select Select a Box data source.
OAuth Select Select the OAuth entry. An OAuth entry should be set up in advance and can be created by first clicking the Manage button. To learn how to configure an OAuth entry, read Box Authentication Guide.
Page Limit Integer Set the page limit for the amount of records to be returned and staged.
Location Select Provide an S3 bucket path that will be used to store the data. Once on an S3 bucket, the data can be referenced by an external table. A folder will be created at this location with the same name as the target table.
Type Dropdown Select between a standard table and an external table.
Standard Schema Dropdown Select the Redshift schema. The special value, [Environment Default], will use the schema defined in the Matillion ETL environment.
External Schema Select Select the table's external schema. To learn more about external schemas, please read our support documentation target="_blank">Getting Started With Amazon Redshift Spectrum.
For more information on using multiple schemas, see Schema Support.
Target Table String Provide a name for the external table to be used.
Warning: Upon running the job, this table will be recreated and will drop any existing table of the same name.
Shared Link String Input the Box shared link. This property is only available when the Data Sources property is set to "Shared Items".
Shared Link Password String Input the password of the shared link. This property is only available when the Data Sources property is set to "Shared Items"

BigQuery Properties
Property Setting Description
Name String A human-readable name for the component.
Data Source Select Select a Box data source.
OAuth Select Select the OAuth entry. An OAuth entry should be set up in advance and can be created by first clicking the Manage button. To learn how to configure an OAuth entry, read Box Authentication Guide.
Page Limit Integer Set the page limit for the amount of records to be returned and staged.
Table Type Select Select whether the table is Native (by default in BigQuery) or an external table.
Project Select Select the Google Bigquery project. The special value, [Environment Default], will use the project defined in the environment.
For more information, refer to the BigQuery documentation.
Dataset Select Select the Google Bigquery dataset to load data into. The special value, [Environment Default], will use the dataset defined in the environment.
For more information, refer to the BigQuery documentation.
Target Table String A name for the table.
Warning: This table will be recreated and will drop any existing table of the same name.
Only available when the table type is Native.
New Target Table String A name for the new external table.
Only available when the table type is External.
Cloud Storage Staging Area Cloud Storage Bucket Specify the target Google Cloud Storage bucket to be used for staging the queried data. Users can either:
  1. Input the URL string of the Cloud Storage bucket following the template provided: gs://<bucket>/<path>
  2. Navigate through the file structure to select the target bucket.

Only available when the table type is Native.
Location Cloud Storage Bucket Specify the target Google Cloud Storage bucket to be used for staging the queried data. Users can either:
  1. Input the URL string of the Cloud Storage bucket following the template provided: gs://<bucket>/<path>
  2. Navigate through the file structure to select the target bucket.
Only available when the table type is External.
Load Options Multiple Select Clean Cloud Storage Files: Destroy staged files on Cloud Storage after loading data. Default is On.
Cloud Storage File Prefix: Give staged file names a prefix of your choice. The default setting is an empty field.
Recreate Target Table: Choose whether the component recreates its target table before the data load. If Off, the component will use an existing table or create one if it does not exist. Default is On.
Use Grid Variable: Check this checkbox to use a grid variable. This box is unchecked by default.
Shared Link String Input the Box shared link. This property is only available when the Data Sources property is set to "Shared Items".
Shared Link Password String Input the password of the shared link. This property is only available when the Data Sources property is set to "Shared Items"

Data Source Properties

The following table lists any Data Source that requires users to configure an additional unique property, with details given about each unique property. If a Data Source is missing from this table, it does NOT have any unique component properties.

Data Source Property Name Type Description
Collaboration (by collaborationId) Collaboration ID String Input the ID of the Box collaboration.
Collaborations (by fileId) File ID String Input the ID of the Box file.
Collaborations (by folderId) Folder ID String Input the ID of the Box folder.
Comment (by commentId) Comment ID String Input the ID of the Box comment.
Comments (by fileID) File ID String Input the ID of the Box file.
Items Folder ID String Input the ID of the Box folder.
Membership (by membershipId) Membership ID String Input the ID of the Box membership.
Memberships (by userId) User ID String Input the ID of the Box user.
Task (by taskId) Task ID String Input the ID of the Box Task.
TaskAssignment (by taskAssignmentId) TaskAssignment ID String Input the ID of the Box TaskAssignment.
TaskAssignment (by taskId) TaskID String Input the ID of the Box Task.
Tasks (by fileId) File ID String Input the ID of the Box file.
What's Next

Cookie consent

We use our own and third-party cookies to understand how you interact with our knowledge base. This helps us show you more relevant content based on your browsing and navigation history.