Skip to content

Commit baafa8d

Browse files
committed
Enhance documentation for New-SqlDscDatabaseSnapshot cmdlet to clarify automatic file group and file generation based on source database structure
1 parent 4b60a75 commit baafa8d

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

source/Public/New-SqlDscDatabaseSnapshot.ps1

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,10 @@
2727
Specifies an array of DatabaseFileGroupSpec objects that define the file groups
2828
and data files for the database snapshot. Each DatabaseFileGroupSpec contains the
2929
file group name and an array of DatabaseFileSpec objects for the sparse files.
30-
When not specified, SQL Server will create sparse files in the default data
31-
directory with automatically generated names.
30+
When not specified, the cmdlet automatically generates DatabaseFileGroupSpec
31+
and DatabaseFileSpec entries based on the source database's file structure,
32+
resulting in sparse files being created in the default data directory with
33+
automatically generated names.
3234
3335
.PARAMETER Force
3436
Specifies that the snapshot should be created without any confirmation.
@@ -77,11 +79,18 @@
7779
.INPUTS
7880
`[Microsoft.SqlServer.Management.Smo.Server]`
7981
82+
Specifies the SQL Server connection object to create the snapshot in.
83+
84+
.INPUTS
8085
`[Microsoft.SqlServer.Management.Smo.Database]`
8186
87+
Specifies the source database object to create a snapshot from.
88+
8289
.OUTPUTS
8390
`[Microsoft.SqlServer.Management.Smo.Database]`
8491
92+
Returns the newly created database snapshot object.
93+
8594
.NOTES
8695
This command is for snapshot creation only and does not support modification
8796
of existing snapshots.

0 commit comments

Comments
 (0)