> ## Documentation Index
> Fetch the complete documentation index at: https://docs.maia.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# New Relic



\<table><tbody><tr><td>Project Availability</td>
            \<td /></tr>
          \<tr><td>Component Type</td>
            \<td>Connector, Orchestration</td></tr>
          \<tr><td>Connection Inputs</td>
            \<td>One</td></tr>
          \<tr><td>Connection Outputs</td>
            \<td>Three</td></tr></tbody></table>

This page describes how to configure the New Relic connector component as part of a data pipeline within Designer. The New Relic component uses the Connect and Configure parameters to create a table of New Relic data, which is then stored in your chosen data warehouse or cloud storage location. You *do not* need to use the Create Table component when using this connector, as the New Relic component will create a new table or replace an existing table for you using the Destination parameters you define.The New Relic connector is a Flex connector. Out of the box, you can use it to:- Retrieve a list of account users.
- Retrieve a list of applications and key transactions.
- Retrieve a list of alert policies.In Maia, Flex connectors let you connect to a curated set of endpoints to load data.You can use the New Relic connector in its preconfigured state, *or* you can edit the connector by adding or amending available New Relic endpoints as per your use case. You can edit Flex connectors in the [Custom Connector](https://docs.maia.ai/docs/guides/custom-connector-setup.md) user interface.For detailed information about authentication, specific endpoint parameters, pagination, and more aspects of the New Relic API, read the [New Relic API documentation](https://docs.newrelic.com/docs/apis/rest-api-v2/get-started/introduction-new-relic-rest-api-v2/).***## PropertiesReference material is provided below for the Connect, Configure, Destination, and Advanced Settings properties.**Name** `string` *required*A human-readable name for the component.### Connect**Data Source** `drop-down` *required*The data source to load data from in this pipeline. The drop-down menu lists the New Relic API endpoints available in the connector. For detailed information about specific endpoints, read the [New Relic API documentation](https://docs.newrelic.com/docs/apis/rest-api-v2/get-started/introduction-new-relic-rest-api-v2/).| Endpoint | Method | Reference |
| - | - | - |
| Account Users | GET | [Returns a list of all account users](https://docs.newrelic.com/docs/apis/rest-api-v2/account-examples-v2/listing-users-your-account/#list_all_users) |
| Applications | GET | [Returns a paginated list of the applications associated with your New Relic account](https://api.newrelic.com/docs/#/Applications/get_applications_json) |
| Key Transactions | GET | [Returns a paginated list of the key transactions associated with your New Relic account](https://api.newrelic.com/docs/#/Key%20Transactions/get_key_transactions_json) |
| Alerts Policies | GET | [Returns a list of the alert policies associated with your New Relic account](https://api.newrelic.com/docs/#/Alerts%20Policies/get_alerts_policies_json) |**Authentication Type** `drop-down` *required*The authentication method to authorize access to your New Relic data. Currently supports API Key.**Key** `string` *required*The key of a working API key:value pair.Enter `X-Api-Key` in the **Key** field.**Value** `drop-down` *required*Use the drop-down menu to select the corresponding secret definition that denotes the value of a working API key:value pair.Read [Secrets and secret definitions](https://docs.maia.ai/docs/guides/secrets-and-secret-definitions.md) to learn how to create a new secret definition.Read the New Relic API documentation to learn how to [acquire an API key](https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/#keys-ui).### Configure**URI Parameters** `column editor` *required*- **Parameter Name:** The name of a URI parameter.
- **Parameter Value:** The value of the corresponding parameter.| Required parameter | Endpoints | Description |
| - | - | - |
| server | All endpoints | The server from which the data is being accessed. Choose from the following options: `api`, `api.eu`, and `staging-api`. |
| api\_version | All endpoints | Enter `v2`. |**Query Parameters** `column editor` *required*- **Parameter Name:** The name of a query parameter.
- **Parameter Value:** The value of the corresponding parameter.**Header Parameters** `column editor` *required*- **Parameter Name:** The name of a header parameter.
- **Parameter Value:** The value of the corresponding parameter.| Required parameter | Endpoints | Description |
| - | - | - |
| accept | All endpoints | application/json |**Post Body** `JSON`If you're sending a `POST` request, enter a JSON body to include in the request.We recommend using the custom connector editor to [send a test request](https://docs.maia.ai/docs/guides/custom-connector-setup.md#send-a-test-request) to make sure your JSON body works as expected. For additional information about endpoints and requests, consult the documentation for the API you're connecting to.**Page Limit** `integer`Enter a numeric value to use as the maximum number of records per page.### DestinationSelect your cloud data warehouse.> [tab] Snowflake
>
> **Destination** `drop-down` *required*
>
> * **Snowflake:** Load your data into Snowflake. You'll need to set a cloud storage location for temporary staging of the data.
> * **Cloud Storage:** Load your data directly into your preferred cloud storage location.
>
> Click either the **Snowflake** or **Cloud Storage** tab on this page for documentation applicable to that destination type.
>
> > [tab] Snowflake
> >
> > **Warehouse** `drop-down` *required*
> >
> > The Snowflake warehouse used to run the queries. The special value `[Environment Default]` uses the warehouse defined in the environment. Read [Overview of Warehouses](https://docs.snowflake.com/en/user-guide/warehouses-overview.html) to learn more.
> >
> > **Database** `drop-down` *required*
> >
> > The Snowflake database. The special value `[Environment Default]` uses the database defined in the environment. Read [Databases, Tables and Views - Overview](https://docs.snowflake.com/en/guides-overview-db) to learn more.
> >
> > **Schema** `drop-down` *required*
> >
> > The Snowflake schema. The special value `[Environment Default]` uses the schema defined in the environment. Read [Database, Schema, and Share DDL](https://docs.snowflake.com/en/sql-reference/ddl-database.html) to learn more.
> >
> > **Table Name** `string` *required*
> >
> > The name of the table to be created.
> >
> > **Load Strategy** `drop-down` *required*
> >
> > * **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:** Each time the pipeline runs, two operations are performed: first, the table is truncated, meaning all existing rows are deleted. Then, your new rows are inserted. The table itself is never destroyed and recreated.
> > * **Fail if Exists:** If the specified table name already exists, this pipeline will fail to run.
> > * **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.
> >
> > **Clean Staged files** `boolean` *required*
> >
> > * **Yes:** Staged files will be destroyed after data is loaded. This is the default setting.
> > * **No:** Staged files are retained in the staging area after data is loaded.
> >
> > **Stage Access Strategy** `drop-down`
> >
> > Select the stage access strategy. The strategies available depend on the cloud platform you select in **Stage Platform**.
> >
> > * **Credentials:** Connects to the external stage (AWS, Azure) using your configured [cloud provider credentials](https://docs.maia.ai/docs/guides/cloud-credentials.md). Not available for Google Cloud Storage.
> > * **Storage Integration:** Use a Snowflake storage integration to grant access to Snowflake to read data from and write to a cloud storage location. This will reveal the **Storage Integration** property, through which you can select any of your existing Snowflake storage integrations.
> >
> > **Stage Platform** `drop-down` *required*
> >
> > Choose a data staging platform using the drop-down menu.
> >
> > * **Amazon S3:** Stage your data on an AWS S3 bucket.
> > * **Snowflake:** Stage your data on a Snowflake internal stage.
> > * **Azure Storage:** Stage your data in an Azure Blob Storage container.
> > * **Google Cloud Storage:** Stage your data in a Google Cloud Storage bucket.
> >
> > Click one of the tabs below for documentation applicable to that staging platform.
> >
> > > [tab] Amazon S3
> > >
> > > **Storage Integration** `drop-down` *required*
> > >
> > > Select the storage integration. Storage integrations are required to permit Snowflake to read data from and write to a cloud storage location. Integrations must be set up in advance of selecting them. Storage integrations can be configured to support Amazon S3, Google Cloud Storage, or Microsoft Azure Blob Storage, regardless of the cloud provider that hosts your Snowflake account.
> > >
> > > **Amazon S3 Bucket** `drop-down` *required*
> > >
> > > An AWS S3 bucket to stage data into. The drop-down menu will include buckets tied to the [cloud provider credentials](https://docs.maia.ai/docs/guides/cloud-credentials.md) that you have associated with your [environment](https://docs.maia.ai/docs/guides/environments.md).
> >
> > > [tab] Snowflake
> > >
> > > **Internal Stage Type** `drop-down` *required*
> > >
> > > Select the Snowflake internal stage type. Use the Snowflake links provided to learn more about each type of stage.
> > >
> > > * **User:** Each Snowflake user has a [user stage](https://docs.snowflake.com/en/user-guide/data-load-local-file-system-create-stage#user-stages) allocated to them by default for file storage. You may find the user stage convenient if your files will only be accessed by a single user, but need to be copied into multiple tables.
> > > * **Named:** A [named stage](https://docs.snowflake.com/en/user-guide/data-load-local-file-system-create-stage#named-stages) provides high flexibility for data loading. Users with the appropriate privileges on the stage can load data into any table. Furthermore, because the stage is a database object, any security or access rules that apply to all objects will apply to the named stage.
> > >
> > > Named stages can be altered and dropped. User stages cannot.
> > >
> > > **Named Stage** `drop-down` *required*
> > >
> > > Select your named stage. Read [Creating a named stage](https://docs.snowflake.com/en/user-guide/data-load-local-file-system-create-stage#creating-a-named-stage) to learn how to create a new named stage.
> > >
> > > > [!NOTE]
> > > >
> > > > You can't select a named stage if its name includes special characters or spaces.
> >
> > > [tab] Azure Storage
> > >
> > > **Storage Integration** `drop-down` *required*
> > >
> > > Select the storage integration. Storage integrations are required to permit Snowflake to read data from and write to a cloud storage location. Integrations must be set up in advance of selecting them. Storage integrations can be configured to support Amazon S3, Google Cloud Storage, or Microsoft Azure Blob Storage, regardless of the cloud provider that hosts your Snowflake account.
> > >
> > > **Storage Account** `drop-down` *required*
> > >
> > > Select a storage account linked to your desired blob container to be used for staging the data. For more information, read [Storage account overview](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-overview).
> > >
> > > **Container** `drop-down` *required*
> > >
> > > Select a Blob container to be used for staging the data. For more information, read [Introduction to Azure Blob storage](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction).
> >
> > > [tab] Google Cloud Storage
> > >
> > > **Stage Access Strategy** `drop-down`
> > >
> > > Select the stage access strategy. The strategies available depend on the cloud platform you select in **Stage Platform**.
> > >
> > > * **Storage Integration:** Use a Snowflake storage integration to grant access to Snowflake to read data from and write to a cloud storage location. This will reveal the **Storage Integration** property, through which you can select any of your existing Snowflake storage integrations.
> > >
> > > **Storage Integration** `drop-down` *required*
> > >
> > > Select the storage integration. Storage integrations are required to permit Snowflake to read data from and write to a cloud storage location. Integrations must be set up in advance of selecting them. Storage integrations can be configured to support Amazon S3, Google Cloud Storage, or Microsoft Azure Blob Storage, regardless of the cloud provider that hosts your Snowflake account.
> > >
> > > **GCS Bucket** `drop-down` *required*
> > >
> > > The drop-down menu will include Google Cloud Storage (GCS) buckets tied to the [cloud provider credentials](https://docs.maia.ai/docs/guides/cloud-credentials.md) that you have associated with your [environment](https://docs.maia.ai/docs/guides/environments.md).
> > >
> > > **Overwrite** `boolean` *required*
> > >
> > > Select whether to overwrite files of the same name when this pipeline runs. Default is Yes.
>
> > [tab] Cloud Storage
> >
> > **Load Strategy** `drop-down`
> >
> > * **Append Files in Folder:** Appends files to storage folder. This is the default setting.
> > * **Overwrite Files in Folder:** Overwrite existing files with matching structure.
> >
> > See the configuration table for how this parameter works with the Folder Path and File Prefix parameters:
> >
> > | Configuration | Description |
> > | - | - |
> > | Append files in folder with defined folder path and file prefix. | Files will be stored under the structure `uniqueID/timestamp-partX` where X is the part number, starting from 1. |
> > | Append files in folder without defined folder path and file prefix. | Files will be stored under the structure `folder/prefix-timestamp-partX` where X is the part number, starting from 1. |
> > | Overwrite files in folder with defined folder path and file prefix. | Files will be stored under the structure `folder/prefix-partX` where X is the part number, starting from 1. All files with matching structures will be overwritten. |
> > | Overwrite files in folder without defined folder path and file prefix. | Validation will fail. Folder path and file prefix must be supplied for this load strategy. |
> >
> > **Folder Path** `string`
> >
> > The folder path of the written files.
> >
> > **File Prefix** `string`
> >
> > A string of characters to include at the beginning of the written files. Often used for organizing database objects.
> >
> > **Storage** `drop-down` *required*
> >
> > A cloud storage location to load your data into for storage. Choose either Amazon S3, Azure Storage, or Google Cloud Storage.
> >
> > Click the tab that corresponds to your chosen cloud storage service.
> >
> > > [tab] Amazon S3
> > >
> > > **Amazon S3 Bucket** `drop-down` *required*
> > >
> > > An AWS S3 bucket to load data into. The drop-down menu will include buckets tied to the [cloud provider credentials](https://docs.maia.ai/docs/guides/cloud-credentials.md) that you have associated with your [environment](https://docs.maia.ai/docs/guides/environments.md).
> >
> > > [tab] Azure Storage
> > >
> > > **Storage Account** `drop-down` *required*
> > >
> > > Select a storage account linked to your desired blob container to be used for staging the data. For more information, read [Storage account overview](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-overview).
> > >
> > > **Container** `drop-down` *required*
> > >
> > > Select a Blob container to be used for staging the data. For more information, read [Introduction to Azure Blob storage](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction).
> >
> > > [tab] Google Cloud Storage
> > >
> > > **GCS Bucket** `drop-down` *required*
> > >
> > > The drop-down menu will include Google Cloud Storage (GCS) buckets tied to the [cloud provider credentials](https://docs.maia.ai/docs/guides/cloud-credentials.md) that you have associated with your [environment](https://docs.maia.ai/docs/guides/environments.md).
> > >
> > > **Overwrite** `boolean` *required*
> > >
> > > Select whether to overwrite files of the same name when this pipeline runs. Default is Yes.> [tab] Databricks
>
> **Destination** `drop-down` *required*
>
> * **Databricks:** Load your data into Databricks. You'll need to set a cloud storage location for temporary staging of the data.
> * **Cloud Storage:** Load your data directly into your preferred cloud storage location.
>
> Click either the **Databricks** or **Cloud Storage** tab on this page for documentation applicable to that destination type.
>
> > [tab] Databricks
> >
> > **Catalog** `drop-down` *required*
> >
> > Select a [Databricks Unity Catalog](https://docs.databricks.com/en/data-governance/unity-catalog/index.html). The special value `[Environment Default]` uses the catalog defined in the environment. Selecting a catalog will determine which databases are available in the next parameter.
> >
> > **Schema** `drop-down` *required*
> >
> > The Databricks schema. The special value `[Environment Default]` uses the schema defined in the environment. Read [Create and manage schemas](https://docs.databricks.com/en/data-governance/unity-catalog/create-schemas.html) to learn more.
> >
> > **Table Name** `string` *required*
> >
> > The name of the table to be created.
> >
> > **Load Strategy** `drop-down` *required*
> >
> > * **Fail if Exists:** If the specified table name already exists, this pipeline will fail to run.
> > * **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:** Each time the pipeline runs, two operations are performed: first, the table is truncated, meaning all existing rows are deleted. Then, your new rows are inserted. The table itself is never destroyed and recreated.
> > * **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.
> >
> > **Column Mapping** `column editor`
> >
> > In the tree structure representing the source data, select the checkboxes next to the fields that you want to output from this connector, then click **Save**.
> >
> > Unselected fields will not be included in the output from this connector.
> >
> > For each field you select, you can click the **Edit Alias** icon to change the name used for this field in all downstream components in this pipeline.
> >
> > **Outer Join** `boolean`
> >
> > Determines what happens to a row when a mapped column comes from a field nested inside an array that's empty or missing for that row. This property only appears once your **Column Mapping** includes a field nested inside an array.
> >
> > * **Yes:** Keep the row, and populate the mapped column with `NULL`. This is the default setting.
> > * **No:** Omit the row from the output entirely.
> >
> > **Primary Keys** `object selector`
> >
> > Select one or more columns to use as the table's primary key. If you select multiple columns, the component creates a composite primary key using the combination of the selected columns.
> >
> > Leave this blank to create the table without a primary key.
> >
> > **Clean Staged Files** `boolean` *required*
> >
> > * **Yes:** Staged files will be destroyed after data is loaded. This is the default setting.
> > * **No:** Staged files are retained in the staging area after data is loaded.
> >
> > **Stage Platform** `drop-down` *required*
> >
> > Choose a data staging platform using the drop-down menu.
> >
> > * **Amazon S3:** Stage your data on an AWS S3 bucket.
> > * **Azure Storage:** Stage your data in an Azure Blob Storage container.
> >
> > Click one of the tabs below for documentation applicable to that staging platform.
> >
> > > [tab] Amazon S3
> > >
> > > **Amazon S3 Bucket** `drop-down` *required*
> > >
> > > An AWS S3 bucket to stage data into. The drop-down menu will include buckets tied to the [cloud provider credentials](https://docs.maia.ai/docs/guides/cloud-credentials.md) that you have associated with your [environment](https://docs.maia.ai/docs/guides/environments.md).
> >
> > > [tab] Azure Storage
> > >
> > > **Storage Account** `drop-down` *required*
> > >
> > > Select a storage account linked to your desired blob container to be used for staging the data. For more information, read [Storage account overview](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-overview).
> > >
> > > **Container** `drop-down` *required*
> > >
> > > Select a Blob container to be used for staging the data. For more information, read [Introduction to Azure Blob storage](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction).
>
> > [tab] Cloud Storage
> >
> > **Load Strategy** `drop-down`
> >
> > * **Append Files in Folder:** Appends files to storage folder. This is the default setting.
> > * **Overwrite Files in Folder:** Overwrite existing files with matching structure.
> >
> > See the configuration table for how this parameter works with the Folder Path and File Prefix parameters:
> >
> > | Configuration | Description |
> > | - | - |
> > | Append files in folder with defined folder path and file prefix. | Files will be stored under the structure `uniqueID/timestamp-partX` where X is the part number, starting from 1. |
> > | Append files in folder without defined folder path and file prefix. | Files will be stored under the structure `folder/prefix-timestamp-partX` where X is the part number, starting from 1. |
> > | Overwrite files in folder with defined folder path and file prefix. | Files will be stored under the structure `folder/prefix-partX` where X is the part number, starting from 1. All files with matching structures will be overwritten. |
> > | Overwrite files in folder without defined folder path and file prefix. | Validation will fail. Folder path and file prefix must be supplied for this load strategy. |
> >
> > **Folder Path** `string`
> >
> > The folder path of the written files.
> >
> > **File Prefix** `string`
> >
> > A string of characters to include at the beginning of the written files. Often used for organizing database objects.
> >
> > **Storage** `drop-down` *required*
> >
> > A cloud storage location to load your data into for storage. Choose either Amazon S3, Azure Storage, or Google Cloud Storage.
> >
> > Click the tab that corresponds to your chosen cloud storage service.
> >
> > > [tab] Amazon S3
> > >
> > > **Amazon S3 Bucket** `drop-down` *required*
> > >
> > > An AWS S3 bucket to load data into. The drop-down menu will include buckets tied to the [cloud provider credentials](https://docs.maia.ai/docs/guides/cloud-credentials.md) that you have associated with your [environment](https://docs.maia.ai/docs/guides/environments.md).
> >
> > > [tab] Azure Storage
> > >
> > > **Storage Account** `drop-down` *required*
> > >
> > > Select a storage account linked to your desired blob container to be used for staging the data. For more information, read [Storage account overview](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-overview).
> > >
> > > **Container** `drop-down` *required*
> > >
> > > Select a Blob container to be used for staging the data. For more information, read [Introduction to Azure Blob storage](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction).
> >
> > > [tab] Google Cloud Storage
> > >
> > > **GCS Bucket** `drop-down` *required*
> > >
> > > The drop-down menu will include Google Cloud Storage (GCS) buckets tied to the [cloud provider credentials](https://docs.maia.ai/docs/guides/cloud-credentials.md) that you have associated with your [environment](https://docs.maia.ai/docs/guides/environments.md).
> > >
> > > **Overwrite** `boolean` *required*
> > >
> > > Select whether to overwrite files of the same name when this pipeline runs. Default is Yes.> [tab] Amazon Redshift
>
> **Destination** `drop-down` *required*
>
> * **Redshift:** Load your data into Amazon Redshift. You'll need to set a cloud storage location for temporary staging of the data.
> * **Cloud Storage:** Load your data directly into your preferred cloud storage location.
>
> Click either the **Amazon Redshift** or **Cloud Storage** tab on this page for documentation applicable to that destination type.
>
> > [tab] Amazon Redshift
> >
> > **Schema** `drop-down` *required*
> >
> > The Amazon Redshift schema. The special value `[Environment Default]` uses the schema defined in the environment. Read [Schemas](https://docs.aws.amazon.com/redshift/latest/dg/r_Schemas_and_tables.html) to learn more.
> >
> > For more information on using multiple schemas, read [Schemas](https://docs.aws.amazon.com/redshift/latest/dg/r_Schemas_and_tables.html).
> >
> > **Table Name** `string` *required*
> >
> > The name of the table to be created.
> >
> > **Load Strategy** `drop-down` *required*
> >
> > * **Replace:** If the specified table name already exists, that table will be destroyed and replaced by the table created during this pipeline run.
> > * **Fail if Exists:** If the specified table name already exists, this pipeline will fail to run.
> > * **Truncate and Insert:** Each time the pipeline runs, two operations are performed: first, the table is truncated, meaning all existing rows are deleted. Then, your new rows are inserted. The table itself is never destroyed and recreated.
> > * **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.
> >
> > **Clean Staged Files** `boolean` *required*
> >
> > * **Yes:** Staged files will be destroyed after data is loaded. This is the default setting.
> > * **No:** Staged files are retained in the staging area after data is loaded.
> >
> > **Amazon S3 Bucket** `drop-down` *required*
> >
> > An AWS S3 bucket to stage data into. The drop-down menu will include buckets tied to the [cloud provider credentials](https://docs.maia.ai/docs/guides/cloud-credentials.md) that you have associated with your [environment](https://docs.maia.ai/docs/guides/environments.md).
>
> > [tab] Cloud Storage
> >
> > **Load Strategy** `drop-down`
> >
> > * **Append Files in Folder:** Appends files to storage folder. This is the default setting.
> > * **Overwrite Files in Folder:** Overwrite existing files with matching structure.
> >
> > See the configuration table for how this parameter works with the Folder Path and File Prefix parameters:
> >
> > | Configuration | Description |
> > | - | - |
> > | Append files in folder with defined folder path and file prefix. | Files will be stored under the structure `uniqueID/timestamp-partX` where X is the part number, starting from 1. |
> > | Append files in folder without defined folder path and file prefix. | Files will be stored under the structure `folder/prefix-timestamp-partX` where X is the part number, starting from 1. |
> > | Overwrite files in folder with defined folder path and file prefix. | Files will be stored under the structure `folder/prefix-partX` where X is the part number, starting from 1. All files with matching structures will be overwritten. |
> > | Overwrite files in folder without defined folder path and file prefix. | Validation will fail. Folder path and file prefix must be supplied for this load strategy. |
> >
> > **Folder Path** `string`
> >
> > The folder path of the written files.
> >
> > **File Prefix** `string`
> >
> > A string of characters to include at the beginning of the written files. Often used for organizing database objects.
> >
> > **Storage** `drop-down` *required*
> >
> > A cloud storage location to load your data into for storage. Choose either Amazon S3, Azure Storage, or Google Cloud Storage.
> >
> > Click the tab that corresponds to your chosen cloud storage service.
> >
> > > [tab] Amazon S3
> > >
> > > **Amazon S3 Bucket** `drop-down` *required*
> > >
> > > An AWS S3 bucket to load data into. The drop-down menu will include buckets tied to the [cloud provider credentials](https://docs.maia.ai/docs/guides/cloud-credentials.md) that you have associated with your [environment](https://docs.maia.ai/docs/guides/environments.md).
> >
> > > [tab] Azure Storage
> > >
> > > **Storage Account** `drop-down` *required*
> > >
> > > Select a storage account linked to your desired blob container to be used for staging the data. For more information, read [Storage account overview](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-overview).
> > >
> > > **Container** `drop-down` *required*
> > >
> > > Select a Blob container to be used for staging the data. For more information, read [Introduction to Azure Blob storage](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction).
> >
> > > [tab] Google Cloud Storage
> > >
> > > **GCS Bucket** `drop-down` *required*
> > >
> > > The drop-down menu will include Google Cloud Storage (GCS) buckets tied to the [cloud provider credentials](https://docs.maia.ai/docs/guides/cloud-credentials.md) that you have associated with your [environment](https://docs.maia.ai/docs/guides/environments.md).
> > >
> > > **Overwrite** `boolean` *required*
> > >
> > > Select whether to overwrite files of the same name when this pipeline runs. Default is Yes.> [tab] Google BigQuery
>
> **Destination** `drop-down` *required*
>
> Select the destination for your data:
>
> * **Google BigQuery:** Load your data into a table in Google BigQuery.
>
> * **Cloud Storage:** Load your data directly into files in your preferred cloud storage location. The format of these files can differ between source systems and will not have a file extension. Check the output to determine the format of the data.
>
> > [tab] Google BigQuery
> >
> > **Project** `drop-down` *required*
> >
> > Select the Google BigQuery project to load data into. The special value `[Environment Default]` uses the project defined in the environment.
> >
> > **Dataset** `drop-down` *required*
> >
> > Select the Google BigQuery dataset to load data into. The special value `[Environment Default]` uses the dataset defined in the environment.
> >
> > **Table Name** `string` *required*
> >
> > The name of the table to be created in your Google BigQuery project. You can use a [Table Input](https://docs.maia.ai/docs/components/table-input.md) component in a transformation pipeline to access and transform this data after it has been loaded.
> >
> > **Load Strategy** `drop-down` *required*
> >
> > * **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:** Each time the pipeline runs, two operations are performed: first, the table is truncated, meaning all existing rows are deleted. Then, your new rows are inserted. The table itself is never destroyed and recreated.
> > * **Fail if Exists:** If the specified table name already exists, this pipeline will fail to run.
> > * **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.
> >
> > **Column Mapping** `column editor`
> >
> > In the tree structure representing the source data, select the checkboxes next to the fields that you want to output from this connector, then click **Save**.
> >
> > Unselected fields will not be included in the output from this connector.
> >
> > For each field you select, you can click the **Edit Alias** icon to change the name used for this field in all downstream components in this pipeline.
> >
> > **Primary Keys** `object selector`
> >
> > Select one or more columns to use as the table's primary key. If you select multiple columns, the component creates a composite primary key using the combination of the selected columns.
> >
> > Leave this blank to create the table without a primary key.
> >
> > **Clean Staged Files** `boolean` *required*
> >
> > * **Yes:** Staged files will be destroyed after data is loaded. This is the default setting.
> > * **No:** Staged files are retained in the staging area after data is loaded.
> >
> > **Partition Type** `drop-down`
> >
> > Select the time period to use to partition the data loaded into your table, for example **Day** or **Month**.
> >
> > **GCS Bucket** `drop-down` *required*
> >
> > Select the Google Cloud Storage (GCS) bucket linked to your Google Cloud Platform account.
> >
> > **Overwrite** `boolean` *required*
> >
> > Select whether to overwrite files of the same name when this pipeline runs. Default is **Yes**.
>
> > [tab] Cloud Storage
> >
> > **Load Strategy** `drop-down`
> >
> > * **Append Files in Folder:** Appends files to storage folder. This is the default setting.
> > * **Overwrite Files in Folder:** Overwrite existing files with matching structure.
> >
> > **Folder Path** `string`
> >
> > The folder path for the files to be written to. Note that this path follows, but does not include, the bucket or container name.
> >
> > **File Prefix** `string`
> >
> > A string of characters that precedes the name of the written files. This can be useful for organizing database objects.
> >
> > **Storage** `drop-down` *required*
> >
> > A cloud storage location to load your data into files for storage. Choose either Amazon S3, Azure Storage, or Google Cloud Storage.### Advanced Settings**Log Level** `drop-down`Select the severity level of logging. Choose from **Error**, **Warn**, **Info**, **Debug**, or **Trace**. The default setting is **Error**.Logs can be found in the [Logging](https://docs.maia.ai/docs/guides/using-designer.md#logging) tab in  when viewing details about a task after the pipeline has been run.**Load Selected Data** `boolean`Choose whether to return the entire payload or only selected data objects. Read [Response](https://docs.maia.ai/docs/guides/custom-connector-setup.md#response) to learn how to select the data objects to include in your API response.- **No:** (Default) Return the entire payload.
- **Yes:** Only return the objects that have been **Set as selected data** when configuring the response structure in the custom connector editor.## Deactivate soft delete for Azure blobs (Databricks)If you intend to set your destination as Databricks *and* your stage platform as Azure Storage, you must turn off the "Enable soft delete for blobs" setting in your Azure account for your pipeline to run successfully. To do this:1) In the [Azure portal](https://portal.azure.com/), navigate to your storage account.
2) In the menu, under **Data management**, click **Data protection**.
3) Clear the **Enable soft delete for blobs** checkbox. For more information, read [Soft delete for blobs](https://learn.microsoft.com/en-gb/azure/storage/blobs/soft-delete-blob-overview).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.