Customize JDBC Connections Using a Properties File

Version 3

    You can use a properties file to customize a JDBC connection. When you create the file and save it to the correct location, the properties in the file will be applied to all JDBC connections to the same data source type.

     

    For example, you can enable encryption of query results for Amazon Athena by creating a properties file. To do this:

     

    1. Create a properties file called athena.properties.
    2. Save the file to the My Tableau Repository\Datasources directory.
    3. Add the key-value pair: query_results_encryption_option=SSE-S3
    4. Save the file.

     

    The next time you open Tableau Desktop, this value is used for all Athena connections to encrypt S3 buckets. For another example of using a JDBC properties file, see Customizing JDBC Connections in the Tableau Knowledge Base.

     

    If you connect through Tableau Server, the properties file needs to be located in the following directory on all server nodes:

     

    Windows: ProgramData\Tableau\Tableau Server\data\tabsvc\vizqlserver\Datasources

    Linux: /var/opt/tableau/tableau_server/data/tabsvc/vizqlserver/Datasources/

     

    Refer to your driver documentation for key value pair information.

     

    Use the following classnames for the appropriate connector:

     

    Connector

    Classname

    Amazon Athena

    athena

    SAP HANA

    saphana


    To validate that Tableau has read the properties file, search the tabprotosrv logs for the following text, replacing
    <file name> with the name of the properties file:

     

    Found jdbc customizations file: <file name>.properties

     

    Like TDC files, properties files are not managed by the backup-restore process. When you upgrade, you must manually restore properties files on both Tableau Desktop and Tableau Server.