Skip to content

JSON Load

JSON Load is an orchestration component that allows you to load data into a table from one or more JSON files from a source location. It automatically infers the schema from the structure of the selected file(s), creates the corresponding table, and loads the data into it.


Properties

Name = string

A human-readable name for the component.


Connect

Type = drop-down

  • Snowflake Managed: Load your file from a Snowflake internal stage.
  • S3: Load your file from an S3 bucket.
  • Google Cloud Storage: Load your file from a Google Cloud Storage bucket.
  • Azure Blob Storage: Load your file from an Azure Blob Storage container.

Stage = drop-down

Select a staging area for the data. The special value [New Stage] will create a temporary stage to be used for loading the data when the corresponding parameter values are provided.

The options in this drop-down menu depend on the values you select for the Database and Schema parameters. If you change these values, the list of available options updates automatically, and the previously selected option may become invalid.

When [New Stage] is selected, the component uses the cloud credentials configured for your environment to access the required resources.

Staged File Path = string (optional)

A stage may include directories. The user has the option to browse and select files from a specific directory path, for example, /Example/Path.

If this is left blank, and if the Pattern parameter is also empty, all files from the stage will be loaded.

S3 Object Prefix = file explorer

To retrieve the intended files, use the file explorer to enter the container path where the S3 bucket is located, or select from the list of S3 buckets.

This must have the format S3://<bucket>/<path>.


Encryption = drop-down

Decide how the files are encrypted inside the S3 bucket. This property is available when using an existing Amazon S3 location for staging.


KMS Key ID = drop-down

The ID of the KMS encryption key you have chosen to use in the Encryption property.

Only available when Encryption is set to KMS Encryption.


Master Key = drop-down

The secret definition denoting your master key for client-side encryption. Your password should be saved as a secret definition before using this component.

Only available when Encryption is set to Client Side Encryption.

Storage Integration = drop-down

Select the storage integration. Storage integrations are required to permit Snowflake to read from and write to a cloud storage location. Integrations must be set up in advance and configured to support Google Cloud Storage. For more information, read Create storage integration.


Google Storage URL Location = file explorer

To retrieve the intended files, use the file explorer to enter the container path where the Google Cloud Storage bucket is located, or select from the list of Google Cloud Storage buckets.

This must have the format gs://<bucket>/<path>.

Azure Storage Location = file explorer

To retrieve the intended files, use the file explorer to enter the container path where the Azure Storage account is located, or select from the list of storage accounts.

This must have the format azure://<STORAGEACCOUNT>/<path>.


Pattern = string (optional)

A valid regular expression (regex) to match part of a file's path or name. Files that match the pattern will be included in the load.

By default, this parameter is set to .*, which matches all files in the specified Staged File Path or Stage parameters. The pattern applies to the entire file path, not just the directory defined in Staged File Path. If the parameter is left empty, the component automatically uses the pattern .*\.json.

The subfolder containing the object to load must be included here.

Note

  • Any pattern entered assumes the file extension .json.
  • Only .json files are supported. Ensure the files you select are valid JSON files.

Configure

File Format = drop-down

The default value is set to [New File Format]. Specify a file format, and a temporary format with those settings will be used when the component runs. Alternatively, select a pre-made file format.


Compression = drop-down

Select the compression method if you wish to compress your data. If you do not wish to compress at all, select NONE.

The default setting is AUTO.


Enable Octal = boolean

When True, enables the parsing of octal values.

Default setting is False.


Allow Duplicates = boolean

When True, allows duplicate object field names.

Default setting is False.


Strip Outer Array = boolean

When True, instructs the JSON parser to remove outer brackets.

Default setting is False.


Strip Null Values = boolean

When True, instructs the JSON parser to remove any object fields or array elements containing NULL values.

Default setting is False.


Ignore UTF8 Errors = boolean

When True, replaces any invalid UTF-8 sequences with Unicode characters. When False, UTF-8 errors will not produce an error in the pipeline run.

Default setting is False.


Binary Format = drop-down

Determines how binary string values are encoded in data files. Use this setting when importing data into a table’s binary columns.

Choose from the following options:

  • HEX: Binary string values are encoded as hexadecimal strings.
  • BASE64: Binary string values are encoded as Base64 strings.
  • UTF8: Binary string values are encoded as UTF-8 strings.

Default setting is HEX.

This will only work when Match By Column Name is set to either Case Insensitive or Case Sensitive.


Multi Line = boolean

Allows multiple lines in a JSON record. When set to No, any JSON record containing a newline character is considered invalid, and will trigger an error.

Default setting is False.


Replace Invalid Characters = boolean

Snowflake replaces invalid UTF-8 characters with the Unicode replacement character. When False, the load operation produces an error when invalid UTF-8 character encoding is detected.

Default setting is False.


Skip Byte Order Mark = boolean

Determines whether to ignore a BOM (byte order mark) in the input file.

If set to FALSE, Snowflake processes any BOM found in the file, which may lead to errors or cause the BOM to be included in the first column of the table.

Default setting is True.


Null If = editor (optional)

Specify one or more strings (one string per row of the table) to convert to NULL values. When one of these strings is encountered in the file, it is replaced with an SQL NULL value for that field in the loaded table. Click + to add a string.

This will only work when Match By Column Name is set to either Case Insensitive or Case Sensitive.


Destination

Warehouse = drop-down

The Snowflake warehouse used to run the queries. The special value [Environment Default] uses the warehouse defined in the environment. Read Overview of Warehouses to learn more.


Database = drop-down

The Snowflake database. The special value [Environment Default] uses the database defined in the environment. Read Databases, Tables and Views - Overview to learn more.


Schema = drop-down

The Snowflake schema. The special value [Environment Default] uses the schema defined in the environment. Read Database, Schema, and Share DDL to learn more.


Target Table Name = string

Select an existing table to load data into. The tables available for selection depend on the chosen schema.


Load Strategy = string

  • Replace: If the specified table name already exists, that table will be destroyed and replaced by the table created during this pipeline run.
  • Truncate and Insert: If the specified table name already exists, all rows within the table will be removed and new rows will be inserted per the next run of this pipeline.
  • Fail if Exists: If the specified table name already exists, this pipeline will fail to run, and no data will be copied to the table.
  • Append: If the specified table name already exists, then the data is inserted without altering or deleting the existing data in the table. It's appended onto the end of the existing data in the table. If the specified table name doesn't exist, then the table will be created, and your data will be inserted into the table. For example, if you have a source holding 100 records, then on the first pipeline run, your target table will be created and 100 rows will be inserted. On the second pipeline run, those same 100 records will be appended to your existing target table, so now it holds 200 records. Third pipeline run will be 300 records in your table, and so on.

Advanced Settings

On Error = drop-down

Decide how to proceed upon an error.

  • Abort Statement: Aborts the load if any error is encountered. This is the default setting.
  • Continue: Continue loading the file.
  • Skip File: Skip file if any errors are encountered in the file.
  • Skip File When n Errors: Skip file when the number of errors in the file is equal to or greater than the specified number in the next property, n.
  • Skip File When n% Errors: Skip file when the percentage of errors in the file exceeds the specified percentage of n.

n = integer

Specify the number of errors or the percentage of errors required to skip the file. This parameter only accepts integer characters. % is not accepted. Specify percentages as a number only.


Size Limit (in bytes) = integer (optional)

Specify the maximum size, in bytes, of data to be loaded for a given COPY statement. If the maximum is exceeded, the COPY operation discontinues loading files. For more information, refer to the Snowflake documentation.


Purge Files = boolean

When True, purges data files after the data is successfully loaded.

Default setting is False.


Match By Column Name = drop-down

Specify whether to load semi-structured data into columns in the target table that match corresponding columns represented in the data.

  • Case Insensitive: Load semi-structured data into columns in the target table that match corresponding columns represented in the data. Column names should be case-insensitive.
  • Case Sensitive: Load semi-structured data into columns in the target table that match corresponding columns represented in the data. Column names should be case-sensitive.
  • None: The COPY operation loads the semi-structured data into a variant column or, if a query is included in the COPY statement, transforms the data.

Truncate Columns = boolean

When True, strings are automatically truncated to the target column length. When False, the COPY statement produces an error if a loaded string exceeds the target column length.

Default setting is False.


Force Load = boolean

When True, loads all files, regardless of whether they have been loaded previously and haven't changed since they were loaded.

Default setting is False.

When set to True, this option reloads files and can lead to duplicated data in a table.


Snowflake Databricks Amazon Redshift

Got feedback or spotted something we can improve?

We'd love to hear from you. Join the conversation in the Documentation forum!