Skip to content

Commit 5b3b41d

Browse files
authored
Add installation instructions for Tableau Server (spiceai#20)
1 parent afda3db commit 5b3b41d

2 files changed

Lines changed: 59 additions & 16 deletions

File tree

README.md

Lines changed: 58 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,38 +11,67 @@ The Spice.ai Tableau Connector is a JDBC-based connector that enables Tableau us
1111

1212
## Installation
1313

14-
### Install Arrow Flight SQL JDBC Driver
14+
### Step 1. Install Arrow Flight SQL JDBC Driver
15+
16+
#### Windows
17+
18+
```powershell
19+
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"
20+
```
1521

1622
#### macOS
1723

1824
```bash
1925
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
2026
```
2127

22-
#### Windows
28+
#### Linux
2329

24-
```powershell
25-
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"
30+
```bash
31+
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
2632
```
2733

28-
### Pre-built Connector
34+
### Step 2. Install Spice.ai Tableau Connector
35+
36+
#### Tableau Server
2937

3038
1. Download the latest `spice.taco` file from the [releases page](https://github.com/spiceai/tableau-connector/releases)
3139
2. Copy to your Tableau connectors directory:
32-
- macOS: `~/Documents/My Tableau Repository/Connectors/`
33-
- Windows: `C:\Users\[USERNAME]\Documents\My Tableau Repository\Connectors\`
40+
- Windows: `C:\Program Files\Tableau\Connectors`
3441

35-
### Build from Source
42+
```powershell
43+
Invoke-WebRequest -Uri "https://github.com/spiceai/tableau-connector/releases/latest/download/spice.taco" -OutFile "C:\Program Files\Tableau\Connectors\spice.taco"
44+
```
3645
37-
```bash
38-
# Clone the repository
39-
git clone https://github.com/spiceai/tableau-connector.git
40-
cd tableau-connector
46+
- Linux: `/opt/tableau/connectors`
4147
42-
# Package and install
43-
make install
44-
make run-tableau-allow-unsigned
45-
```
48+
```bash
49+
curl -L https://github.com/spiceai/tableau-connector/releases/latest/download/spice.taco -o /opt/tableau/connectors/spice.taco
50+
```
51+
52+
3. Restart server: `tsm restart`
53+
54+
#### Tableau Desktop
55+
56+
1. Download the latest `spice.taco` file from the [releases page](https://github.com/spiceai/tableau-connector/releases)
57+
2. Copy to your Tableau connectors directory:
58+
- Windows: `C:\Users\[USERNAME]\Documents\My Tableau Repository\Connectors`
59+
60+
```powershell
61+
Invoke-WebRequest -Uri "https://github.com/spiceai/tableau-connector/releases/latest/download/spice.taco" -OutFile "C:\Users\[USERNAME]\Documents\My Tableau Repository\Connectors\spice.taco"
62+
```
63+
64+
- macOS: `~/Documents/My Tableau Repository/Connectors`
65+
66+
```bash
67+
curl -L https://github.com/spiceai/tableau-connector/releases/latest/download/spice.taco -o ~/Documents/My\ Tableau\ Repository/Connectors/spice.taco
68+
```
69+
70+
- Linux: `/opt/tableau/connectors`
71+
72+
```bash
73+
curl -L https://github.com/spiceai/tableau-connector/releases/latest/download/spice.taco -o /opt/tableau/connectors/spice.taco
74+
```
4675
4776
## Limitations
4877
@@ -66,6 +95,12 @@ The limitation is due to limited arithmetic operations support for Interval by D
6695

6796
- `make` command-line tool
6897
- Python 3.x installed
98+
- Clone the repository
99+
100+
```bash
101+
git clone https://github.com/spiceai/tableau-connector.git
102+
cd tableau-connector
103+
```
69104

70105
### Run Connector
71106

@@ -92,6 +127,13 @@ cd tdvt && spice run
92127
make test
93128
```
94129

130+
### Package
131+
132+
```bash
133+
# Create an unsigned `spice.taco` connector version
134+
make package
135+
```
136+
95137
## License
96138

97139
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

connector-plugin-sdk

Submodule connector-plugin-sdk added at f95f5c5

0 commit comments

Comments
 (0)