Skip to content

Update SingleStore docs #612

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
okramarenko wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update SingleStore docs #612

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f561597
Update SingleStore docs with NativeQuery info
okramarenko Mar 24, 2026
dea100b
Add SingleStore to the list of the connectors that support NativeQuery
okramarenko Mar 24, 2026
b1dbed6
resolve Copilot comments
okramarenko Mar 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion powerquery-docs/connectors/includes/singlestore-capabilities-supported.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@ ms.topic: include

* Import
* DirectQuery (Power BI semantic models)

* Advanced options
* Native SQL statement
2 changes: 1 addition & 1 deletion powerquery-docs/connectors/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ The connectors are listed in alphabetical order in separate tables for each lett
| [![SharePoint list.](media/index/sharepoint-64.png)<br/>**SharePoint list**](./sharepoint-list.md)<br/>By Microsoft | ![Supported - SharePoint list in Excel](media/index/yes.png) | ![Supported - SharePoint list in Power BI (Semantic models)](media/index/yes.png) | ![Supported - SharePoint list in Power BI (Dataflows)](media/index/yes.png) | ![Supported - SharePoint list in Fabric (Dataflow Gen2)](media/index/yes.png) | ![Supported - SharePoint list in Power Apps (Dataflows)](media/index/yes.png) | ![Supported - SharePoint list in Customer Insights (Dataflows)](media/index/yes.png) | ![Supported - SharePoint list in Analysis Services](media/index/yes.png) |
| [![SharePoint Online list.](media/index/sharepoint-64.png)<br/>**SharePoint Online<br/>list**](./sharepoint-online-list.md)<br/>By Microsoft | ![Supported - SharePoint Online list in Excel](media/index/yes.png) | ![Supported - SharePoint Online list in Power BI (Semantic models)](media/index/yes.png) | ![Supported - SharePoint Online list in Power BI (Dataflows)](media/index/yes.png) | ![Supported - SharePoint Online list in Fabric (Dataflow Gen2)](media/index/yes.png) | ![Supported - SharePoint Online list in Power Apps (Dataflows)](media/index/yes.png) <sup>1</sup> | ![Supported - SharePoint Online list in Customer Insights (Dataflows)](media/index/yes.png) | ![Not supported - SharePoint Online list in Analysis Services](media/index/no.png) |
| ![Shortcuts Business Insights (Beta).](media/index/shortcuts-logo-64.png)<br/>**Shortcuts Business Insights (Beta)**<br/>By Shortcuts | ![Not supported - Shortcuts Business Insights (Beta) in Excel](media/index/no.png) | ![Supported - Shortcuts Business Insights (Beta) in Power BI (Semantic models)](media/index/yes.png) | ![Supported - Shortcuts Business Insights (Beta) in Power BI (Dataflows)](media/index/yes.png) | ![Supported - Shortcuts Business Insights (Beta) in Fabric (Dataflow Gen2)](media/index/yes.png) | ![Not supported - Shortcuts Business Insights (Beta) in Power Apps (Dataflows)](media/index/no.png) | ![Not supported - Shortcuts Business Insights (Beta) in Customer Insights (Dataflows)](media/index/no.png) | ![Not supported - Shortcuts Business Insights (Beta) in Analysis Services](media/index/no.png) |
| [![SingleStore.](media/index/singlestore-64.png)<br/>**SingleStore (Beta)**](./singlestore.md)<br/>By SingleStore | ![Not supported - SingleStore in Excel](media/index/no.png) | ![Supported - SingleStore in Power BI (Semantic models)](media/index/yes.png) | ![Supported - SingleStore in Power BI (Dataflows)](media/index/yes.png) | ![Supported - SingleStore in Fabric (Dataflow Gen2)](media/index/yes.png) | ![Not supported - SingleStore in Power Apps (Dataflows)](media/index/no.png) | ![Not supported - SingleStore in Customer Insights (Dataflows)](media/index/no.png) | ![Not supported - SingleStore in Analysis Services](media/index/no.png) |
| [![SingleStore.](media/index/singlestore-64.png)<br/>**SingleStore**](./singlestore.md)<br/>By SingleStore | ![Not supported - SingleStore in Excel](media/index/no.png) | ![Supported - SingleStore in Power BI (Semantic models)](media/index/yes.png) | ![Supported - SingleStore in Power BI (Dataflows)](media/index/yes.png) | ![Supported - SingleStore in Fabric (Dataflow Gen2)](media/index/yes.png) | ![Not supported - SingleStore in Power Apps (Dataflows)](media/index/no.png) | ![Not supported - SingleStore in Customer Insights (Dataflows)](media/index/no.png) | ![Not supported - SingleStore in Analysis Services](media/index/no.png) |
| ![SiteImprove.](media/index/siteimprove-64.png)<br/>**SiteImprove**<br/>By SiteImprove | ![Not supported - SiteImprove in Excel](media/index/no.png) | ![Supported - SiteImprove in Power BI (Semantic models)](media/index/yes.png) | ![Supported - SiteImprove in Power BI (Dataflows)](media/index/yes.png) | ![Supported - SiteImprove in Fabric (Dataflow Gen2)](media/index/yes.png) | ![Not supported - SiteImprove in Power Apps (Dataflows)](media/index/no.png) | ![Not supported - SiteImprove in Customer Insights (Dataflows)](media/index/no.png) | ![Not supported - SiteImprove in Analysis Services](media/index/no.png) |
| [![Smartsheet.](media/index/smartsheet-64.png)<br/>**Smartsheet**<br/>](./smartsheet.md)By Smartsheet | ![Not supported - Smartsheet in Excel](media/index/no.png) | ![Supported - Smartsheet in Power BI (Semantic models)](media/index/yes.png) | ![Supported - Smartsheet in Power BI (Dataflows)](media/index/yes.png) | ![Supported - Smartsheet in Fabric (Dataflow Gen2)](media/index/yes.png) | ![Not supported - Smartsheet in Power Apps (Dataflows)](media/index/no.png) | ![Not supported - Smartsheet in Customer Insights (Dataflows)](media/index/no.png) | ![Not supported - Smartsheet in Analysis Services](media/index/no.png) |
| [![Snowflake.](media/index/database-64.png)<br/>**Snowflake**](snowflake.md)<br/>By Microsoft | ![Not supported - Snowflake in Excel](media/index/no.png) | ![Supported - Snowflake in Power BI (Semantic models)](media/index/yes.png) | ![Supported - Snowflake in Power BI (Dataflows)](media/index/yes.png) | ![Supported - Snowflake in Fabric (Dataflow Gen2)](media/index/yes.png) | ![Supported - Snowflake in Power Apps (Dataflows)](media/index/yes.png) | ![Supported - Snowflake in Customer Insights (Dataflows)](media/index/yes.png) | ![Not supported - Snowflake in Analysis Services](media/index/no.png) |
Expand Down
Binary file modified powerquery-docs/connectors/media/singlestore/ss-db-select-mode.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 15 additions & 27 deletions powerquery-docs/connectors/singlestore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ ms.custom: sfi-image-nochange

[!INCLUDE [Includes_singlestore_capabilities-supported](includes/singlestore-capabilities-supported.md)]

> [!NOTE]
> Existing reports created using the `SingleStoreODBC.Query` (CustomSQL functionality) function call continue to be supported. SingleStore recommends using native database queries for new reports.

## Connect to SingleStore

To connect Microsoft Power BI Desktop to SingleStore DB or Managed Service:
Expand All @@ -36,9 +39,12 @@ To connect Microsoft Power BI Desktop to SingleStore DB or Managed Service:

:::image type="content" source="./media/singlestore/ss-get-data-connector.png" alt-text="Locate the SingleStore Connectors in Get Data dialog.":::

3. In the **SingleStore database** dialog box, enter the IP address or hostname of the SingleStore cluster in **Server**. In **Database**, enter the database name.
3. In the connection configuration dialog, enter or select the following:

Under **Data Connectivity** mode, select the Import or DirectQuery mode, and then select **OK**.
* **Server**: Enter the IP address or the hostname of the SingleStore cluster.
* **Database**: Enter the name of the SingleStore database to connect with.
* **Data Connectivity mode**: Select **Import** or **DirectQuery**.
* (Optional) To ingest data using a native database query, enter the SQL query in the **Native query** box.
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs use two different labels for the same feature: this step refers to the Native query box, while the capabilities section calls it "Native SQL statement". Please align the terminology with the actual UI label used by this connector (and keep it consistent across the page and include) to reduce user confusion.

Suggested change
* (Optional) To ingest data using a native database query, enter the SQL query in the **Native query** box.
* (Optional) To ingest data using a native database query, enter the SQL query in the **Native SQL statement** box.

Copilot uses AI. Check for mistakes.

:::image type="content" source="./media/singlestore/ss-db-select-mode.png" alt-text="Enter server IP / hostname and database and select the connectivity mode.":::

Expand All @@ -47,10 +53,10 @@ To connect Microsoft Power BI Desktop to SingleStore DB or Managed Service:
> [!NOTE]
> SingleStoreDB Cloud users can only use **Basic** authentication.

* For **Windows** authentication, [set up a SingleStore server for Kerberos authentication](https://docs.singlestore.com/db/v7.3/en/security/authentication/kerberos-authentication.html). Then select the **Connect** button.
* For **Windows** authentication, [set up a SingleStore server for Kerberos authentication](https://docs.singlestore.com/db/v9.0/security/authentication/kerberos-authentication). Then select the **Connect** button.

> [!NOTE]
> You need to run Power BI with the user account that maps to the SingleStore DB user.
> You need to run Power BI with the user account that maps to the SingleStore user. Therefore, if the Windows user is 'administrator'@domain, then the database user must be 'administrator'. You may need to create the database user.

:::image type="content" source="./media/singlestore/ss-db-windows.png" alt-text="Select Windows authentication.":::

Expand All @@ -64,31 +70,13 @@ To connect Microsoft Power BI Desktop to SingleStore DB or Managed Service:

You can now use Power BI to explore SingleStore data.

## Create a custom SQL report

> [!NOTE]
> Any user that creates a custom SQL report must only have read-only access to the SingleStore databases.

To create a new custom SQL report:

1. Open Power BI Desktop.

2. In the **Home** ribbon, from the **Get Data** list, select **Blank query**.

3. In the **Power Query Editor** dialog, specify the query in the following format:

SingleStoreODBC.Query("\<_ip_address_or_hostname_>", "\<_database_>", "\<_query_>")

Submit the query.

> [!NOTE]
> If you're using the server for the first time, select **Edit Credentials** and enter the credentials. Go to **Step 4** in [Connect to SingleStore](#connect-to-singlestore) for more information.

4. Verify the data to load, and select **Close & Apply**.
## Limitations of Native Database Queries

5. If you've worked with the data set before and it's cached in memory, refresh the report to reset the local cache. On the **Home** ribbon, select **Refresh**.
* To run a native database query using the connector, the user must only have read-only access to the SingleStore databases.
* DDL queries are not supported.
* If the SQL query is specified outside the connector dialog (the connection configuration step), Power BI may prompt you to approve the query for your credentials.

To update the existing custom SQL reports, select the **Refresh** button on the **Home** ribbon.
Refer to [Limitations and issues](https://learn.microsoft.com/en-us/power-query/native-database-query#limitations-and-issues) for more information.

## Modify credentials

Expand Down
1 change: 1 addition & 0 deletions powerquery-docs/native-database-query.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ The following Power Query connectors support native database queries.
| Oracle database | SQL statement |
| PostgreSQL | SQL statement |
| SAP HANA database | SQL statement |
| SingleStore | SQL statement |
| Snowflake | SQL statement |
| SQL Server Analysis Services database | MDX or DAX query |
| SQL Server database | SQL statement |
Expand Down