Merge branch 'main' of https://github.com/DaxStudio/DaxStudio-Docs

DaxStudio · Oct 12, 2024 · fd6c195 · fd6c195
2 parents e189c62 + 1efbaec
commit fd6c195
Show file tree

Hide file tree

Showing 16 changed files with 4,990 additions and 3,116 deletions.
diff --git a/blog/2022-08-20-welcome/index.md b/blog/2022-08-20-welcome/index.md
@@ -7,4 +7,6 @@ tags: [daxstudio]
 
 Welcome to the DAX Studio blog.
 
-This is an area where we will put content of interest to DAX Studio users
+This is an area where we will put content of interest to DAX Studio users
+
+<!-- truncate -->
diff --git a/blog/2022-08-24-v3-released/index.md b/blog/2022-08-24-v3-released/index.md
@@ -8,7 +8,7 @@ tags: [daxstudio]
 # DAX Studio version 3.0
 
 Today we are happy to announce the release of version 3 of DAX Studio
-
+<!-- truncate -->
 ## Dark Mode!
 
 This has been an outstanding request for a long time and finally we are happy to announce that we now support Dark Mode! You can switch between the 3 different mode settings using the button at the top of the ribbon

diff --git a/blog/2023-03-13-v3_0_6/index.mdx b/blog/2023-03-13-v3_0_6/index.mdx
@@ -9,7 +9,7 @@ import Issue from '@site/src/components/Github-Issue';
 # DAX Studio version 3.0.6
 
 Today we are happy to announce the release of version 3.0.6 of DAX Studio
-
+<!-- truncate -->
 ## Updated Timeline/Waterfall visualization in Server Timings
 The old Waterfall column has been replaced by the new Timeline column. This column contains the same information as the old waterfall column, but includes a new background image to help visualise times during the execution of a query when either the formula engine (denoted by yellow sections) or the storage engine (denoted by blue sections) was active.
 

diff --git a/blog/2023-04-17-v3_0_7/index.mdx b/blog/2023-04-17-v3_0_7/index.mdx
@@ -9,7 +9,7 @@ import Issue from '@site/src/components/Github-Issue';
 # DAX Studio version 3.0.7
 
 Today we are happy to announce the release of version 3.0.7 of DAX Studio
-
+<!-- truncate -->
 ## Metadata loading improvements
 
 DAX Studio uses an asynchronous, lazy loading strategy to populate the metadata which has worked reasonably well over the years, but we occassionaly see some strange errors due about reader objects being already in use (such as those in issue <Issue id="1076"/> ) or responses containing unexpected data. There are actually a number of small tweaks in the previous verion (3.0.6) which were meant to help avoid these issues, but there was also one minor improvement to the formatting of query results which made this worse.

diff --git a/blog/2023-06-30-v3_0_8/index.mdx b/blog/2023-06-30-v3_0_8/index.mdx
@@ -9,7 +9,7 @@ import Issue from '@site/src/components/Github-Issue';
 # DAX Studio version 3.0.8
 
 Today we are happy to announce the release of version 3.0.8 of DAX Studio which includes the following fixes and Updates
-
+<!-- truncate -->
 :::info
 If you are testing out the new Fabric Direct Lake mode you should upgrade to this version as it improves the performance of the metadata loading.
 :::

diff --git a/blog/2023-08-16-v3_0_10/index.mdx b/blog/2023-08-16-v3_0_10/index.mdx
@@ -9,6 +9,6 @@ import Issue from '@site/src/components/Github-Issue';
 # DAX Studio version 3.0.10
 
 Today we are happy to announce the release of version 3.0.10 of DAX Studio which includes the following fix.
-
+<!-- truncate -->
 # Fixes
 * Fix crash dialog that appears when connecting or changing tabs when the [Indent Based Folding](/docs/features/indent-code-folding) preview feature is NOT enabled
diff --git a/blog/2023-08-16-v3_0_9/index.mdx b/blog/2023-08-16-v3_0_9/index.mdx
@@ -9,7 +9,7 @@ import Issue from '@site/src/components/Github-Issue';
 # DAX Studio version 3.0.9
 
 Today we are happy to announce the release of version 3.0.9 of DAX Studio which includes the following fixes and Updates
-
+<!-- truncate -->
 :::info
 If you are testing DAX Optimizer you should update to this release as it includes  .
 :::

diff --git a/blog/2023-11-21-v3_0_11/index.mdx b/blog/2023-11-21-v3_0_11/index.mdx
@@ -9,7 +9,7 @@ import Issue from '@site/src/components/Github-Issue';
 # DAX Studio version 3.0.11
 
 Today we are happy to announce the release of version 3.0.11 of DAX Studio which includes the following fix.
-
+<!-- truncate -->
 ## Updates
 * Improved Query Folding logic
 * updated vpax libraries

diff --git a/blog/2024-07-29-v3_1_0/index.mdx b/blog/2024-07-29-v3_1_0/index.mdx
@@ -9,7 +9,7 @@ import Issue from '@site/src/components/Github-Issue';
 # DAX Studio version 3.1.0
 
 Today we are happy to announce the release of version 3.1.0 of DAX Studio which includes the following fix.
-
+<!-- truncate -->
 ## Highlights
 
 ### DSCMD - DAX Studio command line utility

diff --git a/blog/2024-08-07-v3_2_0/index.mdx b/blog/2024-08-07-v3_2_0/index.mdx
@@ -9,7 +9,7 @@ import Issue from '@site/src/components/Github-Issue';
 # DAX Studio version 3.2.0
 
 Today we are happy to announce the release of version 3.2.0 of DAX Studio which includes the following new features and fixes.
-
+<!-- truncate -->
 ## Updates / New Features
 * Improving [Smart Paste](https://daxstudio.org/docs/features/smart-paste/)
 * <Issue id="1288" /> Added Support for [View Metrics StatsColumnBatchSize](https://daxstudio.org/docs/features/model-metrics/#metric-options-dialog)

diff --git a/blog/2024-09-04-v3_2_1/index.mdx b/blog/2024-09-04-v3_2_1/index.mdx
@@ -9,7 +9,7 @@ import Issue from '@site/src/components/Github-Issue';
 # DAX Studio version 3.2.1
 
 Today we are happy to announce the release of version 3.2.1 of DAX Studio which includes the following new features and fixes.
-
+<!-- truncate -->
 ## DSCMD - DAX Parameter Support 
 If you want to run a DAX query from the command line which has a parameter in it you can now pass a value to be used by that parameter
 

diff --git a/docs/features/command-line/authentication.md b/docs/features/command-line/authentication.md
@@ -4,16 +4,38 @@ title: Authentication
 
 The way that dscmd authenticates to the data source depends on the which set of options are passed to the specific command
 
+By default the identity running the dscmd process will be used for authentication. In the case of connections requiring an Entra ID a popup window will be displayed
+
+## Using Options
+
 ### if the --connectionString option is set
 When you set the --connectionString property none of the other --UserID --Password --Server or --Database options are used, the connection string parameter overrides all of these. So if the connection string has a `User ID=` or `Password=` options then those are used otherwise the identity running the dscmd process will be used 
 
 ### if the  --UserID or --Password options are set
 Then these parameters are used to authenticate to the data source.
 
-### if the Authentication environment variables are set
-Then the values from those will be injected into the User ID= and Password= values in the connection string. There are 2 environment variables that dscmd is aware of
+## Using the Authentication environment variables
+The values from those will be injected into the User ID= and Password= values in the connection string. This allows you to avoid hard coding credentials into scripts that use dscmd.
+
+There are 2 environment variables that dscmd is aware of:
+
 * **`DSCMD_USER`** - this is passed as the User ID
 * **`DSCMD_PASSWORD`** - this is passed as the Password
 
-### Otherwise
-The identity running the dscmd process will be used for authentication. In the case of connections requiring an Entra ID a popup window will be displayed
+## Authenticating as service principal
+
+To use the `ClientID` and `Secret` to login as a service principal you need to use the following format `app:<clientId>@<tenantId>` as the user value and the `secret` or `cert:<thumbprint>` as the password value. 
+
+eg. *note: these are fake random values for illustration purposes only*
+```
+dscmd csv c:\temp\myquery.csv -s localhost\tab19 -d "Adventure Works DW"  ^
+  -m myColor=Red ^
+  -u app:XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX@YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYY ^
+  -p ARandomStringForClientSecretHere
+  -q "EVALUATE FILTER('product', 'product[Color]=@myColor && 'product'[Category]='Bikes')"
+```
+
+:::warning
+It is recommended to store the clientId/secret in environment variables if possible rather than embedding these in your scripts
+:::
+
diff --git a/docs/features/command-line/commands/csv-command.md b/docs/features/command-line/commands/csv-command.md
@@ -28,7 +28,7 @@ DSCMD CSV <OutputFile> [OPTIONS]
 | -c, --connectionstring &lt;CONNECTIONSTRING> | The connection string for the data source |
 | -f, --file &lt;FILE> | A file containing a DAX query to be executed. Could be a text file or .dax or .daxx |
 | -q, --query &lt;QUERY> | A string with the DAX query to be executed |
-| -t, --filetype &lt;VALUE>| Can be one of the following values { UTF8CSV, UNICODECSV, JSON, TAB } if omitted the file extension is used <ul><li>.csv - UFT-8 csv file is generated</li><li>.txt - tab delimited file is generated</li><li>.json - a json file is generated </li></ul>|
+| -t, --filetype &lt;VALUE>| Can be one of the following values ( UTF8CSV, UNICODECSV, JSON, TAB ) if omitted the file extension is used <ul><li>.csv - UFT-8 csv file is generated</li><li>.txt - tab delimited file is generated</li><li>.json - a json file is generated </li></ul>|
 | -m, --parameter &lt;PARAMETER=VALUE> | Parameter values to be passed into the query (see [-m --parameter option](#-m---parameter-option) below)|
 
 ### -m --parameter Option

diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -82,7 +82,7 @@ const config = {
           {href: 'https://github.com/daxstudio/daxstudio/discussions', label:'Discussions',position:'right'  },
           {href: 'https://github.com/daxstudio/daxstudio/issues', label:'Issues / Requests',position:'right'  },
           {
-            to: '/Sponsors',
+            to: '/sponsors',
             label: 'Sponsor',
             position: 'right',
           },