-
Notifications
You must be signed in to change notification settings - Fork 10
/
FreetdsSqlUtil.qm
2216 lines (1890 loc) · 92.2 KB
/
FreetdsSqlUtil.qm
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
# -*- mode: qore; indent-tabs-mode: nil -*-
#! @file FreetdsSqlUtil.qm Qore user module for working with FreeTDS SQL data
/* FreetdsSqlUtil.qm Copyright (C) 2015 - 2022 Qore Technologies, s.r.o.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
*/
# minimum required Qore version
%requires qore >= 1.0
# requires the SqlUtil module
%requires SqlUtil >= 1.5
# requires the Util module
%requires Util >= 1.0
# don't use "$" signs for variables and class members, assume local variable scope
%new-style
# require type definitions everywhere
%require-types
# enable all warnings
%enable-all-warnings
module FreetdsSqlUtil {
version = "1.4.2";
desc = "user module for working with FreeTDS SQL data";
author = "David Nichols <david@qore.org>";
url = "http://qore.org";
license = "MIT";
}
# version history is included below in the docs
/** @mainpage FreetdsSqlUtil Module
@tableofcontents
@section freetdssqlutilintro FreetdsSqlUtil Module Introduction
The %FreetdsSqlUtil module provides a high level API for working with database objects through the freetds driver.
Usually this module is loaded on demand from the SqlUtil module, however to use this module
directly, use \c "%requires FreetdsSqlUtil" in your code.
All the public symbols in the module are defined in the FreetdsSqlUtil namespace
@note This module requires the <a href="https://github.com/qorelanguage/module-sybase">freetds</a> binary module for communication with MS SQL Server and Sybase databases
@section freetds_sql_operations SQL Operations with the FreeTDS Driver
Queries are limited in the number of arguments in the \c "in" operator depending on the database server; use a join with a temporary table
to select a large number of values known at runtime instead of using the \c "in" operator (see @ref SqlUtil::op_in()).
%FreetdsSqlUtil supports the following additional @ref select_option_hash "select option" when working with MS SQL Server databases:
- \c "tablehint": A single string or a list of strings with the following possible values:
- \c "index(...)": Specifies the name or ID of the indexes to be used by SQL Server when processing the statement. Only one index hint per table can be specified. If a clustered index exists, \c "index(0)" forces a clustered index scan and \c "index(1)" forces a clustered index scan or seek. If no clustered index exists, \c "index(0)" forces a table scan and \c "index(1)" is interpreted as an error. See SQL Server docs for more information.
- \c "fastfirstrow": Equivalent to SQL Server option \c "(FAST 1)"
- \c "holdlock": Makes shared locks more restrictive by holding them until the completion of a transaction (instead of releasing the shared lock as soon as the required table or data page is no longer needed, whether or not the transaction has been completed). The scan is performed with the same semantics as a transaction running at the \c "SERIALIZABLE" isolation level. equivalent to \c "serializable"
- \c "nolock": Equivalent to \c "readuncommitted"
- \c "paglock": Takes shared page locks where a single shared table lock is normally taken
- \c "readcommitted": Specifies that a scan is performed with the same locking semantics as a transaction running at \c "READ COMMITTED" isolation level
- \c "readpast": Specifies that locked rows are skipped (read past)
- \c "readuncommitted": Specifies that dirty reads are allowed
- \c "repeatableread": Specifies that a scan is performed with the same locking semantics as a transaction running at \c "REPEATABLE READ" isolation level
- \c "rowlock": Specifies that a shared row lock is taken when a single shared page or table lock is normally taken
- \c "serializable": Makes shared locks more restrictive by holding them until the completion of a transaction (instead of releasing the shared lock as soon as the required table or data page is no longer needed, whether or not the transaction has been completed). The scan is performed with the same semantics as a transaction running at the \c "SERIALIZABLE" isolation level. Equivalent to \c "holdlock".
- \c "tablock": Specifies that a shared lock is taken on the table held until the end-of-statement. If \c "holdlock" is also specified, the shared table lock is held until the end of the transaction.
- \c "tablockx": Specifies that an exclusive lock is taken on the table held until the end-of-statement or end-of-transaction.
- \c "updlock": Specifies that update locks instead of shared locks are taken while reading the table, and that they are held until the end-of-statement or end-of-transaction.
- \c "xlock": Specifies that exclusive locks should be taken and held until the end of transaction on all data processed by the statement. If specified with \c "paglock" or \c "tablock", the exclusive locks apply to the appropriate level of granularity.
@note
- From the SQL Server docs: The SQL Server query optimizer automatically makes the correct determination. It is recommended that table-level locking hints be used to change the default locking behavior only when necessary. Disallowing a locking level can affect concurrency adversely.
- For more details on the above hints as well as information on which hints are supported for your particular version of SQL Server, see the SQL Server docs
@section freetds_schema_management Schema Management with the FreeTDS Driver
@subsection freetds_type_mapping Type Mapping
Column types are mapped from %Qore types as follows:
<b>FreeTDS Column Type Mappings</b>
|!Generic Type Name|!FreeTDS Type Used
|\c float|\c float
|\c integer|\c bigint
|\c number|\c numeric
|\c string|\c varchar
|\c date|\c datetime
|\c binary|\c varbinary
|\c bool|\c tinyint
|@ref SqlUtil::BLOB|\c varbinary
|@ref SqlUtil::CHAR|\c char
|@ref SqlUtil::CLOB|\c text
|@ref SqlUtil::NUMERIC|\c numeric
|@ref SqlUtil::VARCHAR|\c varchar
To use other types, use the \c "native_type"
@ref SqlUtil::AbstractTable::ColumnDescOptions "column description option" with the native FreeTDS type name
instead (under the \c "driver" and \c "freetds" keys for schemas supporting multiple databases).
@subsection freetdssqlutilv141 FreetdsSqlUtil v1.4.2
- fixed a bug where \c offset and \c limit were not properly supported with MS SQL Server DBs
(<a href="https://github.com/qorelanguage/qore/issues/4408">issue 4408</a>)
- fixed a bug where date/time values in other time zones were not bound correctly
(<a href="https://github.com/qorelanguage/qore/issues/4403">issue 4403</a>)
- fixed a bug handling transaction savepoints
(<a href="https://github.com/qorelanguage/qore/issues/4402">issue 4402</a>)
- allow a \c VARCHAR column to be created without a size, assume a default size
(<a href="https://github.com/qorelanguage/qore/issues/4399">issue 4399</a>)
@subsection freetdssqlutilv141 FreetdsSqlUtil v1.4.1
- added APIs to enable duplicate record creation errors to be detected
(<a href="https://github.com/qorelanguage/qore/issues/4308">issue 4308</a>)
@subsection freetdssqlutilv14 FreetdsSqlUtil v1.4
- added support for the DataProvider module
(<a href="https://github.com/qorelanguage/qore/issues/3545">issue 3545</a>)
@subsection freetdssqlutilv131 FreetdsSqlUtil v1.3.1
- fixed quoting of reserved words in column names in table alignment
(<a href="https://github.com/qorelanguage/qore/issues/3400">issue 3400</a>)
@subsection freetdssqlutilv13 FreetdsSqlUtil v1.3
- added support for serializing and deserializing @ref SqlUtil::AbstractTable "AbstractTable" objects
(<a href="https://github.com/qorelanguage/qore/issues/2663">issue 2663</a>)
@subsection freetdssqlutilv121 FreetdsSqlUtil v1.2.1
- implemented support for custom column operators
(<a href="https://github.com/qorelanguage/qore/issues/2314">issue 2314</a>)
@subsection freetdssqlutilv12 FreetdsSqlUtil v1.2
- fixed a bug where @ref SqlUtil::BLOB columns were created as \c VARBINARY columns instead of \c VARBINARY(MAX)
(<a href="https://github.com/qorelanguage/qore/issues/1852">issue 1852</a>)
- implemented @ref cop_trunc_date() operator
(<a href="https://github.com/qorelanguage/qore/issues/2032">issue 2032</a>)
@subsection freetdssqlutilv11 FreetdsSqlUtil v1.1
- implemented the \a force option (i.e. cascade) for dropping code objects
(<a href="https://github.com/qorelanguage/qore/issues/1314">issue 1314</a>)
@subsection freetdssqlutilv10 FreetdsSqlUtil v1.0
- initial release
*/
#! the FreetdsSqlUtil namespace contains all the objects in the FreetdsSqlUtil module
public namespace FreetdsSqlUtil {
#! returns a FreetdsTable object corresponding to the arguments
public FreetdsTable sub get_table(AbstractDatasource nds, string nname, *hash<auto> opts) {
return new FreetdsTable(nds, nname, opts);
}
#! returns a FreetdsDatabase object corresponding to the arguments
public FreetdsDatabase sub get_database(AbstractDatasource nds, *hash<auto> opts) {
return new FreetdsDatabase(nds, opts);
}
sub parse_schema_name(string nname, reference<string> schema, reference<string> name, string default_schema = "dbo") {
*string sstr = (nname =~ x/^(\w+)\.\w+/)[0];
if (sstr) {
schema = sstr;
splice nname, 0, schema.size() + 1;
name = nname;
} else {
schema = default_schema;
name = nname;
}
}
#! FreeTDS savepoint helper
public class FreetdsSavepointHelper inherits AbstractSavepointHelper {
#! Creates the object
/** @note MS SQL Server savepoint identifiers cannot be longer than 32 character by default; the default
savepoint value uses the unique hash for the object, which is 40 characters long, so we have to use
another algorithm to create the savepoint string on Oracle
*/
constructor(AbstractDatasource ds, *string savepoint = "x" + get_random_string(31))
: AbstractSavepointHelper(ds, savepoint) {
}
#! Creates the savepoint
private createSavepointImpl() {
ds.exec("begin transaction");
ds.exec("save tran " + savepoint);
}
#! Rolls back to the savepoint
private rollbackImpl() {
ds.exec("rollback tran " + savepoint);
}
#! Deletes the savepoint
private deleteSavepointImpl() {
# this method intentionally left blank
}
}
#! the data type for FreeTDS DECIMAL columns
public class FreetdsNumberDataType inherits SqlUtil::AbstractNumericDataType {
#! creates the object
constructor(string native_type, bool nullable, *hash<auto> options)
: AbstractNumericDataType(native_type, nullable, options) {
}
}
#! represents a FreeTDS-specific index
public class FreetdsIndex inherits SqlUtil::AbstractIndex {
public {
#! the tablespace (filegroup) name of the index
*string filegroup;
}
#! creates the object from the arguments
constructor(string n_name, bool n_unique, hash n_cols, *string n_filegroup)
: AbstractIndex(n_name, n_unique, n_cols) {
filegroup = n_filegroup;
}
#! returns a string that can be used to create the index in the database
string getCreateSql(string table_name, *hash opt) {
string sql = sprintf("create %sindex %s on %s (%s)", unique ? "unique " : "", name, table_name,
(foldl $1 + ", " + $2, columns.getSqlColumnNameIterator()));
*string ts = opt.index_filegroup ? opt.index_filegroup : filegroup;
if (ts)
sql += sprintf(" on %s", ts);
return sql;
}
#! returns @ref True "True" if the argument is equal to the current index, @ref False "False" if not
private bool equalImpl(AbstractIndex ix) {
return True;
}
#! returns a string that can be used to rename the index in the database
string getRenameSql(string table_name, string new_name) {
return sprintf("exec sp_rename '%s.%s', '%s', 'INDEX'", table_name, name, new_name);
}
}
#! represents a FreeTDS-specific foreign constraint
public class FreetdsForeignConstraint inherits SqlUtil::AbstractForeignConstraint {
#! creates the constraint from the supplied arguments
constructor(string n, Columns c, ForeignConstraintTarget t) : AbstractForeignConstraint(n, c, t) {
}
#! returns a string that can be used to create the constraint in the database
string getCreateSql(string table_name, *hash opt) {
return getCreateSql(name, table_name, opt);
}
softlist getRenameSql(string table_name, string new_name) {
# the following is only valid with FreeTDS 9.2+
#return sprintf("alter table %s rename constraint %s to %s", table_name, name, new_name);
list l += getDropSql(table_name);
l += getCreateSql(new_name, table_name);
return l;
}
#! returns a string that can be used to create the constraint in the database
string getCreateSql(string name, string table_name, *hash opt) {
return sprintf("alter table %s add constraint %s foreign key (%s) references %s (%s)", table_name, name,
(foldl $1 + ", " + $2, h.keys()), target.table, (foldl $1 + ", " + $2, target.columns.keys()));
}
}
#! represents a FreeTDS-specific check constraint
public class FreetdsCheckConstraint inherits SqlUtil::AbstractCheckConstraint {
#! creates the constraint from the supplied arguments
constructor(string n, string n_src) : AbstractCheckConstraint(n, n_src) {
}
#! returns a string that can be used to create the constraint in the database
string getCreateSql(string table_name, *hash opt) {
return getCreateSql(name, table_name, opt);
}
list getRenameSql(string table_name, string new_name) {
# the following is only valid with FreeTDS 9.2+
#return sprintf("alter table %s rename constraint %s to %s", table_name, name, new_name);
list l += getDropSql(table_name);
l += getCreateSql(new_name, table_name);
return l;
}
#! returns a string that can be used to create the constraint in the database
string getCreateSql(string name, string table_name, *hash opt) {
return sprintf("alter table %s add constraint %s check (%s)", table_name, name, src);
}
}
#! represents a FreeTDS-specific column
public class FreetdsColumn inherits SqlUtil::AbstractColumn {
public {
#! byte size of the column
int byte_size;
}
#! empty constructor for subclasses
private constructor() {
}
#! creates the column from the supplied arguments
constructor(string n, string nt, *string qt, int sz, bool nul, *string dv, *string cm, softint bs, *int scale)
: AbstractColumn(n, nt, qt, sz, nul, dv, cm, scale) {
byte_size = bs;
}
#! returns a list of sql strings that can be used to add the column to an existing table
/** @par Example:
@code{.py}
list l = col.getAddColumnSql(t);
@endcode
@param t the SqlUtil::AbstractTable object to modify
*/
softlist getAddColumnSql(AbstractTable t) {
return sprintf("alter table %s add %s", t.getSqlName(), AbstractColumn::getCreateSql(t));
}
#! returns a list of sql strings that can be used to modify the column to the new definition; if the column definitions are identical then an empty list is returned
/** @par Example:
@code{.py}
list l = col.getModifySql(t, newcol);
@endcode
The column names are assumed to be equal.
@param t the SqlUtil::AbstractTable object to modify
@param col the new column definition
@param opt column modification options (none are supported in this class)
@return a list of sql strings that can be used to modify the column to the new definition; if the column definitions are identical then an empty list is returned
*/
list getModifySqlImpl(AbstractTable t, AbstractColumn col, *hash opt) {
list l = ();
FreetdsColumn c = col;
# get new native type declaration string
string nts = c.getNativeTypeString();
string dv_name = getDdlName("dv_" + name);
if (getNativeTypeString() != nts) {
#printf("ME: %s\nDB: %s\n", nts, getNativeTypeString());
if (exists def_val && def_val !== c.def_val)
l += sprintf("alter table %s drop constraint %s", t.getSqlName(), dv_name);
l += sprintf("alter table %s alter column %s %s %snull", t.getSqlName(), ddl_name, nts, c.nullable ? "" : "not ");
if (def_val !== c.def_val && exists c.def_val && c.def_val !== NULL)
l += sprintf("alter table %s add constraint %s default %s for %s", t.getSqlName(), dv_name, c.def_val, ddl_name);
} else {
if (def_val !== c.def_val) {
#printf("L: %N\nXXXXXXXXXXXXXXX\nR: %N\n\n", self, c);
if (exists c.def_val && c.def_val !== NULL)
l += sprintf("alter table %s add constraint %s default %s for %s", t.getSqlName(), dv_name, c.def_val, ddl_name);
else
l += sprintf("alter table %s drop constraint %s", t.getSqlName(), dv_name);
}
if (nullable != c.nullable) {
l += sprintf("alter table %s alter column %s %s %snull", t.getSqlName(), ddl_name, nts, c.nullable ? "" : "not ");
}
}
return l;
}
#! returns a string that can be used to rename the column
/** @par Example:
@code{.py}
string str = col.getRenameSql(t, "new_name");
@endcode
@param t the SqlUtil::AbstractTable object to modify
@param new_name the new name for the column
@return a string that can be used to rename the column
*/
string getRenameSql(AbstractTable t, string new_name) {
return sprintf("sp_rename '%s.%s', '%s', 'COLUMNS'", t.getSqlName(), ddl_name, getDdlName(new_name));
}
#! returns the column name with quoting in case the column name is a reserved word
/** the name returned here will be used when executing DDL
*/
string getDdlName(string name) {
return FreetdsDatabase::FreetdsReservedWords{name.lwr()} ? ("[" + name + "]") : name;
}
#! returns @ref True "True" if the argument is equal to the current object, @ref False "False" if not
private bool equalImpl(AbstractColumn c) {
return True;
}
}
#! represents a FreeTDS-specific numeric column
public class FreetdsNumericColumn inherits FreetdsColumn {
#! creates the column from the supplied arguments
constructor(string n, string nt, *string qt, int sz, bool nul, *string dv, *string cm, softint bs,
softint scale) : FreetdsColumn(n, nt, qt, sz, nul, dv, cm, bs, scale) {
}
}
#! common base class for unique constraints
public class FreetdsUniqueConstraintCommon inherits SqlUtil::AbstractUniqueConstraint {
private {
#! any filegroup for the unique key index
*string filegroup;
}
#! empty constructor for subclasses
private constructor() {
}
#! creates the constraint with an optional filegroup name
constructor(*string ts) {
filegroup = ts;
}
#! returns the filegroup name used for this constraint, if known
*string getTablespace() {
return filegroup;
}
#! sets or clears the filegroup name
setTablespace(*string ts) {
filegroup = ts;
}
#! sets the supporting index name
bool setIndexBase(string ix) {
if (index && index != ix)
return False;
index = ix;
delete filegroup;
return True;
}
#! clears any index base for the constraint
clearIndex() {
delete index;
}
#! adds index options onto the sql creation string
getIndexSql(reference<string> sql, string name, *hash opts) {
sql += sprintf(" (%s)", (foldl $1 + ", " + $2, getSqlColumnNameIterator()));
}
}
#! class modeling a unique constraint
public class FreetdsUniqueConstraint inherits SqlUtil::AbstractUniqueConstraint, FreetdsUniqueConstraintCommon {
private {
#! @ref True "True" if the constraint is enabled, @ref False "False" if not
bool enabled;
}
#! creates the object with the given attributes
/** @param n name of the constraint
@param n_cols column hash
@param e the enabled status of the constraint
@param ts optional filegroup name
*/
constructor(string n, hash n_cols, bool e = True, *string ts) : AbstractUniqueConstraint(n, n_cols), FreetdsUniqueConstraintCommon(ts) {
enabled = e;
}
#! returns the FreetdsColumn value of the given key if it exists, otherwise throws a \c KEY-ERROR exception
/** @par Example:
@code{.py}
auto v = c.name;
@endcode
@param k the name of the key to access
@return the value of the given key in the contained hash if it exists
@throw KEY-ERROR the given key does not exist in the contained hash
@note this method is called automatically when an unknown or inaccessible member name is accessed from outside the class
@see @ref memberGate_methods
*/
FreetdsColumn memberGate(string k) {
if (!h.hasKey(k))
throw "KEY-ERROR", sprintf("cannot access unknown %s %y; expecting one of: %y", getElementName(), k, h.keys());
return h{k};
}
#! returns a string that can be used to create the constraint
string getCreateSql(string table_name, *hash opts) {
return getCreateSql(name, table_name, opts);
}
list getRenameSql(string table_name, string new_name) {
# the following is only valid with FreeTDS 9.2+
#return sprintf("alter table %s rename constraint %s to %s", table_name, name, new_name);
list l += getDropSql(table_name);
l += getCreateSql(new_name, table_name);
return l;
}
#! returns a string that can be used to rename the constraint
string getCreateSql(string name, string table_name, *hash opts) {
string sql = sprintf("alter table %s add constraint %s unique ", table_name, name);
return sql;
}
#! returns @ref True "True" if the constraint is enabled, @ref False "False" if not
bool isEnabled() {
return enabled;
}
}
#! represents a FreeTDS-specific primary key constraint
public class FreetdsPrimaryKey inherits SqlUtil::AbstractPrimaryKey, FreetdsUniqueConstraintCommon {
#! creates an empty primary key object
constructor() {
}
#! creates the object with the given attributes
/** @param n name of the constraint
@param c column hash
@param ts optional filegroup name
*/
constructor(string n, *hash c, *string ts) : AbstractPrimaryKey(n, c), FreetdsUniqueConstraintCommon(ts) {
}
#! returns the FreetdsColumn value of the given key if it exists, otherwise throws a \c KEY-ERROR exception
/** @par Example:
@code{.py}
any v = c.name;
@endcode
@param k the name of the key to access
@return the value of the given key in the contained hash if it exists
@throw KEY-ERROR the given key does not exist in the contained hash
@note this method is called automatically when an unknown or inaccessible member name is accessed from outside the class
@see @ref memberGate_methods
*/
FreetdsColumn memberGate(string k) {
if (!h.hasKey(k))
throw "KEY-ERROR", sprintf("cannot access unknown %s %y; expecting one of: %y", getElementName(), k, h.keys());
return h{k};
}
#! returns a string that can be used to create the constraint
string getCreateSql(string table_name, *hash opts) {
string sql = sprintf("alter table %s add constraint %s primary key", table_name, name);
getIndexSql(\sql, name, opts);
return sql;
}
#! returns a string that can be used to rename the constraint
softlist getRenameSql(string table_name, string new_name) {
return sprintf("sp_rename '%s.%s', '%s', 'OBJECT'", table_name, name, new_name);
}
}
#! class for FreeTDS sequences
public class FreetdsSequence inherits SqlUtil::AbstractSequence {
#! creates the object from the arguments
constructor(string n_name, number n_start = 1, number n_increment = 1, *softnumber n_end) : AbstractSequence(n_name, n_start, n_increment, n_end) {
}
#! returns a string that can be used to create the sequence in the database
string getCreateSql(*hash opt) {
string sql = sprintf("create sequence %s start with %d increment by %d ", name, start, increment);
sql += max ? sprintf("maxvalue %d", max) : "no maxvalue";
return sql;
}
#! returns a string that can be used to rename the sequence in the database
/** The object is renamed in place with this call
@param new_name the new name of the object
@param opt this option is ignored
*/
softlist getRenameSql(string new_name, *hash opt) {
# no idea if this will work
return sprintf("sp_rename '%s', '%s', 'OBJECT'", name, new_name);
}
}
#! represents a FreeTDS view
public class FreetdsView inherits SqlUtil::AbstractView {
#! creates the object from the arguments
constructor(string n_name, string n_src, *string n_schemaname) : AbstractView(n_name, n_src) {
schema = n_schemaname;
updatable = False;
}
#! returns a string that can be used to create the view in the database
string getCreateSql(*hash opt) {
# TODO/FIXME: more freetds options - what's allowed in "opt"?
return sprintf("create %s%sview %s as %s",
opt.replace ? "or replace " : "",
opt.temp ? "temp " : "",
name,
src
);
}
#! returns a string that can be used to rename the view in the database
/** The object is renamed in place with this call
@param new_name the new name of the object
@param opt this option is ignored
*/
softlist getRenameSql(string new_name, *hash opt) {
# no idea if this will work
return sprintf("sp_rename '%s', '%s', 'OBJECT'", name, new_name);
}
}
#! represents a FreeTDS-specific trigger
public class FreetdsTrigger inherits SqlUtil::AbstractTrigger {
#! creates the object and sets its name and the trigger source
constructor(string n, string n_src) : AbstractTrigger(n, n_src) {
}
#! returns a string that can be used to create the trigger in the database
softlist getCreateSql(string table_name, *hash opt) {
return sprintf("create trigger %s %s", name, src);
}
#! returns a string that can be used to drop the trigger from the database
softlist getDropSql(string table_name) {
return sprintf("drop trigger %s", name);
}
#! returns @ref True "True" if the argument is equal to the current object, @ref False "False" if not
private bool equalImpl(AbstractFunctionBase t) {
return True;
}
#! returns a string that can be used to rename the trigger in the database
softlist getRenameSql(string table_name, string new_name) {
# no idea if this will work
return sprintf("sp_rename '%s', '%s', 'OBJECT'", name, new_name);
}
}
#! represents a FreeTDS-specific function
public class FreetdsFunction inherits SqlUtil::AbstractFunction {
public {
*string args;
}
constructor(string n, string n_src, *string a) : AbstractFunction(n, "function", n_src) {
args = a;
}
#! returns a string that can be used to create the function in the database
softlist getCreateSql(*hash opt) {
return sprintf("create function %s %s", name, src);
}
#! returns a string that can be used to drop the function from the database
/** @param opt this argument is ignored
*/
string getDropSql(*hash opt) {
return sprintf("drop function %s", name);
}
#! returns @ref True "True" if the argument is equal to the current object, @ref False "False" if not
private bool equalImpl(AbstractFunctionBase t) {
return True;
}
#! returns a string that can be used to rename the function in the database
/** @param new_name the new name of the object
@param opt this argument is ignored
*/
softlist getRenameSql(string new_name, *hash opt) {
# no idea if this will work
return sprintf("sp_rename '%s', '%s', 'OBJECT'", name, new_name);
}
#! sets the new name of the function
setName(string new_name) {
name = new_name;
}
}
#! provides the FreeTDS-specific implementation of the AbstractDatabase interface
public class FreetdsDatabase inherits SqlUtil::AbstractDatabase {
public {
#! sybase flag
bool is_sybase;
#! default schema for user
string default_schema = "dbo";
#! FreeTDS-specific schema description keys
const FreetdsSchemaDescriptionOptions = AbstractDatabase::SchemaDescriptionOptions;
const FreeTDS_TempSavepoint = "qore_freetds_tmp_savepoint";
#! Options for reclaimSpace()
const FreetdsReclaimSpaceOptions = ReclaimSpaceOptions;
#! hash of reserved words
const FreetdsReservedWords = (
"add": True,
"all": True,
"alter": True,
"and": True,
"any": True,
"as": True,
"asc": True,
"authorization": True,
"backup": True,
"begin": True,
"between": True,
"break": True,
"browse": True,
"bulk": True,
"by": True,
"cascade": True,
"case": True,
"check": True,
"checkpoint": True,
"close": True,
"clustered": True,
"coalesce": True,
"collate": True,
"column": True,
"commit": True,
"compute": True,
"constraint": True,
"contains": True,
"containstable": True,
"continue": True,
"convert": True,
"create": True,
"cross": True,
"current": True,
"current_date": True,
"current_time": True,
"current_timestamp": True,
"current_user": True,
"cursor": True,
"database": True,
"dbcc": True,
"deallocate": True,
"declare": True,
"default": True,
"delete": True,
"deny": True,
"desc": True,
"disk": True,
"distinct": True,
"distributed": True,
"double": True,
"drop": True,
"dump": True,
"else": True,
"end": True,
"errlvl": True,
"escape": True,
"except": True,
"exec": True,
"execute": True,
"exists": True,
"exit": True,
"external": True,
"fetch": True,
"file": True,
"fillfactor": True,
"for": True,
"foreign": True,
"freetext": True,
"freetexttable": True,
"from": True,
"full": True,
"function": True,
"goto": True,
"grant": True,
"group": True,
"having": True,
"holdlock": True,
"identity": True,
"identity_insert": True,
"identitycol": True,
"if": True,
"in": True,
"index": True,
"inner": True,
"insert": True,
"intersect": True,
"into": True,
"is": True,
"join": True,
"key": True,
"kill": True,
"left": True,
"like": True,
"lineno": True,
"load": True,
"merge": True,
"national": True,
"nocheck": True,
"nonclustered": True,
"not": True,
"null": True,
"nullif": True,
"of": True,
"off": True,
"offsets": True,
"on": True,
"open": True,
"opendatasource": True,
"openquery": True,
"openrowset": True,
"openxml": True,
"option": True,
"or": True,
"order": True,
"outer": True,
"over": True,
"percent": True,
"pivot": True,
"plan": True,
"precision": True,
"primary": True,
"print": True,
"proc": True,
"procedure": True,
"public": True,
"raiserror": True,
"read": True,
"readtext": True,
"reconfigure": True,
"references": True,
"replication": True,
"restore": True,
"restrict": True,
"return": True,
"revert": True,
"revoke": True,
"right": True,
"rollback": True,
"rowcount": True,
"rowguidcol": True,
"rule": True,
"save": True,
"schema": True,
"securityaudit": True,
"select": True,
"semantickeyphrasetable": True,
"semanticsimilaritydetailstable": True,
"semanticsimilaritytable": True,
"session_user": True,
"set": True,
"setuser": True,
"shutdown": True,
"some": True,
"statistics": True,
"system_user": True,
"table": True,
"tablesample": True,
"textsize": True,
"then": True,
"to": True,
"top": True,
"tran": True,
"transaction": True,
"trigger": True,
"truncate": True,
"try_convert": True,
"tsequal": True,
"union": True,
"unique": True,
"unpivot": True,
"update": True,
"updatetext": True,
"use": True,
"user": True,
"values": True,
"varying": True,
"view": True,
"waitfor": True,
"when": True,
"where": True,
"while": True,
"with": True,
"within group": True,
"writetext": True,
);
#! Maximum precision
const MaxPrecision = 38;
}
constructor(AbstractDatasource nds, *hash opts) : AbstractDatabase(nds, opts) {
is_sybase = FreetdsDatabase::isSybase(ds);
if (!is_sybase) {
default_schema = nds.selectRow("select schema_name() as \"schema\"").schema;
}
}
#! Returns @ref True if the driver requires a scale to support decimal values in numeric or decimal columns
/** @return @ref True if the driver requires a scale to support decimal values in numeric or decimal columns
@since %FreeSqlUtil 1.4.2
*/
bool requiresScale() {
return True;
}
#! Returns the maximum precision for numeric or decimal columns
/** @return -1 means, no maximum
@since %FreeSqlUtil 1.4.2
*/
int getMaximumPrecision() {
return MaxPrecision;
}
private list<string> featuresImpl() {
return (DB_TABLES, DB_VIEWS, DB_SEQUENCES,
DB_FUNCTIONS, DB_PROCEDURES);
}
private FreetdsSequence makeSequenceImpl(string name, number start = 1, number increment = 1, *softnumber end, *hash opts) {
return new FreetdsSequence(name, start, increment, end);
}
private *AbstractSequence getSequenceImpl(string name) {
return new FreetdsSequence(name);
}
private *AbstractView getViewImpl(string name) {
string schema;
parse_schema_name(name, \schema, \name, default_schema);
# information_schema will return NULL if the view definition > 4000 chars, so we use system tables
*hash<auto> row = ds.selectRow("select smv.definition from sys.all_views v join sys.sql_modules smv on smv.object_id = v.object_id join sys.schemas s on s.schema_id = v.schema_id where s.name = %v and v.name = %v", schema, name);
if (!row)
return;
if (!row.definition)
throw "VIEW-ERROR", sprintf("view %y exists but the current user does not have permission to read the view", name);
row.definition =~ s/create view .* as //ig;
return new FreetdsView(name, row.definition, schema);
}
private FreetdsFunction makeFunctionImpl(string name, string src, *hash opts) {
throw "UNIMPLEMENTED", "unimplemented";
}
private FreetdsFunction makeProcedureImpl(string name, string src, *hash opts) {
return makeFunctionImpl(name, src, opts);
}
private *AbstractFunction getFunctionImpl(string name) {
throw "UNIMPLEMENTED", "unimplemented";
}
private AbstractFunction getProcedureImpl(string name) {
return getFunctionImpl(name);
}
private list getDropSchemaSqlImpl(hash schema_hash, *hash opt) {
return ();
}
private list getAlignSqlImpl(hash schema_hash, *hash opt) {
return ();
}
#! returns a list of string table names in the database
private softlist<string> listTablesImpl() {
return ds.select("select name from sysobjects where type = %v", "U").name;
#return ds.select("select table_name from information_schema.tables").table_name;
}
#! returns a list of string function names in the database