Skip to content

Commit fbc82b4

Browse files
committed
add sample outputs for all sp
1 parent ecf7b43 commit fbc82b4

File tree

7 files changed

+26
-4
lines changed

7 files changed

+26
-4
lines changed

docs/assets/sp_estindex_output.png

31.3 KB
Loading

docs/assets/sp_helpme_output.PNG

127 KB
Loading
221 KB
Loading

docs/sp_doc.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
* [Purpose](#purpose)
1111
* [Arguments](#arguments)
1212
* [Usage](#usage)
13-
* [Sample](#sample)
13+
* [Output](#output)
1414
* [Contributing](#contributing)
1515
* [More](#more)
1616

@@ -91,9 +91,9 @@ EXEC sys.sp_addextendedproperty @name=N'@ExtendedPropertyName',
9191
@level1name=N'sp_doc'
9292
```
9393

94-
## Sample
94+
## Output
9595

96-
Output for the [WideWorldImporters database][sample].
96+
Sample output for the [WideWorldImporters database][sample].
9797

9898
*Note: Slight changes may be made to this database to better demo script capabilities.*
9999

docs/sp_estindex.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
* [Purpose](#purpose)
1111
* [Arguments](#arguments)
1212
* [Usage](#usage)
13+
* [Output](#output)
1314
* [Contributing](#contributing)
1415
* [More](#more)
1516

@@ -50,6 +51,14 @@ EXEC dbo.sp_estindex @SchemaName = 'dbo', @tableName = 'Marathon', @IndexColumns
5051
EXEC dbo.sp_estindex @tableName = 'Marathon', @IndexColumns = 'racer_id, finish_time', @Filter = 'WHERE racer_id IS NOT NULL', @FillFactor = 90;
5152
```
5253

54+
## Output
55+
56+
For `[Sales].[Invoices]` in WorldWideImporters:
57+
58+
*Note: There is no missing index match in this example, so the penultimate result set is empty.*
59+
60+
![sp_estindex output](assets/sp_estindex_output.png)
61+
5362
## Contributing
5463

5564
Missing a feature? Found a bug? Open an [issue][issue] to get some :heart:

docs/sp_helpme.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,15 @@ Changes from the original include:
3838
Basic example:
3939

4040
```tsql
41-
EXEC sp_helpme 'dbo.Sales';
41+
EXEC sp_helpme 'Sales.Invoices';
4242
```
4343

44+
## Output
45+
46+
For `[Sales].[Invoices]` in WideWorldImporters:
47+
48+
![sp_helpme output](assets/sp_helpme_output.png)
49+
4450
## Contributing
4551

4652
Missing a feature? Found a bug? Open an [issue][issue] to get some :heart:

docs/sp_sizeoptimiser.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
* [Purpose](#purpose)
1111
* [Arguments](#arguments)
1212
* [Usage](#usage)
13+
* [Output](#output)
1314
* [Checks](#checks)
1415
* [Contributing](#contributing)
1516
* [More](#more)
@@ -51,6 +52,12 @@ EXEC [dbo].[sp_sizeoptimiser] @IncludeDatabases = @includeDatabases;
5152
GO
5253
```
5354

55+
## Output
56+
57+
For WorldWideImporters:
58+
59+
![sp_sizeoptimiser output](assets/sp_sizeoptimiser_output.png)
60+
5461
## Checks
5562

5663
There are 17 checks currently supported:

0 commit comments

Comments
 (0)