This repository has been archived by the owner on Dec 1, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathNemiro.Data (ru).XML
5940 lines (5861 loc) · 433 KB
/
Nemiro.Data (ru).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
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>Nemiro.Data</name>
</assembly>
<members>
<member name="T:Nemiro.Data.TableAttribute">
<summary>
Атрибут указывает, что класс реализует таблицу базы данных.
</summary>
<remarks>
<para>Данным атрибутом помечаются классы наследованные от <see cref="T:Nemiro.Data.Sql.BaseObject"/>.</para>
</remarks>
</member>
<member name="M:Nemiro.Data.TableAttribute.#ctor(System.String)">
<summary>
Инициализирует новый экземпляр класса <see cref="T:Nemiro.Data.TableAttribute"/> с указанием имени таблицы.
</summary>
<param name="tableName">Имя таблицы, которая реализована в классе.</param>
</member>
<member name="M:Nemiro.Data.TableAttribute.#ctor(System.String,System.String)">
<summary>
Инициализирует новый экземпляр класса <see cref="T:Nemiro.Data.TableAttribute"/> с указанием имени таблицы и строкой соединения с базой данных.
</summary>
<param name="tableName">Имя таблицы, которая реализована в классе.</param>
<param name="connectionString">Строка соединения с базой данных, либо имя параметра строки соединения в файле конфигурации приложения.</param>
</member>
<member name="P:Nemiro.Data.TableAttribute.TableName">
<summary>
Имя таблицы, которая реализована в классе.
</summary>
</member>
<member name="P:Nemiro.Data.TableAttribute.ConnectionString">
<summary>
Строка соединения с БД (опционально).
</summary>
</member>
<member name="T:Nemiro.Data.Sql.SqlClient">
<summary>
Основной класс для работы с базами данных SQL Server.
</summary>
<remarks>
<para>По умолчанию, при инициализации класса используются параметры из файла конфигурации.
Для web-проектов - <c>web.config</c>; для windows-приложений - <c>app.config</c>.</para>
<para>Поддерживаются следующие параметры:
<list type="bullet">
<item><description>NeData:Sql:ConnectionMode</description></item>
<item><description>NeData:Sql:CommandType</description></item>
<item><description>NeData:Sql:CacheType</description></item>
<item><description>NeData:Sql:CacheDuration (не рекомендуется использовать для установки глобального времени кэширования)</description></item>
<item><description>NeData:Sql:CachePath</description></item>
<item><description>NeData:Sql:CacheBinder</description></item>
<item><description>NeData:Sql:CacheBufferSize</description></item>
<item><description>NeData:Sql:CacheBufferAccessTimeout</description></item>
<item><description>NeData:Sql:CacheAccessTimeout</description></item>
<item><description>NeData:Sql:CacheCustom</description></item>
<item><description>NeData:Sql:CacheCustomArgs</description></item>
</list>
</para>
<para>В приложениях Windows имена параметров нужно записывать без двоеточий, и с учетом регистра.
Например:
<list type="bullet">
<item><description>NeDataSqlCacheTyp</description></item>
<item><description>NeDataSqlAutoTrimmingStrings</description></item>
<item><description>NeDataSqlCachePath</description></item>
<item><description>и т.п.</description></item>
</list>
</para>
<para>
По умолчанию используется строка соединения <c>LocalSqlServer</c>.
В качестве <see cref="P:Nemiro.Data.Sql.SqlClient.ConnectionString"/> можно указывать, как саму строку соединения, так и имя параметра в файле конфигурации.
В web-приложениях строка соединения с именем <c>LocalSqlServer</c> иметь путь к SQL Server по умолчанию.
Для использования параметра <c>LocalSqlServer</c> в веб-приложениях со своей базой данных, которая отличается от базы по умолчанию,
необходимо удалить <c>LocalSqlServer</c> из файла конфигурации и добавить заново (написать код удаления и добавления):
</para>
<code lang="XML">
<remove name="LocalSqlServer"/>
<add
name="LocalSqlServer"
connectionString="Data Source=.\SQLEXPRESS;Initial Catalog=example;Trusted_Connection=True;"
/>
</code>
<para>При работе с классом <see cref="T:Nemiro.Data.Sql.SqlClient"/> рекомендуется использовать оператор <c>using</c> .</para>
<code lang="C#">
using (SqlClient client = new SqlClient())
{
// код работы с данными
}
</code>
<code lang="VB">
Using client As new SqlClient()
' код работы с данными
End Using
</code>
</remarks>
<example>
<list type="table">
<listheader>
<description>Обратите внимание</description>
</listheader>
<item>
<description>Показанные ниже примеры лишь демонстрируют использование класса <see cref="T:Nemiro.Data.Sql.SqlClient"/> и содержат строки соединения с базой данных, а также и SQL-запросы. У вас все эти данные могут отличаться. Пожалуйста, учитывайте этот факт и не забудьте поменять строки соединения и запросы на свои, если захотите проверить работу представленных фрагментов кода.</description>
</item>
</list>
<para>В следующем примере создается экземпляр класса <see cref="T:Nemiro.Data.Sql.SqlClient"/> с использованием строки соединения по умолчанию (<c>LocalSqlServer</c>).</para>
<para>При помощи метода <see cref="M:Nemiro.Data.Sql.SqlClient.GetRow"/> выполняется SQL-запрос и в переменную <c>row</c> передается строка данных.</para>
<code lang="C#">
using (SqlClient client = new SqlClient())
{
DataRow row = client.GetRow("SELECT * FROM table WHERE id = 1000");
if(row == null)
{
Console.WriteLine("Запрос не дал результатов");
}
else
{
Console.WriteLine("id = {0}", row["id"]);
}
}
</code>
<code lang="VB">
Using client As New SqlClient()
Dim row As DataRow = client.GetRow("SELECT * FROM table WHERE id = 1000")
If row Is Nothing Then
Console.WriteLine("Запрос не дал результатов")
Else
Console.WriteLine("id = {0}", row("id"))
End If
End Using
</code>
<para>В следующем примере создается экземпляр класса <see cref="T:Nemiro.Data.Sql.SqlClient"/> с явным указанием строки соединения.</para>
<code lang="C#">
using (SqlClient client = new SqlClient(@"Data Source=.\SQLEXPRESS;Initial Catalog=example;Trusted_Connection=True;"))
{
DataRow row = client.GetRow("SELECT * FROM table WHERE id = 1000");
if(row == null)
{
Console.WriteLine("Запрос не дал результатов");
}
else
{
Console.WriteLine("id = {0}", row["id"]);
}
}
</code>
<code lang="VB">
Using client As New SqlClient("Data Source=.\SQLEXPRESS;Initial Catalog=example;Trusted_Connection=True;")
Dim row As DataRow = client.GetRow("SELECT * FROM table WHERE id = 1000")
If row Is Nothing Then
Console.WriteLine("Запрос не дал результатов")
Else
Console.WriteLine("id = {0}", row("id"))
End If
End Using
</code>
<para>В следующем примере создается экземпляр класса <see cref="T:Nemiro.Data.Sql.SqlClient"/> с указанием имени параметра строки соединения в файле конфигурации.</para>
<code lang="C#">
using (SqlClient client = new SqlClient("MyConnectionString"))
{
DataRow row = client.GetRow("SELECT * FROM table WHERE id = 1000");
if(row == null)
{
Console.WriteLine("Запрос не дал результатов");
}
else
{
Console.WriteLine("id = {0}", row["id"]);
}
}
</code>
<code lang="VB">
Using client As New SqlClient("MyConnectionString")
Dim row As DataRow = client.GetRow("SELECT * FROM table WHERE id = 1000")
If row Is Nothing Then
Console.WriteLine("Запрос не дал результатов")
Else
Console.WriteLine("id = {0}", row("id"))
End If
End Using
</code>
<para>В следующем примере показано применение встроенного механизма кэширования.
Данные кэшируются в файловой системе, по умолчанию в одном каталоге с программой.
Продолжительность кэширования указывается в свойстве <see cref="P:Nemiro.Data.Sql.SqlClient.CacheDuration"/>.
После выполнения запроса, в свойстве <see cref="P:Nemiro.Data.Sql.SqlClient.LastQueryTime"/> можно получить информацию о продолжительности выполнения последнего запроса.
При помощи свойства <see cref="P:Nemiro.Data.Sql.SqlClient.LastQueryResultsFromCache"/> можно узнать, был ли использован кэш при выполнении последнего запроса или нет.</para>
<code lang="C#">
using (SqlClient client = new SqlClient())
{
// кэширование результатов в файлом кэше на 30 секунд
client.CacheDuration = 30;
client.CacheType = CachingType.File;
// формирование запроса
client.CommandText = "SELECT * FROM table";
// выполнение запроса
DataTable table = client.GetTable();
// вывод результатов
Console.WriteLine("Получено данных: {0}", table.Rows.Count);
Console.WriteLine("Время выполнения запроса: {0}", client.LastQueryTime);
Console.WriteLine("Результат получен из кэша: {0}", client.LastQueryResultsFromCache);
// повторное выполнение аналогичного запроса
table = client.GetTable();
Console.WriteLine("Получено данных: {0}", table.Rows.Count);
Console.WriteLine("Время выполнения запроса: {0}", client.LastQueryTime);
Console.WriteLine("Результат получен из кэша: {0}", client.LastQueryResultsFromCache);
}
</code>
<code lang="VB">
Using client As New SqlClient()
' кэширование результатов в файлом кэше на 30 секунд
client.CacheDuration = 30
client.CacheType = CachingType.File
' формирование запроса
client.CommandText = "SELECT * FROM test"
' выполнение запроса
Dim table As DataTable = client.GetTable()
' вывод результатов
Console.WriteLine("Получено данных: {0}", table.Rows.Count)
Console.WriteLine("Время выполнения запроса: {0}", client.LastQueryTime)
Console.WriteLine("Результат получен из кэша: {0}", client.LastQueryResultsFromCache)
' повторное выполнение аналогичного запроса
table = client.GetTable()
Console.WriteLine("Получено данных: {0}", table.Rows.Count)
Console.WriteLine("Время выполнения запроса: {0}", client.LastQueryTime)
Console.WriteLine("Результат получен из кэша: {0}", client.LastQueryResultsFromCache)
End Using
</code>
</example>
</member>
<member name="M:Nemiro.Data.Sql.SqlClient.#ctor">
<summary>
Инициализирует новый экземпляр класса <see cref="T:Nemiro.Data.Sql.SqlClient"/> со значениями по умолчанию.
</summary>
<example>
<para>В следующем примере создается экземпляр класса <see cref="T:Nemiro.Data.Sql.SqlClient"/> с параметрами по умолчанию.</para>
<code lang="C#">
using (SqlClient client = new SqlClient())
{
// ...
}
</code>
<code lang="VB">
Using client As New SqlClient()
'...
End Using
</code>
</example>
</member>
<member name="M:Nemiro.Data.Sql.SqlClient.#ctor(System.String)">
<summary>
Инициализирует новый экземпляр класса <see cref="T:Nemiro.Data.Sql.SqlClient"/> с указанием строки соединения с базой данных.
</summary>
<param name="connectionString">Строка соединения с базой данных. Либо имя строки соединения в файле конфигурации (.config).
Например: <c>user id=;password=;data source=(local);initial catalog=</c>
Значение по умолчанию: <c>LocalSqlServer</c> (имя ключа строки соединения в файле .config)
</param>
<example>
<para>В следующем примере создается экземпляр класса <see cref="T:Nemiro.Data.Sql.SqlClient"/> с указанием имени параметра в файле конфигурации, который содержит строку соединения с SQL Server.</para>
<code lang="C#">
using (SqlClient client = new SqlClient("MyConnectionString"))
{
// ...
}
</code>
<code lang="VB">
Using client As New SqlClient("MyConnectionString")
'...
End Using
</code>
<para>Ниже показан фрагмент файла <c>web.config</c> (приложения ASP .NET), который содержит строку соединения с именем <c>MyConnectionString</c>.</para>
<code lang="XML">
<configuration>
<connectionStrings>
<add
name="LocalSqlServer"
connectionString="Data Source=.\SQLEXPRESS;Initial Catalog=example;Trusted_Connection=True;"
/>
</connectionStrings>
</configuration>
</code>
</example>
</member>
<member name="M:Nemiro.Data.Sql.SqlClient.#ctor(System.String,System.Int32)">
<summary>
Инициализирует новый экземпляр класса <see cref="T:Nemiro.Data.Sql.SqlClient"/> с указанием строки соединения с базой данных и времени кэширования результатов выполнения запросов.
</summary>
<param name="connectionString">Строка соединения с базой данных. Либо имя строки соединения в файле конфигурации (.config).
Например: <c>user id=;password=;data source=(local);initial catalog=</c>
Значение по умолчанию: <c>LocalSqlServer</c> (имя ключа строки соединения в файле .config)
</param>
<param name="cacheDuration">Продолжительность кэширования результатов запроса, в секундах. Минус один - без кэширования. Ноль - использовать значение и файла конфигурации, параметр <c>NeData:Sql:CacheDuration</c>.</param>
<example>
<para>В следующем примере создается экземпляр класса <see cref="T:Nemiro.Data.Sql.SqlClient"/> с указанием строки соединения и времени кэширования результатов выполнения запроса.</para>
<code lang="C#">
using (SqlClient client = new SqlClient(@"Data Source=.\SQLEXPRESS;Initial Catalog=example;Trusted_Connection=True;", 300))
{
// ...
}
</code>
<code lang="VB">
Using client As New SqlClient("Data Source=.\SQLEXPRESS;Initial Catalog=example;Trusted_Connection=True;", 300)
'...
End Using
</code>
</example>
</member>
<member name="M:Nemiro.Data.Sql.SqlClient.#ctor(System.String,System.String)">
<summary>
Инициализирует новый экземпляр класса <see cref="T:Nemiro.Data.Sql.SqlClient"/> с указанием строки соединения с базой данных и пути хранения записей кэша в файловой системе.
</summary>
<param name="connectionString">Строка соединения с базой данных. Либо имя строки соединения в файле конфигурации (.config).
Например: <c>user id=;password=;data source=(local);initial catalog=</c>
Значение по умолчанию: <c>LocalSqlServer</c> (имя ключа строки соединения в файле .config)
</param>
<param name="cachePath">Путь к каталогу хранения файлового кэша. Используется только для <see cref="P:Nemiro.Data.Sql.SqlClient.CacheType"/> = <see cref="F:Nemiro.Data.CachingType.File"/>. Если тип кэширования установлен Auto и будет указан cachePath, то данные будут кэшироваться в указанном каталоге. Значение по умолчанию берется из параметра <c>NeData:Sql:CachePath</c> файла конфигурации.</param>
</member>
<member name="M:Nemiro.Data.Sql.SqlClient.#ctor(System.String,System.Type,System.Object[])">
<summary>
Инициализирует новый экземпляр класса <see cref="T:Nemiro.Data.Sql.SqlClient"/> с указанием строки соединения с базой данных и параметрами пользовательской системы кэширования результатов выполнения запросов.
</summary>
<param name="connectionString">Строка соединения с базой данных. Либо имя строки соединения в файле конфигурации (.config).
Например: <c>user id=;password=;data source=(local);initial catalog=</c>
Значение по умолчанию: <c>LocalSqlServer</c> (имя ключа строки соединения в файле .config)
</param>
<param name="cacheCustom">Тип пользовательского объекта кэширования (должен происходить от <see cref="T:System.Runtime.Caching.ObjectCache"/>). Значение по умолчанию берется из параметра <c>NeData:Sql:CacheCustom</c> файла конфигурации.</param>
<param name="cacheCustomArgs">Дополнительные параметры инициализации пользовательского кэша, будут переданы в конструктор. Значение по умолчанию берется из параметра <c>NeData:Sql:CacheCustomArgs</c> файла конфигурации.</param>
</member>
<member name="M:Nemiro.Data.Sql.SqlClient.#ctor(System.Type,System.Object[])">
<summary>
Инициализирует новый экземпляр класса <see cref="T:Nemiro.Data.Sql.SqlClient"/> с указанием параметров пользовательской системы кэширования результатов выполнения запросов к базе данных.
</summary>
<param name="cacheCustom">Тип пользовательского объекта кэширования (должен происходить от <see cref="T:System.Runtime.Caching.ObjectCache"/>). Значение по умолчанию берется из параметра <c>NeData:Sql:CacheCustom</c> файла конфигурации.</param>
<param name="cacheCustomArgs">Дополнительные параметры инициализации пользовательского кэша, будут переданы в конструктор. Значение по умолчанию берется из параметра <c>NeData:Sql:CacheCustomArgs</c> файла конфигурации.</param>
</member>
<member name="M:Nemiro.Data.Sql.SqlClient.#ctor(System.Type,System.Object[],System.Int32)">
<summary>
Инициализирует новый экземпляр класса <see cref="T:Nemiro.Data.Sql.SqlClient"/>.
</summary>
<param name="cacheCustom">Тип пользовательского объекта кэширования (должен происходить от <see cref="T:System.Runtime.Caching.ObjectCache"/>). Значение по умолчанию берется из параметра <c>NeData:Sql:CacheCustom</c> файла конфигурации.</param>
<param name="cacheCustomArgs">Дополнительные параметры инициализации пользовательского кэша, будут переданы в конструктор. Значение по умолчанию берется из параметра <c>NeData:Sql:CacheCustomArgs</c> файла конфигурации.</param>
<param name="cacheDuration">Продолжительность кэширования результатов запроса, в секундах. Минус один - без кэширования. Ноль - использовать значение и файла конфигурации, параметр <c>NeData:Sql:CacheDuration</c>.</param>
</member>
<member name="M:Nemiro.Data.Sql.SqlClient.#ctor(System.Type,System.Int32)">
<summary>
Инициализирует новый экземпляр класса <see cref="T:Nemiro.Data.Sql.SqlClient"/> с указанием параметров пользовательской системы кэширования результатов выполнения запросов к базе данных и продолжительности кэширования данных.
</summary>
<param name="cacheCustom">Тип пользовательского объекта кэширования (должен происходить от <see cref="T:System.Runtime.Caching.ObjectCache"/>). Значение по умолчанию берется из параметра <c>NeData:Sql:CacheCustom</c> файла конфигурации.</param>
<param name="cacheDuration">Продолжительность кэширования результатов запроса, в секундах. Минус один - без кэширования. Ноль - использовать значение и файла конфигурации, параметр <c>NeData:Sql:CacheDuration</c>.</param>
</member>
<member name="M:Nemiro.Data.Sql.SqlClient.#ctor(System.Int32)">
<summary>
Инициализирует новый экземпляр класса <see cref="T:Nemiro.Data.Sql.SqlClient"/> с указанием продолжительности кэширования результатов выполнения запросов к базе данных.
</summary>
<param name="cacheDuration">Продолжительность кэширования результатов запроса, в секундах. Минус один - без кэширования. Ноль - использовать значение и файла конфигурации, параметр <c>NeData:Sql:CacheDuration</c>.</param>
</member>
<member name="M:Nemiro.Data.Sql.SqlClient.#ctor(System.String,System.Int32,System.String,System.Type,System.Object[])">
<summary>
Инициализирует новый экземпляр класса <see cref="T:Nemiro.Data.Sql.SqlClient"/> с указанием основных параметров конфигурации класса.
</summary>
<param name="connectionString">Строка соединения с базой данных. Либо имя строки соединения в файле конфигурации (.config).
Например: <c>user id=;password=;data source=(local);initial catalog=</c>
Значение по умолчанию: <c>LocalSqlServer</c> (имя ключа строки соединения в файле .config)
</param>
<param name="cacheDuration">Продолжительность кэширования результатов запроса, в секундах. Минус один - без кэширования. Ноль - использовать значение и файла конфигурации, параметр <c>NeData:Sql:CacheDuration</c>.</param>
<param name="cachePath">Путь к каталогу хранения файлового кэша. Используется только для <see cref="P:Nemiro.Data.Sql.SqlClient.CacheType"/> = <see cref="F:Nemiro.Data.CachingType.File"/>. Если тип кэширования установлен Auto и будет указан cachePath, то данные будут кэшироваться в указанном каталоге. Значение по умолчанию берется из параметра <c>NeData:Sql:CachePath</c> файла конфигурации.</param>
<param name="cacheCustom">Тип пользовательского объекта кэширования (должен происходить от <see cref="T:System.Runtime.Caching.ObjectCache"/>). Значение по умолчанию берется из параметра <c>NeData:Sql:CacheCustom</c> файла конфигурации.</param>
<param name="cacheCustomArgs">Дополнительные параметры инициализации пользовательского кэша, будут переданы в конструктор. Значение по умолчанию берется из параметра <c>NeData:Sql:CacheCustomArgs</c> файла конфигурации.</param>
</member>
<member name="M:Nemiro.Data.Sql.SqlClient.#ctor(System.String,System.Int32,System.String,System.Type,System.Object[],System.Type)">
<summary>
Инициализирует новый экземпляр класса <see cref="T:Nemiro.Data.Sql.SqlClient"/> с указанием основных параметров конфигурации класса.
</summary>
<param name="connectionString">Строка соединения с базой данных. Либо имя строки соединения в файле конфигурации (.config).
Например: <c>user id=;password=;data source=(local);initial catalog=</c>
Значение по умолчанию: <c>LocalSqlServer</c> (имя ключа строки соединения в файле .config)
</param>
<param name="cacheDuration">Продолжительность кэширования результатов запроса, в секундах. Минус один - без кэширования. Ноль - использовать значение и файла конфигурации, параметр <c>NeData:Sql:CacheDuration</c>.</param>
<param name="cachePath">Путь к каталогу хранения файлового кэша. Используется только для <see cref="P:Nemiro.Data.Sql.SqlClient.CacheType"/> = <see cref="F:Nemiro.Data.CachingType.File"/>. Если тип кэширования установлен Auto и будет указан cachePath, то данные будут кэшироваться в указанном каталоге. Значение по умолчанию берется из параметра <c>NeData:Sql:CachePath</c> файла конфигурации.</param>
<param name="cacheCustom">Тип пользовательского объекта кэширования (должен происходить от <see cref="T:System.Runtime.Caching.ObjectCache"/>). Значение по умолчанию берется из параметра <c>NeData:Sql:CacheCustom</c> файла конфигурации.</param>
<param name="cacheCustomArgs">Дополнительные параметры инициализации пользовательского кэша, будут переданы в конструктор. Значение по умолчанию берется из параметра <c>NeData:Sql:CacheCustomArgs</c> файла конфигурации.</param>
<param name="cacheBinder">Тип сериализатора пользовательских объектов. Используется только для <see cref="P:Nemiro.Data.Sql.SqlClient.CacheType"/> = <see cref="F:Nemiro.Data.CachingType.File"/>.</param>
</member>
<member name="M:Nemiro.Data.Sql.SqlClient.Dispose">
<summary>
Освобождает все ресурсы, занятые объектом.
Если необходимо, закрывает все открытые объектом соединения с базой данных.
</summary>
</member>
<member name="M:Nemiro.Data.Sql.SqlClient.GetData">
<summary>
Выполняет запрос и возвращает <see cref="T:System.Data.DataSet"/>.
Данный метод используется совместно со свойствами <see cref="P:Nemiro.Data.Sql.SqlClient.CommandType"/>, <see cref="P:Nemiro.Data.Sql.SqlClient.CommandText"/> и <see cref="P:Nemiro.Data.Sql.SqlClient.Parameters"/>.
</summary>
<returns>
<para>Если запрос успешно выполнен, возвращает <see cref="T:System.Data.DataSet"/>, содержащий результат выполнения запроса.</para>
<para>Если запрос не дал результатов, возвращает пустой <see cref="T:System.Data.DataSet"/>.</para>
</returns>
<example>
<code lang="C#">
using (SqlClient c = new SqlClient())
{
// формируем запрос
c.CommandText = "SELECT * FROM messages; SELECT * FROM users;";
// выполняем запрос
DataSet data = c.GetData();
if(data.Tables.Count > 0)
{
// есть данные, выводим в консоль
foreach(DataTable t in data.Tables)
{
foreach(DataRow r in table.Rows)
{
Console.WriteLine("id = {0}", r["id"]);
}
}
}
}
</code>
<code lang="VB">
Using c As new SqlClient()
' формируем запрос
c.CommandText = "SELECT * FROM messages; SELECT * FROM users;"
' выполняем запрос
Dim data As DataSet = c.GetData()
If data.Tables.Count > 0 Then
' есть данные, выводим в консоль
For Each t As DataTable In data.Tables
For Each r As DataRow In table.Rows
Console.WriteLine("id = {0}", r("id"))
Next
Next
End If
End Using
</code>
</example>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetTable"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetRow"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.ExecuteScalar"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.ExecuteNonQuery"/>
<exception cref="T:System.Data.SqlClient.SqlException">Исключение возникает при возврате SQL Server предупреждения или ошибки.</exception>
</member>
<member name="M:Nemiro.Data.Sql.SqlClient.GetData(System.String)">
<summary>
Выполняет указанную SQL-инструкцию и возвращает <see cref="T:System.Data.DataSet"/>.
Не рекомендуется использовать этот метод, чтобы избежать возникновение SQL Injection при неправильном построении запроса.
Лучше используйте одну из перегрузок этого метода: <see cref="M:Nemiro.Data.Sql.SqlClient.GetData"/> или <see cref="M:Nemiro.Data.Sql.SqlClient.GetData(System.Data.SqlClient.SqlCommand)"/>.
</summary>
<returns>
<para>Если запрос успешно выполнен, возвращает <see cref="T:System.Data.DataSet"/>, содержащий результат выполнения запроса.</para>
<para>Если запрос не дал результатов, возвращает пустой <see cref="T:System.Data.DataSet"/>.</para>
</returns>
<example>
<para>
Следующий пример демонстрирует выполнение двух инструкций <c>SELECT FROM</c>, для получения данных из двух таблиц: <c>messages</c> и <c>users</c>.
В случае успешного выполнения запроса, в <see cref="T:System.Data.DataSet"/> в свойстве <see cref="P:System.Data.DataSet.Tables"/> будет две таблицы, содержащие результат выполнения запроса.</para>
<code lang="C#">
using (SqlClient c = new SqlClient())
{
// выполняем запрос
DataSet data = c.GetData("SELECT * FROM messages; SELECT * FROM users;");
if(data.Tables.Count > 0)
{
// есть данные, выводим в консоль
foreach(DataTable t in data.Tables)
{
foreach(DataRow r in table.Rows)
{
Console.WriteLine("id = {0}", r["id"]);
}
}
}
}
</code>
<code lang="VB">
Using c As new SqlClient()
' выполняем запрос
Dim data As DataSet = c.GetData("SELECT * FROM messages; SELECT * FROM users;")
If data.Tables.Count > 0 Then
' есть данные, выводим в консоль
For Each t As DataTable In data.Tables
For Each r As DataRow In table.Rows
Console.WriteLine("id = {0}", r("id"))
Next
Next
End If
End Using
</code>
<para>
Следующий пример демонстрирует динамическое построение SQL-запроса в веб-проекте. В запрос передается значение из параметра <c>search</c> адресной строки.
Например, адрес страницы может быть следующим: http://example.org/users?search=pupkin.
</para>
<para>
Этот код содержит уязвимость типа SQL Injection. Поскольку любой пользователь имеет доступ к своей адресной строке и может указать туда все, что угодно,
в том числе любую SQL-инструкцию. Например, чтобы удалить все данные из таблицы, достаточно указать следующий адрес страницы:
http://example.org/users?search='; DELETE FROM users; --
</para>
<para>Именно поэтому не рекомендуется использовать подобные методы построения SQL-запросов, лучше используйте методы <see cref="M:Nemiro.Data.Sql.SqlClient.GetData"/> или <see cref="M:Nemiro.Data.Sql.SqlClient.GetData(System.Data.SqlClient.SqlCommand)"/>.</para>
<code lang="C#">
using (SqlClient c = new SqlClient())
{
// выполняем запрос
DataSet data = c.GetData("SELECT * FROM users WHERE first_name LIKE '%" + Request["search"] + "%'");
if(data.Tables.Count > 0)
{
// есть данные, выводим в консоль
foreach(DataTable t in data.Tables)
{
foreach(DataRow r in table.Rows)
{
Console.WriteLine("id = {0}", r["id"]);
}
}
}
}
</code>
<code lang="VB">
Using c As new SqlClient()
' выполняем запрос
Dim data As DataSet = c.GetData("SELECT * FROM users WHERE first_name LIKE '%" & Request("search") & "%'")
If data.Tables.Count > 0 Then
' есть данные, выводим в консоль
For Each t As DataTable In data.Tables
For Each r As DataRow In table.Rows
Console.WriteLine("id = {0}", r("id"))
Next
Next
End If
End Using
</code>
<para>
Избежать инъекции, в данном примере, можно сделав проверку на наличие в параметре символа одинарной кавычки или экранировать кавычки: <c>Request["search"].Replace("'", "''")</c>.
Но это не все проблемы, с которыми можно столкнуться при подобном способе построения запросов.
Именно поэтому не рекомендуется использовать подобные методы построения SQL-запросов, лучше используйте методы <see cref="M:Nemiro.Data.Sql.SqlClient.GetData"/> или <see cref="M:Nemiro.Data.Sql.SqlClient.GetData(System.Data.SqlClient.SqlCommand)"/>. ;-)
</para>
</example>
<param name="sql">Запрос SQL, который необходимо выполнить. Будьте очень осторожны при динамическом формировании запроса, особенно при передаче в запрос строковых типов данных.</param>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetTable"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetRow"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.ExecuteScalar"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.ExecuteNonQuery"/>
<exception cref="T:System.Data.SqlClient.SqlException">Исключение возникает при возврате SQL Server предупреждения или ошибки.</exception>
</member>
<member name="M:Nemiro.Data.Sql.SqlClient.GetData(System.Data.SqlClient.SqlCommand)">
<summary>
Выполняет запрос к базе данных с указанными в экземпляре класса <see cref="T:System.Data.SqlClient.SqlCommand"/> параметрами и возвращает <see cref="T:System.Data.DataSet"/>.
</summary>
<returns>
<para>Если запрос успешно выполнен, возвращает <see cref="T:System.Data.DataSet"/>, содержащий результат выполнения запроса.</para>
<para>Если запрос не дал результатов, возвращает пустой <see cref="T:System.Data.DataSet"/>.</para>
</returns>
<remarks>
<para>
В большинстве случаев, рекомендуется использовать метод <see cref="M:Nemiro.Data.Sql.SqlClient.GetData"/> без параметров, совместно со свойствами
<see cref="P:Nemiro.Data.Sql.SqlClient.CommandType"/>, <see cref="P:Nemiro.Data.Sql.SqlClient.CommandText"/> и <see cref="P:Nemiro.Data.Sql.SqlClient.Parameters"/>.
Суть будет примерно такой же, как и с <see cref="T:System.Data.SqlClient.SqlCommand"/>, но работать удобней.
</para>
</remarks>
<example>
<code lang="C#">
using (SqlClient c = new SqlClient())
{
// формируем запрос
SqlCommand cmd = new SqlCommand("SELECT * FROM messages; SELECT * FROM users;");
// выполняем запрос
DataSet data = c.GetData(cmd);
if(data.Tables.Count > 0)
{
// есть данные, выводим в консоль
foreach(DataTable t in data.Tables)
{
foreach(DataRow r in table.Rows)
{
Console.WriteLine("id = {0}", r["id"]);
}
}
}
}
</code>
<code lang="VB">
Using c As new SqlClient()
' формируем запрос
Dim cmd As New SqlCommand("SELECT * FROM messages; SELECT * FROM users")
' выполняем запрос
Dim data As DataSet = c.GetData(cmd)
If data.Tables.Count > 0 Then
' есть данные, выводим в консоль
For Each t As DataTable In data.Tables
For Each r As DataRow In table.Rows
Console.WriteLine("id = {0}", row("id"))
Next
Next
End If
End Using
</code>
</example>
<param name="cmd">Экземпляр <see cref="T:System.Data.SqlClient.SqlCommand"/>, содержащий параметры запроса, который необходимо выполнить.</param>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetTable"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetRow"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.ExecuteScalar"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.ExecuteNonQuery"/>
<exception cref="T:System.Data.SqlClient.SqlException">Исключение возникает при возврате SQL Server предупреждения или ошибки.</exception>
</member>
<member name="M:Nemiro.Data.Sql.SqlClient.GetTable">
<summary>
Выполняет запрос и возвращает <see cref="T:System.Data.DataTable"/>.
Данный метод используется совместно со свойствами <see cref="P:Nemiro.Data.Sql.SqlClient.CommandType"/>, <see cref="P:Nemiro.Data.Sql.SqlClient.CommandText"/> и <see cref="P:Nemiro.Data.Sql.SqlClient.Parameters"/>.
</summary>
<returns>
<para>Если запрос успешно выполнен, возвращает таблицу, содержащую результат выполнения запроса.</para>
<para>Если запрос не дал результатов, возвращает пустую таблицу.</para>
</returns>
<example>
<code lang="C#">
using (SqlClient c = new SqlClient())
{
// формируем запрос
c.CommandText = "SELECT * FROM users;";
// выполняем запрос
DataTable table = c.GetTable();
// выводим результат в консоль
foreach(DataRow row in table.Rows)
{
Console.WriteLine("login = {0}", row["login"]);
}
}
</code>
<code lang="VB">
Using c As new SqlClient()
' формируем запрос
c.CommandText = "SELECT * FROM users;"
' выполняем запрос
Dim table As DataTable = c.GetTable()
' выводим результат в консоль
For Each row As DataRow In table.Rows
Console.WriteLine("login = {0}", row("login"))
Next
End Using
</code>
</example>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetData"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetRow"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.ExecuteScalar"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.ExecuteNonQuery"/>
<exception cref="T:System.Data.SqlClient.SqlException">Исключение возникает при возврате SQL Server предупреждения или ошибки.</exception>
</member>
<member name="M:Nemiro.Data.Sql.SqlClient.GetTable(System.String)">
<summary>
Выполняет запрос и возвращает <see cref="T:System.Data.DataTable"/>.
Не рекомендуется использовать этот метод, чтобы избежать возникновение SQL Injection при неправильном построении запроса.
Лучше используйте одну из перегрузок этого метода: <see cref="M:Nemiro.Data.Sql.SqlClient.GetTable"/> или <see cref="M:Nemiro.Data.Sql.SqlClient.GetTable(System.Data.SqlClient.SqlCommand)"/>.
</summary>
<returns>
<para>Если запрос успешно выполнен, возвращает таблицу, содержащую результат выполнения запроса.</para>
<para>Если запрос не дал результатов, возвращает пустую таблицу.</para>
</returns>
<param name="sql">Запрос SQL, который необходимо выполнить. Будьте очень осторожны при динамическом формировании запроса, особенно при передаче в запрос строковых типов данных.</param>
<example>
<code lang="C#">
using (SqlClient c = new SqlClient())
{
// выполняем запрос
DataTable table = c.GetTable("SELECT * FROM users;");
// выводим результат в консоль
foreach(DataRow row in table.Rows)
{
Console.WriteLine("login = {0}", row["login"]);
}
}
</code>
<code lang="VB">
Using c As new SqlClient()
' выполняем запрос
Dim table As DataTable = c.GetTable("SELECT * FROM users;")
' выводим результат в консоль
For Each row As DataRow In table.Rows
Console.WriteLine("login = {0}", row("login"))
Next
End Using
</code>
</example>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetData"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetRow"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.ExecuteScalar"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.ExecuteNonQuery"/>
<exception cref="T:System.Data.SqlClient.SqlException">Исключение возникает при возврате SQL Server предупреждения или ошибки.</exception>
</member>
<member name="M:Nemiro.Data.Sql.SqlClient.GetTable(System.Data.SqlClient.SqlCommand)">
<summary>
Выполняет запрос к базе данных с указанными в экземпляре класса <see cref="T:System.Data.SqlClient.SqlCommand"/> параметрами и возвращает <see cref="T:System.Data.DataTable"/>.
</summary>
<param name="cmd">Объект типа <see cref="T:System.Data.SqlClient.SqlCommand"/>, который должен содержать текст SQL-запроса, а также параметры запроса.</param>
<returns>
<para>Если запрос успешно выполнен, возвращает таблицу, содержащую результат выполнения запроса.</para>
<para>Если запрос не дал результатов, возвращает пустую таблицу.</para>
</returns>
<remarks>
<para>
В большинстве случаев, рекомендуется использовать метод <see cref="M:Nemiro.Data.Sql.SqlClient.GetTable"/> без параметров, совместно со свойствами
<see cref="P:Nemiro.Data.Sql.SqlClient.CommandType"/>, <see cref="P:Nemiro.Data.Sql.SqlClient.CommandText"/> и <see cref="P:Nemiro.Data.Sql.SqlClient.Parameters"/>.
Суть будет примерно такой же, как и с <see cref="T:System.Data.SqlClient.SqlCommand"/>, но работать удобней.
</para>
</remarks>
<example>
<code lang="C#">
using (SqlClient c = new SqlClient())
{
// формируем запрос
SqlCommand cmd = new SqlCommand("SELECT * FROM users;");
// выполняем запрос
DataTable table = c.GetTable(cmd);
// выводим результат в консоль
foreach(DataRow row in table.Rows)
{
Console.WriteLine("login = {0}", row["login"]);
}
}
</code>
<code lang="VB">
Using c As new SqlClient()
' формируем запрос
Dim cmd As New SqlCommand("SELECT * FROM users;")
' выполняем запрос
Dim table As DataTable = c.GetTable(cmd)
' выводим результат в консоль
For Each row As DataRow In table.Rows
Console.WriteLine("login = {0}", row("login"))
Next
End Using
</code>
</example>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetData"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetRow"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.ExecuteScalar"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.ExecuteNonQuery"/>
<exception cref="T:System.Data.SqlClient.SqlException">Исключение возникает при возврате SQL Server предупреждения или ошибки.</exception>
</member>
<member name="M:Nemiro.Data.Sql.SqlClient.GetRow">
<summary>
Выполняет запрос и возвращает строку данных.
Данный метод используется совместно со свойствами <see cref="P:Nemiro.Data.Sql.SqlClient.CommandType"/>, <see cref="P:Nemiro.Data.Sql.SqlClient.CommandText"/> и <see cref="P:Nemiro.Data.Sql.SqlClient.Parameters"/>.
</summary>
<returns>
<para>Если запрос успешно выполнен, возвращает строку, содержащую результат выполнения запроса.</para>
<para>Если запрос не дал результатов, возвращает <c>NULL</c> (в Visual Basic .NET - <c>Nothing</c>).</para>
</returns>
<example>
<code lang="C#">
using (SqlClient c = new SqlClient())
{
// формируем запрос
c.CommandText = "SELECT * FROM users WHERE login = 'anylogin';";
// выполняем запрос
DataRow row = c.GetRow();
// выводим результат в консоль, если есть
if(row != null)
{
Console.WriteLine("nickname = {0}", row["nickname"]);
}
}
</code>
<code lang="VB">
Using c As new SqlClient()
' формируем запрос
c.CommandText = "SELECT * FROM users WHERE login = 'anylogin';"
' выполняем запрос
Dim row As DataRow = c.GetRow()
' выводим результат в консоль, если есть
If row IsNot Nothing Then
Console.WriteLine("nickname = {0}", row("nickname"))
End If
End Using
</code>
</example>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetData"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetTable"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.ExecuteScalar"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.ExecuteNonQuery"/>
<exception cref="T:System.Data.SqlClient.SqlException">Исключение возникает при возврате SQL Server предупреждения или ошибки.</exception>
</member>
<member name="M:Nemiro.Data.Sql.SqlClient.GetRow(System.String)">
<summary>
Выполняет указанный SQL-запрос и возвращает строку данных.
Не рекомендуется использовать этот метод, чтобы избежать возникновение SQL Injection при неправильном построении запроса.
Лучше используйте одну из перегрузок этого метода: <see cref="M:Nemiro.Data.Sql.SqlClient.GetRow"/> или <see cref="M:Nemiro.Data.Sql.SqlClient.GetRow(System.Data.SqlClient.SqlCommand)"/>.
</summary>
<returns>
<para>Если запрос успешно выполнен, возвращает строку, содержащую результат выполнения запроса.</para>
<para>Если запрос не дал результатов, возвращает <c>NULL</c> (в Visual Basic .NET - <c>Nothing</c>).</para>
</returns>
<example>
<code lang="C#">
using (SqlClient c = new SqlClient())
{
// выполняем запрос
DataRow row = c.GetRow("SELECT * FROM users WHERE login = 'anylogin';");
// выводим результат в консоль, если есть
if(row != null)
{
Console.WriteLine("nickname = {0}", row["nickname"]);
}
}
</code>
<code lang="VB">
Using c As new SqlClient()
' выполняем запрос
Dim row As DataRow = c.GetRow("SELECT * FROM users WHERE login = 'anylogin';")
' выводим результат в консоль, если есть
If row IsNot Nothing Then
Console.WriteLine("nickname = {0}", row("nickname"))
End If
End Using
</code>
</example>
<param name="sql">Запрос SQL, который необходимо выполнить. Будьте очень осторожны при динамическом формировании запроса, особенно при передаче в запрос строковых типов данных.</param>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetData"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetTable"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.ExecuteScalar"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.ExecuteNonQuery"/>
<exception cref="T:System.Data.SqlClient.SqlException">Исключение возникает при возврате SQL Server предупреждения или ошибки.</exception>
</member>
<member name="M:Nemiro.Data.Sql.SqlClient.GetRow(System.Data.SqlClient.SqlCommand)">
<summary>
Выполняет запрос к базе данных с указанными в экземпляре класса <see cref="T:System.Data.SqlClient.SqlCommand"/> параметрами и возвращает строку данных.
</summary>
<returns>
<para>Если запрос успешно выполнен, возвращает строку, содержащую результат выполнения запроса.</para>
<para>Если запрос не дал результатов, возвращает <c>NULL</c> (в Visual Basic .NET - <c>Nothing</c>).</para>
</returns>
<remarks>
<para>
В большинстве случаев, рекомендуется использовать метод <see cref="M:Nemiro.Data.Sql.SqlClient.GetRow"/> без параметров, совместно со свойствами
<see cref="P:Nemiro.Data.Sql.SqlClient.CommandType"/>, <see cref="P:Nemiro.Data.Sql.SqlClient.CommandText"/> и <see cref="P:Nemiro.Data.Sql.SqlClient.Parameters"/>.
Суть будет примерно такой же, как и с <see cref="T:System.Data.SqlClient.SqlCommand"/>, но работать удобней.
</para>
</remarks>
<example>
<code lang="C#">
using (SqlClient c = new SqlClient())
{
// формируем запрос
SqlCommand cmd = new SqlCommand("SELECT * FROM users WHERE login = 'anylogin';");
// выполняем запрос
DataRow row = c.GetRow(cmd);
// выводим результат в консоль, если есть
if(row != null)
{
Console.WriteLine("nickname = {0}", row["nickname"]);
}
}
</code>
<code lang="VB">
Using c As new SqlClient()
' формируем запрос
Dim cmd As New SqlCommand("SELECT * FROM users WHERE login = 'anylogin';")
' выполняем запрос
Dim row As DataRow = c.GetRow(cmd)
' выводим результат в консоль, если есть
If row IsNot Nothing Then
Console.WriteLine("nickname = {0}", row("nickname"))
End If
End Using
</code>
</example>
<param name="cmd">Объект типа <see cref="T:System.Data.SqlClient.SqlCommand"/>, который должен содержать текст SQL-запроса, а также параметры запроса.</param>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetData"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetTable"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.ExecuteScalar"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.ExecuteNonQuery"/>
<exception cref="T:System.Data.SqlClient.SqlException">Исключение возникает при возврате SQL Server предупреждения или ошибки.</exception>
</member>
<member name="M:Nemiro.Data.Sql.SqlClient.ExecuteNonQuery">
<summary>
Выполняет запрос и возвращает количество задействованных в инструкции строк данных.
Данный метод используется совместно со свойствами <see cref="P:Nemiro.Data.Sql.SqlClient.CommandType"/>, <see cref="P:Nemiro.Data.Sql.SqlClient.CommandText"/> и <see cref="P:Nemiro.Data.Sql.SqlClient.Parameters"/>.
</summary>
<returns>
<para>Возвращает число, содержащее количество задействованных строк данных в результате выполнения запроса.</para>
<para>Если запрос не коснулся ни одной строки данных, возвращает ноль.</para>
</returns>
<remarks>
<para>Параметры кэширования при работе с этим методом игнорируются.</para>
</remarks>
<example>
<code lang="C#">
using (SqlClient client = new SqlClient())
{
// формируем запрос
client.CommandText = "UPDATE messages SET hits = hits + 1 WHERE id = 42";
// выполняем запрос
int used = client.ExecuteNonQuery();
// выводим результат в консоль
Console.WriteLine("Обновлено {0} строк", used);
}
</code>
<code lang="VB">
Using client As New SqlClient()
' формируем запрос
client.CommandText = "UPDATE messages SET hits = hits + 1 WHERE id = 42"
' выполняем запрос
Dim used As Integer = client.ExecuteNonQuery()
' выводим результат в консоль
Console.WriteLine("Обновлено {0} строк", used)
End Using
</code>
</example>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetData"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetTable"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetRow"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.ExecuteScalar"/>
<exception cref="T:System.Data.SqlClient.SqlException">Исключение возникает при возврате SQL Server предупреждения или ошибки.</exception>
<exception cref="T:Nemiro.Data.ValueForIdentityException">Исключение происходит, если у ключевого свойства отсутствует флаг Identity и при этом соответствующее поле таблицы является числовым счетчиком.</exception>
<exception cref="T:Nemiro.Data.StringOrBinaryDataWouldBeTruncatedException">Исключение возникает, если в некоторые поля таблицы добавляются значения, объем которых превышает допустимый размер поля таблицы.</exception>
</member>
<member name="M:Nemiro.Data.Sql.SqlClient.ExecuteNonQuery(System.String)">
<summary>
Выполняет указанный SQL-запрос и возвращает количество задействованных в инструкции строк.
Не рекомендуется использовать этот метод, чтобы избежать возникновение SQL Injection при неправильном построении запроса.
Лучше используйте одну из перегрузок этого метода: <see cref="M:Nemiro.Data.Sql.SqlClient.ExecuteNonQuery"/> или <see cref="M:Nemiro.Data.Sql.SqlClient.ExecuteNonQuery(System.Data.SqlClient.SqlCommand)"/>.
</summary>
<param name="sql">Запрос SQL, который необходимо выполнить. Будьте очень осторожны при динамическом формировании запроса, особенно при передаче в запрос строковых типов данных.</param>
<returns>
<para>Возвращает число, содержащее количество задействованных строк данных в результате выполнения запроса.</para>
<para>Если запрос не коснулся ни одной строки данных, возвращает ноль.</para>
</returns>
<remarks>
<para>Параметры кэширования при работе с этим методом игнорируются.</para>
</remarks>
<example>
<code lang="C#">
using (SqlClient client = new SqlClient())
{
// выполняем запрос
int used = client.ExecuteNonQuery("UPDATE messages SET hits = hits + 1 WHERE id = 42");
// выводим результат в консоль
Console.WriteLine("Обновлено {0} строк", used);
}
</code>
<code lang="VB">
Using client As New SqlClient()
' выполняем запрос
Dim used As Integer = client.ExecuteNonQuery("UPDATE messages SET hits = hits + 1 WHERE id = 42")
' выводим результат в консоль
Console.WriteLine("Обновлено {0} строк", used)
End Using
</code>
</example>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetData"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetTable"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetRow"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.ExecuteScalar"/>
<exception cref="T:System.Data.SqlClient.SqlException">Исключение возникает при возврате SQL Server предупреждения или ошибки.</exception>
<exception cref="T:Nemiro.Data.ValueForIdentityException">Исключение происходит, если у ключевого свойства отсутствует флаг Identity и при этом соответствующее поле таблицы является числовым счетчиком.</exception>
<exception cref="T:Nemiro.Data.StringOrBinaryDataWouldBeTruncatedException">Исключение возникает, если в некоторые поля таблицы добавляются значения, объем которых превышает допустимый размер поля таблицы.</exception>
</member>
<member name="M:Nemiro.Data.Sql.SqlClient.ExecuteNonQuery(System.Data.SqlClient.SqlCommand)">
<summary>
Выполняет запрос к базе данных с указанными в экземпляре класса <see cref="T:System.Data.SqlClient.SqlCommand"/> параметрами и возвращает количество задействованных в инструкции строк.
</summary>
<returns>
<para>Возвращает число, содержащее количество задействованных строк данных в результате выполнения запроса.</para>
<para>Если запрос не коснулся ни одной строки данных, возвращает ноль.</para>
</returns>
<remarks>
<para>
В большинстве случаев, рекомендуется использовать метод <see cref="M:Nemiro.Data.Sql.SqlClient.ExecuteNonQuery"/> без параметров, совместно со свойствами
<see cref="P:Nemiro.Data.Sql.SqlClient.CommandType"/>, <see cref="P:Nemiro.Data.Sql.SqlClient.CommandText"/> и <see cref="P:Nemiro.Data.Sql.SqlClient.Parameters"/>.
Суть будет примерно такой же, как и с <see cref="T:System.Data.SqlClient.SqlCommand"/>, но работать удобней.
</para>
<para>Параметры кэширования при работе с этим методом игнорируются.</para>
</remarks>
<example>
<code lang="C#">
using (SqlClient client = new SqlClient())
{
// формируем запрос
SqlCommand cmd = new SqlCommand("UPDATE messages SET hits = hits + 1 WHERE id = @id");
cmd.Parameters.Add("@id", SqlDbType.Int).Value = 42;
// выполняем запрос
int used = client.ExecuteNonQuery(cmd);
// выводим результат в консоль
Console.WriteLine("Обновлено {0} строк", used);
}
</code>
<code lang="VB">
Using client As New SqlClient()
' формируем запрос
Dim cmd As New SqlCommand("UPDATE messages SET hits = hits + 1 WHERE id = @id")
cmd.Parameters.Add("@id", SqlDbType.Int).Value = 42
' выполняем запрос
Dim used As Integer = client.ExecuteNonQuery(cmd)
' выводим результат в консоль
Console.WriteLine("Обновлено {0} строк", used)
End Using
</code>
</example>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetData"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetTable"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.GetRow"/>
<seealso cref="M:Nemiro.Data.Sql.SqlClient.ExecuteScalar"/>
<exception cref="T:System.Data.SqlClient.SqlException">Исключение возникает при возврате SQL Server предупреждения или ошибки.</exception>
<exception cref="T:Nemiro.Data.ValueForIdentityException">Исключение происходит, если у ключевого свойства отсутствует флаг Identity и при этом соответствующее поле таблицы является числовым счетчиком.</exception>