MaxCompute Tableau Connector

MaxCompute (previously known as ODPS) is a general purpose, fully managed, multi-tenancy data processing platform for large-scale data warehousing.

This connector allows users to use MaxCompute as datasource in Tableau.

This connector is developed under the Tableau official guidance and TDVT passed.

Setup

1. Install TDVT: python3 -m pip install tdvt-1.5.14.tar.gz
2. Setup MaxCompute project and prepare tables for TDVT(check dataset/maxcompute/*.sql), run setproject.sql as project owner and the output of setproject; should contains

   odps.sql.validate.orderby.limit=false
   odps.sql.decimal.odps2=true
   odps.sql.type.system.odps2=true
   odps.sql.timezone=UTC
   odps.sql.hive.compatible=true
   

3. Update config/odps_config.ini, set 'CommandLineOverride' to be the path to unzipped 'plugin' directory
4. Update config/odps_config.ini, set 'tablePrefix' to be your maxcompute project name
5. Edit config/tdvt/tdvt.ini and set the path to tabquerytool
6. Move MaxCompute jdbc driver (lib/odps-jdbc-*.jar) to the tableau driver directory (eg. ~/Library/Tableau/Drivers on MacOS)
7. Setup dataset, see dataset directory and TDVT guidance for detail
8. Follow the TDVT guidance to run tests

Tips

1. Since TDVT has a fixed 60 minutes timeout, and MaxCompute takes about 140 minutes, please install TDVT using the archive provided by us
2. The log of jdbc is in the same directory of jdbc driver
3. To generate tds file, scripts/start.sh provides an example to start Tableau desktop with MaxCompute connector. You need to modify the path to make the script run correctly

LICENSE

The connector is open sourced under the MIT License.

About MaxCompute

MaxCompute provides command line tool named odpscmd as an interactive shell, which is also open-sourced.

Here's some hints about how to setup and use odpscmd:

1. Download odpscmd package and finish all necessary configuration refer to official document
2. each command has to be ended with a ';'
3. view the metadata of a table with 'desc' command (like 'desc calcs;')
4. execute SQL statements generated by TDVT directly (like 'SELECT * FROM TBL LIMIT 50;')
5. use 'help;' command for more advanced commands