Shopify Query Component

Shopify Query Component



Shopify Query

The Shopify Query component retrieves data from a Shopify server and loads it into a table. This action stages the data, so the table is reloaded each time. Users can then transform their data with Matillion ETL's library of transformation components.

Warning: This component is potentially destructive. If the target table undergoes a change in structure, it will be recreated. Otherwise, the target table is truncated. Setting the Load Option "Recreate Target Table" to Off will prevent both recreation and truncation. Do not modify the target table structure manually.



Redshift Properties

Property Setting Description
Name String Input the descriptive name for the component.
Basic/Advanced Mode Select Basic: This mode will build a query using settings from the Data Source, Data Selection, and Data Source Filter properties. In most cases, this mode will be sufficient.
Advanced: This mode will require you to write an SQL-like query to call data from Shopify. The available fields and their descriptions are documented in the Shopify Data Model.
Shop URL String Provide the URL of the Shopify server from which data is to be sourced. For help acquiring your Shopify URL, read our Shopify Query Authentication Guide.
App ID String Provide the AppID for your Shopify developer app. Within the Shopify portal, this is known as an API Key. For help acquiring this credential, read ourShopify Query Authentication Guide.
Password String Provide the login password for the chosen Shopify server. For help acquiring this credential, read ourShopify Query Authentication Guide.
Users have the option to store their password inside the component but we highly recommend using the Password Manager option.
Connection Options Parameter A JDBC parameter supported by the Database Driver. The available parameters are explained in the Shopify Data Model.
Manual setup is not usually required, since sensible defaults are assumed.
Value A value for the given Parameter.
SQL Query String This is an SQL-like SELECT query. Treat collections as table names, and fields as columns. (This Property is only available in Advanced Mode)
Data Source Select Select a data source from the Shopify server.
Data Selection Select Select one or more columns of your chosen Shopify data source to return from the query. Columns are determined by scanning the first few documents and looking for fields that appear in each document.
Data Source Filter Input Column Select an input column. The available input columns vary depending upon the data source.
Qualifier Is: Compares the column to the value using the comparator.
Not: Reverses the effect of the comparison, so "Equals" becomes "Not equals", "Less than" becomes "Greater than or equal to", etc.
Comparator Choose a method of comparing the column to the value. Possible comparators include: "Equal to", "Greater than", "Less than", "Greater than or equal to", "Less than or equal to", "Like", "Null".

"Equal to" can match exact strings and numeric values, while other comparators, such as "Greater than" and "Less than", will work only with numerics. The "Like" operator allows the wildcard character [%] to be used at the start and end of a string value to match a column. The Null operator matches only null values, ignoring whatever the value is set to.
Note: Not all data sources support all comparators, meaning that it is likely that only a subset of the above comparators will be available to choose from.
Value The value to be compared.
Combine Filters Select Select whether to use the defined filters in combination with one another according to either And or Or.
Limit Integer Set a numeric value to limit the number of rows that are loaded.
Type Select Choose between using a standard table or an external table.
Standard: The data will be staged on an S3 bucket before being loaded into a table.
External: The data will be put into an S3 bucket and referenced by an external table.
Schema Select Select the table schema. The special value, [Environment Default], will use the schema defined in the environment. For more information on using multiple schemas, see this article.
Note: An external schema is required if the Type property is set to "External".
Target Table String Provide a new table name.
Warning: This table will be recreated and will drop any existing table of the same name.
Location S3 Bucket Select an S3 bucket path that will be used to store the data. Once the data is on an S3 bucket, it can be referenced by an external table.
This property is only available when the Type property is set to "External".
S3 Staging Area Select The name of an S3 bucket for temporary storage. Ensure your access credentials have S3 access, as well as permission to write to the bucket. See this document for details on setting up access. The temporary objects created in this bucket will be removed again after the load completes, they are not kept.
Distribution Style Select All: Copy rows to all nodes in the Redshift cluster.
Auto: (Default) Allow Redshift to manage your distribution style.
Even: Distribute rows around the Redshift cluster evenly.
Key: Distribute rows around the Redshift cluster according to the value of a key column.
Table distribution is critical to good performance. See the Amazon Redshift documentation for more information.
Sort Key Multiple Select This is optional, and lets users specify one or more columns from the input that should be set as the table's sort key.
Sort keys are critical to good performance - see the Amazon Redshift documentation for more information.
Sort Key Options Select Decide whether the sort key is of a compound or interleaved variety - see the Amazon Redshift documentation for more information.
Primary Key Multiple Select Select one or more columns to be designated as the table's primary key.
Load Options Multiple Select Columns Comp Update: Apply automatic compression to the target table. Default is On.
Stat Update: Automatically update statistics when filling a table. Default is On. In this case, it is updating the statistics of the target table.
Clean S3 Objects: Automatically remove UUID-based objects on the S3 bucket. Default is On. Effectively, users decide here whether to keep the staged data in the S3 bucket or not.
String Null is Null: Converts any strings equal to "null" into a null value. This is case sensitive and only works with entirely lower-case strings. Default is On.
Recreate Target Table: Choose whether the component recreates its target table before the data load. If Off, the existing table will be used. Default is On.
File Prefix: Give staged file names a prefix of your choice. When this Load Option is selected, users should set their preferred prefix in the text field.
Use Grid Variable: Check this checkbox to use a grid variable. This box is unchecked by default.
Encryption Select Decide on how the files are encrypted inside the S3 bucket.
None: No encryption.
SSE KMS: Encrypt the data according to a key stored on KMS.
SSE S3: Encrypt the data according to a key stored on an S3 bucket.
KMS Key ID Select The ID of the KMS encryption key you have chosen to use in the Encryption property.
Auto Debug Select Choose whether to automatically log debug information about your load. These logs can be found in the Task History and should be included in support requests concerning the component. Turning this on will override any debugging Connection Options.
Debug Level Select The level of verbosity with which your debug information is logged. Levels above 1 can log huge amounts of data and result in slower execution.
1: Will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2: Will log everything included in Level 1, plus cache queries and additional information about the request, if applicable.
3: Will additionally log the body of the request and the response.
4: Will additionally log transport-level communication with the data source. This includes SSL negotiation.
5: Will additionally log communication with the data source, as well as additional details that may be helpful in troubleshooting problems. This includes interface commands.

Snowflake Properties

Property Setting Description
Name String Input the descriptive name for the component.
Basic/Advanced Mode Select Basic: This mode will build a query using settings from the Data Source, Data Selection, and Data Source Filter properties. In most cases, this mode will be sufficient.
Advanced: This mode will require you to write an SQL-like query to call data from Shopify. The available fields and their descriptions are documented in the Shopify Data Model.
Shop URL String Provide the URL of the Shopify server from which data is to be sourced. For help acquiring your Shopify URL, read our Shopify Query Authentication Guide.
App ID String Provide the AppID for your Shopify developer app. Within the Shopify portal, this is known as an API Key. For help acquiring this credential, read ourShopify Query Authentication Guide.
Password String Provide the login password for the chosen Shopify server. For help acquiring this credential, read ourShopify Query Authentication Guide.
Users have the option to store their password inside the component but we highly recommend using the Password Manager option.
Connection Options Parameter A JDBC parameter supported by the Database Driver. The available parameters are explained in the Shopify Data Model.
Manual setup is not usually required, since sensible defaults are assumed.
Value A value for the given Parameter.
SQL Query String This is an SQL-like SELECT query. Treat collections as table names, and fields as columns. (This Property is only available in Advanced Mode)
Data Source Select Select a data source from the Shopify server.
Data Selection Select Select one or more columns of your chosen Shopify data source to return from the query. Columns are determined by scanning the first few documents and looking for fields that appear in each document.
Data Source Filter Input Column Select an input column. The available input columns vary depending upon the data source.
Qualifier Is: Compares the column to the value using the comparator.
Not: Reverses the effect of the comparison, so "Equals" becomes "Not equals", "Less than" becomes "Greater than or equal to", etc.
Comparator Choose a method of comparing the column to the value. Possible comparators include: "Equal to", "Greater than", "Less than", "Greater than or equal to", "Less than or equal to", "Like", "Null".

"Equal to" can match exact strings and numeric values, while other comparators, such as "Greater than" and "Less than", will work only with numerics. The "Like" operator allows the wildcard character [%] to be used at the start and end of a string value to match a column. The Null operator matches only null values, ignoring whatever the value is set to.
Note: Not all data sources support all comparators, meaning that it is likely that only a subset of the above comparators will be available to choose from.
Value The value to be compared.
Combine Filters Select Select whether to use the defined filters in combination with one another according to either And or Or.
Limit Integer Set a numeric value to limit the number of rows that are loaded.
Primary Keys Select Select one or more columns to be designated as the table's primary key.
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. The special value, [Environment Default], will use the schema defined in the environment. For more information on using multiple schemas, see this article.
Target Table String Provide a new table name.
Warning: This table will be recreated and will drop any existing table of the same name.
Staging Select Select a staging setting.
Snowflake Managed: Allow Matillion ETL to create and use a temporary internal stage on Snowflake for staging the data. This stage, along with the staged data, will cease to exist after loading is complete.
(AWS only) Existing Amazon S3 Location: Selecting this will offer the S3 Staging Area property, allowing users to specify a custom staging area on Amazon S3.
(Azure only) Existing Azure Blob Storage Location: Selecting this will offer the Storage Account and Blob Container properties, allowing users to specify a custom staging location on Azure.
(GCP only) Existing Google Cloud Storage Location: Selecting this will offer the GCS Staging Area property, allowing users to specify a custom staging area within Google Cloud Storage.
S3 Staging Area Select (AWS only) Select an S3 bucket for temporary storage. Ensure your access credentials have S3 access and permission to write to the bucket. See this document for details on setting up access. The temporary objects created in this bucket will be removed again after the load completes, they are not kept.
Storage Account Select (Azure only) Select a Storage Account with your desired Blob Container to be used for staging the data.
Blob Container Select (Azure only) Select a Blob Container to be used for staging the data.
GCS Staging Area Select (GCP only) The URL and path of the target Google Cloud Storage bucket used for staging the queried data.
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.
Encryption Select (AWS only) Decide on how the files are encrypted inside the S3 bucket.
None: No encryption.
SSE KMS: Encrypt the data according to a key stored on KMS.
SSE S3: Encrypt the data according to a key stored on an S3 bucket
KMS Key ID Select (AWS only) The ID of the KMS encryption key you have chosen to use in the Encryption property.
Load Options Multiple Select Clean Staged Files: Destroy staged files after loading data. Default is On.
String Null is Null: Converts any strings equal to "null" into a null value. This is case sensitive and only works with entirely lower-case strings. Default is Off.
Recreate Target Table: Choose whether the component recreates its target table before the data load. If Off, the existing table will be used. Default is On.
File Prefix: Give staged file names a prefix of your choice. Default is empty (no prefix).
Trim String Columns: Remove leading and trailing characters from a string column. Default is On
Use Grid Variable: Check this checkbox to use a grid variable. This box is unchecked by default.
Auto Debug Select Choose whether to automatically log debug information about your load. These logs can be found in the Task History and should be included in support requests concerning the component. Turning this on will override any debugging Connection Options.
Debug Level Select The level of verbosity with which your debug information is logged. Levels above 1 can log huge amounts of data and result in slower execution.
1: Will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2: Will log everything included in Level 1, plus cache queries and additional information about the request, if applicable.
3: Will additionally log the body of the request and the response.
4: Will additionally log transport-level communication with the data source. This includes SSL negotiation.
5: Will additionally log communication with the data source, as well as additional details that may be helpful in troubleshooting problems. This includes interface commands.

BigQuery Properties

Property Setting Description
Name String Input the descriptive name for the component.
Basic/Advanced Mode Select Basic: This mode will build a query using settings from the Data Source, Data Selection, and Data Source Filter properties. In most cases, this mode will be sufficient.
Advanced: This mode will require you to write an SQL-like query to call data from Shopify. The available fields and their descriptions are documented in the Shopify Data Model.
Shop URL String Provide the URL of the Shopify server from which data is to be sourced. For help acquiring your Shopify URL, read our Shopify Query Authentication Guide.
App ID String Provide the AppID for your Shopify developer app. Within the Shopify portal, this is known as an API Key. For help acquiring this credential, read ourShopify Query Authentication Guide.
Password String Provide the login password for the chosen Shopify server. For help acquiring this credential, read ourShopify Query Authentication Guide.
Users have the option to store their password inside the component but we highly recommend using the Password Manager option.
Connection Options Parameter A JDBC parameter supported by the Database Driver. The available parameters are explained in the Shopify Data Model.
Manual setup is not usually required, since sensible defaults are assumed.
Value A value for the given Parameter.
SQL Query String This is an SQL-like SELECT query. Treat collections as table names, and fields as columns. (This Property is only available in Advanced Mode)
Data Source Select Select a data source from the Shopify server.
Data Selection Select Select one or more columns of your chosen Shopify data source to return from the query. Columns are determined by scanning the first few documents and looking for fields that appear in each document.
Data Source Filter Input Column Select an input column. The available input columns vary depending upon the data source.
Qualifier Is: Compares the column to the value using the comparator.
Not: Reverses the effect of the comparison, so "Equals" becomes "Not equals", "Less than" becomes "Greater than or equal to", etc.
Comparator Choose a method of comparing the column to the value. Possible comparators include: "Equal to", "Greater than", "Less than", "Greater than or equal to", "Less than or equal to", "Like", "Null".

"Equal to" can match exact strings and numeric values, while other comparators, such as "Greater than" and "Less than", will work only with numerics. The "Like" operator allows the wildcard character [%] to be used at the start and end of a string value to match a column. The Null operator matches only null values, ignoring whatever the value is set to.
Note: Not all data sources support all comparators, meaning that it is likely that only a subset of the above comparators will be available to choose from.
Value The value to be compared.
Combine Filters Select Select whether to use the defined filters in combination with one another according to either And or Or.
Limit Integer Set a numeric value to limit the number of rows that are loaded.
Project Select The target BigQuery project to load data into.
Dataset Select The target BigQuery dataset to load data into.
Target Table String Provide a new table name.
Warning: This table will be recreated and will drop any existing table of the same name.
Cloud Storage Staging Area Cloud Storage Bucket The URL and path of the target Google Storage bucket to be used for staging the queried data.
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. Default is empty (no prefix).
Recreate Target Table: Choose whether the component recreates its target table before the data load. If Off, the existing table will be used. Default is On.
Use Grid Variable: Check this checkbox to use a grid variable. This box is unchecked by default.
Auto Debug Select Choose whether to automatically log debug information about your load. These logs can be found in the Task History and should be included in support requests concerning the component. Turning this on will override any debugging Connection Options.
Debug Level Select The level of verbosity with which your debug information is logged. Levels above 1 can log huge amounts of data and result in slower execution.
1: Will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2: Will log everything included in Level 1, plus cache queries and additional information about the request, if applicable.
3: Will additionally log the body of the request and the response.
4: Will additionally log transport-level communication with the data source. This includes SSL negotiation.
5: Will additionally log communication with the data source, as well as additional details that may be helpful in troubleshooting problems. This includes interface commands.

Variable Exports

This component makes the following values available to export into variables:

Source Description
Time Taken To Stage The amount of time (in seconds) taken to fetch the data from the data source and upload it to storage.
Time Taken To Load The amount of time (in seconds) taken to execute the COPY statement to load the data into the target table from storage.

Strategy

Connect to the target database and issue the query. Stream the results into objects on S3. Then create or truncate the target table and issue a COPY command to load the S3 objects into the table. Finally, clean up the temporary S3 objects.


Filtering Order Results

The Shopify Query component uses the Shopify API to process search criteria that refer to these columns:

  • Id
  • CustomerId
  • FinancialStatus
  • FulfillmentStatus
  • CreatedAt
  • ProcessedAt
  • UpdatedAt

The supported SQL operators for each mentioned column are cited in the table below:

Column Supported SQL Operator
Id 1. =
2. IN
CustomerId 1. =
FinancialStatus 1. =
FulfillmentStatus 1. =
CreatedAt 1. <
2. >
ProcessAt 1. <
2. >
UpdatedAt 1. <
2. >

The Shopify Query driver processes other filters client-side within the driver.

For example, the following queries are processed server side:

SELECT * FROM Orders
SELECT * FROM Orders WHERE Id='123'
SELECT * FROM Orders WHERE CustomerId='123'
SELECT * FROM Orders WHERE FinancialStatus = 'pending'
SELECT * FROM Orders WHERE CreatedAt > '2017-10-25'

Contact Support

If you have any questions about Matillion ETL's Shopify Query component, or require assistance with any other aspect of Matillion ETL, please contact our support team.