dremiojs 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.eslintrc.json +14 -0
- package/.prettierrc +7 -0
- package/README.md +59 -0
- package/dremiodocs/dremio-cloud/cloud-api-reference.md +748 -0
- package/dremiodocs/dremio-cloud/dremio-cloud-about.md +225 -0
- package/dremiodocs/dremio-cloud/dremio-cloud-admin.md +3754 -0
- package/dremiodocs/dremio-cloud/dremio-cloud-bring-data.md +6098 -0
- package/dremiodocs/dremio-cloud/dremio-cloud-changelog.md +32 -0
- package/dremiodocs/dremio-cloud/dremio-cloud-developer.md +1147 -0
- package/dremiodocs/dremio-cloud/dremio-cloud-explore-analyze.md +2522 -0
- package/dremiodocs/dremio-cloud/dremio-cloud-get-started.md +300 -0
- package/dremiodocs/dremio-cloud/dremio-cloud-help-support.md +869 -0
- package/dremiodocs/dremio-cloud/dremio-cloud-manage-govern.md +800 -0
- package/dremiodocs/dremio-cloud/dremio-cloud-overview.md +36 -0
- package/dremiodocs/dremio-cloud/dremio-cloud-security.md +1844 -0
- package/dremiodocs/dremio-cloud/sql-docs.md +7180 -0
- package/dremiodocs/dremio-software/dremio-software-acceleration.md +1575 -0
- package/dremiodocs/dremio-software/dremio-software-admin.md +884 -0
- package/dremiodocs/dremio-software/dremio-software-client-applications.md +3277 -0
- package/dremiodocs/dremio-software/dremio-software-data-products.md +560 -0
- package/dremiodocs/dremio-software/dremio-software-data-sources.md +8701 -0
- package/dremiodocs/dremio-software/dremio-software-deploy-dremio.md +3446 -0
- package/dremiodocs/dremio-software/dremio-software-get-started.md +848 -0
- package/dremiodocs/dremio-software/dremio-software-monitoring.md +422 -0
- package/dremiodocs/dremio-software/dremio-software-reference.md +677 -0
- package/dremiodocs/dremio-software/dremio-software-security.md +2074 -0
- package/dremiodocs/dremio-software/dremio-software-v25-api.md +32637 -0
- package/dremiodocs/dremio-software/dremio-software-v26-api.md +36757 -0
- package/jest.config.js +10 -0
- package/package.json +25 -0
- package/src/api/catalog.ts +74 -0
- package/src/api/jobs.ts +105 -0
- package/src/api/reflection.ts +77 -0
- package/src/api/source.ts +61 -0
- package/src/api/user.ts +32 -0
- package/src/client/base.ts +66 -0
- package/src/client/cloud.ts +37 -0
- package/src/client/software.ts +73 -0
- package/src/index.ts +16 -0
- package/src/types/catalog.ts +31 -0
- package/src/types/config.ts +18 -0
- package/src/types/job.ts +18 -0
- package/src/types/reflection.ts +29 -0
- package/tests/integration_manual.ts +95 -0
- package/tsconfig.json +19 -0
|
@@ -0,0 +1,2522 @@
|
|
|
1
|
+
# Explore and Analyze Your Data | Dremio Documentation
|
|
2
|
+
|
|
3
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/
|
|
4
|
+
|
|
5
|
+
Dremio enables data engineers and data analysts to explore and analyze data regardless of the location of the data or the data format. You can explore and analyze using Dremio's console or use your tool of choice.
|
|
6
|
+
|
|
7
|
+
* **Discover Data**: Dremio offers several ways of discovering your data. Semantic search, metadata, and lineage help you find the right data quickly. Enrich the semantics of your data with wikis and labels so that AI agents and users can quickly identify relevant data. See [Discover Data](/dremio-cloud/explore-analyze/discover).
|
|
8
|
+
* **Explore Using AI Agent**: Use natural language to discover datasets, analyze data, and generate visualizations without writing SQL. The AI Agent uses the AI Semantic Layer to provide relevant responses and ensures governed access to data. See [Explore Using AI Agent](/dremio-cloud/explore-analyze/ai-agent).
|
|
9
|
+
* **Connect Client Applications**: Connect your preferred BI and data tools directly to Dremio to analyze data live without extracts or replication. See [Connect Client Applications](/dremio-cloud/explore-analyze/client-apps/).
|
|
10
|
+
|
|
11
|
+
Was this page helpful?
|
|
12
|
+
|
|
13
|
+
<div style="page-break-after: always;"></div>
|
|
14
|
+
|
|
15
|
+
# Explore Using AI Agent | Dremio Documentation
|
|
16
|
+
|
|
17
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/ai-agent
|
|
18
|
+
|
|
19
|
+
On this page
|
|
20
|
+
|
|
21
|
+
Understanding your data quickly using Dremio's AI Agent, an interface built into the Dremio console that allows users to converse with their data using natural language.
|
|
22
|
+
|
|
23
|
+
The AI Agent accesses data and entities that the logged in user has privileges on to address the prompt.
|
|
24
|
+
|
|
25
|
+
The AI Agent is currently optimized for the following tasks:
|
|
26
|
+
|
|
27
|
+
* **Discover and Explore**: Learn about the data that is available to you to answer your business question.
|
|
28
|
+
* **Analyze**: Ask questions using business terms using natural language and get insights instantly. The AI Agent goes beyond basic analysis to detect patterns in the data and return actionable insights.
|
|
29
|
+
* **Visualize**: Quickly visualize the patterns and trends in your data within the Dremio console.
|
|
30
|
+
* **Explain and Optimize SQL**: Ask the agent to review SQL queries, identify bottlenecks, and suggest optimizations. For more information on this, see [**Explain SQL**](/dremio-cloud/admin/monitor/jobs/#explain-sql).
|
|
31
|
+
* **Analyze and Improve Job Performance**: Ask the agent to review past jobs, identify performance issues, and suggest ways to improve them. For more information on this, see [**Explain Job**](/dremio-cloud/admin/monitor/jobs/#explain-job).
|
|
32
|
+
|
|
33
|
+
As Dremio's AI Agent reasons through your questions and requirements, you're able to see the actions it is taking directly in the interface so you can review, audit, and understand how the response is generated.
|
|
34
|
+
|
|
35
|
+
Generative AI can make mistakes; therefore, you should verify all output.
|
|
36
|
+
|
|
37
|
+
## Use Dremio's AI Agent
|
|
38
|
+
|
|
39
|
+
To use Dremio's AI Agent, you can access it by:
|
|
40
|
+
|
|
41
|
+
1. Typing a question into the chat on the homepage in the Dremio console.
|
|
42
|
+
2. Use the shortcut keys ⌘+Shift+G on a Mac or Ctrl+Shift+G on Windows to open the agent.
|
|
43
|
+
|
|
44
|
+
To use the AI Agent, you need to be granted CALL MODEL on the default model provider.
|
|
45
|
+
|
|
46
|
+
## Discover and Explore
|
|
47
|
+
|
|
48
|
+
Dremio's AI Agent will help you discover available data and provide a detailed breakdown of schema, as well as offer guidance on what tables and views you may want to use. The AI Agent will use wikis and labels as well as perform sampling or other simple analysis on the datasets to determine relevance and interesting patterns. The more detailed the question, the better the insight that the AI Agent can provide.
|
|
49
|
+
|
|
50
|
+
| Okay Prompt | Great Prompt |
|
|
51
|
+
| --- | --- |
|
|
52
|
+
| What tables can I use? | Which tables or views have customer location data? |
|
|
53
|
+
| How can I analyze time series data? | Which tables or views can I use to do a time series analysis on customer activity? |
|
|
54
|
+
| What is the `customer_activity` table? | How is the `customer_activity` table structured, and what other tables does it relate to? |
|
|
55
|
+
|
|
56
|
+
## Analyze
|
|
57
|
+
|
|
58
|
+
Dremio's AI Agent will write and execute SQL on your behalf based on your natural language input and the information available from the semantic layer. From within the chat, you can further audit the SQL by expanding the tool calls in the chat window.
|
|
59
|
+
|
|
60
|
+
| Okay Prompt | Great Prompt |
|
|
61
|
+
| --- | --- |
|
|
62
|
+
| I want to see analysis of customer activity | I want to see an analysis of customer purchase activity by region, by customer type for each month of the year. |
|
|
63
|
+
| Which customers are the most valuable? | Which customers have spent the most with us over the lifetime of the relationship? |
|
|
64
|
+
|
|
65
|
+
## Visualize
|
|
66
|
+
|
|
67
|
+
Dremio's AI Agent will visualize insights on your behalf based on your natural language input. The details you provide, including the chart type, axis requirements, grouping, or trendlines, will be considered by the LLM. The visualization will be accompanied by insights that serve as a narrative for the chart that the AI Agent generated. Once a visualization has been created, you can toggle between the visualization and a grid representation of the data that is used to back the visualization.
|
|
68
|
+
|
|
69
|
+
The AI Agent can return the following types of visualizations: Bar, Line, Area, Scatter, Pie, Heatmap
|
|
70
|
+
|
|
71
|
+
| Okay Prompt | Great Prompt |
|
|
72
|
+
| --- | --- |
|
|
73
|
+
| Visualize the data | Visualize the data as a bar chart with month on the x asis and sum of purchase value as the y axis |
|
|
74
|
+
| Create a visual trendline showing me the activity | Create a visualization with a trendline showing customer activity by month? |
|
|
75
|
+
|
|
76
|
+
## Related Topics
|
|
77
|
+
|
|
78
|
+
* [Jobs](/dremio-cloud/admin/monitor/jobs) – See the **Explain SQL** and **Explain Job** options on the Jobs page.
|
|
79
|
+
* [Data Privacy](/data-privacy/) – Learn more about Dremio's data privacy practices.
|
|
80
|
+
|
|
81
|
+
Was this page helpful?
|
|
82
|
+
|
|
83
|
+
* Use Dremio's AI Agent
|
|
84
|
+
* Discover and Explore
|
|
85
|
+
* Analyze
|
|
86
|
+
* Visualize
|
|
87
|
+
* Related Topics
|
|
88
|
+
|
|
89
|
+
<div style="page-break-after: always;"></div>
|
|
90
|
+
|
|
91
|
+
# Discover Data | Dremio Documentation
|
|
92
|
+
|
|
93
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/discover
|
|
94
|
+
|
|
95
|
+
On this page
|
|
96
|
+
|
|
97
|
+
Dremio provides multiple ways to discover and explore your data. Whether you prefer browsing catalogs, using semantic search, or leveraging the AI Agent, you can find the data you need quickly and efficiently.
|
|
98
|
+
|
|
99
|
+
Data discovery capabilities in Dremio include the following:
|
|
100
|
+
|
|
101
|
+
* Dremio's AI Agent for natural language data discovery and exploration
|
|
102
|
+
* AI-enabled semantic search for objects and entities
|
|
103
|
+
* Catalog exploration in the Dremio console
|
|
104
|
+
* Metadata cards for dataset details
|
|
105
|
+
|
|
106
|
+
## Discover using Dremio's AI Agent
|
|
107
|
+
|
|
108
|
+
Dremio's AI Agent makes it easy to find relevant data using natural language and your business terms. To learn more about using the AI Agent, see [Explore Using AI Agent](/dremio-cloud/explore-analyze/ai-agent).
|
|
109
|
+
|
|
110
|
+
## Search for Dremio Objects and Entities
|
|
111
|
+
|
|
112
|
+
You can quickly and easily find objects and entities with the AI-enabled search experience. Semantic search returns results of sources, folders, tables in Dremio's Open Catalog and external sources registered in Dremio, views in external sources registered in Dremio catalogs, user-defined functions (UDFs), Reflections, scripts, and jobs.
|
|
113
|
+
|
|
114
|
+
Semantic search takes object names and metadata such as wikis and labels into account to return results that are relevant to your search criteria.
|
|
115
|
+
|
|
116
|
+
To search for objects and entities:
|
|
117
|
+
|
|
118
|
+
1. Click the search bar on the top right of the page and type in your search criteria. You can activate the search bar by using the shortcut keys `Command + K` (Mac) or `Ctrl + K` (Windows/Linux).
|
|
119
|
+
2. Press the return or enter key to execute the search. Under **Recents**, you will see your recent searches.
|
|
120
|
+
3. Select a search result to view details. For a table or view, you can click the  icon to query the table or view in the SQL Runner.
|
|
121
|
+
|
|
122
|
+
### Limitations and Considerations
|
|
123
|
+
|
|
124
|
+
* Semantic search has been optimized for English terms.
|
|
125
|
+
* After creating new objects, they can take a few hours to appear in search results.
|
|
126
|
+
* After deleting objects or entities, they can take a few hours to disappear from search results.
|
|
127
|
+
* Data discovery capabilities are optimized for data that is governed by Dremio. Files and folders in object storage that have not been formatted as a table in Dremio may not be easily discoverable.
|
|
128
|
+
|
|
129
|
+
## Navigate Your Catalog
|
|
130
|
+
|
|
131
|
+
The Datasets page allows you to navigate through and explore objects that you have access to in Dremio. To learn more about the Datasets page, see [Quick Tour of the Dremio Console](/dremio-cloud/get-started/quick-tour/#datasets-page). Once you have located the table or view that you are interested in, click it to open the Details panel and view comprehensive information about the dataset.
|
|
132
|
+
|
|
133
|
+
## View Metadata of a Dataset
|
|
134
|
+
|
|
135
|
+
Wherever a dataset is referenced in Dremio, you can view a metadata card with details about the dataset.
|
|
136
|
+
|
|
137
|
+
To view the metadata, hover over a dataset to see a metadata card appear with details about the dataset. Key information displayed on dataset cards includes:
|
|
138
|
+
|
|
139
|
+
* **Dataset type and name**: Icon and title showing the dataset format and name
|
|
140
|
+
* **Quick actions**: Query, edit, or view the dataset
|
|
141
|
+
* **Path and labels**: Location and any applied labels
|
|
142
|
+
* **Usage metrics**: Jobs run and views created from the dataset
|
|
143
|
+
* **Ownership and dates**: Creator, creation date, and last modified
|
|
144
|
+
|
|
145
|
+
## Related Topics
|
|
146
|
+
|
|
147
|
+
* [Wikis and Labels](/dremio-cloud/manage-govern/wikis-labels) – Learn more about using wikis and labels to enrich your data.
|
|
148
|
+
* [Data Privacy](/data-privacy/) – Learn more about Dremio's data privacy practices.
|
|
149
|
+
|
|
150
|
+
Was this page helpful?
|
|
151
|
+
|
|
152
|
+
* Discover using Dremio's AI Agent
|
|
153
|
+
* Search for Dremio Objects and Entities
|
|
154
|
+
+ Limitations and Considerations
|
|
155
|
+
* Navigate Your Catalog
|
|
156
|
+
* View Metadata of a Dataset
|
|
157
|
+
* Related Topics
|
|
158
|
+
|
|
159
|
+
<div style="page-break-after: always;"></div>
|
|
160
|
+
|
|
161
|
+
# Connect Client Applications | Dremio Documentation
|
|
162
|
+
|
|
163
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/client-apps/
|
|
164
|
+
|
|
165
|
+
You can connect to Dremio from several popular applications to query and visualize the data in Dremio:
|
|
166
|
+
|
|
167
|
+
* [Alteryx Designer](/dremio-cloud/explore-analyze/client-apps/alteryx-designer)
|
|
168
|
+
* [Apache Superset](/dremio-cloud/explore-analyze/client-apps/apache-superset)
|
|
169
|
+
* [Astrato](/dremio-cloud/explore-analyze/client-apps/astrato)
|
|
170
|
+
* [DBeaver](/dremio-cloud/explore-analyze/client-apps/dbeaver)
|
|
171
|
+
* [DbVisualizer](/dremio-cloud/explore-analyze/client-apps/dbvisualizer)
|
|
172
|
+
* [Deepnote](/dremio-cloud/explore-analyze/client-apps/deepnote)
|
|
173
|
+
* [Domo](/dremio-cloud/explore-analyze/client-apps/domo)
|
|
174
|
+
* [Hex](/dremio-cloud/explore-analyze/client-apps/hex)
|
|
175
|
+
* [IBM Cognos Analytics](/dremio-cloud/explore-analyze/client-apps/ibm-cognos-analytics)
|
|
176
|
+
* [Looker](/dremio-cloud/explore-analyze/client-apps/looker)
|
|
177
|
+
* [Microsoft Excel PowerPivot](/dremio-cloud/explore-analyze/client-apps/microsoft-excel-powerpivot/)
|
|
178
|
+
* [Microsoft Power BI](/dremio-cloud/explore-analyze/client-apps/microsoft-power-bi/)
|
|
179
|
+
* [Preset](/dremio-cloud/explore-analyze/client-apps/preset/)
|
|
180
|
+
* [SAP Business Objects](/dremio-cloud/explore-analyze/client-apps/sap-business-objects)
|
|
181
|
+
* [Tableau](/dremio-cloud/explore-analyze/client-apps/tableau)
|
|
182
|
+
* [ThoughtSpot](/dremio-cloud/explore-analyze/client-apps/thoughtspot)
|
|
183
|
+
|
|
184
|
+
Dremio provides Arrow Flight SQL ODBC and JDBC drivers:
|
|
185
|
+
|
|
186
|
+
* [Arrow Flight SQL JDBC](/dremio-cloud/explore-analyze/client-apps/drivers/arrow-flight-sql-jdbc/)
|
|
187
|
+
* [Arrow Flight SQL ODBC](/dremio-cloud/explore-analyze/client-apps/drivers/arrow-flight-sql-odbc/)
|
|
188
|
+
|
|
189
|
+
Dremio also supports the [Dremio JDBC (Legacy)](/dremio-cloud/explore-analyze/client-apps/drivers/jdbc-legacy).
|
|
190
|
+
|
|
191
|
+
Was this page helpful?
|
|
192
|
+
|
|
193
|
+
<div style="page-break-after: always;"></div>
|
|
194
|
+
|
|
195
|
+
# Hex | Dremio Documentation
|
|
196
|
+
|
|
197
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/client-apps/hex
|
|
198
|
+
|
|
199
|
+
On this page
|
|
200
|
+
|
|
201
|
+
[Hex](https://hex.tech/) is a data workspace where you can analyze and share data from Dremio.
|
|
202
|
+
|
|
203
|
+
## Supported Authentication Methods
|
|
204
|
+
|
|
205
|
+
Use a personal access token (PAT) obtained from Dremio. To create a PAT, follow the steps in the section [Create a PAT](/dremio-cloud/security/authentication/personal-access-token/#create-a-pat).
|
|
206
|
+
|
|
207
|
+
## Prerequisites
|
|
208
|
+
|
|
209
|
+
If you want to connect to a specific project in Dremio, copy the ID of the project. See [Obtain the ID of a Project](/dremio-cloud/admin/projects/#obtain-the-id-of-a-project) for the steps. After you obtain it, save it somewhere that you can retrieve it from during the procedure.
|
|
210
|
+
|
|
211
|
+
## Create a Connection
|
|
212
|
+
|
|
213
|
+
1. Log into your Hex project.
|
|
214
|
+
2. Go to the **Data sources** tab on the side navigation bar.
|
|
215
|
+
3. Click **+ Add** > **Create project connection**.
|
|
216
|
+
4. Select **Dremio** from the project connections.
|
|
217
|
+
5. In the **Name** field, enter a name for the data connection.
|
|
218
|
+
6. (Optional) In the **Description** field, enter a brief description of the data connection.
|
|
219
|
+
7. In the **JDBC Connection** field, paste your JDBC connection string:
|
|
220
|
+
|
|
221
|
+
JDBC connection string
|
|
222
|
+
|
|
223
|
+
```
|
|
224
|
+
jdbc:dremio:direct=sql.dremio.cloud:443;ssl=true;
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
a. (Optional) Add ;PROJECT\_ID={project-id} to the JDBC connection string and in the **Project ID** field, paste the ID of the project that you want to connect to. If the project ID isn't specified, then the [default project](/dremio-cloud/admin/projects/#set-the-default-project) will be used.
|
|
228
|
+
|
|
229
|
+
b. (Optional) Add ;engine={engine-name} to the JDBC connection string and in the **Engine Name** field, specify the engine that you want the query routed to.
|
|
230
|
+
8. For the **Access Token**, paste your personal access token.
|
|
231
|
+
9. Click **Create Connection**.
|
|
232
|
+
|
|
233
|
+
Was this page helpful?
|
|
234
|
+
|
|
235
|
+
* Supported Authentication Methods
|
|
236
|
+
* Prerequisites
|
|
237
|
+
* Create a Connection
|
|
238
|
+
|
|
239
|
+
<div style="page-break-after: always;"></div>
|
|
240
|
+
|
|
241
|
+
# Domo | Dremio Documentation
|
|
242
|
+
|
|
243
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/client-apps/domo
|
|
244
|
+
|
|
245
|
+
On this page
|
|
246
|
+
|
|
247
|
+
[Domo](https://www.domo.com/) is a cloud-based platform designed to provide direct, simplified, real-time access to business data for decision makers across the company with minimal IT involvement.
|
|
248
|
+
|
|
249
|
+
## Supported Authentication Method
|
|
250
|
+
|
|
251
|
+
Authenticate to Dremio by using a personal access token (PAT). To create one, see [Create a PAT](/dremio-cloud/security/authentication/personal-access-token/#create-a-pat).
|
|
252
|
+
|
|
253
|
+
## Prerequisite
|
|
254
|
+
|
|
255
|
+
Obtain the ID of the project in Dremio that you want to connect to. For the steps, see [Obtain the ID of a Project](/dremio-cloud/admin/projects/#obtain-the-id-of-a-project).
|
|
256
|
+
|
|
257
|
+
## Create a Cloud Integration with Dremio
|
|
258
|
+
|
|
259
|
+
1. Click the **Data** tab to open the Datasets page.
|
|
260
|
+
2. Click the **Federated** tab to open the **Amplify existing cloud warehouses** dialog.
|
|
261
|
+
3. Next to **Native integration**, click **Dremio**.
|
|
262
|
+
4. In the **Cloud integrations** dialog, click **Add new integration**.
|
|
263
|
+
5. In step 1 of the **Connect a Dremio cloud integration** wizard, follow these sub-steps:
|
|
264
|
+
1. In the **Integration name** field, specify a unique name for the integration.
|
|
265
|
+
2. (Optional) In the **Integration description** field, briefly describe the integration.
|
|
266
|
+
3. Select **Dremio Cloud** as the connection type.
|
|
267
|
+
6. Click **Next**.
|
|
268
|
+
7. In step 2 of the wizard, follow these sub-steps:
|
|
269
|
+
1. In the **Dremio connection URL** field, specify the following connection URL, where `PROJECT_ID` is the ID of the project that you want to connect to:
|
|
270
|
+
Connection URL
|
|
271
|
+
|
|
272
|
+
```
|
|
273
|
+
jdbc:dremio:direct=sql.dremio.cloud:443;ssl=true;token_type=personal_access_token;PROJECT_ID=<project-ID>
|
|
274
|
+
```
|
|
275
|
+
2. Paste your PAT into the **Personal Access Token** field.
|
|
276
|
+
8. Click **Next**.
|
|
277
|
+
9. Select the tables that you want to use with Domo through this integration.
|
|
278
|
+
10. Click **Create Datasets**.
|
|
279
|
+
|
|
280
|
+
Datasets are created from the tables, though no data is moved or copied. Datasets in Domo are connections to data in data sources.
|
|
281
|
+
|
|
282
|
+
Was this page helpful?
|
|
283
|
+
|
|
284
|
+
* Supported Authentication Method
|
|
285
|
+
* Prerequisite
|
|
286
|
+
* Create a Cloud Integration with Dremio
|
|
287
|
+
|
|
288
|
+
<div style="page-break-after: always;"></div>
|
|
289
|
+
|
|
290
|
+
# Looker | Dremio Documentation
|
|
291
|
+
|
|
292
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/client-apps/looker
|
|
293
|
+
|
|
294
|
+
On this page
|
|
295
|
+
|
|
296
|
+
You can use [Looker](https://looker.com/) to query and visualize data by means of Dremio.
|
|
297
|
+
|
|
298
|
+
## Supported Authentication Method
|
|
299
|
+
|
|
300
|
+
Use a personal access token (PAT) obtained from Dremio. To create a PAT, follow the steps in [Create a PAT](/dremio-cloud/security/authentication/personal-access-token/#create-a-pat).
|
|
301
|
+
|
|
302
|
+
## Prerequisite
|
|
303
|
+
|
|
304
|
+
Copy the ID of the Dremio project that you want to connect to. See [Obtain the ID of a Project](/dremio-cloud/admin/projects/#obtain-the-id-of-a-project) for the steps. After you obtain it, save it somewhere that you can retrieve it from during the procedure.
|
|
305
|
+
|
|
306
|
+
## Create a Connection
|
|
307
|
+
|
|
308
|
+
1. Log into Looker.
|
|
309
|
+
2. In the menu bar at the top of the page, select **Admin**, and then select **Connections** under **Database**.
|
|
310
|
+
3. Click the **Add Connection** button in the top-right corner of the page to open the Connection Settings page for creating a connection.
|
|
311
|
+
4. Specify a name for the connection.
|
|
312
|
+
5. In the **Dialect** field, select **Dremio 11+**.
|
|
313
|
+
6. In the **Remote Host:Port** fields, specify `sql.dremio.cloud` and `443`.
|
|
314
|
+
7. In the **Database** field, specify any value. Though Looker requires a value in this field, Dremio does not use the value.
|
|
315
|
+
8. In the **Username** and **Password** fields, specify your authentication credentials:
|
|
316
|
+
|
|
317
|
+
* In the **Username** field, type `$token`.
|
|
318
|
+
* In the **Password** field, paste your personal access token.
|
|
319
|
+
9. Ensure that the **SSL** check box is selected.
|
|
320
|
+
10. If there is more that one project in your Dremio organization and you are not connecting to the default project, specify this additional JDBC parameter in the **Additional Settings** section: `PROJECT_ID=<project id>`. To obtain the ID, see [Obtain the ID of a Project](/dremio-cloud/admin/projects/#obtain-the-id-of-a-project).
|
|
321
|
+
11. Click **Test These Settings** at the bottom of the page to check that the information that you specified is all valid.
|
|
322
|
+
12. Click **Add Connection** if the test of the connection is successful.
|
|
323
|
+
|
|
324
|
+
The new connection is listed on the Connections page.
|
|
325
|
+
|
|
326
|
+
Was this page helpful?
|
|
327
|
+
|
|
328
|
+
* Supported Authentication Method
|
|
329
|
+
* Prerequisite
|
|
330
|
+
* Create a Connection
|
|
331
|
+
|
|
332
|
+
<div style="page-break-after: always;"></div>
|
|
333
|
+
|
|
334
|
+
# Preset | Dremio Documentation
|
|
335
|
+
|
|
336
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/client-apps/preset
|
|
337
|
+
|
|
338
|
+
On this page
|
|
339
|
+
|
|
340
|
+
You can use [Preset](https://preset.io/), a cloud service for Superset, to query and visualize data.
|
|
341
|
+
|
|
342
|
+
## Supported Authentication Method
|
|
343
|
+
|
|
344
|
+
Use a personal access token (PAT) obtained from a project.
|
|
345
|
+
To obtain one, follow the steps in [Create a PAT](/dremio-cloud/security/authentication/personal-access-token/#create-a-pat).
|
|
346
|
+
After you obtain a PAT, it is recommended that you URL-encode it. To encode it locally on your system, you can follow these steps:
|
|
347
|
+
|
|
348
|
+
1. In a browser window, right-click an empty area of the page and select **Inspect** or **Inspect Element**, depending on your browser.
|
|
349
|
+
2. In the top bar of the inspection pane, click **Console**.
|
|
350
|
+
3. Type `encodeURIComponent("<PAT>")`, where `<PAT>` is the personal access token that you obtained from Dremio. The URL-encoded PAT appears in red on the next line. You can highlight it and copy it to your clipboard.
|
|
351
|
+
|
|
352
|
+
## Prerequisite
|
|
353
|
+
|
|
354
|
+
Obtain the ID of the project that you want to connect to in Dremio. To obtain the ID, follow these steps inside the project:
|
|
355
|
+
|
|
356
|
+
1. In the Dremio console, hover over  in the side navigation bar and select **Project settings**.
|
|
357
|
+
2. Select **General Information** in the project settings sidebar.
|
|
358
|
+
3. Copy the project ID to your system clipboard.
|
|
359
|
+
|
|
360
|
+
## Create a Connection
|
|
361
|
+
|
|
362
|
+
1. Click **Settings** in the top-right corner, and select **Database Connections** under **Data**.
|
|
363
|
+
2. Click the **+Database** button in the top-right corner.
|
|
364
|
+
3. Select **Other** from the **Supported Databases** field of the Connect a Database dialog.
|
|
365
|
+
4. In the **Display Name** field, specify any name you prefer.
|
|
366
|
+
5. In the **Connect a Database** dialog, follow these steps:
|
|
367
|
+
|
|
368
|
+
1. Select **Other** from the **Supported Databases** field.
|
|
369
|
+
2. In the **Display Name** field, name the new connection.
|
|
370
|
+
3. In the **SQLALCHEMY URI** field, specify a URI that is in this format. Use an ampersand in front of each additional property that you add:SQLAlchemy URI format
|
|
371
|
+
|
|
372
|
+
```
|
|
373
|
+
dremio://$token:<PAT>@sql.dremio.cloud:443/<project-ID>;ssl=1[;<option>=<value>[;...]]
|
|
374
|
+
```
|
|
375
|
+
|
|
376
|
+
* `<PAT>`: The URL-encoded personal access token that you obtained from Dremio. See Supported Authentication Method.
|
|
377
|
+
* `<project-ID>`: The ID of the project that you want to connect to. See Prerequisite for the steps to obtain the ID.
|
|
378
|
+
* `[;<option>=<value>[;...]]`: One or more optional [encryption properties](/dremio-cloud/explore-analyze/client-apps/drivers/jdbc-legacy#encryption-parameters). Separate each property with a semicolon (`;`).Example SQLAlchemy URI
|
|
379
|
+
|
|
380
|
+
```
|
|
381
|
+
dremio://$token:hoYL2mqORpOv1Lq5WNOT-A-REAL-PATq5yeHEYon%2BOT0VHM0JYS%2BCMH7kpL%2BPQ%3D%3D@sql.dremio.cloud:443/1df71752-NOT-A-PROJECT-ID-990e6b194aa4;ssl=1
|
|
382
|
+
```
|
|
383
|
+
|
|
384
|
+
1. Test the connection. If the test fails, check the syntax and values in the connection URI.
|
|
385
|
+
2. Click **Connect**.
|
|
386
|
+
|
|
387
|
+
Was this page helpful?
|
|
388
|
+
|
|
389
|
+
* Supported Authentication Method
|
|
390
|
+
* Prerequisite
|
|
391
|
+
* Create a Connection
|
|
392
|
+
|
|
393
|
+
<div style="page-break-after: always;"></div>
|
|
394
|
+
|
|
395
|
+
# Astrato | Dremio Documentation
|
|
396
|
+
|
|
397
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/client-apps/astrato
|
|
398
|
+
|
|
399
|
+
On this page
|
|
400
|
+
|
|
401
|
+
[Astrato](https://astrato.io/) is a no-code framework to build powerful data visualizations and custom data applications that actively drive better business decisions.
|
|
402
|
+
|
|
403
|
+
## Supported Authentication Method
|
|
404
|
+
|
|
405
|
+
Authenticate to Dremio from Astrato by using a personal access token (PAT). To create one, see [Create a PAT](/dremio-cloud/security/authentication/personal-access-token/#create-a-pat).
|
|
406
|
+
|
|
407
|
+
## Create a Connection to Dremio
|
|
408
|
+
|
|
409
|
+
1. In Astrato, click **Data** in the left-hand navigation bar.
|
|
410
|
+
2. On the Data page, follow either of these sets of steps:
|
|
411
|
+
* Create a connection from the **Data Views** section.
|
|
412
|
+
1. Click **Data Views**.
|
|
413
|
+
2. In the top-right corner, click **New Data View**.
|
|
414
|
+
* Create a connection from the **Data Connections** section.
|
|
415
|
+
1. Click **Data Connection**.
|
|
416
|
+
2. In the top-right corner of the page, click **New connection**.
|
|
417
|
+
3. In the Create connection page, click the **Dremio** tile.
|
|
418
|
+
4. In the **Host** field, follow either of these steps:
|
|
419
|
+
* If your Dremio organization is in the [European control plane](/dremio-cloud/about/regions), leave the default value of `eu.dremio.cloud`.
|
|
420
|
+
* If your Dremio organization is in the [US control plane](/dremio-cloud/about/regions), specify `dremio.cloud`.
|
|
421
|
+
5. In the **Personal Access Token** field, paste your PAT.
|
|
422
|
+
6. Click **Test connection**.
|
|
423
|
+
7. In the Connect to Dremio page, follow these steps:
|
|
424
|
+
1. Select the project that you want to connect to in your organization.
|
|
425
|
+
2. Select the folder that you want to connect to in your project.
|
|
426
|
+
3. Click **Connect**.
|
|
427
|
+
|
|
428
|
+
You can now define a data view from data that resides in the folder that you connected to.
|
|
429
|
+
|
|
430
|
+
Was this page helpful?
|
|
431
|
+
|
|
432
|
+
* Supported Authentication Method
|
|
433
|
+
* Create a Connection to Dremio
|
|
434
|
+
|
|
435
|
+
<div style="page-break-after: always;"></div>
|
|
436
|
+
|
|
437
|
+
# DBeaver | Dremio Documentation
|
|
438
|
+
|
|
439
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/client-apps/dbeaver
|
|
440
|
+
|
|
441
|
+
On this page
|
|
442
|
+
|
|
443
|
+
You can run SQL from [DBeaver](https://dbeaver.io/) to explore your data in your data lakes and relational databases through Dremio.
|
|
444
|
+
|
|
445
|
+
## Supported Versions
|
|
446
|
+
|
|
447
|
+
You can use any version of DBeaver for Linux, MacOS, or Windows, except for version 23.0.2.202304091457.
|
|
448
|
+
|
|
449
|
+
## Supported Authentication Method
|
|
450
|
+
|
|
451
|
+
Authenticate to Dremio by using a personal access token. To create one, see [Create a PAT](/dremio-cloud/security/authentication/personal-access-token/#create-a-pat).
|
|
452
|
+
|
|
453
|
+
## Prerequisites
|
|
454
|
+
|
|
455
|
+
* Download the [Arrow Flight SQL JDBC driver](https://www.dremio.com/drivers/jdbc/).
|
|
456
|
+
* For MacOS, ensure you have the latest version of Java Runtime Environment (JRE).
|
|
457
|
+
|
|
458
|
+
## Connect to Dremio
|
|
459
|
+
|
|
460
|
+
### Step 1: Add the JDBC Driver
|
|
461
|
+
|
|
462
|
+
You only need to add the Arrow Flight SQL JDBC driver once. You can skip this step if DBeaver already lists this driver in its Driver Manager dialog. To add the JDBC driver, follow these steps:
|
|
463
|
+
|
|
464
|
+
1. In the menubar, select **Database** > **Driver Manager**.
|
|
465
|
+
2. In the Driver Manager dialog, click **New**.
|
|
466
|
+
3. In the Settings section, follow these steps:
|
|
467
|
+
|
|
468
|
+
1. In the **Name** field, specify a name for the driver, such as "Arrow Flight SQL JDBC Driver".
|
|
469
|
+
2. In the **Driver Type** field, ensure that **Generic** is the selected driver type.
|
|
470
|
+
3. In the **Class Name** field, specify `org.apache.arrow.driver.jdbc.ArrowFlightJdbcDriver`.
|
|
471
|
+
4. In the **URL Template** field, specify `jdbc:arrow-flight-sql://data.dremio.cloud:443/` .
|
|
472
|
+
5. In the **Default Port** field, specify `443`.
|
|
473
|
+
4. In the Libraries section, click **Add File** and select the `.jar` file for the Arrow Flight SQL JDBC driver.
|
|
474
|
+
5. Click **OK**.
|
|
475
|
+
|
|
476
|
+
### Step 2: Create a Connection
|
|
477
|
+
|
|
478
|
+
Once you've added the Arrow Flight SQL JDBC driver, follow these steps to create a connection to Dremio:
|
|
479
|
+
|
|
480
|
+
1. Select **Database** > **New Connection from JDBC URL**.
|
|
481
|
+
2. In the dialog that follows, enter `jdbc:arrow-flight-sql://data.dremio.cloud:443/`. At this point, DBeaver lists the driver in the **Drivers** field. If the driver is not immediately suggested, type and then delete a character in the input field to refresh suggestions.
|
|
482
|
+
3. Select the JDBC driver and click **Next**.
|
|
483
|
+
4. In the Connect to a Database dialog, follow these steps:
|
|
484
|
+
|
|
485
|
+
1. Select **URL** as the value for **Connect By**.
|
|
486
|
+
2. In the JDBC URL field, append `?token=<encoded_pat>` to the URL and replace `<encoded_pat>` with your URL-encoded personal access token.
|
|
487
|
+
|
|
488
|
+
note
|
|
489
|
+
|
|
490
|
+
If connecting to a non-default project, you must also append `&catalog=<project_id>` to the URL and replace `<project_id>` with your project ID.
|
|
491
|
+
3. (Optional) Click **Test Connection**. If the connection works, the **Connection Test** dialog opens and indicates that DBeaver is able to connect to Dremio. The connection is not held open. Click **OK**.
|
|
492
|
+
5. Click **Finish**.
|
|
493
|
+
|
|
494
|
+
Was this page helpful?
|
|
495
|
+
|
|
496
|
+
* Supported Versions
|
|
497
|
+
* Supported Authentication Method
|
|
498
|
+
* Prerequisites
|
|
499
|
+
* Connect to Dremio
|
|
500
|
+
+ Step 1: Add the JDBC Driver
|
|
501
|
+
+ Step 2: Create a Connection
|
|
502
|
+
|
|
503
|
+
<div style="page-break-after: always;"></div>
|
|
504
|
+
|
|
505
|
+
# Tableau | Dremio Documentation
|
|
506
|
+
|
|
507
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/client-apps/tableau
|
|
508
|
+
|
|
509
|
+
On this page
|
|
510
|
+
|
|
511
|
+
Connect [Tableau](https://www.tableau.com/) to Dremio to derive powerful insights from your data and create real-time dashboards.
|
|
512
|
+
|
|
513
|
+
note
|
|
514
|
+
|
|
515
|
+
When using Tableau with Dremio, avoid using periods in space or dataset names. Due to differences in hierarchy support, periods in paths are treated as separators, resulting in errors when navigating or selecting spaces or datasets with periods in their names.
|
|
516
|
+
|
|
517
|
+
You can connect from your Tableau application to Dremio in either of two ways:
|
|
518
|
+
|
|
519
|
+
* Configure a reusable connection in Tableau Desktop, Tableau Server, or Tableau Cloud.
|
|
520
|
+
* Connect to a specific dataset by downloading the `.tds` file from Dremio and opening it in Tableau Desktop.
|
|
521
|
+
|
|
522
|
+
## Supported Versions
|
|
523
|
+
|
|
524
|
+
| Product | Supported Versions |
|
|
525
|
+
| --- | --- |
|
|
526
|
+
| Tableau Desktop | 2022.1 and later |
|
|
527
|
+
| Tableau Server | 2022.1 and later |
|
|
528
|
+
| Tableau Cloud | Latest version deployed by Tableau |
|
|
529
|
+
|
|
530
|
+
## Supported Authentication Methods
|
|
531
|
+
|
|
532
|
+
From Tableau, you can authenticate to Dremio with a username and password, or with a [personal access token (PAT)](/dremio-cloud/security/authentication/personal-access-token/#create-a-pat) that can be obtained from the Dremio console.
|
|
533
|
+
|
|
534
|
+
You can also configure single sign-on (SSO) through OAuth 2.0. For steps on how to configure SSO, see Enable SSO to Dremio from Tableau.
|
|
535
|
+
|
|
536
|
+
## Tableau Desktop
|
|
537
|
+
|
|
538
|
+
Tableau Desktop includes a native connector that you can use to connect to Dremio.
|
|
539
|
+
|
|
540
|
+
### Prerequisites for Using the Dremio JDBC Driver (Legacy)
|
|
541
|
+
|
|
542
|
+
To connect to Dremio, you'll also need to install the Dremio JDBC driver. Download the Dremio JDBC driver and copy it to the Tableau Desktop's `Drivers` folder.
|
|
543
|
+
|
|
544
|
+
Download driver for macOS by running this command in a Terminal window
|
|
545
|
+
|
|
546
|
+
```
|
|
547
|
+
curl -L https://download.dremio.com/jdbc-driver/dremio-jdbc-driver-LATEST.jar -o ~/Library/Tableau/Drivers/dremio-jdbc-driver-LATEST.jar
|
|
548
|
+
```
|
|
549
|
+
|
|
550
|
+
Download driver for Windows by running this command in a PowerShell window
|
|
551
|
+
|
|
552
|
+
```
|
|
553
|
+
Invoke-WebRequest -Uri "https://download.dremio.com/jdbc-driver/dremio-jdbc-driver-LATEST.jar" -OutFile "C:\Program Files\Tableau\Drivers\dremio-jdbc-driver-LATEST.jar"
|
|
554
|
+
```
|
|
555
|
+
|
|
556
|
+
### Prerequisites for Using the Arrow Flight SQL JDBC Driver
|
|
557
|
+
|
|
558
|
+
The Tableau Desktop 2025.1+ connector for Dremio supports Arrow Flight SQL JDBC in place of the Dremio JDBC driver (Legacy). To change the driver, download the Arrow Flight SQL JDBC driver, copy it to Tableau Desktop's `Drivers` folder, and select the **Use Arrow Flight SQL Driver (preview)** option in the **Advanced** tab of the connection dialog.
|
|
559
|
+
|
|
560
|
+
Download driver for macOS by running this command in a Terminal window
|
|
561
|
+
|
|
562
|
+
```
|
|
563
|
+
curl -L https://repo1.maven.org/maven2/org/apache/arrow/flight-sql-jdbc-driver/18.3.0/flight-sql-jdbc-driver-18.3.0.jar -o ~/Library/Tableau/Drivers/flight-sql-jdbc-driver-18.3.0.jar
|
|
564
|
+
```
|
|
565
|
+
|
|
566
|
+
Download driver for Windows by running this command in a PowerShell window
|
|
567
|
+
|
|
568
|
+
```
|
|
569
|
+
Invoke-WebRequest -Uri "https://repo1.maven.org/maven2/org/apache/arrow/flight-sql-jdbc-driver/18.3.0/flight-sql-jdbc-driver-18.3.0.jar" -OutFile "C:\Program Files\Tableau\Drivers\flight-sql-jdbc-driver-18.3.0.jar"
|
|
570
|
+
```
|
|
571
|
+
|
|
572
|
+
### Steps for Connecting
|
|
573
|
+
|
|
574
|
+
To create a Dremio source in Tableau Desktop:
|
|
575
|
+
|
|
576
|
+
1. Open Tableau Desktop. If you already had Tableau Desktop open, restart the application. Under the **To a Server** section in the **Connect** panel, click **More**.
|
|
577
|
+
2. Select **Dremio**. The **Dremio** connection dialog opens.
|
|
578
|
+
3. In the **Product** field, select **Dremio Cloud**.
|
|
579
|
+
4. In the **Region** field, select the Dremio control plane in which your Dremio organization is located: `US` or `Europe`. For Tableau 2024.3 or before, in the **Server** field, select `sql.dremio.cloud (US)` or `sql.eu.dremio.cloud (EU)`.
|
|
580
|
+
5. In the **Authentication** field, select **Personal Access Token** or **OAuth 2.0**.
|
|
581
|
+
* If you selected **Personal Access Token**, in the **Password** field, specify your [PAT](/dremio-cloud/security/authentication/personal-access-token#create-a-pat).
|
|
582
|
+
* If you selected **OAuth 2.0**, specify one of these URLs in the **Dremio Authentication Server** field:
|
|
583
|
+
+ If your Dremio organization is on the US control plane: `https://login.dremio.cloud`
|
|
584
|
+
+ If your Dremio organization is on the EU control plane: `https://login.eu.dremio.cloud`
|
|
585
|
+
6. (Optional) In the **Project** field, if your datasets are in a non-default project of your Dremio organization or you do not have access to the default project, paste the ID of the project that you want to connect to. To obtain the project ID, see [Obtain the ID of a project](/dremio-cloud/admin/projects/#obtain-the-id-of-a-project).
|
|
586
|
+
7. (Optional for Tableau 2025.1+) If you are using the Arrow Flight SQL JDBC driver, in the **Advanced** tab, select the **Use Arrow Flight SQL Driver (preview)** option. Ensure that you have the Arrow Flight SQL JDBC driver [downloaded](/dremio-cloud/explore-analyze/client-apps/drivers/arrow-flight-sql-jdbc).
|
|
587
|
+
8. (Optional) In the **Advanced** tab, specify an **Engine** to run queries on.
|
|
588
|
+
9. Click **Sign In**.
|
|
589
|
+
|
|
590
|
+
### Create a Live Connection to a Dataset from Dremio
|
|
591
|
+
|
|
592
|
+
You can generate a Tableau Datasource (`.tds`) file that represents a live connection to a dataset that is in Dremio. No actual data is stored in this file, and you can think of it as a shortcut to a Tableau session with a preconfigured view of your data.
|
|
593
|
+
|
|
594
|
+
note
|
|
595
|
+
|
|
596
|
+
* The `.tds` file download option must be enabled for users to have access to this feature. To enable this feature, see Enable the .tds File Download in the Dremio Console.
|
|
597
|
+
* OAuth is the only supported authentication mechanism for `.tds` files.
|
|
598
|
+
|
|
599
|
+
To download a `.tds` file:
|
|
600
|
+
|
|
601
|
+
1. On the Datasets page of your Dremio project, find the dataset you want to work with and open the Details panel for the dataset.
|
|
602
|
+
2. Click the button that displays the Tableau logo. Dremio downloads a `.tds` file to your system.
|
|
603
|
+
3. Open the `.tds` file.
|
|
604
|
+
4. Authenticate to Dremio in the browser window that Tableau opens. The dataset will open in Tableau Desktop.
|
|
605
|
+
|
|
606
|
+
## Tableau Server
|
|
607
|
+
|
|
608
|
+
Tableau Server includes a native connector that you can use to connect to Dremio.
|
|
609
|
+
|
|
610
|
+
### Prerequisites for Using the Dremio JDBC (Legacy) Driver
|
|
611
|
+
|
|
612
|
+
To connect to Dremio, you'll need to install the Dremio JDBC driver. Download the Dremio JDBC driver and copy it to the `Drivers` folder.
|
|
613
|
+
|
|
614
|
+
Download driver for Windows by running this command in a PowerShell window
|
|
615
|
+
|
|
616
|
+
```
|
|
617
|
+
Invoke-WebRequest -Uri "https://download.dremio.com/jdbc-driver/dremio-jdbc-driver-LATEST.jar" -OutFile "C:\Program Files\Tableau\Drivers\dremio-jdbc-driver-LATEST.jar"
|
|
618
|
+
```
|
|
619
|
+
|
|
620
|
+
Download driver for Linux by running this command in a command-line window
|
|
621
|
+
|
|
622
|
+
```
|
|
623
|
+
curl -L https://download.dremio.com/jdbc-driver/dremio-jdbc-driver-LATEST.jar -o /opt/tableau/tableau_driver/jdbc/dremio-jdbc-driver-LATEST.jar
|
|
624
|
+
```
|
|
625
|
+
|
|
626
|
+
### Prerequisites for Using the Arrow Flight SQL JDBC Driver
|
|
627
|
+
|
|
628
|
+
The Tableau Server 2025.1+ connector for Dremio supports Arrow Flight SQL JDBC in place of the Dremio JDBC driver (Legacy). To change the driver, download the Arrow Flight SQL JDBC driver, copy it to the `Drivers` folder, and select the **Use Arrow Flight SQL Driver (preview)** option in the **Advanced** tab of the connection dialog.
|
|
629
|
+
|
|
630
|
+
Download driver for Windows by running this command in a PowerShell window
|
|
631
|
+
|
|
632
|
+
```
|
|
633
|
+
Invoke-WebRequest -Uri "https://repo1.maven.org/maven2/org/apache/arrow/flight-sql-jdbc-driver/18.3.0/flight-sql-jdbc-driver-18.3.0.jar" -OutFile "C:\Program Files\Tableau\Drivers\flight-sql-jdbc-driver-18.3.0.jar"
|
|
634
|
+
```
|
|
635
|
+
|
|
636
|
+
Download driver for Linux by running this command in a command-line window
|
|
637
|
+
|
|
638
|
+
```
|
|
639
|
+
curl -L https://repo1.maven.org/maven2/org/apache/arrow/flight-sql-jdbc-driver/18.3.0/flight-sql-jdbc-driver-18.3.0.jar -o /opt/tableau/tableau_driver/jdbc/flight-sql-jdbc-driver-18.3.0.jar
|
|
640
|
+
```
|
|
641
|
+
|
|
642
|
+
### Steps for Connecting
|
|
643
|
+
|
|
644
|
+
To create a Dremio source in Tableau Server:
|
|
645
|
+
|
|
646
|
+
1. In a web browser, navigate to your Tableau Server site.
|
|
647
|
+
2. In your workbook, click **Add a Data Source**. Alternatively, you can [publish an existing data source](https://help.tableau.com/current/pro/desktop/en-us/publish_datasources.htm) to Tableau Server.
|
|
648
|
+
3. In the **Connect to Data** dialog, select **Dremio** under the **Connectors** tab.
|
|
649
|
+
4. In the **Dremio** connection dialog, for the **Product** field, select **Dremio Cloud**.
|
|
650
|
+
5. In the **Region** field, select the Dremio control plane in which your Dremio organization is located: `US` or `Europe`. For Tableau 2024.3 or before, in the **Server** field, select `sql.dremio.cloud (US)` or `sql.eu.dremio.cloud (EU)`.
|
|
651
|
+
6. In the **Authentication** field, select **Personal Access Token** or **OAuth 2.0**.
|
|
652
|
+
* If you selected **Personal Access Token**, in the **Password** field, specify your [PAT](/dremio-cloud/security/authentication/personal-access-token#create-a-pat).
|
|
653
|
+
* If you selected **OAuth 2.0**, specify one of these URLs in the **Dremio Authentication Server** field:
|
|
654
|
+
+ If your Dremio organization is on the US control plane: `https://login.dremio.cloud`
|
|
655
|
+
+ If your Dremio organization is on the EU control plane: `https://login.eu.dremio.cloud`
|
|
656
|
+
7. (Optional) In the **Project** field, if your datasets are in a non-default project of your Dremio organization or you do not have access to the default project, paste the ID of the project that you want to connect to. To obtain the project ID, see [Obtain the ID of a project](/dremio-cloud/admin/projects/#obtain-the-id-of-a-project).
|
|
657
|
+
8. (Optional for Tableau 2025.1+) If you are using the Arrow Flight SQL JDBC driver, in the **Advanced** tab, select the **Use Arrow Flight SQL Driver (preview)** option. Ensure that you have the Arrow Flight SQL JDBC driver [downloaded](/dremio-cloud/explore-analyze/client-apps/drivers/arrow-flight-sql-jdbc).
|
|
658
|
+
9. (Optional) In the **Advanced** tab, specify an **Engine** to run queries on.
|
|
659
|
+
10. Click **Sign In**.
|
|
660
|
+
|
|
661
|
+
## Tableau Cloud
|
|
662
|
+
|
|
663
|
+
Tableau Cloud includes a native connector that you can use to connect to Dremio.
|
|
664
|
+
|
|
665
|
+
note
|
|
666
|
+
|
|
667
|
+
The Tableau Cloud 2025.1 connector for Dremio has an option to use the [Arrow Flight SQL JDBC](/dremio-cloud/explore-analyze/client-apps/drivers/arrow-flight-sql-jdbc) driver in place of the Dremio JDBC driver to power the connection to Dremio. In the **Advanced** tab, select the **Use Arrow Flight SQL Driver (preview)** option.
|
|
668
|
+
|
|
669
|
+
To create a Dremio source in Tableau Cloud:
|
|
670
|
+
|
|
671
|
+
1. In a web browser, navigate to your Tableau Cloud site.
|
|
672
|
+
2. Click **New** > **Published Data Source** to create a reusable data source or **Data** > **Add a Data Source** from within a workbook. Alternatively, you can [publish an existing data source](https://help.tableau.com/current/pro/desktop/en-us/publish_datasources.htm) to Tableau Cloud.
|
|
673
|
+
3. In the **Connect to Data** dialog, select Dremio under the Connectors tab.
|
|
674
|
+
4. In the **Dremio** connection dialog, for the **Product** field, select **Dremio Cloud**.
|
|
675
|
+
5. In the **Region** field, select the Dremio control plane in which your Dremio organization is located: `US` or `Europe`.
|
|
676
|
+
6. In the **Authentication** field, select **Personal Access Token** or **OAuth 2.0**.
|
|
677
|
+
* If you selected **Personal Access Token**, in the **Password** field, specify your [PAT](/dremio-cloud/security/authentication/personal-access-token#create-a-pat).
|
|
678
|
+
* If you selected **OAuth 2.0**, specify one of these URLs in the **Dremio Authentication Server** field:
|
|
679
|
+
+ If your Dremio organization is on the US control plane: `https://login.dremio.cloud`
|
|
680
|
+
+ If your Dremio organization is on the EU control plane: `https://login.eu.dremio.cloud`
|
|
681
|
+
7. (Optional) In the **Project** field, if your datasets are in a non-default project of your Dremio organization or you do not have access to the default project, paste the ID of the project that you want to connect to. To obtain the project ID, see [Obtain the ID of a Project](/dremio-cloud/admin/projects/#obtain-the-id-of-a-project).
|
|
682
|
+
8. (Optional for Tableau 2025.1+) If you are using the Arrow Flight SQL JDBC driver, in the **Advanced** tab, select the **Use Arrow Flight SQL Driver (preview)** option.
|
|
683
|
+
9. (Optional) In the **Advanced** tab, specify an **Engine** to run queries on.
|
|
684
|
+
10. Click **Sign In**.
|
|
685
|
+
|
|
686
|
+
## Advanced Configuration
|
|
687
|
+
|
|
688
|
+
### Enable the `.tds` File Download in the Dremio console
|
|
689
|
+
|
|
690
|
+
`ADMIN` privileges are required to make updates to this setting.
|
|
691
|
+
|
|
692
|
+
To enable users to download `.tds` files for datasets in Dremio, follow these steps:
|
|
693
|
+
|
|
694
|
+
1. In the Dremio console, click  in the side navigation bar and select **Project settings**.
|
|
695
|
+
2. Select **BI Applications** in the project settings sidebar.
|
|
696
|
+
3. Select the **Tableau** tab.
|
|
697
|
+
4. Toggle the **Enable Tableau Desktop** setting on.
|
|
698
|
+
|
|
699
|
+
After the organization administrator completes these steps, refresh your browser window.
|
|
700
|
+
|
|
701
|
+
### Enable SSO to Dremio from Tableau
|
|
702
|
+
|
|
703
|
+
SSO using OAuth 2.0 is supported by Tableau Desktop 2022.3 or later, Tableau Server, and Tableau Cloud.
|
|
704
|
+
|
|
705
|
+
Users of Tableau Desktop will use SSO authentication whether connecting directly to Dremio or connecting through a `.tds` file downloaded from Dremio. If you want to use SSO to authenticate when connecting to Dremio through a `.tds` file, ensure that SSO is enabled and configured for your Dremio cluster before the file is downloaded.
|
|
706
|
+
|
|
707
|
+
To enable SSO to Dremio from Tableau, ensure that your Dremio cluster has SSO configured with your [identity provider](/dremio-cloud/security/authentication/idp/) and follow these steps:
|
|
708
|
+
|
|
709
|
+
1. For Tableau Server only, follow the configuration steps.
|
|
710
|
+
2. Follow the steps to enable SSO to Dremio from Tableau.
|
|
711
|
+
|
|
712
|
+
#### Configure SSO for Tableau Server
|
|
713
|
+
|
|
714
|
+
note
|
|
715
|
+
|
|
716
|
+
**Use OAuth 2.0 with Tableau Server**
|
|
717
|
+
If you are using Tableau Server and you want to use OAuth 2.0 to authenticate to Dremio, you must have TLS enabled for Tableau Server for OAuth 2.0 to work. See [Example: SSL Certificate - Generate a Key and CSR](https://help.tableau.com/current/server-linux/en-us/ssl_cert_create.htm) in the Tableau's documentation for additional information.
|
|
718
|
+
|
|
719
|
+
To configure SSO using [OAuth for Tableau Server](https://tableau.github.io/connector-plugin-sdk/docs/oauth), follow these steps:
|
|
720
|
+
|
|
721
|
+
1. Run the following command in the Tableau Services Manager (TSM) command line. The only variable that you need to set the value for is `<tableau-server-domain-name-or-ip>`, which is the domain name or IP of your Tableau Server deployment:
|
|
722
|
+
|
|
723
|
+
Configure OAuth for Tableau Server
|
|
724
|
+
|
|
725
|
+
```
|
|
726
|
+
tsm configuration set -k oauth.config.clients -v "[{\"oauth.config.id\":\"dremio\", \"oauth.config.client_id\":\"https\:\/\/connectors.dremio.app\/tableau\", \"oauth.config.client_secret\":\"test-client-secret\", \"oauth.config.redirect_uri\":\"https://<tableau-server-domain-name-or-ip>/auth/add_oauth_token\"}]" --force-keys
|
|
727
|
+
```
|
|
728
|
+
2. To apply the changes to Tableau Server, run the command `tsm pending-changes apply`.
|
|
729
|
+
|
|
730
|
+
#### Configure Dremio
|
|
731
|
+
|
|
732
|
+
To enable SSO authentication to Dremio from Tableau:
|
|
733
|
+
|
|
734
|
+
1. In the Dremio console, click  in the side navigation bar and select **Project settings**.
|
|
735
|
+
2. Select **BI Applications** in the project settings sidebar.
|
|
736
|
+
3. On the BI Applications page, click **Tableau**.
|
|
737
|
+
4. Ensure that **Enable single sign-on for Tableau** is toggled on.
|
|
738
|
+
5. **For Tableau Server only:** In the **Redirect URIs** field, paste in the redirect URI for your Tableau Server. If you have set up more than one Tableau Server, you can add multiple URIs, separating them with commas. Each URI uses this format, where `<tableau-server>` is the hostname or IP address of Tableau Server:
|
|
739
|
+
|
|
740
|
+
Redirect URI for Tableau Server
|
|
741
|
+
|
|
742
|
+
```
|
|
743
|
+
https://<tableau-server>/auth/add_oauth_token
|
|
744
|
+
```
|
|
745
|
+
|
|
746
|
+
### Customize the Connection String
|
|
747
|
+
|
|
748
|
+
If you want to add JDBC parameters to the JDBC URL that Tableau generates for connections to Dremio, parameters other than those Tableau sets through the Dremio connection dialog, see [Use a Properties file to customize a JDBC connection](https://help.tableau.com/current/pro/desktop/en-us/connect_customize.htm#use-a-properties-file-to-customize-a-jdbc-connection) in the Tableau documentation.
|
|
749
|
+
|
|
750
|
+
### Manually Install the Dremio Connector
|
|
751
|
+
|
|
752
|
+
If you are previewing a feature that hasn't been released or you have been provided a `.taco` file with a fix that hasn't been released, you can manually install this version of the Dremio connector for temporary use.
|
|
753
|
+
|
|
754
|
+
To manually install the connector:
|
|
755
|
+
|
|
756
|
+
1. Download the [`dremio.taco` file](https://download.dremio.com/tableau-connector/).
|
|
757
|
+
2. Move the `dremio.taco` file:
|
|
758
|
+
|
|
759
|
+
Copy dremio.taco file on macOS
|
|
760
|
+
|
|
761
|
+
```
|
|
762
|
+
cp <download-location>/dremio.taco ~/Library/Tableau/Connectors/
|
|
763
|
+
```
|
|
764
|
+
|
|
765
|
+
Copy dremio.taco file on Windows
|
|
766
|
+
|
|
767
|
+
```
|
|
768
|
+
copy C:\<download-location>\dremio.taco "C:\Program Files\Tableau\Connectors"
|
|
769
|
+
```
|
|
770
|
+
|
|
771
|
+
Move dremio.taco file for Linux (Tableau Server only)
|
|
772
|
+
|
|
773
|
+
```
|
|
774
|
+
mv <download-location>/dremio.taco /opt/tableau/connectors/dremio.taco
|
|
775
|
+
```
|
|
776
|
+
3. (Optional) If a new version of the Dremio JDBC driver is required, download it and copy it to Tableau Desktop's `Drivers` folder by running the following command:
|
|
777
|
+
|
|
778
|
+
Download driver for macOS
|
|
779
|
+
|
|
780
|
+
```
|
|
781
|
+
curl https://download.dremio.com/jdbc-driver/dremio-jdbc-driver-LATEST.jar -o -l ~/Library/Tableau/Drivers/dremio-jdbc-driver-LATEST.jar
|
|
782
|
+
```
|
|
783
|
+
|
|
784
|
+
Download driver for Windows
|
|
785
|
+
|
|
786
|
+
```
|
|
787
|
+
Invoke-WebRequest -Uri "https://download.dremio.com/jdbc-driver/dremio-jdbc-driver-LATEST.jar" -OutFile "C:\Program Files\Tableau\Drivers\dremio-jdbc-driver-LATEST.jar"
|
|
788
|
+
```
|
|
789
|
+
|
|
790
|
+
For Linux, download the driver from the [download site](https://download.dremio.com/jdbc-driver/?_ga=2.148321079.1016122501.1667783452-235854462.1630284576&_gac=1.263316990.1664550761.CjwKCAjwp9qZBhBkEiwAsYFsb0x4InlcRP7Rv4XsjamZQHhJILHJWOtBOu30xZC1QwvEXF8cPFs1HhoCB-kQAvD_BwE) and move it by using this command:
|
|
791
|
+
Download driver for Linux (Tableau Server only)
|
|
792
|
+
|
|
793
|
+
```
|
|
794
|
+
mv <download-location>/dremio-jdbc-driver-LATEST.jar /opt/tableau/tableau_driver/jdbc/dremio-jdbc-driver-LATEST.jar
|
|
795
|
+
```
|
|
796
|
+
4. Now you can connect to Dremio from Tableau Desktop. or Tableau Server.
|
|
797
|
+
|
|
798
|
+
Was this page helpful?
|
|
799
|
+
|
|
800
|
+
* Supported Versions
|
|
801
|
+
* Supported Authentication Methods
|
|
802
|
+
* Tableau Desktop
|
|
803
|
+
+ Prerequisites for Using the Dremio JDBC Driver (Legacy)
|
|
804
|
+
+ Prerequisites for Using the Arrow Flight SQL JDBC Driver
|
|
805
|
+
+ Steps for Connecting
|
|
806
|
+
+ Create a Live Connection to a Dataset from Dremio
|
|
807
|
+
* Tableau Server
|
|
808
|
+
+ Prerequisites for Using the Dremio JDBC (Legacy) Driver
|
|
809
|
+
+ Prerequisites for Using the Arrow Flight SQL JDBC Driver
|
|
810
|
+
+ Steps for Connecting
|
|
811
|
+
* Tableau Cloud
|
|
812
|
+
* Advanced Configuration
|
|
813
|
+
+ Enable the `.tds` File Download in the Dremio console
|
|
814
|
+
+ Enable SSO to Dremio from Tableau
|
|
815
|
+
+ Customize the Connection String
|
|
816
|
+
+ Manually Install the Dremio Connector
|
|
817
|
+
|
|
818
|
+
<div style="page-break-after: always;"></div>
|
|
819
|
+
|
|
820
|
+
# Deepnote | Dremio Documentation
|
|
821
|
+
|
|
822
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/client-apps/deepnote
|
|
823
|
+
|
|
824
|
+
On this page
|
|
825
|
+
|
|
826
|
+
You can use [Deepnote](https://deepnote.com/) to explore data in Dremio with Python and SQL.
|
|
827
|
+
|
|
828
|
+
## Supported Authentication Method
|
|
829
|
+
|
|
830
|
+
Use a personal access token (PAT) obtained from Dremio. To create a PAT, follow the steps in the section [Create a PAT](/dremio-cloud/security/authentication/personal-access-token/#create-a-pat).
|
|
831
|
+
|
|
832
|
+
## Create an Integration with Dremio
|
|
833
|
+
|
|
834
|
+
1. After logging into Deepnote, click **Integrations** on the left.
|
|
835
|
+
2. Scroll down to **Create new integration**.
|
|
836
|
+
3. Under **Data warehouses & lakes**, click **Dremio**.
|
|
837
|
+
4. Specify a name for the integration.
|
|
838
|
+
5. In the **Host name** field, specify either `data.dremio.cloud` (Dremio's US control plane) or `data.eu.dremio.cloud` (Dremio's European control plane).
|
|
839
|
+
6. In the **Port** field, specify the number 443.
|
|
840
|
+
7. (Optional) In the **Schema** field, specify the database schema to use by default when a schema is not given in a query.
|
|
841
|
+
8. In the **Token** field, paste the PAT that you obtained from Dremio Cloud.
|
|
842
|
+
9. Click **Create integration**.
|
|
843
|
+
|
|
844
|
+
note
|
|
845
|
+
|
|
846
|
+
Do not toggle on the **Use SSH** switch. Dremio integrations do not support SSH tunnels.
|
|
847
|
+
|
|
848
|
+
Deepnote gives you the option of associating the integration with a project immediately. If you click **Skip**, the integration is listed under **Workspace integrations** on the **Integrations** page.
|
|
849
|
+
|
|
850
|
+
Was this page helpful?
|
|
851
|
+
|
|
852
|
+
* Supported Authentication Method
|
|
853
|
+
* Create an Integration with Dremio
|
|
854
|
+
|
|
855
|
+
<div style="page-break-after: always;"></div>
|
|
856
|
+
|
|
857
|
+
# Drivers | Dremio Documentation
|
|
858
|
+
|
|
859
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/client-apps/drivers/
|
|
860
|
+
|
|
861
|
+
Dremio provides Arrow Flight SQL ODBC and JDBC drivers:
|
|
862
|
+
|
|
863
|
+
* [Arrow Flight SQL JDBC](/dremio-cloud/explore-analyze/client-apps/drivers/arrow-flight-sql-jdbc/)
|
|
864
|
+
* [Arrow Flight SQL ODBC](/dremio-cloud/explore-analyze/client-apps/drivers/arrow-flight-sql-odbc/)
|
|
865
|
+
|
|
866
|
+
Dremio also supports the [Dremio JDBC (Legacy)](/dremio-cloud/explore-analyze/client-apps/drivers/jdbc-legacy).
|
|
867
|
+
|
|
868
|
+
note
|
|
869
|
+
|
|
870
|
+
To connect from supported client applications, follow the connection steps for that specific application rather than installing drivers separately. For example, to connect from Tableau, follow the steps in [Tableau](/dremio-cloud/explore-analyze/client-apps/tableau/), which include driver installation instructions.
|
|
871
|
+
|
|
872
|
+
Was this page helpful?
|
|
873
|
+
|
|
874
|
+
<div style="page-break-after: always;"></div>
|
|
875
|
+
|
|
876
|
+
# ThoughtSpot | Dremio Documentation
|
|
877
|
+
|
|
878
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/client-apps/thoughtspot
|
|
879
|
+
|
|
880
|
+
On this page
|
|
881
|
+
|
|
882
|
+
You can use [ThoughtSpot](https://www.thoughtspot.com/) to search directly against your data in Dremio for live analytics and actionable insights.
|
|
883
|
+
|
|
884
|
+
## Supported Versions
|
|
885
|
+
|
|
886
|
+
Dremio supports ThoughtSpot cloud 8.3 and ThoughtSpot software 7.2.1.
|
|
887
|
+
|
|
888
|
+
## Supported Authentication Methods
|
|
889
|
+
|
|
890
|
+
Use a personal access token (PAT) obtained from Dremio. To create a PAT, follow the steps in the section [Create a PAT](/dremio-cloud/security/authentication/personal-access-token/#create-a-pat).
|
|
891
|
+
|
|
892
|
+
If you want to use an OAuth application for authentication, you will first need to [add the OAuth application](/dremio-cloud/security/authentication/app-authentication/oauth-apps) and then copy the client ID.
|
|
893
|
+
|
|
894
|
+
## Prerequisites
|
|
895
|
+
|
|
896
|
+
If you want to connect to a specific project in Dremio, copy the ID of the project. See [Obtain the ID of a Project](/dremio-cloud/admin/projects/#obtain-the-id-of-a-project) for the steps. After you obtain it, save it somewhere that you can retrieve it from during the procedure.
|
|
897
|
+
|
|
898
|
+
## Create a Connection
|
|
899
|
+
|
|
900
|
+
note
|
|
901
|
+
|
|
902
|
+
While you're using the connection, the data fields that you create, modify, and delete in Dremio are reflected as table columns in ThoughtSpot. To account for new or outdated fields, you will need to go back into the data connection to check or uncheck the columns that you want added or removed on the Select Tables page.
|
|
903
|
+
|
|
904
|
+
1. Log into ThoughtSpot.
|
|
905
|
+
2. Navigate to **Data** > **Connections** > **Add Connection**.
|
|
906
|
+
3. On the Choose Your Data Warehouse page, specify your data connection details:
|
|
907
|
+
|
|
908
|
+
* In the **Name your connection** field, enter a name.
|
|
909
|
+
* (Optional) In the **Describe your connection** field, enter a brief description.
|
|
910
|
+
* For the **Choose your data warehouse** field, select **Dremio**.
|
|
911
|
+
4. Click **Continue**.
|
|
912
|
+
5. On the Dremio Connection Details page, to provide your authentication credentials, follow either of these steps:
|
|
913
|
+
|
|
914
|
+
a. To use a personal access token that you obtained from Dremio, select **Use Service Account**.
|
|
915
|
+
|
|
916
|
+
b. To use an OAuth application that you added in Dremio, select **Use OAuth**.
|
|
917
|
+
6. In the **Host** field, enter sql.dremio.cloud.
|
|
918
|
+
7. In the **Port** field, enter 443.
|
|
919
|
+
8. Follow either of these steps based on the authentication type that you chose:
|
|
920
|
+
|
|
921
|
+
a. For using a personal access token:
|
|
922
|
+
|
|
923
|
+
* In the **User** field, type `$token`.
|
|
924
|
+
* In the **Password** field, paste your personal access token.
|
|
925
|
+
* (Optional) In the **Project ID** field, paste the project ID.
|
|
926
|
+
|
|
927
|
+
b. For using an OAuth application:
|
|
928
|
+
|
|
929
|
+
* In the **Project ID** field, paste the project ID.
|
|
930
|
+
* In the **OAuth Client ID** field, paste the client ID.
|
|
931
|
+
* In the **OAuth Client Secret** field, enter your password.
|
|
932
|
+
* In the **Auth URL** field, enter the authorization URL of the application.
|
|
933
|
+
* In the **Access Token URL** field, enter the URL of the access token.
|
|
934
|
+
9. (Optional) In the **Schema** field, enter the project schema.
|
|
935
|
+
10. Click **Continue**.
|
|
936
|
+
11. On the Select Tables page, you can see all the data tables and views from Dremio. To select tables and columns from that list, select a table and check the boxes next to the columns for that table.
|
|
937
|
+
12. Click **Create Connection**.
|
|
938
|
+
13. In the **Create Connection** dialog, click **Confirm**.
|
|
939
|
+
|
|
940
|
+
Was this page helpful?
|
|
941
|
+
|
|
942
|
+
* Supported Versions
|
|
943
|
+
* Supported Authentication Methods
|
|
944
|
+
* Prerequisites
|
|
945
|
+
* Create a Connection
|
|
946
|
+
|
|
947
|
+
<div style="page-break-after: always;"></div>
|
|
948
|
+
|
|
949
|
+
# DbVisualizer | Dremio Documentation
|
|
950
|
+
|
|
951
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/client-apps/dbvisualizer
|
|
952
|
+
|
|
953
|
+
On this page
|
|
954
|
+
|
|
955
|
+
You can use [DbVisualizer](https://www.dbvis.com/) to query and visualize data by means of Dremio.
|
|
956
|
+
|
|
957
|
+
## Supported Versions
|
|
958
|
+
|
|
959
|
+
You can use any version of DbVisualizer, as long as you use Dremio JDBC Driver 14.0.0 or later.
|
|
960
|
+
|
|
961
|
+
## Supported Authentication Methods
|
|
962
|
+
|
|
963
|
+
There are two methods of authenticating that you can choose from when you connect from DbVisualizer to Dremio:
|
|
964
|
+
|
|
965
|
+
* Use Microsoft Entra ID as an enterprise identity provider
|
|
966
|
+
|
|
967
|
+
To configure Microsoft Entra ID, see [Microsoft Entra ID](/dremio-cloud/security/authentication/idp/microsoft-entra-id/).
|
|
968
|
+
|
|
969
|
+
note
|
|
970
|
+
|
|
971
|
+
You can use Microsoft authentication only if the admin for your Dremio organization has enabled it.
|
|
972
|
+
* Use a personal access token (PAT) obtained from Dremio
|
|
973
|
+
|
|
974
|
+
To create a PAT, follow the steps in [Create a PAT](/dremio-cloud/security/authentication/personal-access-token/#create-a-pat).
|
|
975
|
+
|
|
976
|
+
## Prerequisites
|
|
977
|
+
|
|
978
|
+
* [Download the Dremio JDBC driver](https://www.dremio.com/drivers/jdbc).
|
|
979
|
+
* If you do not want to connect to the default project in your Dremio organization, copy the ID of the Dremio Cloud project that you want to connect to. See [Obtain the ID of a Project](/dremio-cloud/admin/projects/#obtain-the-id-of-a-project) for the steps. After you obtain it, save it somewhere that you can retrieve it from during the procedure.
|
|
980
|
+
|
|
981
|
+
## Add Dremio's JDBC Driver to DbVisualizer's Driver Manager
|
|
982
|
+
|
|
983
|
+
1. Launch DbVisualizer.
|
|
984
|
+
2. Select **Tools** > **Driver Manager**.
|
|
985
|
+
3. In the **Driver Name** list of the **Driver Manager** dialog, select **Dremio**.
|
|
986
|
+
4. Click the folder icon to find and select the downloaded Dremio JDBC driver.
|
|
987
|
+
5. Close the **Driver Manager** dialog.
|
|
988
|
+
|
|
989
|
+
## Create a Connection
|
|
990
|
+
|
|
991
|
+
1. Launch DbVisualizer.
|
|
992
|
+
2. Select **Database** > **Create Database Connection**.
|
|
993
|
+
3. In the **Use Connection Wizard?** dialog, click **No Wizard**.
|
|
994
|
+
4. Name the connection.
|
|
995
|
+
5. Ensure that these default values are set:
|
|
996
|
+
|
|
997
|
+
| Field | Value |
|
|
998
|
+
| --- | --- |
|
|
999
|
+
| **Settings Format** | Server Info |
|
|
1000
|
+
| **Database Type** | Auto Detect (Dremio) |
|
|
1001
|
+
| **Driver** | Dremio |
|
|
1002
|
+
| **Connection Type** | Direct |
|
|
1003
|
+
6. In the **Database Server** field, specify `sql.dremio.cloud`.
|
|
1004
|
+
7. In the **Database Port** field, specify `443`.
|
|
1005
|
+
8. In the **Database Userid** and **Database Password** fields, specify your authentication credentials:
|
|
1006
|
+
|
|
1007
|
+
* If you want to authenticate by using a Microsoft account and password, and Microsoft Entra ID is configured as an enterprise identity provider for Dremio Cloud, specify the username and password for the account.
|
|
1008
|
+
* If you want to authenticate by using a personal access token, specify these values:
|
|
1009
|
+
|
|
1010
|
+
+ In the **Username** field, type `$token`.
|
|
1011
|
+
+ In the **Password** field, paste your personal access token.
|
|
1012
|
+
9. Click **Properties**.
|
|
1013
|
+
10. Click the plus sign to add a new parameter.
|
|
1014
|
+
11. Name the parameter `ssl`.
|
|
1015
|
+
12. Specify `true` for the value of this parameter.
|
|
1016
|
+
13. If you do not want to connect to the default project in your organization, follow these steps:
|
|
1017
|
+
|
|
1018
|
+
a. Click the plus sign to add a new parameter.
|
|
1019
|
+
|
|
1020
|
+
b. Name the parameter `PROJECT_ID`.
|
|
1021
|
+
|
|
1022
|
+
c. In the `Value` field, paste the ID of the project that you want to connect to.
|
|
1023
|
+
14. Click **Apply**.
|
|
1024
|
+
15. Click **Connect**.
|
|
1025
|
+
|
|
1026
|
+
If the connection works, DbVisualizer displays a message as shown below (the reported version numbers might differ):
|
|
1027
|
+
|
|
1028
|
+
`Dremio Server 20.0.0-202112201840340507-df2e9b7c`
|
|
1029
|
+
|
|
1030
|
+
`Dremio JDBC Driver 19.1.0-202111160130570172-0ee00450`
|
|
1031
|
+
|
|
1032
|
+
You can now expand your Dremio connection to see a list of the data sources that are in the project.
|
|
1033
|
+
|
|
1034
|
+
Was this page helpful?
|
|
1035
|
+
|
|
1036
|
+
* Supported Versions
|
|
1037
|
+
* Supported Authentication Methods
|
|
1038
|
+
* Prerequisites
|
|
1039
|
+
* Add Dremio's JDBC Driver to DbVisualizer's Driver Manager
|
|
1040
|
+
* Create a Connection
|
|
1041
|
+
|
|
1042
|
+
<div style="page-break-after: always;"></div>
|
|
1043
|
+
|
|
1044
|
+
# Apache Superset | Dremio Documentation
|
|
1045
|
+
|
|
1046
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/client-apps/apache-superset
|
|
1047
|
+
|
|
1048
|
+
On this page
|
|
1049
|
+
|
|
1050
|
+
You can use [Superset](https://superset.apache.org/) to query and visualize data.
|
|
1051
|
+
|
|
1052
|
+
## Supported Versions
|
|
1053
|
+
|
|
1054
|
+
* Superset 1.5.3 and later
|
|
1055
|
+
* Dremio SQLAlchemy connector 3.0.2 and later
|
|
1056
|
+
|
|
1057
|
+
## Supported Authentication Method
|
|
1058
|
+
|
|
1059
|
+
Use a personal access token (PAT) created in a project. To create one, follow the steps [Create a PAT](/dremio-cloud/security/authentication/personal-access-token/#create-a-pat). After you obtain a PAT, it is recommended that you URL-encode it. To encode it locally on your system, you can follow these steps:
|
|
1060
|
+
|
|
1061
|
+
1. In a browser window, right-click an empty area of the page and select **Inspect** or **Inspect Element**, depending on your browser.
|
|
1062
|
+
2. In the top bar of the inspection pane, click **Console**.
|
|
1063
|
+
3. Type `encodeURIComponent("<PAT>")`, where `<PAT>` is the personal access token that you obtained from Dremio. The URL-encoded PAT appears in red on the next line. You can highlight it and copy it to your clipboard.
|
|
1064
|
+
|
|
1065
|
+
## Prerequisites
|
|
1066
|
+
|
|
1067
|
+
If you installed Superset according to [the instructions for installing from scratch](https://superset.apache.org/docs/installation/installing-superset-from-scratch), install the Dremio SQLAlchemy Connector on the system or in the VM where Apache Superset is running. Instructions are in the [sqlalchemy\_dremio repository](https://github.com/narendrans/sqlalchemy_dremio) in GitHub.
|
|
1068
|
+
|
|
1069
|
+
## Create a Connection
|
|
1070
|
+
|
|
1071
|
+
1. If you are using a version of Superset earlier than 2.1.0, follow these steps:
|
|
1072
|
+
|
|
1073
|
+
1. Select **Data** > **Databases** in the menu bar at the top of the screen.
|
|
1074
|
+
2. Click the **Database** button in the top-right corner of the screen.
|
|
1075
|
+
2. If you are using version 2.1.0 or later of Superset, follow these steps:
|
|
1076
|
+
|
|
1077
|
+
1. Click **Datasets** in the menu bar at the top of the screen.
|
|
1078
|
+
2. Click the plus (+) icon in the top-right corner.
|
|
1079
|
+
3. Select **Data** > **Connect database**.
|
|
1080
|
+
3. In the **Connect a Database** dialog, follow these steps:
|
|
1081
|
+
|
|
1082
|
+
1. Select **Other** from the **Supported Databases** field.
|
|
1083
|
+
2. In the **Display Name** field, name the new connection.
|
|
1084
|
+
3. In the **SQLALCHEMY URI** field, specify a URI that is in this format. Use an ampersand in front of each additional property that you add:SQLAlchemy URI format
|
|
1085
|
+
|
|
1086
|
+
```
|
|
1087
|
+
dremio+flight://data.dremio.cloud:443/[<schema>]?token=<PAT>&UseEncryption=true[&<option>=<value>[&...]]
|
|
1088
|
+
```
|
|
1089
|
+
|
|
1090
|
+
* `<schema>`: The name of the database schema to use by default when a schema is not given in a query. Providing a schema is optional. Specifying a schema does not prevent queries from being issued for other schemas; such queries must explicitly include the schema.
|
|
1091
|
+
* `<PAT>`: The URL-encoded personal access token that you obtained from Dremio. See Supported Authentication Method.
|
|
1092
|
+
* `[&<option>=<value>[&...]]` is one or more optional properties from the SSL connection properties and Advanced properties tables below. Separate each property with an ampersand (`&`).Example SQLAlchemy URI
|
|
1093
|
+
|
|
1094
|
+
```
|
|
1095
|
+
dremio+flight://data.dremio.cloud:443/?token=dOOfxnJlTnebGu7Beta9NOT-A-REAL-PATyfOoNbJwEMep7UjkQu0JTsFXpYGm==&UseEncryption=true
|
|
1096
|
+
```
|
|
1097
|
+
|
|
1098
|
+
|
|
1099
|
+
4. Test the connection. If the test fails, check the syntax and values in the connection URI.
|
|
1100
|
+
5. Click **Connect**.
|
|
1101
|
+
|
|
1102
|
+
## SSL Connection Properties
|
|
1103
|
+
|
|
1104
|
+
Use the following properties to configure SSL encryption and verification methods:
|
|
1105
|
+
|
|
1106
|
+
| Name | Type | Description | Default Value |
|
|
1107
|
+
| --- | --- | --- | --- |
|
|
1108
|
+
| UseEncryption | integer | Forces the client to use an SSL-encrypted connection to communicate with Dremio. Accepted value: `true`, the client communicates with Dremio only using SSL encryption. This is the only possible value. | true |
|
|
1109
|
+
| disableCertificateVerification | integer | Specifies whether to verify the host certificate against the trust store. Accepted values: `false`, verifies the certificate against the trust store; `true`, does not verify the certificate against the trust store. | false |
|
|
1110
|
+
| trustedCerts | string | The full path of the .pem file containing certificates trusted by a CA, for the purpose of verifying the server. If this option is not set, defaults to using the trusted CA certificates .pem file. The TLS connection fails if you do not specify a value when UseEncryption is true and disableCertificateVerification is false. | N/A |
|
|
1111
|
+
|
|
1112
|
+
## Advanced Properties
|
|
1113
|
+
|
|
1114
|
+
| Name | Type | Description | Default Value | Required? |
|
|
1115
|
+
| --- | --- | --- | --- | --- |
|
|
1116
|
+
| routing\_engine | string | The engine to route queries to while a connection remains open. | N/A | No |
|
|
1117
|
+
| routing\_tag | string | The tag to be associated with all queries executed within a connection session. | N/A | No |
|
|
1118
|
+
|
|
1119
|
+
Was this page helpful?
|
|
1120
|
+
|
|
1121
|
+
* Supported Versions
|
|
1122
|
+
* Supported Authentication Method
|
|
1123
|
+
* Prerequisites
|
|
1124
|
+
* Create a Connection
|
|
1125
|
+
* SSL Connection Properties
|
|
1126
|
+
* Advanced Properties
|
|
1127
|
+
|
|
1128
|
+
<div style="page-break-after: always;"></div>
|
|
1129
|
+
|
|
1130
|
+
# Alteryx Designer | Dremio Documentation
|
|
1131
|
+
|
|
1132
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/client-apps/alteryx-designer
|
|
1133
|
+
|
|
1134
|
+
On this page
|
|
1135
|
+
|
|
1136
|
+
You can use Alteryx Designer to quickly prepare, blend, conform, and analyze data from datasets in Dremio.
|
|
1137
|
+
|
|
1138
|
+
## Supported Versions
|
|
1139
|
+
|
|
1140
|
+
Alteryx Designer 10.6+
|
|
1141
|
+
|
|
1142
|
+
## Prerequisite
|
|
1143
|
+
|
|
1144
|
+
Download, install, and configure the [ODBC driver for Arrow Flight SQL](/dremio-cloud/explore-analyze/client-apps/drivers/arrow-flight-sql-odbc/).
|
|
1145
|
+
|
|
1146
|
+
note
|
|
1147
|
+
|
|
1148
|
+
* The driver supports 64-bit Windows 10 or later.
|
|
1149
|
+
* The personal access token (PAT) that you add to the DSN that you configure for the driver determines the Dremio project that the driver connects you to. Ensure that you create your PAT in the correct project.
|
|
1150
|
+
|
|
1151
|
+
## Select Dremio as a Data Source
|
|
1152
|
+
|
|
1153
|
+
1. In Alteryx Designer, select **File** > **New Workflow**.
|
|
1154
|
+
2. Drag the **Input Data** tool from the tool palette on to the workflow canvas.
|
|
1155
|
+
3. In the configuration properties for Input Data, click the arrow on the right side of the **Connect a File or Database** field.
|
|
1156
|
+
4. In the Data connections dialog, follow these steps:
|
|
1157
|
+
|
|
1158
|
+
a. Select **Recent** and click **Clear List** in the top-right corner if there are any entries on the page.
|
|
1159
|
+
|
|
1160
|
+
b. Select **Data Sources**.
|
|
1161
|
+
|
|
1162
|
+
c. Scroll down to the option **Generic connection**.
|
|
1163
|
+
|
|
1164
|
+
d. Click either **ODBC** or **OleDB**.
|
|
1165
|
+
5. If you clicked **ODBC**, follow these steps in the ODBC Connection dialog:
|
|
1166
|
+
|
|
1167
|
+
a. In the **Data Source Name** field, select the data source name for the Arrow Flight SQL ODBC driver.
|
|
1168
|
+
|
|
1169
|
+
b. Leave the **User name** and **Password** field blank. The authentication credentials for connecting to Dremio are already present in the user DSN.
|
|
1170
|
+
|
|
1171
|
+
c. Click **OK**.
|
|
1172
|
+
6. If you clicked **OleDB**, follow these steps in the Data Link Properties dialog:
|
|
1173
|
+
|
|
1174
|
+
a. On the **Provider** tab, select **Microsoft OLE DB Provider for ODBC Drivers**.
|
|
1175
|
+
|
|
1176
|
+
b. Click **Next>>**.
|
|
1177
|
+
|
|
1178
|
+
c. For step 1 on the **Connection** tab, select **Use data source name**, and then select the data source name for the Arrow Flight SQL ODBC driver.
|
|
1179
|
+
|
|
1180
|
+
d. For step 2 on the **Connection** tab, leave the **User name** and **Password** fields blank. The authentication credentials for connecting to Dremio are already present in the user DSN.
|
|
1181
|
+
|
|
1182
|
+
e. (Optional) Click **Test Connection** to find out whether the info you specified on this tab is correct.
|
|
1183
|
+
|
|
1184
|
+
f. Click **OK**.
|
|
1185
|
+
|
|
1186
|
+
You can now browse and query datasets that are in Dremio.
|
|
1187
|
+
|
|
1188
|
+
Was this page helpful?
|
|
1189
|
+
|
|
1190
|
+
* Supported Versions
|
|
1191
|
+
* Prerequisite
|
|
1192
|
+
* Select Dremio as a Data Source
|
|
1193
|
+
|
|
1194
|
+
<div style="page-break-after: always;"></div>
|
|
1195
|
+
|
|
1196
|
+
# Microsoft Power BI | Dremio Documentation
|
|
1197
|
+
|
|
1198
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/client-apps/microsoft-power-bi
|
|
1199
|
+
|
|
1200
|
+
On this page
|
|
1201
|
+
|
|
1202
|
+
Connect [Microsoft Power BI](https://www.microsoft.com/en-us/power-platform/products/power-bi) to visualize your data and create reports.
|
|
1203
|
+
|
|
1204
|
+
You can connect Power BI to Dremio in one of the following ways:
|
|
1205
|
+
|
|
1206
|
+
* Configure a reusable connection to use in Power BI Desktop, Power BI Gateway, or Power BI Service. Power BI Service can connect to Dremio through DirectQuery or through Power BI Gateway.
|
|
1207
|
+
* Connect to a specific dataset by downloading the `.pbids` file from Dremio and opening it in Power BI Desktop.
|
|
1208
|
+
|
|
1209
|
+
## Supported Authentication Methods
|
|
1210
|
+
|
|
1211
|
+
From Power BI, you can authenticate to Dremio with one of the following methods:
|
|
1212
|
+
|
|
1213
|
+
* **Personal access token (PAT)**: For details, see [Create a PAT](/dremio-cloud/security/authentication/personal-access-token#create-a-pat).
|
|
1214
|
+
* **Single sign-on (SSO) through OAuth 2.0**: For steps on how to configure SSO, see Enable SSO to Dremio from Power BI.
|
|
1215
|
+
|
|
1216
|
+
## Connect to Dremio from Power BI
|
|
1217
|
+
|
|
1218
|
+
The Power BI connector for Dremio now supports connectivity through the open-source [Arrow Database Connectivity (ADBC) driver](https://arrow.apache.org/docs/format/ADBC.html), which Dremio highly recommends using to connect to Dremio. To enable reports to use ADBC, see Enable Connectivity with ADBC.
|
|
1219
|
+
|
|
1220
|
+
Existing connections will continue to work, but we recommend using the embedded ADBC driver for all new reports and migrating existing reports to ADBC to benefit from improved performance and supportability.
|
|
1221
|
+
|
|
1222
|
+
To connect to Dremio from Power BI Desktop:
|
|
1223
|
+
|
|
1224
|
+
1. Click **Get data**, search for `Dremio`, select **Dremio Cloud**, and click **Connect**.
|
|
1225
|
+
2. In the Dremio Cloud dialog, follow these steps:
|
|
1226
|
+
|
|
1227
|
+
a. Use the Flight SQL ADBC driver and in the **Server** field specify which of Dremio's control planes to connect to:
|
|
1228
|
+
|
|
1229
|
+
* If your Dremio organization is on the US control plane: `adbc://data.dremio.cloud`
|
|
1230
|
+
* If your Dremio organization is on the EU control plane: `adbc://data.eu.dremio.cloud`
|
|
1231
|
+
|
|
1232
|
+
b. (Optional) In the **Project** field, if your datasets are in a non-default project of your Dremio organization or you do not have access to the default project, paste the ID of the project that you want to connect to. To obtain the project ID, see [Obtain the ID of a Project](/dremio-cloud/admin/projects/#obtain-the-id-of-a-project).
|
|
1233
|
+
|
|
1234
|
+
c. (Optional) In the **Engine** field, specify the name of the query-execution engine for your project. For information about query-execution engines, see [Manage Engines](/dremio-cloud/admin/engines/).
|
|
1235
|
+
|
|
1236
|
+
d. (Optional) In the **Native Query** field, specify a SQL query as the data input source.
|
|
1237
|
+
|
|
1238
|
+
e. Under **Data Connectivity mode**, select either **Import** or **DirectQuery**. Click **OK**.
|
|
1239
|
+
|
|
1240
|
+
f. For **Authentication Method**, select **Key** or **Microsoft Account**.
|
|
1241
|
+
|
|
1242
|
+
* **Key**: Paste in the personal access token you obtained from Dremio. For details, see [Create a PAT](/dremio-cloud/security/authentication/personal-access-token#create-a-pat).
|
|
1243
|
+
* **Microsoft Account**: Click **Sign in**, and then specify your credentials.
|
|
1244
|
+
|
|
1245
|
+
note
|
|
1246
|
+
|
|
1247
|
+
Creating Dataflows through Power BI Service is also supported. To create a dataflow, click **New** > **Dataflow**. For the data source connection, follow the steps above.
|
|
1248
|
+
|
|
1249
|
+
### Create a Live Connection to a Dataset from Dremio
|
|
1250
|
+
|
|
1251
|
+
You can generate a Microsoft Power BI Data Source (`.pbids`) file that represents a live connection to a dataset that is in Dremio. No actual data is stored in this file, and you can think of it as a shortcut to a Power BI Desktop session with a preconfigured view of your data.
|
|
1252
|
+
|
|
1253
|
+
note
|
|
1254
|
+
|
|
1255
|
+
The `.pbids` file download option must be enabled for users to have access to this feature. To enable this feature, see Enable the .pbids file download.
|
|
1256
|
+
|
|
1257
|
+
To download a `.pbids` file:
|
|
1258
|
+
|
|
1259
|
+
1. On the Datasets page in Dremio, find the dataset you want to work with and open the Details panel for the dataset.
|
|
1260
|
+
2. Click the button that displays the Power BI logo. Dremio downloads a `.pbids` file to your system.
|
|
1261
|
+
3. Open the `.pbids` file.
|
|
1262
|
+
4. Authenticate using a personal access token or your organizational account and click **Load**.
|
|
1263
|
+
|
|
1264
|
+
### Connect to Dremio via PrivateLink
|
|
1265
|
+
|
|
1266
|
+
Use these instructions to connect to Dremio if your organization uses PrivateLink for secure private connectivity.
|
|
1267
|
+
|
|
1268
|
+
#### Prerequisites
|
|
1269
|
+
|
|
1270
|
+
* A [PrivateLink](/dremio-cloud/security/privatelink) connection configured in your AWS VPC.
|
|
1271
|
+
* The November 2025 version of Power BI Desktop.
|
|
1272
|
+
|
|
1273
|
+
#### Connect with an Organizational Account
|
|
1274
|
+
|
|
1275
|
+
1. In Power BI Desktop, click Get data.
|
|
1276
|
+
2. In the Get Data dialog, choose Blank Query and click **Connect**.
|
|
1277
|
+
3. Select Advanced Editor and add the following:
|
|
1278
|
+
|
|
1279
|
+
```
|
|
1280
|
+
let
|
|
1281
|
+
Source = DremioCloud.DatabasesByServerV370("adbc://<orgAlias>.data.privatelink.dremio.cloud", null, null, null, null, "Enabled-PEM", [AuthorizationServerPort=443, AuthorizationServerDomain="<orgAlias>.login.privatelink.dremio.cloud"])
|
|
1282
|
+
in
|
|
1283
|
+
Source
|
|
1284
|
+
```
|
|
1285
|
+
|
|
1286
|
+
where `<orgAlias>` is the organization alias implemented in your [PrivateLink configuration](/dremio-cloud/security/privatelink).
|
|
1287
|
+
4. Click **Done**.
|
|
1288
|
+
5. Select **Edit Credentials**.
|
|
1289
|
+
6. Choose Organizational Account and click **Sign in**.
|
|
1290
|
+
|
|
1291
|
+
#### Connect with a Personal Access Token
|
|
1292
|
+
|
|
1293
|
+
1. In Power BI Desktop, click Get data, choose Dremio Cloud, and click **Connect**.
|
|
1294
|
+
2. In the Dremio Cloud connection box, enter the PrivateLink DNS name created in your [PrivateLink configuration](/dremio-cloud/security/privatelink), in the form
|
|
1295
|
+
|
|
1296
|
+
```
|
|
1297
|
+
adbc://<orgAlias>.data.privatelink.dremio.cloud
|
|
1298
|
+
```
|
|
1299
|
+
|
|
1300
|
+
where `<orgAlias>` is your PrivateLink organization alias. Click **OK**.
|
|
1301
|
+
|
|
1302
|
+
## Power BI Gateway
|
|
1303
|
+
|
|
1304
|
+
To enable Power BI users to connect to Dremio via Power BI Gateway:
|
|
1305
|
+
|
|
1306
|
+
1. In Power BI Service, click **...** next to your profile picture at the top-right corner of the browser and navigate to **Settings > Manage gateways**.
|
|
1307
|
+
2. Under **GATEWAY CLUSTERS**, select the gateway you created previously.
|
|
1308
|
+
3. Select the checkbox **Allow user's cloud data sources to refresh through this gateway cluster**.
|
|
1309
|
+
4. At the top of the page, click **Add data sources to use the gateway**. This launches the *Data Source Settings* page.
|
|
1310
|
+
5. Enter a **Data Source Name**.
|
|
1311
|
+
6. Select the **Data Source Type** drop-down menu and select **Dremio Cloud**.
|
|
1312
|
+
7. In the **Server** field, specify which of Dremio's control planes to connect to:
|
|
1313
|
+
|
|
1314
|
+
* If your Dremio organization is on the US control plane: `sql.dremio.cloud`.
|
|
1315
|
+
* If your Dremio organization is on the EU control plane: `sql.eu.dremio.cloud`.
|
|
1316
|
+
8. (Optional) In the **Project** field, if your datasets are in a non-default project of your Dremio organization or you do not have access to the default project, paste the ID of the project that you want to connect to. To obtain the project ID, see [Obtain the ID of a project](/dremio-cloud/admin/projects/#obtain-the-id-of-a-project).
|
|
1317
|
+
9. For **Authentication Method**, select **Key** or **Microsoft Account**.
|
|
1318
|
+
|
|
1319
|
+
* **Key**: Paste in the personal access token you obtained from Dremio. For details, see [Create a PAT](/dremio-cloud/security/authentication/personal-access-token#create-a-pat).
|
|
1320
|
+
* **Microsoft Account**: Click **Sign in**, and then specify your credentials.
|
|
1321
|
+
10. Ignore the **Engine** field. It is not used.
|
|
1322
|
+
11. Under **Advanced Settings**, set the **Connection Encryption setting for this data source** to **Encrypted**.
|
|
1323
|
+
12. Click **Add**. A **Connection Successful** message is shown on top of the Data Source Settings page.
|
|
1324
|
+
|
|
1325
|
+
## Advanced Configuration
|
|
1326
|
+
|
|
1327
|
+
### Enable Connectivity with ADBC
|
|
1328
|
+
|
|
1329
|
+
Dremio supports connectivity through Arrow Database Connectivity (ADBC). To enable this for Power BI Service, see the following options.
|
|
1330
|
+
|
|
1331
|
+
#### Enable the ADBC Option for a New Connection
|
|
1332
|
+
|
|
1333
|
+
1. In Power BI Desktop, click **Get data**.
|
|
1334
|
+
2. In the Get Data dialog, locate and select **Dremio Cloud**, and click **Connect**.
|
|
1335
|
+
3. In the Dremio Cloud dialog, in the **Server** field, enter `adbc://data.dremio.cloud` or `adbc://data.eu.dremio.cloud`, depending on which control plane your Dremio account is on.
|
|
1336
|
+
4. (Optional) Complete the other fields in the dialog as you normally would.
|
|
1337
|
+
5. Click **OK**.
|
|
1338
|
+
6. Authenticate using your preferred method, and click **Connect**.
|
|
1339
|
+
|
|
1340
|
+
#### Enable the ADBC Option for an Existing Connection
|
|
1341
|
+
|
|
1342
|
+
1. In Power BI Desktop, go to **Data source settings**, select your source, and click **Change source**.
|
|
1343
|
+
2. In the Dremio Cloud dialog, update the **Server** field to `adbc://data.dremio.cloud` or `adbc://data.eu.dremio.cloud`, depending on which control plane your Dremio account is on. If you're unable to edit the source this way, click **Transform data**, then click **Advanced Editor** in the **Home** tab. In the dialog that appears, update the hostname/server with the `adbc://` prefix, and click **Done**.
|
|
1344
|
+
3. Click **OK**.
|
|
1345
|
+
4. Reauthenticate using your preferred method, and click **Connect**.
|
|
1346
|
+
|
|
1347
|
+
### Enable the `.pbids` File Download in the Dremio Console
|
|
1348
|
+
|
|
1349
|
+
`ADMIN` privileges are required to make updates to this setting.
|
|
1350
|
+
|
|
1351
|
+
To enable users to download `.pbids` files for datasets in the Dremio console, follow these steps:
|
|
1352
|
+
|
|
1353
|
+
1. Click  in the side navigation bar and select **Project Settings**.
|
|
1354
|
+
2. Select **BI Applications** in the projects settings sidebar.
|
|
1355
|
+
3. Toggle the **Microsoft Power BI Desktop** setting on.
|
|
1356
|
+
|
|
1357
|
+
After the organization administrator completes these steps, refresh your browser window.
|
|
1358
|
+
|
|
1359
|
+
### Enable SSO to Dremio from Power BI
|
|
1360
|
+
|
|
1361
|
+
When Single Sign-On (SSO) is enabled, viewers of reports in Power BI Service run them under their own Power BI username instead of as the user who published the reports, or under the username of the user who set up Power BI Gateway. SSO is supported for DirectQuery mode.
|
|
1362
|
+
|
|
1363
|
+
To enable SSO to Dremio from Power BI, ensure that your Dremio organization is configured with [Microsoft Entra ID](/cloud/security/authentication/idp/microsoft-entra-id/) and follow these steps:
|
|
1364
|
+
|
|
1365
|
+
1. In the Dremio console, click  in the side navigation bar and select **Organization Settings**.
|
|
1366
|
+
2. Select **BI Applications** from the organization settings sidebar.
|
|
1367
|
+
3. On the BI Applications page, click **Power BI**.
|
|
1368
|
+
4. Ensure that **Enable single sign-on for Power BI** is toggled on.
|
|
1369
|
+
5. For **Microsoft Entra Tenant ID**, enter the tenant ID of your Microsoft Entra ID account. The tenant ID of each Microsoft Entra ID account can only be assigned to a single Dremio organization.
|
|
1370
|
+
6. For **User Claim Mapping**, specify the key of the user claim that Dremio must look up in access tokens to find the username of the user attempting to log in. See [User Claim Mapping](/cloud/security/authentication/app-authentication/external-token#user-claim-mapping) for more information about this field.
|
|
1371
|
+
7. Click **Save**.
|
|
1372
|
+
8. In the Power BI Admin portal, select **Tenant settings** and toggle on the **Enabled** switch under **Dremio SSO**.
|
|
1373
|
+
|
|
1374
|
+
#### Enable SSO for a DirectQuery Report
|
|
1375
|
+
|
|
1376
|
+
To enable SSO for a report that uses DirectQuery:
|
|
1377
|
+
|
|
1378
|
+
1. In Power BI Service, open the workspace to which you published the report.
|
|
1379
|
+
2. Find the dataset that is associated with the report, click the three dots next to its name, and select **Settings**.
|
|
1380
|
+
3. Expand the **Data source credentials** section and click **Edit credentials**.
|
|
1381
|
+
4. In the configure dialog, follow these steps:
|
|
1382
|
+
|
|
1383
|
+
1. In the **Authentication method** field, select one of these options:
|
|
1384
|
+
|
|
1385
|
+
* **Key**: Paste your personal access token into the **Account Key** field.
|
|
1386
|
+
* **OAuth2**: Authenticate by using your Microsoft ID and password.
|
|
1387
|
+
2. In the **Privacy level setting for this data source** field, ensure that **Private** is selected.
|
|
1388
|
+
3. Select the check box **Report viewers can only access this data source with their own Power BI identities using DirectQuery**.
|
|
1389
|
+
4. Click **Sign in**.
|
|
1390
|
+
|
|
1391
|
+
#### Enable SSO for Reports with Power BI Gateway
|
|
1392
|
+
|
|
1393
|
+
To enable SSO when you are using Power BI Gateway:
|
|
1394
|
+
|
|
1395
|
+
1. In Power BI Service, open the workspace to which you published the report.
|
|
1396
|
+
2. Find the dataset that is associated with the report, click the three dots next to its name, and select **Settings**.
|
|
1397
|
+
3. In the settings for the dataset, expand **Gateway connection**.
|
|
1398
|
+
4. Recreate your data source by following these steps:
|
|
1399
|
+
|
|
1400
|
+
1. Select the **Maps to** field.
|
|
1401
|
+
2. Select **Manually add to gateway**.
|
|
1402
|
+
3. In the New data source dialog, create a data source that matches the one that you previously used for your dataset. However, give the new data source a different name.
|
|
1403
|
+
4. In the **Authentication method** field, select one of these options:
|
|
1404
|
+
|
|
1405
|
+
* **Key**: Paste your personal access token into the **Account Key** field.
|
|
1406
|
+
* **OAuth2**: Click **Edit credentials** and select the option **Use SSO via Microsoft Entra ID for DirectQuery queries**.
|
|
1407
|
+
5. Click **Create**.
|
|
1408
|
+
5. Under **Gateway connection**, verify that the new data source is selected in the **Maps to** field.
|
|
1409
|
+
|
|
1410
|
+
## Arrow Database Connectivity (ADBC) Limitations
|
|
1411
|
+
|
|
1412
|
+
* ADBC is not enabled by default. It must be enabled by the owner of the report.
|
|
1413
|
+
* NativeQuery is not supported.
|
|
1414
|
+
* Metadata calls are not cached.
|
|
1415
|
+
* SSO is not supported in environments that use different domain names for the UI and Flight services.
|
|
1416
|
+
* Power BI Desktop occasionally caches errors that might affect future connection attempts until the cache is cleared.
|
|
1417
|
+
* Complex data types such as `MAP` and `INTERVAL` are not supported.
|
|
1418
|
+
* When using DirectQuery, chaining functions is supported, but some complex scenarios may not work as expected. Complex optional parameters for functions are not supported.
|
|
1419
|
+
|
|
1420
|
+
## Troubleshoot Power BI
|
|
1421
|
+
|
|
1422
|
+
### Cached Data Issues
|
|
1423
|
+
|
|
1424
|
+
If you have previously installed older versions of Power BI Desktop, cached data may interfere with the newer versions of the Flight SQL drivers resulting in connection errors.
|
|
1425
|
+
|
|
1426
|
+
#### Problem
|
|
1427
|
+
|
|
1428
|
+
For example, when using Flight SQL ADBC, cached connection data in Power BI could cause the following errors:
|
|
1429
|
+
|
|
1430
|
+
* `ADBC: IOError [] [FlightSQL] [FlightSQL] unresolved address (Unavailable; GetObjects(GetDBSchemas))`
|
|
1431
|
+
* `ADBC: IOError [] [FlightSQL] [FlightSQL] connection error: desc = "transport: authentication handshake failed: credentials: cannot check peer: missing selected ALPN property. If you upgraded from a grpc-go version earlier than 1.67, your TLS connections may have stopped working due to ALPN enforcement. For more details, see: https://github.com/grpc/grpc-go/issues/434" (Unavailable; GetObjects(GetDBSchemas))`
|
|
1432
|
+
|
|
1433
|
+
#### Solution
|
|
1434
|
+
|
|
1435
|
+
Clear the Power BI Desktop cache and any cached data source permissions involving Dremio connections by following these steps:
|
|
1436
|
+
|
|
1437
|
+
1. [Clear Power BI Desktop Caches](https://community.fabric.microsoft.com/t5/Desktop/How-to-clear-cache-in-Power-BI-Desktop/m-p/853389#M409501).
|
|
1438
|
+
2. In Power BI Desktop, go to **File** > **Options and Settings** > **Data Source Settings**.
|
|
1439
|
+
3. Select **Global Permissions**.
|
|
1440
|
+
4. Clear all cached connections by clicking **Clear All Permissions**, or select specific Dremio data sources and click **Clear Permissions**.
|
|
1441
|
+
|
|
1442
|
+
After completing these steps, try reconnecting to Dremio using the instructions above.
|
|
1443
|
+
|
|
1444
|
+
### Large Result Sets
|
|
1445
|
+
|
|
1446
|
+
#### Problem
|
|
1447
|
+
|
|
1448
|
+
When fetching data from Dremio with ADBC you may see the following error:
|
|
1449
|
+
|
|
1450
|
+
* `Unexpected error: [FlightSQL] grpc: received message larger than max (43747370 vs. 16777216) (ResourceExhausted; DoGet: endpoint 0: [])`
|
|
1451
|
+
|
|
1452
|
+
#### Solution
|
|
1453
|
+
|
|
1454
|
+
By default, the ADBC driver accepts only messages up to 16 MiB in size. This can be fixed by updating the Power BI M expression to customize the connection as follows:
|
|
1455
|
+
|
|
1456
|
+
```
|
|
1457
|
+
let
|
|
1458
|
+
Source = DremioCloud.DatabasesByServerV370("adbc://data.dremio.cloud", null, null, null, null, "Enabled-PEM", [AdbcMaxMessageSize=33554432]) // 32 MiB
|
|
1459
|
+
in
|
|
1460
|
+
Source
|
|
1461
|
+
```
|
|
1462
|
+
|
|
1463
|
+
Was this page helpful?
|
|
1464
|
+
|
|
1465
|
+
* Supported Authentication Methods
|
|
1466
|
+
* Connect to Dremio from Power BI
|
|
1467
|
+
+ Create a Live Connection to a Dataset from Dremio
|
|
1468
|
+
+ Connect to Dremio via PrivateLink
|
|
1469
|
+
* Power BI Gateway
|
|
1470
|
+
* Advanced Configuration
|
|
1471
|
+
+ Enable Connectivity with ADBC
|
|
1472
|
+
+ Enable the `.pbids` File Download in the Dremio Console
|
|
1473
|
+
+ Enable SSO to Dremio from Power BI
|
|
1474
|
+
* Arrow Database Connectivity (ADBC) Limitations
|
|
1475
|
+
* Troubleshoot Power BI
|
|
1476
|
+
+ Cached Data Issues
|
|
1477
|
+
+ Large Result Sets
|
|
1478
|
+
|
|
1479
|
+
<div style="page-break-after: always;"></div>
|
|
1480
|
+
|
|
1481
|
+
# Dremio JDBC (Legacy) | Dremio Documentation
|
|
1482
|
+
|
|
1483
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/client-apps/drivers/jdbc-legacy
|
|
1484
|
+
|
|
1485
|
+
On this page
|
|
1486
|
+
|
|
1487
|
+
You can use the Dremio JDBC driver (Legacy) version 25+ to connect to Dremio from JDBC client applications. This driver is licensed under [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
|
|
1488
|
+
|
|
1489
|
+
## Prerequisites
|
|
1490
|
+
|
|
1491
|
+
Java 11 is required as of Dremio JDBC (Legacy) version 25.
|
|
1492
|
+
|
|
1493
|
+
note
|
|
1494
|
+
|
|
1495
|
+
The [Arrow Flight SQL JDBC driver](/dremio-cloud/explore-analyze/client-apps/drivers/arrow-flight-sql-jdbc) is the recommended driver for connectivity to Java-based applications. The Dremio JDBC driver (Legacy) will not be updated or fixed moving forward.
|
|
1496
|
+
|
|
1497
|
+
## Supported Authentication Methods
|
|
1498
|
+
|
|
1499
|
+
* Use personal access tokens. To generate one, see [Personal Access Tokens](/dremio-cloud/security/authentication/personal-access-token#create-a-pat).
|
|
1500
|
+
* Use JSON Web Tokens (JWT) from an external token provider. To use a JWT, you must have OAuth enabled in Dremio. For more information about using JWTs, see [External Token Providers](/dremio-cloud/security/authentication/app-authentication/external-token).
|
|
1501
|
+
|
|
1502
|
+
## Download and Install
|
|
1503
|
+
|
|
1504
|
+
You can download the JDBC driver from [here](https://www.dremio.com/drivers/jdbc/). The driver does not require installation.
|
|
1505
|
+
|
|
1506
|
+
## Connect to Dremio
|
|
1507
|
+
|
|
1508
|
+
note
|
|
1509
|
+
|
|
1510
|
+
If you are using the JDBC driver to connect to Dremio from a supported client application, refer to the documentation for [creating connections from that application](/dremio-cloud/explore-analyze/client-apps/).
|
|
1511
|
+
|
|
1512
|
+
If you want to start with the base JDBC connection string for your Dremio project:
|
|
1513
|
+
|
|
1514
|
+
1. Click Project Settings  in the side navigation bar.
|
|
1515
|
+
2. Select **General Information** in the project settings sidebar.
|
|
1516
|
+
3. Copy the connection string that is in the **JDBC Connection** field.
|
|
1517
|
+
|
|
1518
|
+
To construct a connection string:
|
|
1519
|
+
|
|
1520
|
+
1. Set the subprotocol to `jdbc:dremio:`.
|
|
1521
|
+
2. Set the property `direct` equal to `sql.dremio.cloud:443`.
|
|
1522
|
+
3. Add one of these types of authentication credentials for connecting from your JDBC client application to Dremio:
|
|
1523
|
+
|
|
1524
|
+
* Use a [personal access token (PAT)](/dremio-cloud/security/authentication/personal-access-token/) in either of the following ways:
|
|
1525
|
+
|
|
1526
|
+
+ Set `user` to `$token` and use the PAT as the password when the client application does not support OAuth:
|
|
1527
|
+
|
|
1528
|
+
Use PAT as password when client app does not support OAuth
|
|
1529
|
+
|
|
1530
|
+
```
|
|
1531
|
+
jdbc:dremio:direct=sql.dremio.cloud:443;user=$token;password=<personal-access-token>;
|
|
1532
|
+
```
|
|
1533
|
+
+ Set `token_type` to `personal_access_token`, use the PAT as the password, and set `username` to null when the client application supports OAuth:
|
|
1534
|
+
|
|
1535
|
+
Use PAT as password
|
|
1536
|
+
|
|
1537
|
+
```
|
|
1538
|
+
jdbc:dremio:direct=sql.dremio.cloud:443;token_type=personal_access_token;password=<personal-access-token>;username=;
|
|
1539
|
+
```
|
|
1540
|
+
* Use a [JSON Web Token (JWT)](/dremio-cloud/security/authentication/app-authentication/external-token). You can use a JWT when the tool used with the JDBC driver supports OAuth:
|
|
1541
|
+
|
|
1542
|
+
Use a JWT
|
|
1543
|
+
|
|
1544
|
+
```
|
|
1545
|
+
jdbc:dremio:direct=sql.dremio.cloud:443;token_type=jwt;password=<jwt>;username=;
|
|
1546
|
+
```
|
|
1547
|
+
4. Set the property `ssl` equal to `true`: `ssl=true;`
|
|
1548
|
+
5. Add the ID of the project that you are connecting to: `project_id=<project-id>;`
|
|
1549
|
+
6. (Optional) Route queries to a particular [engine](/dremio-cloud/admin/engines/) in your project, set the property `engine` to the name of an engine: `engine=<engine-name>;`
|
|
1550
|
+
|
|
1551
|
+
## Connection Parameters
|
|
1552
|
+
|
|
1553
|
+
### Encryption Parameters
|
|
1554
|
+
|
|
1555
|
+
To encrypt communication between your JDBC client applications and Dremio,
|
|
1556
|
+
use the SSL JDBC connection parameters and a fully qualified host name to
|
|
1557
|
+
configure the JDBC connection string and connect to Dremio.
|
|
1558
|
+
|
|
1559
|
+
| SSL JDBC Connection Parameter | Type | Description | Default Value | Required |
|
|
1560
|
+
| --- | --- | --- | --- | --- |
|
|
1561
|
+
| disableCertificateVerification | boolean | Controls whether the driver verifies the host certificate against the trust store. * The driver **will** verify the certificate against the trust store when it is set to `false`. * The driver **will not** verify the certificate against the trust store when the value is set to `true` . | `false` | No |
|
|
1562
|
+
| disableHostVerification | boolean | Forces the driver to verify that the host in the certificate is the host being connected to. * The driver **will** verify the certificate against the host being connected to when it is set to `false`. * The driver **will not** verify the certificate against the host whe it is set to `true`. | `false` | No |
|
|
1563
|
+
| ssl | boolean | Forces the client to use an SSL encrypted connection to communicate with the Dremio server. * SSL encryption is disabled with the client when it is set to `false`. * The client communicates with the Dremio server only using SSL encryption when it is set to `true`. **Note:** To connect to Dremio, SSL must be enabled. | `false` | Yes |
|
|
1564
|
+
| trustStoreType | string | The trustStore type. Accepted value is: JKS PKCS12 The following property only applies to **Windows**. * If the `useSystemTrustStore` parameter is set to true, the accepted values are: `Windows-MY` and `Windows-ROOT`. * Import the certificate into the **Trusted Root Certificate Authorities** and set `trustStoreType=Windows-ROOT`. * Import the certificate into **Trusted Root Certificate Authorities** or **Personal** and set `trustStoreType=Windows-MY`. | `None` | No |
|
|
1565
|
+
| trustStore | string | Path to the truststore. If this parameter is not specified, it defaults to Java truststore (`$JAVA_HOME/lib/security/cacerts`) and the trustStorePassword parameter is ignored. | `$JAVA_HOME/lib/security/cacerts` | No |
|
|
1566
|
+
| useSystemTrustStore | boolean | Bypasses trustStoreType and automatically picks the correct truststore based on the operating system: * Keychain on MacOS * [Local Machine and Current User Certificate Stores](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/local-machine-and-current-user-certificate-stores) on Windows * Default truststore on other systems | `true` | No |
|
|
1567
|
+
| trustStorePassword | string | Password to the truststore. | `None` | No |
|
|
1568
|
+
|
|
1569
|
+
### SOCKS Proxy Connection Parameters
|
|
1570
|
+
|
|
1571
|
+
If you want to connect to Dremio through a SOCKS proxy, use these connection parameters:
|
|
1572
|
+
|
|
1573
|
+
| Parameter | Type | Description | Default Value | Required? |
|
|
1574
|
+
| --- | --- | --- | --- | --- |
|
|
1575
|
+
| socksProxyHost | string | The IP address or hostname of the SOCKS proxy. | N/A | Yes |
|
|
1576
|
+
| socksProxyPort | integer | The port to use on the SOCKS proxy. | 1080 | No |
|
|
1577
|
+
| socksProxyUsername | string | The username to use for connections. | N/A | No |
|
|
1578
|
+
| socksProxyPassword | string | The password to use for connections. | N/A | Only if a username is specified. |
|
|
1579
|
+
|
|
1580
|
+
### Advanced Parameters
|
|
1581
|
+
|
|
1582
|
+
| Name | Type | Description | Default Value |
|
|
1583
|
+
| --- | --- | --- | --- |
|
|
1584
|
+
| quoting | string | Specifies which type of character to use to delimit values in queries. The value can be `BACK_TICK`, `BRACKET`, or `DOUBLE_QUOTE`. | `DOUBLE_QUOTE` |
|
|
1585
|
+
| routing\_tag | string | When this parameter is set, the specified tag is associated with all queries executed within a session. Rules can check for the presence of a tag with the function "tag()". For more information, see [Workload Management](/dremio-cloud/admin/engines/workload-management). | N/A |
|
|
1586
|
+
| stringColumnLength | string | The maximum length of data in columns of the STRING datatype and of complex datatypes. The range is 1 to 2147483647. | 1024. |
|
|
1587
|
+
|
|
1588
|
+
## Parameterized Queries with Prepared Statements
|
|
1589
|
+
|
|
1590
|
+
Dremio supports using parameters in prepared statements for SELECT queries.
|
|
1591
|
+
|
|
1592
|
+
The parameter marker is `?` in prepared statements. To execute a prepared statement, you must set the parameter marker with one of the supported data types and set methods.
|
|
1593
|
+
|
|
1594
|
+
The example below uses the Date type parameter and the `setDate` set method. For set methods, the first argument is the index of the parameter marker in the SQL query, starting from 1. This example includes only one parameter marker, and the second argument is the value for the parameter marker. After you set the parameter, you can execute the prepared statement by calling the `executeQuery()` method on the prepared statement.
|
|
1595
|
+
|
|
1596
|
+
Example prepared statement with parameters
|
|
1597
|
+
|
|
1598
|
+
```
|
|
1599
|
+
public class HelloWorld {
|
|
1600
|
+
public static void main(String[] args) {
|
|
1601
|
+
try (PreparedStatement stmt = getConnection().prepareStatement("SELECT * FROM (values (DATE '2024-02-20'), (null)) AS a(id) WHERE id=?")) {
|
|
1602
|
+
Date date = Date.valueOf(LocalDate.of(2024, 02, 20));
|
|
1603
|
+
stmt.setDate(1, date);
|
|
1604
|
+
try (ResultSet rs = stmt.executeQuery()) {
|
|
1605
|
+
assertThat(rs.getMetaData().getColumnCount()).isEqualTo(1);
|
|
1606
|
+
assertThat(rs.next()).isTrue();
|
|
1607
|
+
assertThat(rs.getDate(1)).isEqualTo(date);
|
|
1608
|
+
assertThat(rs.next()).isFalse();
|
|
1609
|
+
}
|
|
1610
|
+
}
|
|
1611
|
+
}
|
|
1612
|
+
}
|
|
1613
|
+
```
|
|
1614
|
+
|
|
1615
|
+
The example below demonstrates how to reuse the same prepared statement by defining a different set method and parameter value.
|
|
1616
|
+
|
|
1617
|
+
Example prepared statement with different set method and parameters
|
|
1618
|
+
|
|
1619
|
+
```
|
|
1620
|
+
public class HelloWorld {
|
|
1621
|
+
public static void main(String[] args) {
|
|
1622
|
+
try (PreparedStatement stmt = getConnection().prepareStatement("SELECT * FROM (values (DATE '2024-02-20'), (null)) AS a(id) WHERE id=?")) {
|
|
1623
|
+
Date date = Date.valueOf(LocalDate.of(2024, 02, 20));
|
|
1624
|
+
stmt.setDate(1, date);
|
|
1625
|
+
try (ResultSet rs = stmt.executeQuery()) {
|
|
1626
|
+
assertThat(rs.getMetaData().getColumnCount()).isEqualTo(1);
|
|
1627
|
+
assertThat(rs.next()).isTrue();
|
|
1628
|
+
assertThat(rs.getDate(1)).isEqualTo(date);
|
|
1629
|
+
assertThat(rs.next()).isFalse();
|
|
1630
|
+
}
|
|
1631
|
+
stmt.setDate(1, Date.valueOf(LocalDate.of(2025, 02, 20)));
|
|
1632
|
+
try (ResultSet rs = stmt.executeQuery()) {
|
|
1633
|
+
assertThat(rs.next()).isFalse();
|
|
1634
|
+
}
|
|
1635
|
+
}
|
|
1636
|
+
}
|
|
1637
|
+
}
|
|
1638
|
+
```
|
|
1639
|
+
|
|
1640
|
+
The following example shows how to use more than one parameter in a prepared statement.
|
|
1641
|
+
|
|
1642
|
+
Example prepared statement with two parameters
|
|
1643
|
+
|
|
1644
|
+
```
|
|
1645
|
+
public class HelloWorld {
|
|
1646
|
+
public static void main(String[] args) {
|
|
1647
|
+
try (PreparedStatement stmt = getConnection().prepareStatement("SELECT * FROM (values (1), (2), (null)) AS a(id) WHERE id = ? OR id < ?")) {
|
|
1648
|
+
stmt.setInt(1, 1);
|
|
1649
|
+
stmt.setInt(2, 3);
|
|
1650
|
+
try (ResultSet rs = stmt.executeQuery()) {
|
|
1651
|
+
assertThat(rs.getMetaData().getColumnCount()).isEqualTo(1);
|
|
1652
|
+
assertThat(rs.next()).isTrue();
|
|
1653
|
+
assertThat(rs.getInt(1)).isEqualTo(1);
|
|
1654
|
+
assertThat(rs.next()).isFalse();
|
|
1655
|
+
}
|
|
1656
|
+
}
|
|
1657
|
+
}
|
|
1658
|
+
}
|
|
1659
|
+
```
|
|
1660
|
+
|
|
1661
|
+
### Supported Data Types and Set Methods
|
|
1662
|
+
|
|
1663
|
+
To execute a prepared statement, you must set the parameter marker with one of the supported set methods listed in the table below.
|
|
1664
|
+
|
|
1665
|
+
| Column Data Type | Supported Set Methods |
|
|
1666
|
+
| --- | --- |
|
|
1667
|
+
| Integer | setInt(), setShort(), setNull() |
|
|
1668
|
+
| Numeric | setInt(), setShort(), setLong(), setBigDecimal(), setNull() |
|
|
1669
|
+
| Decimal | setShort(), setInt(), setLong(), setBigDecimal(), setNull() |
|
|
1670
|
+
| BigInt | setShort(), setInt(), setLong(), setBigDecimal(), setNull() |
|
|
1671
|
+
| Double | setDouble(), setFloat(), setNull() |
|
|
1672
|
+
| Float | setFloat(), setNull() |
|
|
1673
|
+
| Char | setString(), setNull() |
|
|
1674
|
+
| Varchar | setString(), setNull() |
|
|
1675
|
+
| Boolean | setBoolean(), setNull() |
|
|
1676
|
+
| Time | setTime(), setNull() |
|
|
1677
|
+
| TimeStamp | setTimestamp(), setNull() |
|
|
1678
|
+
| Date | setDate(), setNull() |
|
|
1679
|
+
| VarBinary | setNull(), setBytes() |
|
|
1680
|
+
|
|
1681
|
+
Was this page helpful?
|
|
1682
|
+
|
|
1683
|
+
* Prerequisites
|
|
1684
|
+
* Supported Authentication Methods
|
|
1685
|
+
* Download and Install
|
|
1686
|
+
* Connect to Dremio
|
|
1687
|
+
* Connection Parameters
|
|
1688
|
+
+ Encryption Parameters
|
|
1689
|
+
+ SOCKS Proxy Connection Parameters
|
|
1690
|
+
+ Advanced Parameters
|
|
1691
|
+
* Parameterized Queries with Prepared Statements
|
|
1692
|
+
+ Supported Data Types and Set Methods
|
|
1693
|
+
|
|
1694
|
+
<div style="page-break-after: always;"></div>
|
|
1695
|
+
|
|
1696
|
+
# IBM Cognos Analytics | Dremio Documentation
|
|
1697
|
+
|
|
1698
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/client-apps/ibm-cognos-analytics
|
|
1699
|
+
|
|
1700
|
+
On this page
|
|
1701
|
+
|
|
1702
|
+
You can run SQL from [Cognos Analytics](https://www.ibm.com/products/cognos-analytics) to explore your data through Dremio. Cognos Analytics Dynamic Query supports connections to Dremio through the [legacy JDBC driver](/dremio-cloud/explore-analyze/client-apps/drivers/jdbc-legacy/).
|
|
1703
|
+
|
|
1704
|
+
## Supported Versions
|
|
1705
|
+
|
|
1706
|
+
To learn which versions of Dremio are supported with IBM Cognos 11.2.x, see [DQM testing of vendor-supported client driver versions for each Cognos Analytics 11.2.x release](https://www.ibm.com/support/pages/node/6441017#11.2.4fp2r).
|
|
1707
|
+
|
|
1708
|
+
To learn which versions of Dremio are supported with IBM Cognos 12.0.x, see [DQM testing of vendor-supported client driver versions for each Cognos Analytics 12.0.x release](https://www.ibm.com/support/pages/node/6989513#12.0.2r).
|
|
1709
|
+
|
|
1710
|
+
## Supported Authentication Methods
|
|
1711
|
+
|
|
1712
|
+
Use a Dremio [personal access token (PAT)](/dremio-cloud/security/authentication/personal-access-token/#create-a-pat) for authentication.
|
|
1713
|
+
|
|
1714
|
+
## Create a Connection
|
|
1715
|
+
|
|
1716
|
+
1. Launch Cognos Analytics.
|
|
1717
|
+
2. Navigate to **Manage** > **Data Server Connections**.
|
|
1718
|
+
3. Click **Add Data Server** and select **Dremio** as the type of connection.
|
|
1719
|
+
4. In the **JDBC URL** field, enter the connection string in the JDBC Connection field in the project settings' General Information sidebar in Dremio. The EU and US have different control planes, so the connection strings differ slightly depending on the control plane you're using.
|
|
1720
|
+
|
|
1721
|
+
JDBC connection string example for US control plane
|
|
1722
|
+
|
|
1723
|
+
```
|
|
1724
|
+
jdbc:dremio:direct=sql.eu.dremio.cloud:443[;ssl=true;PROJECT_ID=<YOUR_PROJECT_ID>;ENGINE=<OPTIONAL_ENGINE_NAME>]
|
|
1725
|
+
```
|
|
1726
|
+
|
|
1727
|
+
JDBC connection string example for EU control plane
|
|
1728
|
+
|
|
1729
|
+
```
|
|
1730
|
+
jdbc:dremio:direct=sql.eu.dremio.cloud:443[;ssl=true;PROJECT_ID=<YOUR_PROJECT_ID>;ENGINE=<OPTIONAL_ENGINE_NAME>]
|
|
1731
|
+
```
|
|
1732
|
+
5. In the **Username** field, enter `$token`, and in the **Password** field, enter your Dremio PAT to authenticate to Dremio.
|
|
1733
|
+
6. Click **Save**.
|
|
1734
|
+
7. Click **Test** to confirm the connection.
|
|
1735
|
+
|
|
1736
|
+
Was this page helpful?
|
|
1737
|
+
|
|
1738
|
+
* Supported Versions
|
|
1739
|
+
* Supported Authentication Methods
|
|
1740
|
+
* Create a Connection
|
|
1741
|
+
|
|
1742
|
+
<div style="page-break-after: always;"></div>
|
|
1743
|
+
|
|
1744
|
+
# SAP Business Objects | Dremio Documentation
|
|
1745
|
+
|
|
1746
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/client-apps/sap-business-objects
|
|
1747
|
+
|
|
1748
|
+
On this page
|
|
1749
|
+
|
|
1750
|
+
You can use [SAP Business Objects](https://www.sap.com/products/technology-platform/bi-platform.html) to query and visualize data by means of Dremio.
|
|
1751
|
+
|
|
1752
|
+
## Supported Versions
|
|
1753
|
+
|
|
1754
|
+
SAP Business Objects 4.0+
|
|
1755
|
+
|
|
1756
|
+
## Prerequisite
|
|
1757
|
+
|
|
1758
|
+
Download, install, and configure the [Arrow Flight SQL ODBC driver](/dremio-cloud/explore-analyze/client-apps/drivers/arrow-flight-sql-odbc/).
|
|
1759
|
+
|
|
1760
|
+
## Connect to Dremio
|
|
1761
|
+
|
|
1762
|
+
1. Open Information Design Tool.
|
|
1763
|
+
2. Select **File** > **New** > **Project**.
|
|
1764
|
+
3. Set the name of the project and click **Finish**.
|
|
1765
|
+
4. Right-click the project and select **New** > **Relational Connection**.
|
|
1766
|
+
5. Specify a name for the relational connection and click **Next**.
|
|
1767
|
+
6. Select the Generic ODBC3 datasource driver and click **Next**.
|
|
1768
|
+
7. Follow either of these steps:
|
|
1769
|
+
|
|
1770
|
+
* Select **Use existing data source** and select the Arrow Flight SQL ODBC DSN.
|
|
1771
|
+
* Select Use connection string, select the Arrow Flight SQL ODBC driver, and specify this base connection string:
|
|
1772
|
+
|
|
1773
|
+
Base connection string
|
|
1774
|
+
|
|
1775
|
+
```
|
|
1776
|
+
HOST=data.dremio.cloud;PORT=443;token=<personal-access-token>;
|
|
1777
|
+
UseEncryption=true;DisableCertificateVerification=false;
|
|
1778
|
+
```
|
|
1779
|
+
|
|
1780
|
+
See [Connection Parameters](/dremio-cloud/explore-analyze/client-apps/drivers/arrow-flight-sql-odbc/#connection-parameters) for additional connection parameters that are available.
|
|
1781
|
+
8. (Optional) Test the connection.
|
|
1782
|
+
9. Click **Finish**.
|
|
1783
|
+
|
|
1784
|
+
Dremio schemas and tables are now available.
|
|
1785
|
+
|
|
1786
|
+
Was this page helpful?
|
|
1787
|
+
|
|
1788
|
+
* Supported Versions
|
|
1789
|
+
* Prerequisite
|
|
1790
|
+
* Connect to Dremio
|
|
1791
|
+
|
|
1792
|
+
<div style="page-break-after: always;"></div>
|
|
1793
|
+
|
|
1794
|
+
# Driver Release Notes | Dremio Documentation
|
|
1795
|
+
|
|
1796
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/client-apps/drivers/release-notes/
|
|
1797
|
+
|
|
1798
|
+
On this page
|
|
1799
|
+
|
|
1800
|
+
This section contains the changes for the drivers that are supported for use with Dremio.
|
|
1801
|
+
|
|
1802
|
+
## Arrow Flight SQL Drivers
|
|
1803
|
+
|
|
1804
|
+
* [Arrow Flight SQL JDBC](/dremio-cloud/explore-analyze/client-apps/drivers/release-notes/arrow-flight-sql-jdbc/)
|
|
1805
|
+
* [Arrow Flight SQL ODBC](/dremio-cloud/explore-analyze/client-apps/drivers/release-notes/arrow-flight-sql-odbc/)
|
|
1806
|
+
|
|
1807
|
+
## Other Drivers
|
|
1808
|
+
|
|
1809
|
+
* [Dremio JDBC Driver (Legacy)](/dremio-cloud/explore-analyze/client-apps/drivers/release-notes/jdbc-legacy)
|
|
1810
|
+
|
|
1811
|
+
note
|
|
1812
|
+
|
|
1813
|
+
The [Arrow Flight SQL JDBC driver](/dremio-cloud/explore-analyze/client-apps/drivers/arrow-flight-sql-jdbc) is the recommended driver for connectivity to Java-based applications. The Dremio JDBC driver (Legacy) will not be updated or fixed moving forward.
|
|
1814
|
+
|
|
1815
|
+
Was this page helpful?
|
|
1816
|
+
|
|
1817
|
+
* Arrow Flight SQL Drivers
|
|
1818
|
+
* Other Drivers
|
|
1819
|
+
|
|
1820
|
+
<div style="page-break-after: always;"></div>
|
|
1821
|
+
|
|
1822
|
+
# Microsoft Excel PowerPivot | Dremio Documentation
|
|
1823
|
+
|
|
1824
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/client-apps/microsoft-excel-powerpivot
|
|
1825
|
+
|
|
1826
|
+
On this page
|
|
1827
|
+
|
|
1828
|
+
## Prerequisites
|
|
1829
|
+
|
|
1830
|
+
* Ensure that your operating system is 64-bit Windows 10 or later.
|
|
1831
|
+
* Download, install, and configure the [Arrow Flight SQL ODBC driver](/dremio-cloud/explore-analyze/client-apps/drivers/arrow-flight-sql-odbc/).
|
|
1832
|
+
|
|
1833
|
+
## Update the DSN Configuration
|
|
1834
|
+
|
|
1835
|
+
1. Launch ODBC Data Sources on your Windows system.
|
|
1836
|
+
2. Select the **User DSN** tab.
|
|
1837
|
+
3. Select the DSN entry that you created when you configured the Arrow Flight SQL ODBC driver.
|
|
1838
|
+
4. Click **Configure**.
|
|
1839
|
+
5. In the **Advanced Properties** section, add the following key/value pair:
|
|
1840
|
+
* **Key:** quoting
|
|
1841
|
+
* **Value:** BRACKET
|
|
1842
|
+
|
|
1843
|
+
## Connect to Dremio
|
|
1844
|
+
|
|
1845
|
+
1. Open Excel.
|
|
1846
|
+
2. Click the **Power Pivot** tab and then click **Manage**.
|
|
1847
|
+
3. Select **From Other Sources**.
|
|
1848
|
+
4. In the Table Import Wizard, select **Others (OLEDB/ODBC)**.
|
|
1849
|
+
5. Click **Next**.
|
|
1850
|
+
6. Click **Build**.
|
|
1851
|
+
7. In the Data Link Properties dialog, follow these steps:
|
|
1852
|
+
|
|
1853
|
+
a. On the **Provider** tab, select **Microsoft OLE DB Provider for ODBC Drivers**.
|
|
1854
|
+
|
|
1855
|
+
b. Click **Next>>**.
|
|
1856
|
+
|
|
1857
|
+
c. For step 1 on the **Connection** tab, select **Use data source name**, and then select the data source name for the Arrow Flight SQL ODBC driver.
|
|
1858
|
+
|
|
1859
|
+
d. For step 2 on the **Connection** tab, leave the **User name** and **Password** fields blank. The authentication credentials for connecting to Dremio Cloud are already present in the user DSN.
|
|
1860
|
+
|
|
1861
|
+
e. (Optional) Click **Test Connection** to find out whether the info you specified on this tab is correct.
|
|
1862
|
+
|
|
1863
|
+
f. Click **OK**.
|
|
1864
|
+
8. Click **Next**.
|
|
1865
|
+
9. Ensure that the option **Select from a list of tables and views to choose the data to import**.
|
|
1866
|
+
10. Click **Next**.
|
|
1867
|
+
11. Select the tables and views that you want to import data from.
|
|
1868
|
+
12. Click **Finish**.
|
|
1869
|
+
|
|
1870
|
+
Was this page helpful?
|
|
1871
|
+
|
|
1872
|
+
* Prerequisites
|
|
1873
|
+
* Update the DSN Configuration
|
|
1874
|
+
* Connect to Dremio
|
|
1875
|
+
|
|
1876
|
+
<div style="page-break-after: always;"></div>
|
|
1877
|
+
|
|
1878
|
+
# Arrow Flight SQL JDBC | Dremio Documentation
|
|
1879
|
+
|
|
1880
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/client-apps/drivers/arrow-flight-sql-jdbc
|
|
1881
|
+
|
|
1882
|
+
On this page
|
|
1883
|
+
|
|
1884
|
+
The Arrow Flight SQL JDBC driver is an open-source driver that is based on the specifications for the Java Database Connectivity (JDBC) API. The Flight SQL JDBC driver uses Apache Arrow, so it is able to move large amounts of data faster, in part because it does not need to serialize and then deserialize data.
|
|
1885
|
+
|
|
1886
|
+
This driver is licensed under [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
|
|
1887
|
+
|
|
1888
|
+
## Prerequisites
|
|
1889
|
+
|
|
1890
|
+
You can use the Arrow Flight SQL JDBC 18.3.0 driver on systems that:
|
|
1891
|
+
|
|
1892
|
+
* Support Java versions: Java 11+
|
|
1893
|
+
* Run the following 64-bit operating systems:
|
|
1894
|
+
+ Linux: RedHat/CentOS
|
|
1895
|
+
+ Windows 10 and later
|
|
1896
|
+
+ macOS
|
|
1897
|
+
|
|
1898
|
+
## Supported Authentication Method
|
|
1899
|
+
|
|
1900
|
+
You can use personal access tokens for authenticating to Dremio. To generate one, see [Personal Access Tokens](/dremio-cloud/security/authentication/personal-access-token#create-a-pat).
|
|
1901
|
+
|
|
1902
|
+
## Download and Install
|
|
1903
|
+
|
|
1904
|
+
1. Download the Driver: You can download the driver at [Arrow Flight SQL JDBC Driver](https://www.dremio.com/drivers/jdbc/).
|
|
1905
|
+
2. Integrate the Driver: To integrate the driver into your development environment, you need to add the location of the driver to your classpath to inform the Java Virtual Machine (JVM) and the Java compiler where to locate the driver class files and resources during compilation and runtime.
|
|
1906
|
+
3. For name the of the driver class, specify `org.apache.arrow.driver.jdbc.ArrowFlightJdbcDriver`.
|
|
1907
|
+
|
|
1908
|
+
## Connect to Dremio
|
|
1909
|
+
|
|
1910
|
+
Use this template to create a direct connection to Dremio Cloud:
|
|
1911
|
+
|
|
1912
|
+
Template for the JDBC URL
|
|
1913
|
+
|
|
1914
|
+
```
|
|
1915
|
+
jdbc:arrow-flight-sql://data.dremio.cloud:443/?token=<encoded_pat>[&catalog=<project_id>][&schema=<schema>][&<properties>]
|
|
1916
|
+
```
|
|
1917
|
+
|
|
1918
|
+
* `token`: The personal access token to use to authenticate to Dremio. See [Personal Access Tokens](/cloud/security/authentication/personal-access-token/) for information about enabling and creating PATs. You must URL-encode PATs that you include in JDBC URLs. See URL-encode Values for suggested steps.
|
|
1919
|
+
* `catalog`: Specifies the project ID of a project in Dremio Cloud. You can use this to connect to non-default Dremio Cloud projects.
|
|
1920
|
+
* `schema`: The name of the schema (data source or folder, including child paths, such as `mySource.folder1` and `folder1.folder2`) to use by default when a schema is not specified in a query.
|
|
1921
|
+
* `<properties>`: A list of JDBC properties for encrypting connections and routing queries to particular engines. Values must be URL-encoded. See URL-encode Values for suggested steps.
|
|
1922
|
+
|
|
1923
|
+
To authenticate to Dremio Cloud, pass in a personal access token (PAT) with the `token` property. Use the PAT as the value. See [Personal Access Tokens](/cloud/security/authentication/personal-access-token/) for information about enabling the use of PATs in Dremio and about creating PATs. You must URL-encode PATs that you include in JDBC URLs. To encode a PAT locally on your system, you can follow the steps in URL-encode Values.
|
|
1924
|
+
|
|
1925
|
+
## Connection Parameters
|
|
1926
|
+
|
|
1927
|
+
### Encryption Parameters
|
|
1928
|
+
|
|
1929
|
+
If you are setting up encrypted communication between your JDBC client applications and the Dremio server, use the SSL JDBC connection parameters and fully qualified hostname to
|
|
1930
|
+
configure the JDBC connection string and connect to Dremio.
|
|
1931
|
+
|
|
1932
|
+
note
|
|
1933
|
+
|
|
1934
|
+
This driver does not yet support these features:
|
|
1935
|
+
|
|
1936
|
+
* Disabling host verification
|
|
1937
|
+
* Impersonation
|
|
1938
|
+
|
|
1939
|
+
| Properties | Value | Required | Description |
|
|
1940
|
+
| --- | --- | --- | --- |
|
|
1941
|
+
| `disableCertificateVerification` | `true` or `false` | [Optional] | If `true`, Dremio does not verify the host certificate against the truststore. The default value is `false`. |
|
|
1942
|
+
| `trustStoreType` | string | [Optional] | Default: JKS The trustStore type. Allowed values are : `JKS`, `PKCS12` If the useSystemTrustStore option is set to true (on Windows only), the allowed values are: `Windows-MY`, `Windows-ROOT` Import the certificate into the **Trusted Root Certificate Authorities** and set `trustStoreType=Windows-ROOT`. Also import the certificate into **Trusted Root Certificate Authorities** or **Personal** and set `trustStoreType=Windows-MY`. |
|
|
1943
|
+
| `trustStore` | string | [Optional] | Path to the truststore. If not provided, the default Java truststore is used (usually `$JAVA_HOME/lib/security/cacerts`) and the trustStorePassword parameter is ignored. |
|
|
1944
|
+
| `useSystemTrustStore` | `true` or `false` | [Optional] | By default, the value is `true`. Bypasses trustStoreType and automatically picks the correct truststore based on the operating system: Keychain on MacOS, [Local Machine and Current User Certificate Stores](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/local-machine-and-current-user-certificate-stores) on Windows, and default truststore on other operating systems. If you are using an operating system other than MacOS or Windows, you must use the `trustStorePassword` property to pass the password of the truststore. Here is an example of a connection string for Linux: `jdbc:arrow-flight-sql://data.dremio.cloud:443/?useEncryption=true&token=1234&trustStorePassword=901234` |
|
|
1945
|
+
| `trustStorePassword` | string | [Optional] | Password to the truststore. |
|
|
1946
|
+
|
|
1947
|
+
### Advanced Parameters
|
|
1948
|
+
|
|
1949
|
+
| Name | Type | Description | Default Value |
|
|
1950
|
+
| --- | --- | --- | --- |
|
|
1951
|
+
| quoting | string | Specifies which type of character to use to delimit values in queries. The value can be `BACK_TICK`, `BRACKET`, or `DOUBLE_QUOTE`. | `DOUBLE_QUOTE` |
|
|
1952
|
+
| routing\_tag | string | When this parameter is set, the specified tag is associated with all queries executed within a session. Rules can check for the presence of a tag with the function "tag()". For more information, see [Workload Management](/dremio-cloud/admin/engines/workload-management). | N/A |
|
|
1953
|
+
| stringColumnLength | string | The maximum length of data in columns of the STRING datatype and of complex datatypes. The range is 1 to 2147483647. | 1024 |
|
|
1954
|
+
|
|
1955
|
+
### URL-encode Values
|
|
1956
|
+
|
|
1957
|
+
To encode a personal access token (PAT) or property value locally on your system, you can follow these steps:
|
|
1958
|
+
|
|
1959
|
+
1. In a browser window, right-click an empty area of the page and select **Inspect**.
|
|
1960
|
+
2. Click **Console**.
|
|
1961
|
+
3. Type `encodeURIComponent("<PAT-or-value>")`, where `<PAT-or-value>` is the personal access token that you obtained from Dremio or the value of a supported JDBC property. The URL-encoded PAT or value appears on the next line. You can highlight it and copy it to your clipboard.
|
|
1962
|
+
|
|
1963
|
+
## Parameterized Queries with Prepared Statements
|
|
1964
|
+
|
|
1965
|
+
Prepared statements allow you to dynamically pass parameters to SQL queries using placeholders, ensuring safer query execution by separating the query structure from the values in parameters.
|
|
1966
|
+
|
|
1967
|
+
With a prepared statement, parameters (`?`) can be set at runtime using set methods to reuse queries with different values.
|
|
1968
|
+
|
|
1969
|
+
note
|
|
1970
|
+
|
|
1971
|
+
This feature requires Apache Arrow 18.3.0 or later. It supports `SELECT` and `DML` statements.
|
|
1972
|
+
|
|
1973
|
+
To use parameterized queries with prepared statements, follow these steps:
|
|
1974
|
+
|
|
1975
|
+
1. Use the `prepareStatement()` method to define a query with parameters, which act as placeholders for dynamic values.
|
|
1976
|
+
2. Set the values by replacing each parameter with a value using the appropriate set methods.
|
|
1977
|
+
3. Ensure all parameters are set before running the query, with indexing starting at 1. If parameters are not set before running the query, JBDC throws an exception.
|
|
1978
|
+
4. Call `executeQuery()` to run the `SELECT` query and retrieve results, or `executeUpdate()` to run the `DML` query and retrieve the count of modified records.
|
|
1979
|
+
|
|
1980
|
+
Java examples for SELECT and DML queries
|
|
1981
|
+
|
|
1982
|
+
```
|
|
1983
|
+
PreparedStatement preparedStatement = connection.prepareStatement(
|
|
1984
|
+
"SELECT * FROM employees WHERE department = ? AND salary > ?");
|
|
1985
|
+
preparedStatement.setString(1, "Engineering");
|
|
1986
|
+
preparedStatement.setDouble(2, 75000);
|
|
1987
|
+
ResultSet resultSet = preparedStatement.executeQuery();
|
|
1988
|
+
|
|
1989
|
+
PreparedStatement preparedStatement = connection.prepareStatement(
|
|
1990
|
+
"DELETE FROM employees WHERE department = ? AND salary > ?");
|
|
1991
|
+
preparedStatement.setString(1, "Engineering");
|
|
1992
|
+
preparedStatement.setDouble(2, 75000);
|
|
1993
|
+
int rowsUpdated = preparedStatement.executeUpdate();
|
|
1994
|
+
```
|
|
1995
|
+
|
|
1996
|
+
### Supported Data Types and Set Methods
|
|
1997
|
+
|
|
1998
|
+
| **Column Data Type** | **Supported Set Methods** |
|
|
1999
|
+
| --- | --- |
|
|
2000
|
+
| Integer | `setInt()`, `setShort()`, `setNull()` |
|
|
2001
|
+
| Numeric | `setInt()`, `setShort()`, `setLong()`, `setBigDecimal()`, `setNull()` |
|
|
2002
|
+
| Decimal | `setShort()`, `setInt()`, `setLong()`, `setBigDecimal()`, `setNull()` |
|
|
2003
|
+
| BigInt | `setShort()`, `setInt()`, `setLong()`, `setBigDecimal()`, `setNull()` |
|
|
2004
|
+
| Double | `setDouble()`, `setFloat()`, `setNull()` |
|
|
2005
|
+
| Float | `setFloat()`, `setNull()` |
|
|
2006
|
+
| Char | `setString()`, `setNull()` |
|
|
2007
|
+
| Varchar | `setString()`, `setNull()` |
|
|
2008
|
+
| Boolean | `setBoolean()`, `setNull()` |
|
|
2009
|
+
| Time | `setTime()`, `setNull()` |
|
|
2010
|
+
| Timestamp | `setTimestamp()`, `setNull()` |
|
|
2011
|
+
| Date | `setNull()` |
|
|
2012
|
+
| VarBinary | `setBytes()`, `setNull()` |
|
|
2013
|
+
|
|
2014
|
+
### Limitations
|
|
2015
|
+
|
|
2016
|
+
The JDBC client does not support the `setDate()` method due to mismatched date encoding formats between the Arrow Flight JDBC client and Dremio.
|
|
2017
|
+
|
|
2018
|
+
## Differences between the Arrow Flight SQL JDBC and the Dremio JDBC (Legacy) Driver
|
|
2019
|
+
|
|
2020
|
+
The Arrow Flight SQL JDBC driver differs from the Dremio JDBC (Legacy) driver in the following:
|
|
2021
|
+
|
|
2022
|
+
* Requires Java 11+.
|
|
2023
|
+
* Supports `ResultSet.getBoolean()` on `varchar` columns in which boolean values are represented as these strings: "0", "1", "true", "false".
|
|
2024
|
+
* Supports `null` Calendar in calls to `ResultSet.getDate()`, `ResultSet.getTime()`, and `ResultSet.getTimestamp()`
|
|
2025
|
+
When a call to one of these methods has no `Calendar` parameter, or the `Calendar` parameter is `null`, the Flight JDBC driver uses the default timezone when it constructs the returned object.
|
|
2026
|
+
* Supports `ResultSet.getDate()`, `ResultSet.getTime()`, and `ResultSet.getTimestamp()` on `varchar` columns in which dates, times, or timestamps are represented as strings.
|
|
2027
|
+
* Supports varchar values that represent numeric values in calls to `ResultSet.getInteger()`, `ResultSet.getFloat()`, `ResultSet.getDouble()`, `ResultSet.getShort()`, `ResultSet.getLong()`, and `ResultSet.getBigDecimal()`
|
|
2028
|
+
* Supports integer values in calls to `getFloat()`
|
|
2029
|
+
Integers returned gain one decimal place.
|
|
2030
|
+
* Supports the native SQL complex types `List`, `Map`, and `Struct`
|
|
2031
|
+
Dremio's legacy JDBC driver uses String representations of these types.
|
|
2032
|
+
* Supports using the Interval data type in SQL functions.
|
|
2033
|
+
* Removes support for calling `ResultSet.getBinaryStream()` on non-binary data types. Though such support exists in traditional JDBC drivers, it is not in the specification for the JDBC API.
|
|
2034
|
+
|
|
2035
|
+
note
|
|
2036
|
+
|
|
2037
|
+
Calling `DatabaseMetadata.getCatalog()` when connected to Dremio returns empty. Other `DatabaseMetadata` methods return null values in the `TABLE_CAT` column. This is expected behavior because Dremio does not have a catalog.
|
|
2038
|
+
|
|
2039
|
+
## Supported Conversions from Dremio Datatypes to JDBC Datatypes
|
|
2040
|
+
|
|
2041
|
+
| **DREMIO TYPE** | **JDBCARROW TYPE** |
|
|
2042
|
+
| --- | --- |
|
|
2043
|
+
| BIGINT | Int |
|
|
2044
|
+
| BIT | Bool |
|
|
2045
|
+
| DATE | Date |
|
|
2046
|
+
| DECIMAL | Decimal |
|
|
2047
|
+
| DOUBLE | FloatingPoint(DOUBLE) |
|
|
2048
|
+
| FIXEDSIZEBINARY | FixedSizeBinary |
|
|
2049
|
+
| FLOAT | FloatingPoint(SINGLE) |
|
|
2050
|
+
| INT | Int |
|
|
2051
|
+
| INTERVAL\_DAY\_SECONDS | Interval(DAY\_TIME) |
|
|
2052
|
+
| INTERVAL\_YEAR\_MONTHS | Interval(YEAR\_MONTH) |
|
|
2053
|
+
| LIST | List |
|
|
2054
|
+
| MAP | Map |
|
|
2055
|
+
| NULL | Null |
|
|
2056
|
+
| OBJECT | Not Supported |
|
|
2057
|
+
| STRUCT | Struct |
|
|
2058
|
+
| TIME | Time(MILLISECOND) |
|
|
2059
|
+
| TIMESTAMP | Timestamp(MILLISECOND) |
|
|
2060
|
+
| VARBINARY | Binary |
|
|
2061
|
+
| VARCHAR | Utf8 |
|
|
2062
|
+
|
|
2063
|
+
## Add the Root CA Certificate to Your System Truststore
|
|
2064
|
+
|
|
2065
|
+
1. At a command-line prompt, run this command:
|
|
2066
|
+
|
|
2067
|
+
```
|
|
2068
|
+
openssl s_client -showcerts -connect data.dremio.cloud:443 </dev/null
|
|
2069
|
+
```
|
|
2070
|
+
2. Copy the last certificate, including the lines `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`, to your clipboard.
|
|
2071
|
+
3. Create a text file and paste the certificate into it.
|
|
2072
|
+
4. Save the text file as `cert.pem`.
|
|
2073
|
+
5. If you are using MacOS, follow these steps:
|
|
2074
|
+
|
|
2075
|
+
a. In Finder, double-click the `cert.pem` file.
|
|
2076
|
+
|
|
2077
|
+
b. In the dialog that opens, select the option to add the root certificate to the system truststore.
|
|
2078
|
+
6. If you are using Windows, follow these steps:
|
|
2079
|
+
|
|
2080
|
+
a. At a command-line prompt, enter one of these commands:
|
|
2081
|
+
|
|
2082
|
+
* `certlm` if you want to add the certificate for all user accounts on your Windows system.
|
|
2083
|
+
* `certmgr` if you want to add the certificate only for the current user account.
|
|
2084
|
+
|
|
2085
|
+
b. Right-click the folder **Trusted Root Certification Authorities**.
|
|
2086
|
+
|
|
2087
|
+
c. Select **Import**.
|
|
2088
|
+
|
|
2089
|
+
d. Browse for the `cert.pem` file and import it.
|
|
2090
|
+
7. If you are using a version of Linux, follow the instructions for your version.
|
|
2091
|
+
8. If you are developing your own client application to use the driver to connect to Dremio, add the certificate to the Java truststore. You must know the path to the `cacerts` file from `$JAVA_HOME`.
|
|
2092
|
+
|
|
2093
|
+
* If you are using Java 11, run this command:
|
|
2094
|
+
|
|
2095
|
+
```
|
|
2096
|
+
keytool -import -trustcacerts -file cert.pem -alias gtsrootr1ca -keystore $JAVA_HOME/lib/security/cacerts
|
|
2097
|
+
```
|
|
2098
|
+
|
|
2099
|
+
## Limitations
|
|
2100
|
+
|
|
2101
|
+
* Impersonation is not supported.
|
|
2102
|
+
* Disabling host verification is not supported.
|
|
2103
|
+
|
|
2104
|
+
Was this page helpful?
|
|
2105
|
+
|
|
2106
|
+
* Prerequisites
|
|
2107
|
+
* Supported Authentication Method
|
|
2108
|
+
* Download and Install
|
|
2109
|
+
* Connect to Dremio
|
|
2110
|
+
* Connection Parameters
|
|
2111
|
+
+ Encryption Parameters
|
|
2112
|
+
+ Advanced Parameters
|
|
2113
|
+
+ URL-encode Values
|
|
2114
|
+
* Parameterized Queries with Prepared Statements
|
|
2115
|
+
+ Supported Data Types and Set Methods
|
|
2116
|
+
+ Limitations
|
|
2117
|
+
* Differences between the Arrow Flight SQL JDBC and the Dremio JDBC (Legacy) Driver
|
|
2118
|
+
* Supported Conversions from Dremio Datatypes to JDBC Datatypes
|
|
2119
|
+
* Add the Root CA Certificate to Your System Truststore
|
|
2120
|
+
* Limitations
|
|
2121
|
+
|
|
2122
|
+
<div style="page-break-after: always;"></div>
|
|
2123
|
+
|
|
2124
|
+
# Arrow Flight SQL ODBC | Dremio Documentation
|
|
2125
|
+
|
|
2126
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/client-apps/drivers/arrow-flight-sql-odbc
|
|
2127
|
+
|
|
2128
|
+
On this page
|
|
2129
|
+
|
|
2130
|
+
You can use the Arrow Flight SQL ODBC 0.9.7 driver to connect to Dremio from ODBC client applications.
|
|
2131
|
+
|
|
2132
|
+
This driver is licensed under [GNU Library General Public License, Version 2](https://github.com/dremio/warpdrive/blob/master/license.txt).
|
|
2133
|
+
|
|
2134
|
+
## Prerequisites
|
|
2135
|
+
|
|
2136
|
+
You can use the Arrow Flight SQL ODBC 0.9.7 driver on systems that:
|
|
2137
|
+
|
|
2138
|
+
* Run the following 64-bit operating systems:
|
|
2139
|
+
+ Linux: RedHat/CentOS
|
|
2140
|
+
+ Windows 10 and later
|
|
2141
|
+
+ macOS
|
|
2142
|
+
|
|
2143
|
+
## Supported Authentication Method
|
|
2144
|
+
|
|
2145
|
+
You can use personal access tokens for authenticating to Dremio. To generate one, see [Personal Access Tokens](/dremio-cloud/security/authentication/personal-access-token#create-a-pat).
|
|
2146
|
+
|
|
2147
|
+
## Windows
|
|
2148
|
+
|
|
2149
|
+
### Download and Install
|
|
2150
|
+
|
|
2151
|
+
To download and install the Arrow Flight SQL ODBC driver:
|
|
2152
|
+
|
|
2153
|
+
1. Download the Windows 64-bit version of the driver from the [ODBC driver download page](https://www.dremio.com/drivers/odbc/).
|
|
2154
|
+
2. Run the installer.
|
|
2155
|
+
3. (Optional) In the **User Account Control** page, click **Yes**. This page appears only if there is user account control configured on your Windows machine.
|
|
2156
|
+
4. In the **Welcome to Dremio** page, click **Next**.
|
|
2157
|
+
5. Click **Install**.
|
|
2158
|
+
6. In the **Installation Complete** page, click **Next**.
|
|
2159
|
+
7. In the **Completing Arrow Flight SQL ODBC Driver Setup Wizard** page, click **Finish**.
|
|
2160
|
+
|
|
2161
|
+
### Connect to Dremio
|
|
2162
|
+
|
|
2163
|
+
caution
|
|
2164
|
+
|
|
2165
|
+
Do not follow these steps if you are using Microsoft Power BI Desktop to connect to Dremio. For the steps for configuring Power BI, see [Connecting from Microsoft Power BI](/dremio-cloud/explore-analyze/client-apps/microsoft-power-bi/).
|
|
2166
|
+
|
|
2167
|
+
note
|
|
2168
|
+
|
|
2169
|
+
Before following these steps, generate a personal access token in Dremio. See [Personal Access Tokens](/dremio-cloud/security/authentication/personal-access-token#create-a-pat).
|
|
2170
|
+
|
|
2171
|
+
To configure a user DSN:
|
|
2172
|
+
|
|
2173
|
+
1. Go to **Start Menu** > **Window Administrative Tools**. Click **ODBC Data Sources (64-bit)**.
|
|
2174
|
+
2. In the **ODBC Data Source Administrator (64-bit)** dialog, click **System DSN**.
|
|
2175
|
+
3. Select **Arrow Flight SQL ODBC DSN** and click **Configure**.
|
|
2176
|
+
4. (Optional) Change the data source name.
|
|
2177
|
+
5. In the **Host name** field, `data.dremio.cloud` for the US control plane, or `data.eu.dremio.cloud` for the European control plane.
|
|
2178
|
+
6. In the **Port** field, specify `443`.
|
|
2179
|
+
7. In the **Authentication Type** field, select **Token Authentication**.
|
|
2180
|
+
8. In the **Authentication Token** field, paste a personal access token.
|
|
2181
|
+
9. Click the **Advanced** tab.
|
|
2182
|
+
10. Ensure that the **Use Encryption** option is selected.
|
|
2183
|
+
|
|
2184
|
+
For additional parameters, see [Connection Parameters](/dremio-cloud/explore-analyze/client-apps/drivers/arrow-flight-sql-odbc/#connection-parameters).
|
|
2185
|
+
|
|
2186
|
+
If you ever need to enable tracing for troubleshooting problems with the driver, click the **Tracing** tab in the **ODBC Data Source Administrator (64-bit)** dialog, set the log-file path, and then click **Start Tracing Now**.
|
|
2187
|
+
|
|
2188
|
+
## Linux
|
|
2189
|
+
|
|
2190
|
+
### Download and Install
|
|
2191
|
+
|
|
2192
|
+
To download and install the Arrow Flight SQL ODBC driver:
|
|
2193
|
+
|
|
2194
|
+
1. Download the Linux version of the driver from the [ODBC driver download page](https://www.dremio.com/drivers/odbc/).
|
|
2195
|
+
2. Run the following command to install the driver and automatically create the data source name (DSN) `Arrow Flight SQL ODBC DSN`:
|
|
2196
|
+
|
|
2197
|
+
Install Dremio ODBC driver
|
|
2198
|
+
|
|
2199
|
+
```
|
|
2200
|
+
sudo yum localinstall <dremio-odbc-rpm-path>
|
|
2201
|
+
```
|
|
2202
|
+
|
|
2203
|
+
### Connect to Dremio
|
|
2204
|
+
|
|
2205
|
+
note
|
|
2206
|
+
|
|
2207
|
+
* Before configuring, ensure that unixODBC is installed.
|
|
2208
|
+
* In Dremio, generate a personal access token. See [Personal Access Tokens](/dremio-cloud/security/authentication/personal-access-token#create-a-pat).
|
|
2209
|
+
* If you want to base your configuration on examples, copy the content of the `odbc.ini` and `odbcinst.ini` files in the `/opt/arrow-flight-sql/odbc-driver/conf` directory and paste the content into your system `/etc/odbc.ini` and `/etc/odbcinst.ini` files.
|
|
2210
|
+
|
|
2211
|
+
To configure the properties in the odbc.ini file:
|
|
2212
|
+
|
|
2213
|
+
1. For `HOST`, specify `data.dremio.cloud` for the US control plane, or `data.eu.dremio.cloud` for the European control plane.
|
|
2214
|
+
2. For `PORT`, specify `443`.
|
|
2215
|
+
3. For `TOKEN`, specify a personal access token.
|
|
2216
|
+
4. Ensure that the value of `SSL` is `1`.
|
|
2217
|
+
|
|
2218
|
+
For additional parameters, see [Connection Parameters](/dremio-cloud/explore-analyze/client-apps/drivers/arrow-flight-sql-odbc/#connection-parameters).
|
|
2219
|
+
|
|
2220
|
+
note
|
|
2221
|
+
|
|
2222
|
+
To find out unixODBC has created your `odbc.ini` and `odbcinst.ini` files, run this command: `odbcinst -j`
|
|
2223
|
+
|
|
2224
|
+
If you ever need to enable tracing for troubleshooting problems with the driver, see the help for unixODBC.
|
|
2225
|
+
|
|
2226
|
+
## macOS
|
|
2227
|
+
|
|
2228
|
+
### Download and Install
|
|
2229
|
+
|
|
2230
|
+
To download and install the Arrow Flight SQL ODBC driver:
|
|
2231
|
+
|
|
2232
|
+
Intel Macs Only
|
|
2233
|
+
|
|
2234
|
+
This driver only supports Intel-based Macs. It is not compatible with Apple Silicon M1, M2, and M3 processors.
|
|
2235
|
+
|
|
2236
|
+
1. Download the macOS driver version from the [ODBC driver download page](https://www.dremio.com/drivers/odbc/).
|
|
2237
|
+
2. Go to the download location and double-click the downloaded `.dmg` file.
|
|
2238
|
+
3. Double-click the `.pkg` file.
|
|
2239
|
+
4. In the **Welcome to the Arrow Flight SQL ODBC Driver Installer** page, click **Continue**.
|
|
2240
|
+
5. In the **Standard Install on "Macintosh HD"** page, Click **Install**. Optionally, if you want to change the install location, click **Change Install Location** and navigate to the new location.
|
|
2241
|
+
6. In the **Installer is trying to install new software** dialog, specify your macOS password. Then, click **Install Software**.
|
|
2242
|
+
7. After the installation is complete, click **Close**.
|
|
2243
|
+
|
|
2244
|
+
### Connect to Dremio
|
|
2245
|
+
|
|
2246
|
+
note
|
|
2247
|
+
|
|
2248
|
+
Before configuring, follow these steps:
|
|
2249
|
+
|
|
2250
|
+
* Ensure that [ODBC Manager](http://www.odbcmanager.net/) is installed.
|
|
2251
|
+
* In Dremio, generate a personal access token. See [Personal Access Tokens](/dremio-cloud/security/authentication/personal-access-token#create-a-pat).
|
|
2252
|
+
|
|
2253
|
+
To configure a system DSN:
|
|
2254
|
+
|
|
2255
|
+
1. Launch ODBC Manager.
|
|
2256
|
+
2. On the User DSN page, select **Arrow Flight SQL ODBC DSN** and click **Configure**.
|
|
2257
|
+
3. (Optional) Change the DSN.
|
|
2258
|
+
4. In the **Host** field, specify `data.dremio.cloud` for the US control plane, or `data.eu.dremio.cloud` for the European control plane.
|
|
2259
|
+
5. In the **Port** field, specify `443`.
|
|
2260
|
+
6. Select the **UID** field and click **Remove**.
|
|
2261
|
+
7. Select the **PWD** field and click **Remove**.
|
|
2262
|
+
8. In the **UseEncryption** field, specify `true`.
|
|
2263
|
+
9. Click **Add** to add a line for a new parameter. Change `keyword` to `TOKEN`, Paste a personal access token as the value.
|
|
2264
|
+
|
|
2265
|
+
For additional parameters, see [Connection Parameters](/dremio-cloud/explore-analyze/client-apps/drivers/arrow-flight-sql-odbc/#connection-parameters).
|
|
2266
|
+
|
|
2267
|
+
If you ever need to enable tracing for troubleshooting problems with the driver, see the help for your driver manager.
|
|
2268
|
+
|
|
2269
|
+
## Connection Parameters
|
|
2270
|
+
|
|
2271
|
+
### Primary Connection Parameters
|
|
2272
|
+
|
|
2273
|
+
Use these parameters to configure basic connection details such as what data source to connect with.
|
|
2274
|
+
|
|
2275
|
+
note
|
|
2276
|
+
|
|
2277
|
+
The Arrow Flight SQL ODBC driver does not support password-protected `.pem`/`.crt` files or multiple `.crt` certificates in a single `.pem`/`.crt` file.
|
|
2278
|
+
|
|
2279
|
+
| Name | Type | Description | Default Value |
|
|
2280
|
+
| --- | --- | --- | --- |
|
|
2281
|
+
| Host | string | `data.dremio.cloud` for the US control plane, `data.eu.dremio.cloud` for the European control plane. | None |
|
|
2282
|
+
| Port | integer | Sets the TCP port number that Dremio uses to listen to connections from ODBC clients. | 443 |
|
|
2283
|
+
| Schema | string | Provides the name of the database schema to use by default when a schema is not specified in a query. However, this does not prevent queries from being issued for other schemas. Such queries must explicitly include the schema. | None |
|
|
2284
|
+
| Token | string | Sets the personal access token to use when authenticating to Dremio. See [Creating a Token](/cloud/security/authentication/personal-access-token/#creating-a-token) for the steps to generate a personal access token. | None |
|
|
2285
|
+
|
|
2286
|
+
### Encryption Parameters
|
|
2287
|
+
|
|
2288
|
+
Use the following parameters to configure SSL encryption and verification methods for regular connections.
|
|
2289
|
+
|
|
2290
|
+
| Name | Type | Description | Default Value |
|
|
2291
|
+
| --- | --- | --- | --- |
|
|
2292
|
+
| useEncryption | integer | Forces the client to use an SSL-encrypted connection to communicate with Dremio. Accepted values include: `true`: The client communicates with Dremio only using SSL encryption. This is the only possible value. `false`: The value cannot be false. | true |
|
|
2293
|
+
| disableCertificateVerification | integer | Specifies whether the driver should verify the host certificate against the trust store. Accepted values are: `false`: The driver verifies the certificate against the trust store. `true`: The driver does not verify the certificate against the trust store. | false |
|
|
2294
|
+
| useSystemTrustStore | integer | Controls whether to use a CA certificate from the system's trust store, or from a specified .pem file. `true`: The driver verifies the connection using a certificate in the system trust store. `false`: The driver verifies the connection using the .pem file specified by the trustedCerts parameter. | true on Windows and macOS, false on Linux (which does not have a system truststore) |
|
|
2295
|
+
| trustedCerts | string | The full path of the .pem file containing certificates trusted by a CA, for the purpose of verifying the server. If this option is not set, then the driver defaults to using the trusted CA certificates .pem file installed by the driver. The exact file path varies according to the operating system on which the driver is installed. The path for the Windows driver is different from the path set for the macOS driver. The TLS connection fails if you do not specify a value when useEncryption is true and disableCertificateVerification is false. | N/A |
|
|
2296
|
+
|
|
2297
|
+
### Advanced Parameters
|
|
2298
|
+
|
|
2299
|
+
| Name | Type | Description | Default Value |
|
|
2300
|
+
| --- | --- | --- | --- |
|
|
2301
|
+
| quoting | string | Specifies which type of character to use to delimit values in queries. The value can be `BACK_TICK`, `BRACKET`, or `DOUBLE_QUOTE`. | `DOUBLE_QUOTE` |
|
|
2302
|
+
| routing\_tag | string | When this parameter is set, the specified tag is associated with all queries executed within a session. Rules can check for the presence of a tag with the function "tag()". For more information, see [Workload Management](/dremio-cloud/admin/engines/workload-management). | N/A |
|
|
2303
|
+
| stringColumnLength | string | The maximum length of data in columns of the STRING datatype and of complex datatypes. The range is 1 to 2147483647. | 1024 |
|
|
2304
|
+
|
|
2305
|
+
### Example of a Basic Connection String
|
|
2306
|
+
|
|
2307
|
+
Some BI client applications, such as Microsoft Excel, let you specify a connection string, rather than select a DSN, for connecting to Dremio. If you want to connect by using a connection string, you can use this example, basic connection string as a basis for your own:
|
|
2308
|
+
|
|
2309
|
+
Example connection string
|
|
2310
|
+
|
|
2311
|
+
```
|
|
2312
|
+
host=data.dremio.cloud;port=443;useEncryption=1;disableCertificateVerification=1;token=<personal-access-token>
|
|
2313
|
+
```
|
|
2314
|
+
|
|
2315
|
+
## Supported Conversions from Dremio Datatypes to ODBC Datatypes
|
|
2316
|
+
|
|
2317
|
+
| Dremio Data Types | SQL\_C\_BINARY | SQL\_C\_BIT | SQL\_C\_CHAR | SQL\_C\_WCHAR | SQL\_C\_STINYINT | SQL\_C\_UTINYINT | SQL\_C\_SSHORT | SQL\_C\_USHORT | SQL\_C\_SLONG | SQL\_C\_ULONG | SQL\_C\_SBIGINT | SQL\_C\_UBIGINT | SQL\_C\_FLOAT | SQL\_C\_DOUBLE | SQL\_C\_NUMERIC | SQL\_C\_DATE | SQL\_C\_TIME | SQL\_C\_TIMESTAMP | SQL\_C\_GUID | SQL\_C\_INTERVAL\_\* |
|
|
2318
|
+
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
|
2319
|
+
| BOOLEAN | N | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | N | Invalid | Invalid | Invalid | Invalid | N |
|
|
2320
|
+
| VARBINARY | Y | Invalid | N | N | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid |
|
|
2321
|
+
| DATE | N | Invalid | Y | Y | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Y | Invalid | Y | Invalid | Invalid |
|
|
2322
|
+
| FLOAT | N | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | N | Invalid | Invalid | Invalid | Invalid | N |
|
|
2323
|
+
| DECIMAL | N | N | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Invalid | Invalid | Invalid | Invalid | N |
|
|
2324
|
+
| DOUBLE | N | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | N | Invalid | Invalid | Invalid | Invalid | N |
|
|
2325
|
+
| INTERVAL (day to seconds) | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | Invalid | Invalid | Invalid | N |
|
|
2326
|
+
| INTERVAL (years to months) | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | N | Invalid | Invalid | Invalid | N |
|
|
2327
|
+
| INT | N | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | N | Invalid | Invalid | Invalid | Invalid | N |
|
|
2328
|
+
| BIGINT | N | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | N | Invalid | Invalid | Invalid | Invalid | N |
|
|
2329
|
+
| TIME | N | N | Y | Y | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Y | Y | Invalid | Invalid |
|
|
2330
|
+
| TIMESTAMP | N | N | Y | Y | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Y | Y | Invalid | Invalid |
|
|
2331
|
+
| VARCHAR | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y | N | Invalid |
|
|
2332
|
+
| STRUCT | N | N | Y | Y | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid |
|
|
2333
|
+
| LIST | N | Invalid | Y | Y | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid | Invalid |
|
|
2334
|
+
|
|
2335
|
+
Was this page helpful?
|
|
2336
|
+
|
|
2337
|
+
* Prerequisites
|
|
2338
|
+
* Supported Authentication Method
|
|
2339
|
+
* Windows
|
|
2340
|
+
+ Download and Install
|
|
2341
|
+
+ Connect to Dremio
|
|
2342
|
+
* Linux
|
|
2343
|
+
+ Download and Install
|
|
2344
|
+
+ Connect to Dremio
|
|
2345
|
+
* macOS
|
|
2346
|
+
+ Download and Install
|
|
2347
|
+
+ Connect to Dremio
|
|
2348
|
+
* Connection Parameters
|
|
2349
|
+
+ Primary Connection Parameters
|
|
2350
|
+
+ Encryption Parameters
|
|
2351
|
+
+ Advanced Parameters
|
|
2352
|
+
+ Example of a Basic Connection String
|
|
2353
|
+
* Supported Conversions from Dremio Datatypes to ODBC Datatypes
|
|
2354
|
+
|
|
2355
|
+
<div style="page-break-after: always;"></div>
|
|
2356
|
+
|
|
2357
|
+
# Dremio JDBC (Legacy) Release Notes | Dremio Documentation
|
|
2358
|
+
|
|
2359
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/client-apps/drivers/release-notes/jdbc-legacy
|
|
2360
|
+
|
|
2361
|
+
On this page
|
|
2362
|
+
|
|
2363
|
+
This article contains the release notes for the Dremio JDBC driver (Legacy). See [Dremio JDBC Driver (Legacy)](/dremio-cloud/explore-analyze/client-apps/drivers/jdbc-legacy) for documentation.
|
|
2364
|
+
|
|
2365
|
+
note
|
|
2366
|
+
|
|
2367
|
+
The [Arrow Flight SQL JDBC driver](/dremio-cloud/explore-analyze/client-apps/drivers/arrow-flight-sql-jdbc) is the recommended driver for connectivity to Java-based applications. The Dremio JDBC driver (Legacy) will not be updated or fixed moving forward.
|
|
2368
|
+
|
|
2369
|
+
## Legacy JDBC Driver 17.0.0 (June 2021)
|
|
2370
|
+
|
|
2371
|
+
***Connection.getCatalog() would always return `null`.***
|
|
2372
|
+
Connection.getCatalog() now returns the current catalog for the connection.
|
|
2373
|
+
|
|
2374
|
+
## Legacy JDBC Driver 15.2.0 (March 2021)
|
|
2375
|
+
|
|
2376
|
+
* Dremio uses the local timezone rather than UTC for datetime values.
|
|
2377
|
+
|
|
2378
|
+
## Legacy JDBC Driver 15.0.0 (March 2021)
|
|
2379
|
+
|
|
2380
|
+
* Provides a `useSystemTrustStore` property that bypasses `trustStoreType` and automatically selects the correct Truststore based on the operating system. See [JDBC Parameters for Dremio Wire Encryption](/dremio-cloud/explore-analyze/client-apps/drivers/jdbc-legacy/#encryption-parameters) for more information.
|
|
2381
|
+
|
|
2382
|
+
* Dremio no longer maps empty usernames to anonymous. Rather, Dremio treats empty usernames as empty.
|
|
2383
|
+
|
|
2384
|
+
## Legacy JDBC Driver 14.0.0 (February 2021)
|
|
2385
|
+
|
|
2386
|
+
* Provides a new class loader from a previously-loaded class when no class loader is available for a thread.
|
|
2387
|
+
|
|
2388
|
+
## Legacy JDBC Driver 11.0.0 (November 2020)
|
|
2389
|
+
|
|
2390
|
+
* Support for TLS SNI when connecting to a TLS-enabled Dremio deployment. Dremio implicitly sets the TLS SNI property to the hostname used in the connection string.
|
|
2391
|
+
|
|
2392
|
+
Was this page helpful?
|
|
2393
|
+
|
|
2394
|
+
* Legacy JDBC Driver 17.0.0 (June 2021)
|
|
2395
|
+
* Legacy JDBC Driver 15.2.0 (March 2021)
|
|
2396
|
+
* Legacy JDBC Driver 15.0.0 (March 2021)
|
|
2397
|
+
* Legacy JDBC Driver 14.0.0 (February 2021)
|
|
2398
|
+
* Legacy JDBC Driver 11.0.0 (November 2020)
|
|
2399
|
+
|
|
2400
|
+
<div style="page-break-after: always;"></div>
|
|
2401
|
+
|
|
2402
|
+
# Arrow Flight SQL JDBC Release Notes | Dremio Documentation
|
|
2403
|
+
|
|
2404
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/client-apps/drivers/release-notes/arrow-flight-sql-jdbc
|
|
2405
|
+
|
|
2406
|
+
On this page
|
|
2407
|
+
|
|
2408
|
+
You can connect to Dremio through the Arrow Flight SQL JDBC driver. The driver is open-source and you are free to use it with Dremio's data lakehouse platform or any other data platform that has an Arrow Flight SQL endpoint.
|
|
2409
|
+
These release notes summarize Dremio-specific updates, compatibility notes, and limitations.
|
|
2410
|
+
|
|
2411
|
+
For more information about this driver, see [Arrow Flight SQL JDBC](/dremio-cloud/explore-analyze/client-apps/drivers/arrow-flight-sql-jdbc).
|
|
2412
|
+
|
|
2413
|
+
## Version 10.0.0 (November 2022)
|
|
2414
|
+
|
|
2415
|
+
### Security
|
|
2416
|
+
|
|
2417
|
+
Transport Layer Security (TLS) communication is enabled by default for Arrow Flight client applications.
|
|
2418
|
+
|
|
2419
|
+
### Limitations
|
|
2420
|
+
|
|
2421
|
+
* Time offsets are not being reported in query results.
|
|
2422
|
+
* User impersonation is not yet supported.
|
|
2423
|
+
|
|
2424
|
+
### Recommendation
|
|
2425
|
+
|
|
2426
|
+
It is recommended to use the Arrow Flight SQL JDBC driver instead of the Dremio JDBC (Legacy) driver. The Dremio JDBC (Legacy) driver will not be updated or fixed moving forward.
|
|
2427
|
+
|
|
2428
|
+
Was this page helpful?
|
|
2429
|
+
|
|
2430
|
+
* Version 10.0.0 (November 2022)
|
|
2431
|
+
+ Security
|
|
2432
|
+
+ Limitations
|
|
2433
|
+
+ Recommendation
|
|
2434
|
+
|
|
2435
|
+
<div style="page-break-after: always;"></div>
|
|
2436
|
+
|
|
2437
|
+
# Arrow Flight SQL ODBC Release Notes | Dremio Documentation
|
|
2438
|
+
|
|
2439
|
+
Original URL: https://docs.dremio.com/dremio-cloud/explore-analyze/client-apps/drivers/release-notes/arrow-flight-sql-odbc
|
|
2440
|
+
|
|
2441
|
+
On this page
|
|
2442
|
+
|
|
2443
|
+
This article contains the release notes for the Arrow Flight SQL ODBC driver.
|
|
2444
|
+
|
|
2445
|
+
See [Arrow Flight SQL ODBC](/dremio-cloud/explore-analyze/client-apps/drivers/arrow-flight-sql-odbc/) for documentation.
|
|
2446
|
+
|
|
2447
|
+
## 0.9.7 (August 2025)
|
|
2448
|
+
|
|
2449
|
+
Issues Fixed
|
|
2450
|
+
|
|
2451
|
+
General Updates
|
|
2452
|
+
|
|
2453
|
+
Fixed an issue on macOS where the error was sometimes not displayed in Microsoft Excel.
|
|
2454
|
+
|
|
2455
|
+
DX-90575
|
|
2456
|
+
|
|
2457
|
+
General Updates
|
|
2458
|
+
|
|
2459
|
+
Fixed an issue with an inconsistent searchable attribute returned by the `SQLColAttribute` function.
|
|
2460
|
+
|
|
2461
|
+
DX-102851
|
|
2462
|
+
|
|
2463
|
+
General Updates
|
|
2464
|
+
|
|
2465
|
+
Fixed an issue where Microsoft Excel was not showing small decimals correctly.
|
|
2466
|
+
|
|
2467
|
+
DX-104574
|
|
2468
|
+
|
|
2469
|
+
## 0.9.6 (June 2025)
|
|
2470
|
+
|
|
2471
|
+
Issues Fixed
|
|
2472
|
+
|
|
2473
|
+
General Updates
|
|
2474
|
+
|
|
2475
|
+
Resolved an issue where the Arrow Flight SQL ODBC driver failed to connect to TLS-secured Flight endpoints.
|
|
2476
|
+
|
|
2477
|
+
General Updates
|
|
2478
|
+
|
|
2479
|
+
Fixed an issue where calling metadata functions like `SQLPrimaryKeysW` or `SQLForeignKeysW` caused an error.
|
|
2480
|
+
The driver now handles these calls more gracefully.
|
|
2481
|
+
|
|
2482
|
+
## 0.9.5 (May 2025)
|
|
2483
|
+
|
|
2484
|
+
What's New
|
|
2485
|
+
|
|
2486
|
+
General Updates
|
|
2487
|
+
|
|
2488
|
+
A new driver configuration flag is available for macOS (Intel and Apple Silicon): `hideSQLTablesListing`.
|
|
2489
|
+
|
|
2490
|
+
DX-101630
|
|
2491
|
+
|
|
2492
|
+
## 0.9.4 (April 2025)
|
|
2493
|
+
|
|
2494
|
+
What's New
|
|
2495
|
+
|
|
2496
|
+
General Updates
|
|
2497
|
+
|
|
2498
|
+
The Arrow Flight SQL ODBC driver now supports Apple Silicon. [Download the driver](https://download.dremio.com/arrow-flight-sql-odbc-driver/arrow-flight-sql-odbc-LATEST-armv8.dmg).
|
|
2499
|
+
|
|
2500
|
+
General Updates
|
|
2501
|
+
|
|
2502
|
+
Upgraded to Arrow Flight [v9](https://arrow.apache.org/docs/9.0/format/FlightSql.html) for enhanced compatibility and performance.
|
|
2503
|
+
|
|
2504
|
+
Issues Fixed
|
|
2505
|
+
|
|
2506
|
+
General Updates
|
|
2507
|
+
|
|
2508
|
+
Fixed date handling for pre-1970 dates in Microsoft tools.
|
|
2509
|
+
|
|
2510
|
+
General Updates
|
|
2511
|
+
|
|
2512
|
+
Fixed segmentation fault in Arrow Flight SQL ODBC Driver.
|
|
2513
|
+
|
|
2514
|
+
Was this page helpful?
|
|
2515
|
+
|
|
2516
|
+
* 0.9.7 (August 2025)
|
|
2517
|
+
* 0.9.6 (June 2025)
|
|
2518
|
+
* 0.9.5 (May 2025)
|
|
2519
|
+
* 0.9.4 (April 2025)
|
|
2520
|
+
|
|
2521
|
+
<div style="page-break-after: always;"></div>
|
|
2522
|
+
|