Skip to content

Commit

Permalink
doc updates for 3.2.1
Browse files Browse the repository at this point in the history
  • Loading branch information
dgosbell committed Sep 3, 2024
1 parent 776cdb9 commit ed29574
Show file tree
Hide file tree
Showing 7 changed files with 65 additions and 8 deletions.
16 changes: 15 additions & 1 deletion docs/features/command-line/commands/csv-command.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,21 @@ 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 | 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
If you have a DAX query with parameters you can pass these in using the `-m, -parameter` option, if you have multiple parameters in your query you can provide multiple parameter values

In the following example the query has 2 parameters **@myColor** and **@myCategory** which are passed in using 2 `-m` options

eg.
```
dscmd csv c:\temp\myquery.csv -s localhost\tab19 -d "Adventure Works DW" ^
-m myColor=Red ^
-m myCategory=Bikes ^
-q "EVALUATE FILTER('product', 'product[Color]=@myColor && 'product'[Category]=@myCategory)"
```

## Examples

Expand Down
5 changes: 2 additions & 3 deletions docs/features/command-line/commands/export-csv-command.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ DSCMD EXPORT CSV <OutputFolder> [OPTIONS]
| -q, --query &lt;QUERY> | A string with the DAX query to be executed |
| -t, --tables &lt;TABLES> | A list of tables to be exported (defaults to all tables) |

## -t --tables Option
### -t --tables Option
This option is a comma separate list of table names

:::info
Expand All @@ -44,11 +44,10 @@ If you need to include `,` or `\` characters these need to be doubled up eg. `-t
|---|---|---|
| No Spaces | `-t Table1,Table2,Table3` | Table1<br/>Table2<br/>Table3|
| Including Spaces | `-t "Table 1,Table 2,Table3"` | Table 1<br/>Table 2<br/>Table3|
| Including Quotes | `-t "Table1,My \"Table\" 2,Table3"` | Table1<br/>My "Table" 2<br/>Table3|
| Including Quotes & Spaces | `-t "Table1,My \"Table\" 2,Table3"` | Table1<br/>My "Table" 2<br/>Table3|
| Including Commas | `-t Table1,My,,Table2,Table3` | Table1<br/>My,Table2<br/>Table3|
| Including Quotes,Commas & Spaces | `-t "Table1,My,,\"Table\" 2,Table3"` | Table1<br/>My,"Table" 2<br/>Table3|


## Examples

The following example exports all of the tables from the `Adventure Works` model to the `c:\temp\export` folder as .csv files.
Expand Down
2 changes: 1 addition & 1 deletion docs/features/command-line/commands/export-sql-command.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ DSCMD EXPORT SQL <OutputFolder> [OPTIONS]
| -e, --schema &lt;SCHEMA> | The schema in which the destination tables belong (defaults to 'dbo') |
| -r, --recreate-tables | Will drop and re-create the target tables |

## -t --tables Option
### -t --tables Option
This option is a comma separate list of table names

:::info
Expand Down
1 change: 1 addition & 0 deletions docs/features/command-line/commands/vpax-command.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ DSCMD VPAX <OutputFile> [OPTIONS]
| -t, --excludeTom | Setting this flag will exclude a .bim file inside the vpax file (which just contains additional metadata) |
| -r, --donotreadstatsfromdata | Setting this flag will prevent the standard distinctcount queries that read the statistics from the data model |
| -q, --readstatsfromdirectquery | Setting this flag will force the execution of distinctcount queries that read the statistics from the data model (which is normally suppressed for Direct Query models) |
| -b, --StatsColumnBatchSize &lt;VALUE>| The number of columns to include in each batch of the column statistics queries |


## Examples
Expand Down
13 changes: 13 additions & 0 deletions docs/features/command-line/commands/xlsx-command.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,20 @@ DSCMD XLSX <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 |
| -m, --parameter &lt;PARAMETER=VALUE> | Parameter values to be passed into the query (see [-m --parameter option](#-m---parameter-option) below)|

### -m --parameter Option
If you have a DAX query with parameters you can pass these in using the `-m, -parameter` option, if you have multiple parameters in your query you can provide multiple parameter values

In the following example the query has 2 parameters **@myColor** and **@myCategory** which are passed in using 2 `-m` options

eg.
```
dscmd csv c:\temp\myquery.csv -s localhost\tab19 -d "Adventure Works DW" ^
-m myColor=Red ^
-m myCategory=Bikes ^
-q "EVALUATE FILTER('product', 'product[Color]=@myColor && 'product'[Category]=@myCategory)"
```
## Examples

The following example exports to a file called myquery.xlsx in the c:\temp folder and connects as the user running the command
Expand Down
7 changes: 6 additions & 1 deletion docs/features/command-line/syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ dscmd <arguments> [options]
```

## &lt;Arguments>
Arguments are indicated by angled brackets and are required
Arguments are indicated by angled brackets and are _**required**_

## \[Options]
Are indicated by square brackets and are not required in all circumstances. But there are scenarios where certain combinations of options must be used.
Expand All @@ -19,6 +19,11 @@ you **cannot** also use the `--server` or `--database` options.

And if you use the `--database` option you **must** also use the `--server` option.

## Values with spaces
If you need to pass a value with spaces, for example if you have a database called **Adventure Works** you would surround that value with quotes.

eg. `--database "Adventure Works"`

:::info
Using an invalid combination of options should generate a meaningful error message explaining what the problem is
:::
29 changes: 27 additions & 2 deletions docs/features/options/options-window-standard.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ These setting control the bahaviour of the automatic metadata refresh
| Prompt before refreshing Metadata | Controls whether DAX Studio will show a prompt before refreshing metadata | False |


## Detect Metadata Changes
### Detect Metadata Changes

These settings control which connection types DAX Studio will automatically check for metadata changes

Expand All @@ -98,7 +98,7 @@ These settings control which connection types DAX Studio will automatically chec
| Network Connections | For any connections to SSAS | true |
| Cloud Connections | For any connections to data sources that start with asazure:// or powerbi:// | false |

## Scrollbars
### Scrollbars

| **Setting** | **Description** | **Default** |
| --- | --- | --- |
Expand Down Expand Up @@ -170,6 +170,7 @@ DAX Studio keeps a log of recently executed commands (both successful and failed

## Results

### Results - Grid
These settings change settings for the Results window

| **Setting** | **Description** | **Default** |
Expand All @@ -180,6 +181,12 @@ These settings change settings for the Results window
| Font Size | This is the default size for the results font | 11pt |
| Scale Font with Editor | When this option is selected increasing the zoom factor on the editor will also increase the zoom for the results pane | true |

### Results - Excel File
| **Setting** | **Description** | **Default** |
| --- | --- | --- |
| Always write cell references| This setting adds extra metadata to the excel file which helps compatibility with more external applications that read xlsx data, but it does also increase the file size. | True |
| Use Zip64 | Enables writing xlsx files larger than 4Gb, but not all client applications may be able to read these files | False |


## Server Timings

Expand Down Expand Up @@ -221,3 +228,21 @@ This setting controls the behavours of the various tracing features.



## Vertipaq Analyzer

| **Setting** | **Description** | **Default** |
| --- | --- | --- |
|Include TOM| this option will include a copy of the current data model's .bim file (which is just metadata) in the .vpax file| True |
|Read Statistics from data| This will cause Vertipaq Analyzer to issue more accurate, but more expensive queries to the data source | True |
|Read statistics from DirectQuery tables| Specifies whether or not to gather statistics from Direct Query tables | False |
|Direct Lake Behaviour| Determines how the Read statistics from data behaves for Direct Lake models [more details](/docs/features/model-metrics/#metric-options-dialog)| ResidentOnly |
|Sample Referential Integrity| The number of example missing keys to display. Note: these are only shown when viewing metrics, when you save a vpax file this information is not included | 3 |
|Do not show options dialog| Specifies whether to show the Options dialog when viewing or exporting metrics. This setting can also be set when the user ticks the option to not show this dialog again | False |
|Statistics Column Batch Size| The number of columns to include in each batch when collecting statistics. For large Direct Lake models it may be necessary to reduce this amount to avoid out of memory issues | 50 |
|Table/Column name display in Columns tab| Specifies how the table & column names are shown in the Columns tab | combined as Table-Column|

## Preview Features

**Show Debug Commas** - turning this option on replaces the **Swap Delimiters** command in the ribbon with the **Debug Commas** command

**Show XMLA Commands** - will show command events in the All Queries trace

0 comments on commit ed29574

Please sign in to comment.