Skip to content

Commit 86cee0b

Browse files
committed
Update Tableau instructions
1 parent 09f7dcd commit 86cee0b

7 files changed

Lines changed: 85 additions & 32 deletions

File tree

website/docs/clients/tableau/index.md

Lines changed: 85 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -7,58 +7,111 @@ pagination_prev: 'clients/index'
77
pagination_next: null
88
---
99

10-
Use [Tableau](https://www.tableau.com/) to access, visualise and analyse datasets loaded in Spice.
10+
import Tabs from '@theme/Tabs';
11+
import TabItem from '@theme/TabItem';
1112

12-
> The world's leading analytics platform. Tableau is the broadest and deepest end-to-end data and analytics platform. Ensure the responsible use of data and drive better business outcomes with fully integrated data management and governance, visual analytics and data storytelling, and collaboration – all with Salesforce’s industry-leading Einstein built right in.
13+
Use instructions below to install the **Spice.ai Tableau Connector** that enables [Tableau](https://www.tableau.com/) users to easily connect to and visualize data loaded in Spice.
14+
15+
> Tableau is the world's leading analytics platform. Tableau is the broadest and deepest end-to-end data and analytics platform. Ensure the responsible use of data and drive better business outcomes with fully integrated data management and governance, visual analytics and data storytelling, and collaboration – all with Salesforce’s industry-leading Einstein built right in.
1316
>
1417
> [The Tableau platform](https://www.tableau.com/)
1518
16-
## Install Tableau Desktop
19+
## Step 1. Install the Arrow Flight SQL JDBC Driver
1720

18-
Download and install [Tableau Desktop](https://www.tableau.com/products/desktop/download).
21+
[JDBC](https://docs.oracle.com/javase/tutorial/jdbc/basics/index.html) (Java Database Connectivity) is a standard interface for connecting to and interacting with databases. The Flight SQL driver is a JDBC driver implementation based on the [Arrow Flight SQL](https://arrow.apache.org/docs/format/FlightSql.html) protocol. As Spice supports the Flight SQL protocol, the driver helps establish a connection between Tableau and Spice, enabling Tableau to execute queries and retrieve data from Spice efficiently.
1922

20-
## Download and install the Flight SQL JDBC driver
23+
Download the [flight-sql-jdbc-driver.jar](https://repo1.maven.org/maven2/org/apache/arrow/flight-sql-jdbc-driver/) file to the Tableau drivers folder:
2124

22-
[JDBC](https://docs.oracle.com/javase/tutorial/jdbc/basics/index.html) (Java Database Connectivity) is a standard way to connect to, and interact with a database. The Flight SQL driver is a JDBC driver implementation that utilizes the underlying [Flight SQL](https://arrow.apache.org/docs/format/FlightSql.html) protocol, allowing any program that connects via JDBC to seamlessly connect and interact with databases that support Flight SQL. Because Spice supports Flight SQL, this driver acts as a bridge, enabling Tableau to establish a connection with Spice, execute queries, and retrieve data.
25+
<Tabs>
26+
<TabItem value="windows" label="Windows" default>
27+
**PowerShell Install Script**
2328

24-
1. **Download the Flight SQL JDBC driver**
29+
```powershell
30+
Invoke-WebRequest -Uri "https://repo1.maven.org/maven2/org/apache/arrow/flight-sql-jdbc-driver/16.1.0/flight-sql-jdbc-driver-16.1.0.jar" -OutFile "C:\Program Files\Tableau\Drivers\flight-sql-jdbc-driver-16.1.0.jar"
31+
```
32+
</TabItem>
33+
<TabItem value="macos" label="macOS">
34+
**Install Script**
2535

26-
- Visit the [Flight SQL JDBC driver](https://central.sonatype.com/artifact/org.apache.arrow/flight-sql-jdbc-driver/) page
27-
- Select the **Versions** tab
28-
- Click **Browse** next to the version you want to download
29-
- Click the `flight-sql-jdbc-driver-XX.XX.XX.jar` file (with only the `.jar` file extension) from the list of files to download the driver jar file
36+
```bash
37+
curl -L https://repo1.maven.org/maven2/org/apache/arrow/flight-sql-jdbc-driver/16.1.0/flight-sql-jdbc-driver-16.1.0.jar -o ~/Library/Tableau/Drivers/flight-sql-jdbc-driver-16.1.0.jar
38+
```
39+
</TabItem>
40+
<TabItem value="linux" label="Linux">
41+
**Install Script**
3042

31-
2. **Copy the downloaded jar file into the following directory based on your operating system**
43+
```bash
44+
curl -L https://repo1.maven.org/maven2/org/apache/arrow/flight-sql-jdbc-driver/16.1.0/flight-sql-jdbc-driver-16.1.0.jar -o /opt/tableau/tableau_driver/jdbc/flight-sql-jdbc-driver-16.1.0.jar
45+
```
46+
</TabItem>
47+
</Tabs>
3248

33-
- Windows: `C:\Program Files\Tableau\Drivers`
34-
- Mac: `~/Library/Tableau/Drivers`
35-
- Linux: `/opt/tableau/tableau_driver/jdbc` - Start or restart Tableau
49+
## Step 2. Install Spice.ai Tableau Connector
3650

37-
## Configure a Spice connection
51+
### Tableau Server
3852

39-
1. Open **Tableau**
40-
2. In the **Connect** column, under **To a Server**, select **Other Databases (JDBC)**.
41-
3. Provide the following configuration:
53+
1. Download the latest `spiceai.taco` file from [Releases](https://github.com/spicehq/tableau-connector/releases)
54+
2. Copy to the Tableau connectors directory
4255

43-
- **URL**: `jdbc:arrow-flight-sql://127.0.0.1:50051?useEncryption=false`
44-
- **Dialect**: `PostgreSQL`
45-
<img width="400" src="/img/tableau/tableau-jdbc-conn.png" />
56+
<Tabs>
57+
<TabItem value="windows" label="Windows" default>
58+
**PowerShell Install Script**
4659

47-
4. Ensure Spice is running
48-
5. Click **Sign In**
60+
```powershell
61+
Invoke-WebRequest -Uri "https://github.com/spicehq/tableau-connector/releases/latest/download/spiceai.taco" -OutFile "C:\Program Files\Tableau\Connectors\spiceai.taco"
62+
```
63+
</TabItem>
64+
<TabItem value="linux" label="Linux">
65+
**Install Script**
4966

50-
## Working with Spice datasets
67+
```bash
68+
curl -L https://github.com/spicehq/tableau-connector/releases/latest/download/spiceai.taco -o /opt/tableau/connectors/spiceai.taco
69+
```
70+
</TabItem>
71+
</Tabs>
72+
73+
3. Restart server: `tsm restart`
74+
75+
### Tableau Desktop
76+
77+
1. Download the latest `spiceai.taco` file from [Releases](https://github.com/spiceai/tableau-connector/releases)
78+
2. Copy to the Tableau connectors directory
5179

52-
Once connected, Spice datasets will be listed under the `datafusion.public` schema.
80+
<Tabs>
81+
<TabItem value="windows" label="Windows" default>
82+
**PowerShell Install Script**
5383

54-
:::note
84+
```powershell
85+
Invoke-WebRequest -Uri "https://github.com/spicehq/tableau-connector/releases/latest/download/spiceai.taco" -OutFile "C:\Users\[USERNAME]\Documents\My Tableau Repository\Connectors\spiceai.taco"
86+
```
87+
</TabItem>
88+
<TabItem value="macos" label="macOS">
89+
**Install Script**
5590

56-
Tableau support is currently in alpha, and not all functionality is supported. Use **New Custom SQL** to start working with Spice datasets as shown below.
91+
```bash
92+
curl -L https://github.com/spicehq/tableau-connector/releases/latest/download/spiceai.taco -o ~/Documents/My\ Tableau\ Repository/Connectors/spiceai.taco
93+
```
94+
</TabItem>
95+
<TabItem value="linux" label="Linux">
96+
**Install Script**
5797

58-
:::
98+
```bash
99+
curl -L https://github.com/spicehq/tableau-connector/releases/latest/download/spiceai.taco -o /opt/tableau/connectors/spiceai.taco
100+
```
101+
</TabItem>
102+
</Tabs>
59103

60-
<img width="800" src="/img/tableau/tableau-tables-list.png" />
104+
## Configure a Spice connection
105+
106+
1. Open **Tableau**
107+
2. In the **Connect** column, under **To a Server**, select **Spice by Spice.ai Inc**.
108+
3. Configure a Spice connection to **Spice.ai OSS Self-Hosted** instance or to **Spice Cloud Platform**.
109+
<img width="400" src="/img/tableau/tableau-spice-dialog.png" alt="Spice Tableau Connection Dialog" />
110+
111+
4. Click **Sign In**
112+
113+
## Working with Spice datasets
61114

62-
<img width="800" src="/img/tableau/tableau-custom-sql.png" />
115+
After establishing a connection, Spice datasets appear under their respective schemas, with the default schema being `spice.public`. When writing queries, use the `PostgreSQL` dialect, as Spice is built on this standard.
63116

64-
<img width="800" src="/img/tableau/tableau-spice-chart.png" />
117+
<img width="800" src="/img/tableau/tableau-spice-example.png" alt="Spice Tableau Example"/>
-66.3 KB
Binary file not shown.
-25.8 KB
Binary file not shown.
-188 KB
Binary file not shown.
138 KB
Loading
569 KB
Loading
-108 KB
Binary file not shown.

0 commit comments

Comments
 (0)