ru/Microsoft.SqlServer.Management.PSProvider.dll-Help.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
<?xml version="1.0" encoding="utf-8"?>

<helpItems schema="maml">

<!-- v 1.3.0.36 -->
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
<command:details>
<command:name>
                   Decode-SqlName
</command:name>
<maml:description>
<maml:para>После получения идентификатора, закодированного в формат, используемый в путях PowerShell, возвращает исходный идентификатор SQL Server.</maml:para>
</maml:description>
<maml:copyright>
<maml:para></maml:para>
</maml:copyright>
<command:verb>Decode</command:verb>
<command:noun>SqlName</command:noun>
<dev:version></dev:version>
</command:details>
<maml:description>
<maml:para>После получения идентификатора, закодированного в формат, используемый в путях PowerShell, возвращает раскодированный идентификатор SQL Server. Идентификаторы SQL Server с разделителями могут содержать особые символы, которые обычно не поддерживаются в именах объектов PowerShell. Эти символы расширенного набора требуется кодировать в шестнадцатеричный вид или экранировать с помощью символа `. С другой стороны, экранирование некоторых символов, таких как символ двоеточия (:), невозможно. Шестнадцатеричное кодирование имеет формат %nn. Команда Decode-SqlName преобразует следующие кодировки в соответствующие символы:    %5C-\    %3A-:    %2E-.    %2F-/   %25-%    %3C-&lt;    %3E-&gt;    %2A-*    %3F-?    %5B-[    %5D-]    %7C-|</maml:para>
</maml:description>
<!-- Cmdlet syntax section-->
<command:syntax>
<command:syntaxItem>
<maml:name>Decode-SqlName</maml:name>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="2">
<maml:name>SqlName</maml:name>
<maml:description>
<maml:para>Идентификатор SQL Server для переформатирования.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<!-- Cmdlet parameter section  -->
<command:parameters>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="2">
<maml:name>SqlName</maml:name>
<maml:description>
<maml:para>Идентификатор SQL Server для переформатирования.</maml:para>

</maml:description>
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
<dev:type>
<maml:name>string</maml:name>
<maml:uri/>
</dev:type>
<dev:defaultValue></dev:defaultValue>
</command:parameter>
</command:parameters>
<!-- Input - Output section-->
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>String</maml:name>
<maml:uri/>
<maml:description />
</dev:type>
<maml:description>
<maml:para>
<!-- description  -->

</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
<maml:description />
</dev:type>   
<maml:description>
<maml:para>
<!-- description  -->

</maml:para>
</maml:description> 
</command:returnValue>
</command:returnValues>
<!-- Error section-->
<command:terminatingErrors />
<command:nonTerminatingErrors />
<!-- Notes section  -->
<maml:alertSet>
<maml:title></maml:title>
<maml:alert>
<maml:para>
                          
                        </maml:para>
</maml:alert>
<maml:alert>
<maml:para></maml:para>
</maml:alert>
</maml:alertSet>
 <!-- Example section  -->
<command:examples>

<command:example>
<maml:title>
-------------------------- EXAMPLE 1 --------------------------
</maml:title> 
<maml:introduction>
<maml:para>C:\PS&gt;</maml:para>
</maml:introduction> 
   <dev:code>
Decode-SqlName -SqlName &#34;My%3ATable`/&#34;

My:Table/                        </dev:code>
        <dev:remarks>
                                <maml:para>Описание</maml:para>
                                <maml:para>-----------</maml:para>
           <maml:para>Декодирует идентификатор SQL Server, имеющий закодированное шестнадцатеричное представление для символа : . PowerShell также удаляет символ экранирования (`) из экранированного символа /.</maml:para>
                        <maml:para></maml:para>
                        <maml:para></maml:para>
                        <maml:para></maml:para>
                        <maml:para></maml:para>
   </dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText></command:commandText>
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<!-- Link section  -->
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>SQL Server Books Online: Using SQL Server Identifiers in PowerShell</maml:linkText>
<maml:uri/>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Encode-SqlName</maml:linkText>
<maml:uri/>
</maml:navigationLink>
</maml:relatedLinks>
</command:command>

<!-- v 1.3.0.36 -->
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
<command:details>
<command:name>
                   Encode-SqlName
</command:name>
<maml:description>
<maml:para>Кодирует символы расширенного набора в именах SQL Server в форматы, которые можно использовать в путях PowerShell.</maml:para>
</maml:description>
<maml:copyright>
<maml:para></maml:para>
</maml:copyright>
<command:verb>Encode</command:verb>
<command:noun>SqlName</command:noun>
<dev:version></dev:version>
</command:details>
<maml:description>
<maml:para>Кодирует особые символы в именах SQL Server в форматы, которые можно использовать в путях PowerShell. Идентификаторы SQL Server с разделителями могут содержать символы, которые обычно не поддерживаются в именах объектов PowerShell. При использовании идентификаторов с разделителями в путях поставщиков SQL Server символы расширенного набора требуется либо кодировать в шестнадцатеричное представление, либо экранировать с помощью символа `. С другой стороны, экранирование некоторых символов, таких как символ двоеточия (:), невозможно. Закодированный в шестнадцатеричное представление символ имеет формат %nn. Символы, кодируемые командой Encode-SqlName: \:./%&lt;&gt;*?[]|</maml:para>
</maml:description>
<!-- Cmdlet syntax section-->
<command:syntax>
<command:syntaxItem>
<maml:name>Encode-SqlName</maml:name>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="2">
<maml:name>SqlName</maml:name>
<maml:description>
<maml:para>Идентификатор SQL Server для кодирования.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<!-- Cmdlet parameter section  -->
<command:parameters>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="2">
<maml:name>SqlName</maml:name>
<maml:description>
<maml:para>Идентификатор SQL Server для кодирования.</maml:para>

</maml:description>
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
<dev:type>
<maml:name>string</maml:name>
<maml:uri/>
</dev:type>
<dev:defaultValue></dev:defaultValue>
</command:parameter>
</command:parameters>
<!-- Input - Output section-->
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>String</maml:name>
<maml:uri/>
<maml:description />
</dev:type>
<maml:description>
<maml:para>
<!-- description  -->

</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
<maml:description />
</dev:type>   
<maml:description>
<maml:para>
<!-- description  -->

</maml:para>
</maml:description> 
</command:returnValue>
</command:returnValues>
<!-- Error section-->
<command:terminatingErrors />
<command:nonTerminatingErrors />
<!-- Notes section  -->
<maml:alertSet>
<maml:title></maml:title>
<maml:alert>
<maml:para>
                          
                        </maml:para>
</maml:alert>
<maml:alert>
<maml:para></maml:para>
</maml:alert>
</maml:alertSet>
 <!-- Example section  -->
<command:examples>

<command:example>
<maml:title>
-------------------------- EXAMPLE 1 --------------------------
</maml:title> 
<maml:introduction>
<maml:para>C:\PS&gt;</maml:para>
</maml:introduction> 
   <dev:code>
Encode-SqlName -SqlName &#34;My:Table/&#34;

My%3ATable%2F                        </dev:code>
        <dev:remarks>
                                <maml:para>Описание</maml:para>
                                <maml:para>-----------</maml:para>
           <maml:para>Кодирует имя таблицы SQL Server, которое содержит символы : и /.</maml:para>
                        <maml:para></maml:para>
                        <maml:para></maml:para>
                        <maml:para></maml:para>
                        <maml:para></maml:para>
   </dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText></command:commandText>
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<!-- Link section  -->
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>SQL Server Books Online: Using SQL Server Identifiers in PowerShell</maml:linkText>
<maml:uri/>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Decode-SqlName</maml:linkText>
<maml:uri/>
</maml:navigationLink>
</maml:relatedLinks>
</command:command>

<!-- v 1.3.0.36 -->
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
<command:details>
<command:name>
                   Convert-UrnToPath
</command:name>
<maml:description>
<maml:para>Преобразует универсальное имя ресурса управляющего объекта SQL Server в путь поставщика SQL Server PowerShell.</maml:para>
</maml:description>
<maml:copyright>
<maml:para></maml:para>
</maml:copyright>
<command:verb>Convert</command:verb>
<command:noun>UrnToPath</command:noun>
<dev:version></dev:version>
</command:details>
<maml:description>
<maml:para>Преобразует универсальное имя ресурса объекта управляющего объекта SQL Server в путь поставщика SQL Server. У управляющих объектов SQL Server есть свойство URN, которое возвращает строку, указывающую их расположение в иерархии объектов SQL Server.  Если узлами в свойстве URN являются идентификаторы SQL Server с разделителями, в которых есть символы расширенного набора, неподдерживаемые в узлах путей PowerShell, эти дополнительные символы кодируются в соответствующие шестнадцатеричные представления. Например, имя таблицы «My:Table» после кодирования будет выглядеть так: «My%3ATable».</maml:para>
</maml:description>
<!-- Cmdlet syntax section-->
<command:syntax>
<command:syntaxItem>
<maml:name>Convert-UrnToPath</maml:name>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named">
<maml:name>Urn</maml:name>
<maml:description>
<maml:para>Строка символов, содержащая уникальное имя ресурса (URN) SQL Server.   URN SQL Server  это строка, которая идентифицирует расположение объекта в иерархии SQL Server. В URN содержатся те же данные, что и в пути SQL Server PowerShell, отличаются они только форматом. У управляющих объектов SQL Server есть свойство Urn.</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<!-- Cmdlet parameter section  -->
<command:parameters>
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named">
<maml:name>Urn</maml:name>
<maml:description>
<maml:para>Строка символов, содержащая уникальное имя ресурса (URN) SQL Server.   URN SQL Server  это строка, которая идентифицирует расположение объекта в иерархии SQL Server. В URN содержатся те же данные, что и в пути SQL Server PowerShell, отличаются они только форматом. У управляющих объектов SQL Server есть свойство Urn.</maml:para>

</maml:description>
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
<dev:type>
<maml:name>string</maml:name>
<maml:uri/>
</dev:type>
<dev:defaultValue></dev:defaultValue>
</command:parameter>
</command:parameters>
<!-- Input - Output section-->
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>String</maml:name>
<maml:uri/>
<maml:description />
</dev:type>
<maml:description>
<maml:para>
<!-- description  -->
Строка символов, содержащая URN управляющего объекта SQL Server.
</maml:para>
</maml:description>
</command:inputType>
</command:inputTypes>
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
<maml:description />
</dev:type>   
<maml:description>
<maml:para>
<!-- description  -->
Строка символов, содержащая путь поставщика SQL Server PowerShell.
</maml:para>
</maml:description> 
</command:returnValue>
</command:returnValues>
<!-- Error section-->
<command:terminatingErrors />
<command:nonTerminatingErrors />
<!-- Notes section  -->
<maml:alertSet>
<maml:title></maml:title>
<maml:alert>
<maml:para>
                          
                        </maml:para>
</maml:alert>
<maml:alert>
<maml:para></maml:para>
</maml:alert>
</maml:alertSet>
 <!-- Example section  -->
<command:examples>

<command:example>
<maml:title>
-------------------------- EXAMPLE 1 --------------------------
</maml:title> 
<maml:introduction>
<maml:para>C:\PS&gt;</maml:para>
</maml:introduction> 
   <dev:code>
Set-Location SQLSERVER:\SQL\MyComputer\MyInstance\Databases\AdventureWorks2012
Convert-UrnToPath -Urn (Get-Item .).Urn.ToString()

SQLSERVER:\SQL\MyComputer\MyInstance\Databases\AdventureWorks2012                        </dev:code>
        <dev:remarks>
                                <maml:para>Описание</maml:para>
                                <maml:para>-----------</maml:para>
           <maml:para>Возвращает строку символов, содержащую текущий путь. В этом примере для возврата Urn в виде строки символов используется функция ToString() свойства Urn объекта SMO.</maml:para>
                        <maml:para></maml:para>
                        <maml:para></maml:para>
                        <maml:para></maml:para>
                        <maml:para></maml:para>
   </dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText></command:commandText>
</command:commandLine>
</command:commandLines>
</command:example>

<command:example>
<maml:title>
-------------------------- EXAMPLE 2 --------------------------
</maml:title> 
<maml:introduction>
<maml:para>C:\PS&gt;</maml:para>
</maml:introduction> 
   <dev:code>
Set-Location ( Convert-UrnToPath -Urn &#34;Server[@Name='MyComputer']/Database[@Name='AdventureWorks']/Table[@Name='Address' and @Schema = 'Person']&#34; ) </dev:code>
        <dev:remarks>
                                <maml:para>Описание</maml:para>
                                <maml:para>-----------</maml:para>
           <maml:para>Устанавливает путь в расположение, указанное в URN управляющего объекта SQL Server.</maml:para>
                        <maml:para></maml:para>
                        <maml:para></maml:para>
                        <maml:para></maml:para>
                        <maml:para></maml:para>
   </dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText></command:commandText>
</command:commandLine>
</command:commandLines>
</command:example>

<command:example>
<maml:title>
-------------------------- EXAMPLE 3 --------------------------
</maml:title> 
<maml:introduction>
<maml:para>C:\PS&gt;</maml:para>
</maml:introduction> 
   <dev:code>
Set-Location SQLSERVER:\SQL\MyComputer\DEFAULT\Databases
foreach ($Item in Get-ChildItem) { $Item.Urn.ToString() | Convert-UrnToPath}

SQLSERVER:\SQL\MyComputer\DEFAULT\Databases\AdventureWorks2012                        </dev:code>
        <dev:remarks>
                                <maml:para>Описание</maml:para>
                                <maml:para>-----------</maml:para>
           <maml:para>Возвращает набор строк символов, каждая из которых содержит путь к базе данных в экземпляре по умолчанию. Использует конвейер для передачи URN текущего узла команде Convert-UrnToPath</maml:para>
                        <maml:para></maml:para>
                        <maml:para></maml:para>
                        <maml:para></maml:para>
                        <maml:para></maml:para>
   </dev:remarks>
<command:commandLines>
<command:commandLine>
<command:commandText></command:commandText>
</command:commandLine>
</command:commandLines>
</command:example>
</command:examples>
<!-- Link section  -->
<maml:relatedLinks>
<maml:navigationLink>
<maml:linkText>Decode-SqlName</maml:linkText>
<maml:uri/>
</maml:navigationLink>
<maml:navigationLink>
<maml:linkText>Encode-SqlName</maml:linkText>
<maml:uri/>
</maml:navigationLink>
</maml:relatedLinks>
</command:command>

<!-- v 1.3.0.34 -->
<providerHelp>

<Name>
SQLServer
</Name>

<Drives>
<Para>SQLSERVER</Para>
</Drives>
<Synopsis>
Access SQL Server instances and their databases.
</Synopsis>

<DetailedDescription>
<para>The Microsoft SQL Server PowerShell provider lets you manage the configuration of instances of the SQL Server Database Engine and the objects in those instances. The SQL Server PowerShell provider implements separate path hierarchies for different classes of objects that are supported by the SQL Server management object models.

The SQL Server PowerShell provider implements one virtual drive named SQLSERVER:. The SQLSERVER: drive has several folders: \SQL, \SQLPolicy, \SQLRegistration, \Utility, \DAC, \DataCollection, \IntegrationServices, and SQLAS.

The SQLServer:\SQL folder lets you navigate to instances of the SQL Server Database Engine and manage the objects in the instances, such as logins, tables, functions, jobs, queues, and mail agents. The SQL folder operates using the objects in these namespaces:

  Microsoft.SqlServer.Management.SMO
  Microsoft.SqlServer.Management.SMO.Agent
  Microsoft.SqlServer.Management.SMO.Broker
  Microsoft.SqlServer.Management.SMO.Mail

The SQLSERVER:\SQLPolicy folder lets you navigate to instances of the Database Engine that contains a Policy-Based Management policy store and manage objects such as policies and facets. The SQLPolicy folder operates using the objects in the Microsoft.SqlServer.Management.Dmf and Microsoft.SqlServer.Management.Facets namespaces.

The SQLSERVER:\SQLRegistration folder lets you navigate to instances of the Database Engine and manage Registered Server objects such as server groups and registered servers. The SQLRegistration folder operates using the objects in the Microsoft.SqlServer.Management.RegisteredServers and Microsoft.SqlServer.Management.RegSvrEnum namespace.

The SQLSERVER:\Utility folder lets you navigate to the managed instances and data-tier applications registered in the SQL Server Utility. The Utility folder operates using the objects in the Microsoft.SqlServer.Management.Utility namespace.

The SQLServer:\DAC folder lets you navigage through data-tier applications objects such as DAC package files. The DAC folder operates using the objects in the Microsoft.SqlServer.Management.DAC namespace.

The SQLServer:\DataCollection folder lets you navigate to instances of the Database Engine and manage Data Collector objects such as collection sets and configuration stores. The DataCollection folder operates using the objects in the Microsoft.SqlServer.Management.Collector namespace.

The SQLServer:\IntegrationServices folder lets you manage SQL Server Integration Services objects such as projects, packages, and environments. The IntegrationServices folder operates using the Microsoft.SqlServer.Management.IntegrationServices namespace.

The SQLServer:\SQLAS folders lets you manage SQL Server Analysis Services objects such as aggregations, dimensions, and cubes. The SQLAS folder operates using the Microsoft.AnalysisServices namespace.

You can navigate the SQLSERVER: paths by using PowerShell path cmdlets such as Get-Location, Set-Location, and Get-ChildItem.

The leading part of a SQLSERVER:\SQL path has the form SQLSERVER:\SQL\ComputerName\InstanceName. You must always specify an instance name, even for default instances. Specify DEFAULT for default instance names. The path nodes following the InstanceName alternate between object classes and object names. Schemas are not represented as an object class. When you specify a path node for top level objects in schemas, such as tables or views, the node name must be in the format SchemaName.ObjectName. For example, this is the path to the AddressID column in the Address table of the Person schema:

SQLSERVER:\SQL\MyComputer\DEFAULT\Databases\AdventureWorks\Tables\Person.Address\Columns\AddressID

To save typing, you can create your own PowerShell drives that map over the first several nodes of an SQL path.

The information that is returned by Get-ChildItem depends on which part of the path the cmdlet is executed from:

Returns the local computer name and the list of computers to which you have opened Database Engine connections by using WMI:
PS SQLSERVER:\SQL&gt; Get-ChildItem

Returns the list of instances on the specified computer:
PS SQLSERVER:\SQL\ComputerName&gt; Get-ChildItem

Returns the list of top-level object types from the instance, such as Logins and Databases:
PS SQLSERVER:\SQL\ComputerName\InstanceName&gt; Get-ChildItem.

With the SQL Server PowerShell provider, you manage the objects that are exposed in SQL Server paths by using the SQL Server management object model methods and properties for that class of object. For example, you can use the methods of the Microsoft.SQLServer.Management.SMO.Database class to perform actions such as creating, altering, and dropping databases. You can also use the class properties to query the current state of the objects. Use the Get-Member cmdlet to get a list of the methods and properties that are supported for the various objects. For information about the classes, see the namespace reference sections in the SQL Server Books Online.

You cannot select, insert, update, or delete data in tables and views by using the SQL Server PowerShell provider. For example, there is no Select() or Insert() method for tables. Use the Invoke-Sqlcmd cmdlet to access and change the data in tables and views.

By default, the SQL Server PowerShell provider opens Windows Authentication connections by using the credentials of the Windows account that is running the PowerShell session. See SQL Server Books Online for information about opening a SQL Server Authentication connection using the provider.

In complex databases, the lists returned by Get-ChildItem and the PowerShell tab-completion lists can be very large. You can use three system variables created by the SQL Server PowerShell provider to control the size of these lists:

$SqlServerMaximumTabCompletion = n
n is an integer that specifies the maximum number of objects in a tab completion list. The default is 0, which means all objects are returned.

$SqlServerMaximumChildItems = n
n is an integer that specifies the maximum number of objects returned when you run Get-ChildItem on SQL Server path nodes. The default is 0, which means all objects are returned.

$SQLServerIncludeSystemObjects = { $True | $False }
Specifies whether SQL Server system objects are returned by Get-ChildItem or included in tab-completion lists. The default is $True</para>
</DetailedDescription>

<Capabilities>
<para></para>
</Capabilities>
<Filters>
<para></para>
</Filters>
<Notes>
SQL Server delimited identifiers are object names that are enclosed in brackets ([Table:Name]) or quotation marks (&#34;View&gt;Name&#34;). Delimited identifiers can contain any Unicode character. The special characters in these names must be either encoded to their hexadecimal representation or escaped for use in PowerShell paths. The hexadecimal encoding for characters uses the format %nn. An example of encoding the colon (:)character in the name &#34;Table:Name&#34; is:
Set-Location &#34;Table%3AName&#34;.

The PowerShell escape character is the back tick (`) character that is typically on the key at the top left of the keyboard. An example of escaping an extended character is as follows:
Set-Location &#34;View`&gt;Name&#34;

Certain characters, such as the colon character (:), cannot be escaped. They must be encoded. The SQL Server PowerShell provider snapin implements two cmdlets to help encode and decode delimited identifiers: Encode-SqlName and Decode-SqlName.

You must supply a registry or directory object for the -Type parameter when using these core cmdlets with a SQLRegistration: drive: Copy-Object, Move-Object, New-Object, Remove-Object, and Rename-Object.
</Notes>
<Tasks>
<Task>
   <Title>
Navigating SQLSERVER:\SQL paths
</Title>

    <Description>
<para></para>
</Description>

<Examples>
                        <Example>
                         <Title>
-------------------------- EXAMPLE 1 --------------------------
</Title> 
<Introduction>
<para>This example uses the Set-Location cmdlet to change the path to the SQL folder.</para>
</Introduction> 
   <Code>
Set-Location SQLSERVER:\SQL
</Code>
<Remarks>
<para></para>
   </Remarks>
</Example>
                        <Example>
                         <Title>
-------------------------- EXAMPLE 2 --------------------------
</Title> 
<Introduction>
<para>This example uses Set-Location to change the path to a default instance of the Database Engine</para>
</Introduction> 
   <Code>
Set-Location SQLSERVER:\SQL\MyComputer\DEFAULT
</Code>
<Remarks>
<para></para>
   </Remarks>
</Example>
                        <Example>
                         <Title>
-------------------------- EXAMPLE 3 --------------------------
</Title> 
<Introduction>
<para>This example uses Set-Location to change the path to the AdventureWorks sample database.</para>
</Introduction> 
   <Code>
Set-Location SQLSERVER:\SQL\MyComputer\MyInstance\Databases\AdventureWorks
</Code>
<Remarks>
<para></para>
   </Remarks>
</Example>
</Examples>
</Task>
<Task>
   <Title>
Build a New PowerShell Drive
</Title>

    <Description>
<para></para>
</Description>

<Examples>
                        <Example>
                         <Title>
-------------------------- EXAMPLE 1 --------------------------
</Title> 
<Introduction>
<para>If you are going to do a lot of work in the AdventureWorks database, create a new AWDB: drive to save typing.</para>
</Introduction> 
   <Code>
New-PSDrive -Name AWDB -Root SQLSERVER:\SQL\MyComputer\DEFAULT\Databases\AdventureWorks -PSProvider SQLServer
</Code>
<Remarks>
<para></para>
   </Remarks>
</Example>
</Examples>
</Task>
<Task>
   <Title>
Get the Methods and Properties of a SQL Server Object
</Title>

    <Description>
<para></para>
</Description>

<Examples>
                        <Example>
                         <Title>
-------------------------- EXAMPLE 1 --------------------------
</Title> 
<Introduction>
<para>This command sets a variable to the SMO Database class and then gets a list of the methods and properties supported by the class.</para>
</Introduction> 
   <Code>
$MyVar = New-Object Microsoft.SqlServer.Management.SMO.Database
$MyVar | Get-Member -Type Methods
$MyVar | Get-Member -Type Properties
</Code>
<Remarks>
<para></para>
   </Remarks>
</Example>
                        <Example>
                         <Title>
-------------------------- EXAMPLE 2 --------------------------
</Title> 
<Introduction>
<para>This command navigates to the database node in an SQL-based path and get s a list of the properties that are supported for databases.</para>
</Introduction> 
   <Code>
Set-Location SQLSERVER:\SQL\MyComputer\DEFAULT\Databases
Get-Item . | Get-Member -Type Properties
</Code>
<Remarks>
<para></para>
   </Remarks>
</Example>
</Examples>
</Task>
<Task>
   <Title>
Filter SQL Server Objects by Using SMO Properties
</Title>

    <Description>
<para></para>
</Description>

<Examples>
                        <Example>
                         <Title>
-------------------------- EXAMPLE 1 --------------------------
</Title> 
<Introduction>
<para>This command lists only the tables that are in the AdventureWorks Sales schema.</para>
</Introduction> 
   <Code>
Set-Location SQLSERVER:\SQL\MyComputer\DEFAULT\Databases\AdventureWorks\Tables
Get-ChildItem | WHERE {$_.Schema -eq &#34;Sales&#34;}
</Code>
<Remarks>
<para></para>
   </Remarks>
</Example>
</Examples>
</Task>
<Task>
   <Title>
Generate Scripts That Create SQL Server Objects
</Title>

    <Description>
<para></para>
</Description>

<Examples>
                        <Example>
                         <Title>
-------------------------- EXAMPLE 1 --------------------------
</Title> 
<Introduction>
<para>This script creates a Views.sql file that contains the CREATE VIEW statements that are required to recreate all of the views that are defined in AdventureWorks.</para>
</Introduction> 
   <Code>
Remove_Item c:\PowerShell\Views.sql
Set-Location SQLSERVER:\SQL\MyComputer\DEFAULT\Databases\AdventureWorks\Views
foreach ($Item in Get-ChildItem) {$Item.Script() | Out-File -Filepath c:\PowerShell\Views.sql -append }
</Code>
<Remarks>
<para></para>
   </Remarks>
</Example>
</Examples>
</Task>
<Task>
   <Title>
Use SMO to Manage SQL Server Objects
</Title>

    <Description>
<para></para>
</Description>

<Examples>
                        <Example>
                         <Title>
-------------------------- EXAMPLE 1 --------------------------
</Title> 
<Introduction>
<para>This script uses SMO to create a database and then query its state.</para>
</Introduction> 
   <Code>
Set-Location SQLSERVER:\SQL\MyComputer\DEFAULT\Databases
$MyVar = New-Object Microsoft.SqlServer.Management.SMO.Database
$MyVar.Parent = (Get-Item ..)
$MyVar.Name = &#34;NewDB&#34;
$MyVar.Create()
$MyVar.State
</Code>
<Remarks>
<para></para>
   </Remarks>
</Example>
</Examples>
</Task>
<Task>
   <Title>
Controlling SQL Server Objects in Tab-completion and Get-ChildItem
</Title>

    <Description>
<para></para>
</Description>

<Examples>
                        <Example>
                         <Title>
-------------------------- EXAMPLE 1 --------------------------
</Title> 
<Introduction>
<para>This script sets the values for the system variables that control the number of SQL Server objects included in tab-completion lists or returned by Get-ChildItem.</para>
</Introduction> 
   <Code>
$SqlServerMaximumTabCompletion = 20
$SqlServerMaximumChildItems = 10
$SqlServerIncludeSystemObjects = $False
dir variable:sqlserver*
</Code>
<Remarks>
<para></para>
   </Remarks>
</Example>
</Examples>
</Task>
</Tasks>
<DynamicParameters>
<DynamicParameter>
<Name></Name>

<CmdletSupported></CmdletSupported>

<Type>
             <Name></Name>
       </Type>

       <Description></Description>

<PossibleValues>
<PossibleValue>
<Value></Value>

<Description>
<para></para>
</Description>

</PossibleValue>
</PossibleValues>
</DynamicParameter>
</DynamicParameters>
<RelatedLinks>
    <navigationLink>
        <linkText>about_provider</linkText>
        <uri/>
    </navigationLink>
    <navigationLink>
        <linkText>Encode-SqlName</linkText>
        <uri/>
    </navigationLink>
    <navigationLink>
        <linkText>Decode-SqlName</linkText>
        <uri/>
    </navigationLink>
    <navigationLink>
        <linkText>Invoke-Sqlcmd</linkText>
        <uri/>
    </navigationLink>
    <navigationLink>
        <linkText>New-PSDrive</linkText>
        <uri/>
    </navigationLink>
    <navigationLink>
        <linkText>Get-Member</linkText>
        <uri/>
    </navigationLink>
    <navigationLink>
        <linkText>Invoke-PolicyEvaluation</linkText>
        <uri/>
    </navigationLink>
</RelatedLinks>

</providerHelp>



</helpItems>