AdditionalServerProperties

sharedFolderPath

Shared Folder Path for temporary file for bulk uploads

string

relativeFolderName

Relative Folder Path

string

timezone

Override timezone for session

string

hiveIP

Hadoop HIVE IP address

string

hivePort

Hadoop HIVE port number

integer

int32

hdfsIP

Hadoop HDFS IP address

string

hdfsPort

Hadoop HDFS port number

integer

int32

authMethod

relevant to olap datasources, specify the auth method used against the cube for end user

CubeAuthMethod

ftpSettings

settings for FTP server connections

FtpSettings

allowHighDataRate

allow using BigQuery Storage API for faster (but more expensive) data extraction

boolean

azureTabular

Mark true if it is Azure Tabular

boolean

proxyAccountInUse

Relevant for OLAP, Tabular, Snowflake and SAP BW; specify the effective proxy account to use for connection when supported by the auth type

ServerEffectiveUserName

machineAccountFallback

Allow fallback of multi-pass authentication for olap to the machine account

boolean

keytabPath

The name of the keytab to use

string

keytabId

The id of the keytab to use

string

uuid

awsAccessKeyId

Storage Access key (AWS S3 or Azure Blob) for Redshift, Athena and Synapse. To use an AWS IAM role, set awsAccessKeyId: "iam" after configuring a role on AWS. In this case, you do not need to set awsSecretAccessKey.

string

awsSecretAccessKey

Storage Secret access key (AWS S3 or Azure Blob) for Redshift, Athena and Synapse

string

awsRegion

Region of Athena connection

string

awsBucketName

Bucket name for uploading temp files for Redshift, BigQuery and Synapse

string

bulkWritingType

Bulk copy method (Synapse, Snowflake connection only)

BulkWritingType

s3StagingDir

s3 destination for Athena query results

string

disableDBTables

Disable database tables - SAP HANA

boolean

disableAttributeViews

Disable attribute views - SAP HANA

boolean

disableAnalyticViews

Disable analytic views - SAP HANA

boolean

disableCalculationViews

Disable calculation views - SAP HANA

boolean

hierarchyType

Hierarchy treatment - SAP HANA

HierarchyType

salesforceSecurityToken

Salesforce security token

string

warehouse

Warehouse name (required for Snowflake connection only)

string

accessToken

Access token for facebook connection

string

consumerKey

Customer key for SalesForce connection

string

consumerSecret

Consumer secret for facebook and salesForce connection

string

useSSL

Use SSL to connect

boolean

shouldValidateServerCert

Should validate Server certificate

boolean

isCustomCertHostname

Should validate a different hostname than the server hostname

boolean

customCertHostname

Hostname in certificate that we should validate

string

isCustomKeyStore

Using a different keystore than the java VM keystore?

boolean

customKeyStore

Path to custom keystore (in Pyramid server filesystem)

string

customKeyStoreType

Custom keystore type (JKS / PKCS12)

string

customKeyStorePassword

Keystore password

string

isCustomTrustStore

Using a different java trust store than the java VM trust store?

boolean

customTrustStore

Path to custom java trust store (in Pyramid server filesystem)

string

customTrustStorePassword

Trust store password

string

isOperatingSystemTrustStore

Using a Operating System trust store instead of java VM trust store

boolean

isDatabaseSchema

Treat schemas names as database names in Pyramid

boolean

accountId

Account ID

string

roleId

Role ID

string

sysNumber

Sys number connection parameter for SAP BW

string

clientNumber

Custom client parameter for SAP HANA and BW

string

sncPartnerName

SNC partner name parameter for SAP BW

string

sapRouter

SAP Router property for SAP BW

string

bwInfoAreaIconIds

Custom data source types to include in info area tree, for SAP BW

string

defaultCulture

Language option for SAP HANA and BW

string

urlPortal

URL portal property for SAP BW

string

bringNonOleDbComponents

Include components eithout 'OLE DB for OLAP' access, for SAP BW

boolean

showInfoAreaTree

Deprecated: use BwInfoAreaViewType

boolean

mdxCompatibility

MDX compatibility mode

integer

int32

supportsBwFlatQueries

Elect whether to enable the optimized execution modes, for SAP BW

boolean

sapBwServerConnectionType

Sap BW connection types: the typical "application server" connection or the "Message server" connection

SapBwServerConnectionType

messageServerHost

Sap BW "Message server" connection - Server host

string

messageServerService

Sap BW "Message server" connection - Server service

string

systemR3Name

Sap BW "Message server" connection - System (R3) Name

string

groupServer

Sap BW "Message server" connection - Group/Server

string

avoidMultiPassAuthentication

Multi Pass Authentication can be used to cascade through multiple authentication options, such as username/ password. for OLAP and Tabular

boolean

msOlapConnectionType

Configure the manner in which the SSAS server is configured to receive used for OLAP and Tabular

MsOlapConnectionType

odbcDirectQueryOptions

Direct query options for ODBC direct query connections

OdbcDirectQueryOptions

customJdbcId

Required when serverType is CustomJdbc and specifies which custom jdbc it is

string

uuid

customJdbcProps

Key:Value collection of custom properties for custom JDBC connection (as defined by Custom JDBC admin page)

[string] [string]

sparkTransportMode

Transport mode for Spark connection: Binary, SASL or HTTP or HTTPS

SparkTransportMode

isOverrideConnectionString

Should we override the connection string - if so, use optionalJdbcParameters to specify the full JDBC connection string

boolean

shouldValidateServerCertHostname

Should validate the server certificate's hostname

boolean

certValidationCustomRootCaType

The type of the custom root CA to use when validating the server's certificate

CustomRootCAType

customRootCaCert

Custom root CA certificate used to validate the server's certificate

string

defaultTrustStorePassword

Password for the default trust store

string

useCustomCertificateConfig

Specify whether to customize the certificate configuration

boolean

useClientCertificate

Should the client use an ssl certificate?

boolean

clientCertPath

Path to the client's certificate

string

clientKeyPath

Path to the client's key

string

clientKeyPassword

Password for the client's key

string

customTrustStoreType

Custom truststore type (JKS / PKCS12)

string

oauthDataSourceSettings

oAuth settings

OauthDataSourceSettings

bwSupportStructures

Elect whether to "enable" characteristic structures, for SAP BW

boolean

bwDataBaseListTechnique

Choose which type of Database ('info-provider') listing technique to use

BwDatabaseListType

bwInfoAreaTreeViewType

Configures the SAP BW server instance to support different views in the databases panel

BwInfoAreaTreeViewType

krbServiceName

service principal name for kerberos authentication

string

quotaProjectId

quota project id for bigquery

string

googleAnalyticsType

Google Analytics version

GaType

privateCertId

Id of private/public certificate pair associated with imdb instance

string

azureTenantId

tenant id used for MS fabric

string

recipient

Recipient name for Databricks unity catalog

string

runOnConnect

Optional SQL commands to run after connecting

string [ ]

isEntraPassword

is Microsoft Entra Password authentication method, for SQL serve azure and synapse only when serverAuthenticationMethod == UserPassword

boolean

customBatchSize

Customize batch size for bulk writing

integer

int32