Skip to content

Commit 882947a

Browse files
authored
Merge pull request #305 from clairecadman/sqlserver250_docs
(MODULES-8761) Docs release review
2 parents 09388da + 5852fc3 commit 882947a

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1188,40 +1188,40 @@ Use this parameter — especially when using the `fuzzy_match` parameter — to
11881188

11891189
* **instance_name**
11901190

1191-
The name of the instance to start a job on. The value defaults to the default instance on the machine.
1191+
The name of the instance. The value defaults to the default instance on the machine.
11921192
Refer to named instances by either the short name of the instance or by `<COMPUTERNAME>\<INSTANCE_NAME>`.
11931193
Specifying an instance name will access only that instance.
1194-
Pass the values `.`, `MSSQLSERVER`, the node name, or leave blank refer to only the default instance.
1195-
This is an optional parameter which accepts a single string or array of strings as input.
1194+
Pass the values `.`, `MSSQLSERVER`, the node name, or leave blank which will refer to the default instance.
1195+
This is an optional parameter which accepts a single string or an array of strings as input.
11961196

11971197
* **job_name**
11981198

1199-
The name of a job to start. By default job names must be exact.
1200-
See the `fuzzy_match` parameter below for pattern matching job names.
1201-
This parameter is required and will accept a string or an array of strings as input.
1199+
The name of a job. By default, the job names must be exact.
1200+
See the `fuzzy_match` parameter below for an example of pattern matching job names.
1201+
This parameter is required and accepts a string or an array of strings as input.
12021202

12031203
* **fuzzy_match**
12041204

1205-
Modifies the behavior of the `job_name` parameter so that the value given is a job name pattern to match.
1206-
Searches are done using the PowerShell `-match` operator.
1207-
For example, if the string `backup` is passed to the `job_name` parameter, while `fuzzy_match` is set to true, jobs such as `Daily Backup` and `System Backup` will be matched and started.
1205+
Modifies the behavior of the `job_name` parameter so that the value given is matched to the job name pattern.
1206+
The `fuzzy_match` paremeter searches using the PowerShell `-match` operator.
1207+
For example, when `fuzzy_match` is set to true, if you pass the string `backup` to the `job_name` parameter, jobs such as `Daily Backup` and `System Backup` will be matched and executed.
12081208
This is an optional parameter which accepts either `true` or `false`. Its default value is false.
12091209

12101210
* **step**
12111211

1212-
The step number you would like to execute. Leave blank to execute at the first step.
1213-
Keep in mind that these job step numbers refer to a zero based array of job step.
1214-
If you want to execute a job starting at step 5 you need to pass 4 to this parameter.
1215-
This is because contrary to the SQLServer user interface in many places, the programming objects
1212+
The step number you want to execute. Leave blank to execute the first step.
1213+
Note that these job step numbers refer to a zero based array of job steps.
1214+
To execute a job starting at step 5, pass step 4 to this parameter.
1215+
This is because contrary to the SQLServer user interface, the programming objects
12161216
this task leverages are zero based.
12171217

12181218
* **wait**
12191219

1220-
This parameter tells the task to wait until a set of jobs has completed and then return job data.
1221-
All matched jobs are started concurrently and the task waits in a loop for all of them to complete.
1222-
If this parameter is not set to true, then matched jobs are started and the task returns job data indicating that the job is executing.
1223-
Keep in mind that jobs that complete rapidly may complete before the task has finished executing.
1224-
This could result in returned job information indicating the job is currently idle. Please inspect the `lastRunDate` property of the job and the steps to determine if the job was executed successfully.
1220+
This parameter tells the task to wait until a set of jobs has been completed before returning the job data.
1221+
All matched jobs start concurrently. The task waits in a loop for all of the jobs to complete.
1222+
If this parameter is not set to true, matched jobs are started and the task returns job data indicating that the job has started.
1223+
Note that if a job completes quickly, it may finish before the task has finished executing.
1224+
This could result in false information that the job is idle. If this happens, check the `lastRunDate` property of the job to see if it was executed successfully.
12251225
This is a boolean parameter that defaults to false.
12261226

12271227
### Microsoft SQL Server terms

0 commit comments

Comments
 (0)