Skip to content

Commit 0738e23

Browse files
committed
readme update
1 parent bed339b commit 0738e23

File tree

1 file changed

+5
-8
lines changed

1 file changed

+5
-8
lines changed

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ Think of this script as an **evidence pack generator**. A strong LLM can then re
6767
```sql
6868
:SETVAR TargetDB "YourDatabaseName"
6969
:SETVAR OutputDir "C:\Temp\DatabaseTuner\" -- directory must already exist
70-
:SETVAR ExportSchema "0" -- 0 or 1
71-
:SETVAR SafeMode "1" -- 0 or 1 (public script defaults to 1)
70+
:SETVAR ExportSchema "1" -- 0 or 1 (1 as default)
71+
:SETVAR SafeMode "1" -- 0 or 1 (1 as default)
7272
```
7373

7474
5. Press **F5** to run the script.
@@ -96,21 +96,18 @@ These variables are defined at the top of the Database Tuner script.
9696
- The directory must already exist. If it does not, `sqlcmd` falls back to printing the Markdown to STDOUT (for example the SSMS Messages tab).
9797

9898
- **`ExportSchema`**
99-
- `0` (default) = do not append a schema appendix.
100-
- `1` = append a schema export to the end of the report. This includes definitions for views, procedures, functions, triggers, tables, constraints, indexes, and more.
99+
- `0` = do not append a schema appendix.
100+
- `1` (default) = append a schema export to the end of the report. This includes definitions for views, procedures, functions, triggers, tables, constraints, indexes, and more.
101101
- This can be very verbose and may include sensitive code. Prefer `0` when sharing externally unless you explicitly need schema context.
102102

103103
- **`SafeMode`**
104104
- `0` = full detail.
105-
- `1` = **Safe Mode ON**. Certain fields are redacted or gated and replaced with `[SafeMode]`. Examples include:
105+
- `1` (default) = **Safe Mode ON**. Certain fields are redacted or gated and replaced with `[SafeMode]`. Examples include:
106106
- Server and instance names.
107107
- Host names and file system paths.
108108
- Some job commands, mail profiles, credentials, and SQL text.
109109
- Temp table schemas do not change; only values are masked. This makes it easier to share reports outside your organisation or with cloud-hosted LLMs.
110110

111-
- **`Version`**
112-
- Free-form label used in the report header and file name (for example `"2.11"` or a date stamp).
113-
114111
These flags also appear in the report header and in the Assistant Brief so the LLM can see how the report was generated.
115112

116113
---

0 commit comments

Comments
 (0)