Skip to main content

Configuration Attributes

This page details the config payload to create each source type.

Amazon Redshift​

Dremio source type: REDSHIFT. This type determines the config parameters that display as specified in the Source Attributes. If you are not familiar with the following parameters that are available for Redshift, see Amazon Redshift Configuration for additional information.

Config attributes for connecting to an Amazon Redshift source
"config": {
  "connectionString": "jdbc:redshift://redshift.example.com:5439/database",
  "authenticationType": [
    "ANONYMOUS",
    "MASTER",
    "AWS_PROFILE"
  ],
  "username": "myUsername",
  "password": "myPassword",
  "secretResourceUrl": arn:aws:secretsmanager:us-west-2:123456789012:secret:my-rds-secret-VNenFy,
  "awsProfile": "profileName",
  "dbUser": "userName",
  "fetchSize": 200,
  "maxIdleConns": 8,
  "idleTimeSec": 60,
  "queryTimeoutSec": 0,
  "propertyList": [
    {
      "name": "ApplicationName", 
      "value": "MarketingDashboard"
    }
  ]
}

Parameters​

{{< api-section file="data/api/source-types.json" data="amazonRedshift" >}}

Examples of Different Configurations for authenticationType​

No authentication required
{
  "authenticationType": "ANONYMOUS"
}
Master credentials
{
  "authenticationType": "MASTER",
  "username": "myUsername",
  "password": "myPassword"
}
Secret resource URL
{
  "authenticationType": "MASTER",
  "username": "myUsername",
  "secretResourceUrl": "myPassword"
}
AWS Profile
{
  "authenticationType": "AWS_PROFILE",
  "awsProfile": "profileName",
  "dbUser": "userName"
}

Amazon S3​

Dremio source type: S3. This type determines the config parameters that display as specified in the Source Attributes. If you are not familiar with the following parameters that are available for S3, see Adding an S3 Source for additional information.

Config attributes for connecting to an Amazon S3 source
"config": {
  "credentialType": [
    "PROJECT_DATA_CRED",
    "ACCESS_KEY"
  ]
  "assumedRoleARN": "arn:aws:iam::123456789012:root",
  "awsAccessKey": "AKIAIOSFODNN7EXAMPLE",
  "awsAccessSecret": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
  "externalBucketList": /bucket-name/,
  "secure": false,
  "enableAsync": true,
  "compatibilityMode": false,
  "requesterPays": false,
  "enableFileStatusCheck": true,
  "isPartitionInferenceEnabled": false,
  "rootPath": "/",
  "kmsKeyARN": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
  "defaultCtasFormat": "ICEBERG",
  "propertyList": [
    {
      "name": "fs.s3a.proxy.host", 
      "value": "proxyHost.example.com"
    },
  ],
  "whitelistedBuckets": "sales",
  "isCachingEnabled": true,
  "maxCacheSpacePct": 100
}

Parameters​

{{< api-section file="data/api/source-types.json" data="amazonS3" >}}

Examples of Different Configurations for credentialType​

Project data credentials
{
  "credentialType": "PROJECT_DATA_CRED"
}
Data source credentials (IAM role)
{
  "credentialType": "PROJECT_DATA_CRED",
  "assumedRoleARN": "arn:aws:iam::123456789012:root"
}
Data source credentials (access key)
{
  "credentialType": "ACCESS_KEY",
  "assumedRoleARN": "arn:aws:iam::123456789012:root",
  "awsAccessKey": "AKIAIOSFODNN7EXAMPLE",
  "awsAccessSecret": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
}

Arctic (Preview)​

Dremio source type: ARCTIC. This type determines the config parameters that display as specified in the Source Attributes. If you are not familiar with the following parameters that are available for Arctic, see Dremio Sonar for additional information.

Config attributes for configuring an Arctic source
"config": {
  "awsRootPath": "/your-s3-bucket-name",
  "asyncEnabled": true,
  "isCachingEnabled": true,
  "maxCacheSpacePct": 100,
  "defaultCtasFormat": "ICEBERG",
  "credentialType": [
    "PROJECT_DATA_CRED",
    "ACCESS_KEY"
  ]
  "assumedRoleARN": "arn:aws:iam::123456789012:root",
  "arcticCatalogId": "ab12cdef-a123-b456-ab1234-cdef5678ghij"
},

Parameters​

{{< api-section file="data/api/source-types.json" data="arctic" >}}

Examples of Different Configurations for credentialType​

Project data credentials
{
  "credentialType": "PROJECT_DATA_CRED"
}
Data source credentials (IAM role)
{
  "credentialType": "PROJECT_DATA_CRED",
  "assumedRoleARN": "arn:aws:iam::123456789012:root"
}
Data source credentials (access key)
{
  "credentialType": "ACCESS_KEY",
  "assumedRoleARN": "arn:aws:iam::123456789012:root",
  "awsAccessKey": "AKIAIOSFODNN7EXAMPLE",
  "awsAccessSecret": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
}

AWS Glue Data Catalog​

Dremio source type: AWSGLUE. This type determines the config parameters that display as specified in the Source Attributes. If you are not familiar with the following parameters that are available for AWS Glue, see Adding an AWS Glue Data Catalog for additional information.

Config attributes for connecting to an AWS Glue Data Catalog
"config": {
  "credentialType": [
    "PROJECT_DATA_CRED",
    "ACCESS_KEY"
  ]
  "assumedRoleARN": "arn:aws:iam::123456789012:root",
  "awsAccessKey": "AKIAIOSFODNN7EXAMPLE",
  "awsAccessSecret": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
  "regionNameSelection": "us-east-1",
  "secure": false,
  "enableAsync": true,
  "propertyList": [
   {
      "name": "hive.metastore.warehouse.dir", 
      "value": "s3://bucket-name/folder"
    },
  ],
  "isCachingEnabled": true,
  "maxCacheSpacePct": 100
}

Parameters​

{{< api-section file="data/api/source-types.json" data="awsGlue" >}}

Examples of Different Configurations for credentialType​

Project data credentials
{
  "credentialType": "PROJECT_DATA_CRED"
}
Data source credentials (IAM role)
{
  "credentialType": "PROJECT_DATA_CRED",
  "assumedRoleARN": "arn:aws:iam::123456789012:root"
}
Data source credentials (access key)
{
  "credentialType": "ACCESS_KEY",
  "assumedRoleARN": "arn:aws:iam::123456789012:root",
  "awsAccessKey": "AKIAIOSFODNN7EXAMPLE",
  "awsAccessSecret": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
}

Microsoft SQL Server​

Dremio source type: MSSQL. This type determines the config parameters that display as specified in the Source Attributes. If you are not familiar with the following parameters that are available for SQL Server, see SQL Server Configuration for additional information.

Config attributes for connecting to a Microsoft SQL Server source
"config": {
  "authenticationType": [
    "ANONYMOUS",
    "MASTER"
  ]
  "username": "myUsername",
  "password": "myPassword".
  "hostname": "localhost",
  "port": "1433",
  "database": "my_database",
  "useSsl": true,
  "showOnlyConnectionDatabase": false,
  "fetchSize": 200,
  "maxIdleConns": 8,
  "idleTimeSec": 60,
  "enableServerVerification": true,
  "hostnameOverride": "localhost",
  "propertyList": [
    {
      "name": "applicationIntent", 
      "value": "ReadWrite"
    }
  ]
}

Parameters​

{{< api-section file="data/api/source-types.json" data="mssql" >}}

Examples of Different Configurations for authenticationType​

No authentication required
{
  "authenticationType": "ANONYMOUS"
}
Master credentials
{
  "authenticationType": "MASTER",
  "username": "myUsername",
  "password": "myPassword"
}

MySQL​

Dremio source type: MYSQL. This type determines the config parameters that display as specified in the Source Attributes. If you are not familiar with the following parameters that are available for MySQL, see MySQL Configuration for additional information.

Config attributes for connecting to a MySQL source
"config": {
  "authenticationType": [
    "ANONYMOUS",
    "MASTER",
  ]
  "username": "myUsername",
  "password": "myPassword"
  "hostname": "localhost",
  "port": "3306",
  "netWriteTimeout": 60,
  "fetchSize": 200,
  "maxIdleConns": 8,
  "idleTimeSec": 60,
  "propertyList": [
    {
      "name": "DataSource", 
      "value": "sales2021"
    }
  ]
}

Parameters​

{{< api-section file="data/api/source-types.json" data="mysql" >}}

Examples of Different Configurations for authenticationType​

No authentication required
{
  "authenticationType": "ANONYMOUS"
}
Master credentials
{
  "authenticationType": "MASTER",
  "username": "myUsername",
  "password": "myPassword"
}

Oracle​

Dremio source type: ORACLE. This type determines the config parameters that display as specified in the Source Attributes. If you are not familiar with the following parameters that are available for Oracle, see Oracle Configuration for additional information.

Config attributes for connecting to an Oracle source
"config": {
  "authenticationType": [
    "ANONYMOUS",
    "MASTER"
  ]
  "username": "myUsername",
  "password": "myPassword",
  "hostname": "localhost",
  "port": "1521",
  "instance": "sales",
  "useSsl": true,
  "nativeEncryption": "ACCEPTED", 
  "useTimezoneAsRegion": true,
  "includeSynonyms": false,
  "mapDateToTimestamp": true,
  "fetchSize": 200,
  "maxIdleConns": 8,
  "idleTimeSec": 60,
  "useLdap": false,
  "bindDN": String,
  "sslServerCertDN": String,
  "propertyList": [
    {
      "name": "connect_timeout", 
      "value": "0"
    }
  ]
}

Parameters​

{{< api-section file="data/api/source-types.json" data="oracle" >}}

Examples of Different Configurations for authenticationType​

No authentication required
{
  "authenticationType": "ANONYMOUS"
}
Master credentials
{
  "authenticationType": "MASTER",
  "username": "myUsername",
  "password": "myPassword"
}
Secret resource URL
{
  "authenticationType": "MASTER",
  "username": "myUsername",
  "secretResourceUrl": "String"
}
Using Kerberos
{
  "credentialType": "KERBEROS",
  "username": null,
  "password": null,
  "useKerberos": true
}

PostgreSQL​

Dremio source type: POSTGRES. This type determines the config parameters that display as specified in the Source Attributes. If you are not familiar with the following parameters that are available for PostgreSQL, see PostgreSQL Configuration for additional information.

Config attributes for connecting to a PostgreSQL source
"config": {
  "authenticationType": [
    "ANONYMOUS",
    "MASTER"
  ]
  "username": "myUsername",
  "password": "myPassword",
  "hostname": "localhost",
  "port": "5432",
  "databaseName": "sales_2021",
  "useSsl": false,
  "fetchSize": 200,
  "maxIdleConns": 8,
  "idleTimeSec": 60,
  "encryptionValidationMode": "CERTIFICATE_AND_HOSTNAME_VALIDATION",
  "propertyList": [
    {
      "name": "connect_timeout", 
      "value": "10&application_name=myapp"
    }
  ]
}

Parameters​

{{< api-section file="data/api/source-types.json" data="postgres" >}}

Examples of Different Configurations for authenticationType​

No authentication required
{
"authenticationType": "ANONYMOUS"
}
Master credentials
{
"authenticationType": "MASTER",
"username": "myUsername",
"password": "myPassword"
}

Snowflake​

Dremio source type: SNOWFLAKE. This type determines the config parameters that display as specified in the Source Attributes. If you are not familiar with the following parameters that are available for Snowflake, see Configuring Snowflake as a Source for additional information.

Config attributes for connecting to a Snowflake source
"config": {
  "hostname": "https://locator_id.snowflakecomputing.com",
  "username": "myUsername",
  "password": "myPassword",
  [ "database": "myDatabase" ],
  [ "role": "PUBLIC" ],
  [ "schema": "mySchema" ],
  [ "warehouse": "myWarehouse" ]  
}

Parameters​

{{< api-section file="data/api/source-types.json" data="snowflake" >}}