1- # CrateDB tableau's connector.
1+ # CrateDB connector for Tableau
22
33[ ![ CI status] ( https://github.com/crate/cratedb-tableau-connector/actions/workflows/main.yml/badge.svg )] ( https://github.com/crate/cratedb-tableau-connector/actions/workflows/main.yml )
44![ GitHub Release] ( https://img.shields.io/github/v/release/crate/cratedb-tableau-connector )
55![ Static Badge] ( https://img.shields.io/badge/tdvt_compatibility-95%25-brightgreen?style=flat&logo=cratedb )
66![ Static Badge] ( https://img.shields.io/badge/CrateDB-5.10.1-brightgreen?style=flat&logo=cratedb )
77
8- For simple queries and graphs, you can use the default PostgresSQL connector,
9- but for more advance usage SQL compatibility issues and nuanced SQL functionalities get into play,
10- we circumvent/fix those limitations with our custom connector.
8+ ## About
119
12- ## How to use.
10+ [ Tableau] is a visual business intelligence and analytics software platform.
11+ It expresses data by translating drag-and-drop actions into data queries
12+ through an intuitive interface.
1313
14- You will need two things:
14+ [ CrateDB] is a distributed and scalable SQL database for storing and analyzing
15+ massive amounts of data in near real-time, even with complex queries. It is
16+ PostgreSQL-compatible, and based on Lucene.
1517
16- The ` postgresql jdbc driver ` and the ` cratedb ` connector..
18+ ## Install
1719
18- ### Get the Postgresql jdbc driver.
20+ You will need to acquire and install two software artefacts,
21+ the PostgreSQL JDBC driver, and the CrateDB connector.
1922
20- Download the driver from [ here] ( https://jdbc.postgresql.org/download/ ) and put it in:
23+ ### PostgreSQL JDBC driver
24+
25+ Download the driver from the [ pgJDBC page] and put it into:
2126
2227- Windows: ` C:\Program Files\Tableau\Drivers `
2328- Mac: ` ~/Library/Tableau/Drivers `
2429- Linux: ` /opt/tableau/tableau_driver/jdbc `
2530
26- The latest PostgreSQL jdbc tested driver is ` postgresql-42.7.4.jar ` .
27-
28- The latest CrateDB jdbc tested driver is ` cratedb-jdbc-standalone-2.7.0 `
31+ The latest validated PostgreSQL JDBC driver version is ` postgresql-42.7.4.jar ` .
32+ The latest validated CrateDB JDBC driver is ` cratedb-jdbc-standalone-2.7.0 ` .
2933
30- Note: ` postgresql-42.7.5.jar ` does not seem to work.
34+ Note: The most recent release ` postgresql-42.7.5.jar ` is not compatible with CrateDB.
35+ We are currently working with upstream authors on resolving this regression.
3136
32- ### Get the CrateDB connector.
37+ ### CrateDB connector
3338
34- You can find the connector in the [ release section.] ( https://github.com/crate/cratedb-tableau-connector/releases )
35-
36- Put it in:
39+ You can find the connector on the [ releases page] . Put it into:
3740
3841#### Tableau Desktop
3942
@@ -49,23 +52,59 @@ Put it in:
4952- Windows: ` C:\Program Files\Tableau\Connectors `
5053- Linux: ` /opt/tableau/connectors `
5154
52- For older versions see https://help.tableau.com/current/pro/desktop/en-us/examples_connector_sdk.htm
55+ For older versions, see [ Tableau Connector SDK legacy documentation ] .
5356
54- ## Disabling signature verification.
5557
56- The current release of the connector is not signed. This issue is being addressed, but in the meantime, verification can be disabled.
58+ ## Usage
5759
58- * On _ Tableau Desktop_ , please use this command-line argument: ` -DDisableVerifyConnectorPluginSignature=true `
60+ ### Configure data source
61+
62+ Todo: Add a few words how to actually establish the connection to CrateDB
63+ after installing the driver and connector?
5964
60- * On _ Tableau Server_ , you can disable signature verification by setting ` native_api.disable_verify_connector_plugin_signature ` to ` true ` via TSM.
6165
62- More information can be found [ here ] ( https://tableau.github.io/connector-plugin-sdk/docs/run-taco )
66+ ### Signature verification
6367
68+ The current release of the connector is not signed. This issue is being addressed,
69+ but in the meantime, signature verification can be disabled.
6470
65- ## State of the driver.
71+ * On _ Tableau Desktop _ , please use this command-line argument: ` -DDisableVerifyConnectorPluginSignature=true `
6672
67- This custom connector aims to offer the best Tableau experience possible, this is a work in progress since
68- PostgresSQL compatibility is not 100% and is bound to change over time.
73+ * On _ Tableau Server_ , you can disable signature verification by setting ` native_api.disable_verify_connector_plugin_signature ` to ` true ` via TSM.
6974
70- We test compatibility issues with Tableau's connector sdk: [ TDVT suite] ( https://tableau.github.io/connector-plugin-sdk/docs/tdvt ) .
71- Progress is tracked in https://github.com/crate/cratedb-tableau-connector/issues/2
75+ More information can be found on the [ Tableau Connector SDK ` run-taco ` documentation] .
76+
77+
78+ ## Status
79+
80+ The native CrateDB connector for Tableau aims to offer excellent compatibility
81+ with Tableau's line of products, providing optimal user experience.
82+ While it does not offer 100% compatibility yet, the connector is pretty close to
83+ cover Tableau's test suite successfully and completely.
84+
85+ ```
86+ CrateDB version: 5.10.1
87+ Last update: 20/02/2024
88+ Pass: 96%
89+ ```
90+ ```
91+ Test Count: 848 tests
92+ Passed tests: 807
93+ Failed tests: 41
94+ Tests run: 848
95+ Disabled tests: 0
96+ Skipped tests: 0
97+ ```
98+
99+ Compatibility is validated using Tableau's Connector SDK, specifically using its [ TDVT suite] .
100+ Compatibility progress is tracked in [ TABLEAU-2] .
101+
102+
103+ [ CrateDB ] : https://cratedb.com/database
104+ [ pgJDBC page ] : https://jdbc.postgresql.org/download/
105+ [ releases page ] : https://github.com/crate/cratedb-tableau-connector/releases
106+ [ Tableau ] : https://www.tableau.com/
107+ [ Tableau Connector SDK legacy documentation ] : https://help.tableau.com/current/pro/desktop/en-us/examples_connector_sdk.htm
108+ [ Tableau Connector SDK `run-taco` documentation ] : https://tableau.github.io/connector-plugin-sdk/docs/run-taco
109+ [ TABLEAU-2 ] : https://github.com/crate/cratedb-tableau-connector/issues/2
110+ [ TDVT suite ] : https://tableau.github.io/connector-plugin-sdk/docs/tdvt
0 commit comments