dwh 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +5 -4
- data/Rakefile +1 -1
- data/docs/DWH/Adapters/Adapter.html +33 -27
- data/docs/DWH/Adapters/Athena.html +25 -21
- data/docs/DWH/Adapters/Boolean.html +1 -1
- data/docs/DWH/Adapters/Druid.html +18 -12
- data/docs/DWH/Adapters/DuckDb.html +29 -27
- data/docs/DWH/Adapters/MySql.html +25 -19
- data/docs/DWH/Adapters/OpenAuthorizable/ClassMethods.html +3 -6
- data/docs/DWH/Adapters/OpenAuthorizable.html +5 -10
- data/docs/DWH/Adapters/Postgres.html +27 -23
- data/docs/DWH/Adapters/Snowflake.html +39 -24
- data/docs/DWH/Adapters/SqlServer.html +27 -25
- data/docs/DWH/Adapters/Trino.html +30 -30
- data/docs/DWH/Adapters.html +1 -1
- data/docs/DWH/AuthenticationError.html +1 -1
- data/docs/DWH/Behaviors.html +6 -11
- data/docs/DWH/Capabilities.html +10 -26
- data/docs/DWH/Column.html +7 -15
- data/docs/DWH/ConfigError.html +1 -1
- data/docs/DWH/ConnectionError.html +1 -1
- data/docs/DWH/DWHError.html +1 -1
- data/docs/DWH/ExecutionError.html +1 -1
- data/docs/DWH/Factory.html +1 -1
- data/docs/DWH/Functions/Arrays.html +8 -8
- data/docs/DWH/Functions/Dates.html +5 -7
- data/docs/DWH/Functions/ExtractDatePart.html +13 -25
- data/docs/DWH/Functions/Nulls.html +3 -3
- data/docs/DWH/Functions.html +6 -9
- data/docs/DWH/Logger.html +3 -5
- data/docs/DWH/OAuthError.html +1 -1
- data/docs/DWH/Settings.html +6 -9
- data/docs/DWH/StreamingStats.html +2 -3
- data/docs/DWH/Table.html +14 -26
- data/docs/DWH/TableStats.html +1 -1
- data/docs/DWH/TokenExpiredError.html +1 -1
- data/docs/DWH/UnsupportedCapability.html +1 -1
- data/docs/DWH.html +1 -1
- data/docs/_index.html +1 -1
- data/docs/file.README.html +43 -48
- data/docs/file.adapters.html +318 -343
- data/docs/file.creating-adapters.html +347 -357
- data/docs/file.getting-started.html +143 -151
- data/docs/file.usage.html +257 -278
- data/docs/index.html +43 -48
- data/docs/top-level-namespace.html +1 -1
- data/lib/dwh/adapters.rb +2 -2
- data/lib/dwh/version.rb +1 -1
- metadata +2 -2
@@ -648,13 +648,19 @@ connection object or self</p>
|
|
648
648
|
|
649
649
|
|
650
650
|
—
|
651
|
-
<div class='inline'><p>return format type
|
652
|
-
|
653
|
-
|
654
|
-
|
655
|
-
|
656
|
-
|
657
|
-
|
651
|
+
<div class='inline'><p>return format type</p>
|
652
|
+
|
653
|
+
<ul>
|
654
|
+
<li>array returns array of array</li>
|
655
|
+
<li>object returns array of Hashes</li>
|
656
|
+
<li>csv returns as csv</li>
|
657
|
+
<li>native returns the native result from any clients used
|
658
|
+
|
659
|
+
<ul>
|
660
|
+
<li>For example: Postgres using pg client will return PG::Result</li>
|
661
|
+
<li>Http clients will returns the HTTP response object</li>
|
662
|
+
</ul></li>
|
663
|
+
</ul>
|
658
664
|
</div>
|
659
665
|
|
660
666
|
</li>
|
@@ -938,9 +944,9 @@ to the provided IO object.</p>
|
|
938
944
|
Pass in optional catalog and schema info.</p>
|
939
945
|
|
940
946
|
<p>Example:
|
941
|
-
metadata(
|
942
|
-
metadata(
|
943
|
-
metadata(
|
947
|
+
metadata("public.big_table")
|
948
|
+
metadata("big_table")
|
949
|
+
metadata("big_table",schema: "public")</p>
|
944
950
|
|
945
951
|
|
946
952
|
</div>
|
@@ -960,7 +966,7 @@ Pass in optional catalog and schema info.</p>
|
|
960
966
|
|
961
967
|
—
|
962
968
|
<div class='inline'><ul>
|
963
|
-
|
969
|
+
<li>table name</li>
|
964
970
|
</ul>
|
965
971
|
</div>
|
966
972
|
|
@@ -999,7 +1005,7 @@ Pass in optional catalog and schema info.</p>
|
|
999
1005
|
</span>
|
1000
1006
|
|
1001
1007
|
— <div class='inline'><p>optional catalog or equivalent name space.
|
1002
|
-
will be ignored if the adapter doesn
|
1008
|
+
will be ignored if the adapter doesn't support</p>
|
1003
1009
|
</div>
|
1004
1010
|
|
1005
1011
|
</li>
|
@@ -1012,7 +1018,7 @@ will be ignored if the adapter doesn’t support</p>
|
|
1012
1018
|
</span>
|
1013
1019
|
|
1014
1020
|
— <div class='inline'><p>optional schema to scope to.
|
1015
|
-
will be ignored if the adapter doesn
|
1021
|
+
will be ignored if the adapter doesn't support</p>
|
1016
1022
|
</div>
|
1017
1023
|
|
1018
1024
|
</li>
|
@@ -1195,7 +1201,7 @@ date_start, and date_end.</p>
|
|
1195
1201
|
</span>
|
1196
1202
|
|
1197
1203
|
— <div class='inline'><p>optional catalog or equivalent name space.
|
1198
|
-
will be ignored if the adapter doesn
|
1204
|
+
will be ignored if the adapter doesn't support</p>
|
1199
1205
|
</div>
|
1200
1206
|
|
1201
1207
|
</li>
|
@@ -1208,7 +1214,7 @@ will be ignored if the adapter doesn’t support</p>
|
|
1208
1214
|
</span>
|
1209
1215
|
|
1210
1216
|
— <div class='inline'><p>optional schema to scope to.
|
1211
|
-
will be ignored if the adapter doesn
|
1217
|
+
will be ignored if the adapter doesn't support</p>
|
1212
1218
|
</div>
|
1213
1219
|
|
1214
1220
|
</li>
|
@@ -1446,7 +1452,7 @@ config only specified here.</p>
|
|
1446
1452
|
</span>
|
1447
1453
|
|
1448
1454
|
— <div class='inline'><p>optional catalog or equivalent name space.
|
1449
|
-
will be ignored if the adapter doesn
|
1455
|
+
will be ignored if the adapter doesn't support</p>
|
1450
1456
|
</div>
|
1451
1457
|
|
1452
1458
|
</li>
|
@@ -1459,7 +1465,7 @@ will be ignored if the adapter doesn’t support</p>
|
|
1459
1465
|
</span>
|
1460
1466
|
|
1461
1467
|
— <div class='inline'><p>optional schema to scope to.
|
1462
|
-
will be ignored if the adapter doesn
|
1468
|
+
will be ignored if the adapter doesn't support</p>
|
1463
1469
|
</div>
|
1464
1470
|
|
1465
1471
|
</li>
|
@@ -1615,7 +1621,7 @@ connection object or self</p>
|
|
1615
1621
|
|
1616
1622
|
</h3><div class="docstring">
|
1617
1623
|
<div class="discussion">
|
1618
|
-
<p>Custom date truncation implementation. MySql doesn
|
1624
|
+
<p>Custom date truncation implementation. MySql doesn't offer
|
1619
1625
|
a native function. We basially have to format it and convert back
|
1620
1626
|
to date object.</p>
|
1621
1627
|
|
@@ -1694,7 +1700,7 @@ to date object.</p>
|
|
1694
1700
|
</div>
|
1695
1701
|
|
1696
1702
|
<div id="footer">
|
1697
|
-
Generated on
|
1703
|
+
Generated on Mon Aug 25 10:59:28 2025 by
|
1698
1704
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1699
1705
|
0.9.37 (ruby-3.4.4).
|
1700
1706
|
</div>
|
@@ -125,8 +125,7 @@
|
|
125
125
|
|
126
126
|
|
127
127
|
|
128
|
-
<span class="summary_desc"><div class='inline'>
|
129
|
-
</div></span>
|
128
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
130
129
|
|
131
130
|
</li>
|
132
131
|
|
@@ -148,8 +147,7 @@
|
|
148
147
|
|
149
148
|
|
150
149
|
|
151
|
-
<span class="summary_desc"><div class='inline'>
|
152
|
-
</div></span>
|
150
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
153
151
|
|
154
152
|
</li>
|
155
153
|
|
@@ -176,7 +174,6 @@
|
|
176
174
|
<div class="discussion">
|
177
175
|
|
178
176
|
|
179
|
-
|
180
177
|
</div>
|
181
178
|
</div>
|
182
179
|
<div class="tags">
|
@@ -255,7 +252,7 @@
|
|
255
252
|
</div>
|
256
253
|
|
257
254
|
<div id="footer">
|
258
|
-
Generated on
|
255
|
+
Generated on Mon Aug 25 10:59:28 2025 by
|
259
256
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
260
257
|
0.9.37 (ruby-3.4.4).
|
261
258
|
</div>
|
@@ -176,8 +176,7 @@ class method.</p>
|
|
176
176
|
|
177
177
|
|
178
178
|
|
179
|
-
<span class="summary_desc"><div class='inline'>
|
180
|
-
</div></span>
|
179
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
181
180
|
|
182
181
|
</li>
|
183
182
|
|
@@ -323,8 +322,7 @@ class method.</p>
|
|
323
322
|
|
324
323
|
|
325
324
|
|
326
|
-
<span class="summary_desc"><div class='inline'>
|
327
|
-
</div></span>
|
325
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
328
326
|
|
329
327
|
</li>
|
330
328
|
|
@@ -369,8 +367,7 @@ class method.</p>
|
|
369
367
|
|
370
368
|
|
371
369
|
|
372
|
-
<span class="summary_desc"><div class='inline'>
|
373
|
-
</div></span>
|
370
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
374
371
|
|
375
372
|
</li>
|
376
373
|
|
@@ -415,8 +412,7 @@ class method.</p>
|
|
415
412
|
|
416
413
|
|
417
414
|
|
418
|
-
<span class="summary_desc"><div class='inline'>
|
419
|
-
</div></span>
|
415
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
420
416
|
|
421
417
|
</li>
|
422
418
|
|
@@ -1039,7 +1035,6 @@ it will generate a new token.</p>
|
|
1039
1035
|
<div class="discussion">
|
1040
1036
|
|
1041
1037
|
|
1042
|
-
|
1043
1038
|
</div>
|
1044
1039
|
</div>
|
1045
1040
|
<div class="tags">
|
@@ -1092,7 +1087,7 @@ it will generate a new token.</p>
|
|
1092
1087
|
</div>
|
1093
1088
|
|
1094
1089
|
<div id="footer">
|
1095
|
-
Generated on
|
1090
|
+
Generated on Mon Aug 25 10:59:28 2025 by
|
1096
1091
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1097
1092
|
0.9.37 (ruby-3.4.4).
|
1098
1093
|
</div>
|
@@ -221,7 +221,7 @@ to extra_connection_params. (ie sslrootcert, sslcert etc.)</code></pre>
|
|
221
221
|
|
222
222
|
|
223
223
|
|
224
|
-
<span class="summary_desc"><div class='inline'><p>Need to override default add method since postgres doesn
|
224
|
+
<span class="summary_desc"><div class='inline'><p>Need to override default add method since postgres doesn't support quarter as an interval.</p>
|
225
225
|
</div></span>
|
226
226
|
|
227
227
|
</li>
|
@@ -451,8 +451,7 @@ to extra_connection_params. (ie sslrootcert, sslcert etc.)</code></pre>
|
|
451
451
|
|
452
452
|
|
453
453
|
|
454
|
-
<span class="summary_desc"><div class='inline'>
|
455
|
-
</div></span>
|
454
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
456
455
|
|
457
456
|
</li>
|
458
457
|
|
@@ -677,7 +676,7 @@ connection object or self</p>
|
|
677
676
|
</h3><div class="docstring">
|
678
677
|
<div class="discussion">
|
679
678
|
<p>Need to override default add method
|
680
|
-
since postgres doesn
|
679
|
+
since postgres doesn't support quarter as an
|
681
680
|
interval.</p>
|
682
681
|
|
683
682
|
|
@@ -817,13 +816,19 @@ interval.</p>
|
|
817
816
|
|
818
817
|
|
819
818
|
—
|
820
|
-
<div class='inline'><p>return format type
|
821
|
-
|
822
|
-
|
823
|
-
|
824
|
-
|
825
|
-
|
826
|
-
|
819
|
+
<div class='inline'><p>return format type</p>
|
820
|
+
|
821
|
+
<ul>
|
822
|
+
<li>array returns array of array</li>
|
823
|
+
<li>object returns array of Hashes</li>
|
824
|
+
<li>csv returns as csv</li>
|
825
|
+
<li>native returns the native result from any clients used
|
826
|
+
|
827
|
+
<ul>
|
828
|
+
<li>For example: Postgres using pg client will return PG::Result</li>
|
829
|
+
<li>Http clients will returns the HTTP response object</li>
|
830
|
+
</ul></li>
|
831
|
+
</ul>
|
827
832
|
</div>
|
828
833
|
|
829
834
|
</li>
|
@@ -1111,9 +1116,9 @@ to the provided IO object.</p>
|
|
1111
1116
|
Pass in optional catalog and schema info.</p>
|
1112
1117
|
|
1113
1118
|
<p>Example:
|
1114
|
-
metadata(
|
1115
|
-
metadata(
|
1116
|
-
metadata(
|
1119
|
+
metadata("public.big_table")
|
1120
|
+
metadata("big_table")
|
1121
|
+
metadata("big_table",schema: "public")</p>
|
1117
1122
|
|
1118
1123
|
|
1119
1124
|
</div>
|
@@ -1133,7 +1138,7 @@ Pass in optional catalog and schema info.</p>
|
|
1133
1138
|
|
1134
1139
|
—
|
1135
1140
|
<div class='inline'><ul>
|
1136
|
-
|
1141
|
+
<li>table name</li>
|
1137
1142
|
</ul>
|
1138
1143
|
</div>
|
1139
1144
|
|
@@ -1172,7 +1177,7 @@ Pass in optional catalog and schema info.</p>
|
|
1172
1177
|
</span>
|
1173
1178
|
|
1174
1179
|
— <div class='inline'><p>optional catalog or equivalent name space.
|
1175
|
-
will be ignored if the adapter doesn
|
1180
|
+
will be ignored if the adapter doesn't support</p>
|
1176
1181
|
</div>
|
1177
1182
|
|
1178
1183
|
</li>
|
@@ -1185,7 +1190,7 @@ will be ignored if the adapter doesn’t support</p>
|
|
1185
1190
|
</span>
|
1186
1191
|
|
1187
1192
|
— <div class='inline'><p>optional schema to scope to.
|
1188
|
-
will be ignored if the adapter doesn
|
1193
|
+
will be ignored if the adapter doesn't support</p>
|
1189
1194
|
</div>
|
1190
1195
|
|
1191
1196
|
</li>
|
@@ -1433,7 +1438,7 @@ date_start, and date_end.</p>
|
|
1433
1438
|
</span>
|
1434
1439
|
|
1435
1440
|
— <div class='inline'><p>optional catalog or equivalent name space.
|
1436
|
-
will be ignored if the adapter doesn
|
1441
|
+
will be ignored if the adapter doesn't support</p>
|
1437
1442
|
</div>
|
1438
1443
|
|
1439
1444
|
</li>
|
@@ -1446,7 +1451,7 @@ will be ignored if the adapter doesn’t support</p>
|
|
1446
1451
|
</span>
|
1447
1452
|
|
1448
1453
|
— <div class='inline'><p>optional schema to scope to.
|
1449
|
-
will be ignored if the adapter doesn
|
1454
|
+
will be ignored if the adapter doesn't support</p>
|
1450
1455
|
</div>
|
1451
1456
|
|
1452
1457
|
</li>
|
@@ -1760,7 +1765,7 @@ config only specified here.</p>
|
|
1760
1765
|
</span>
|
1761
1766
|
|
1762
1767
|
— <div class='inline'><p>optional catalog or equivalent name space.
|
1763
|
-
will be ignored if the adapter doesn
|
1768
|
+
will be ignored if the adapter doesn't support</p>
|
1764
1769
|
</div>
|
1765
1770
|
|
1766
1771
|
</li>
|
@@ -1773,7 +1778,7 @@ will be ignored if the adapter doesn’t support</p>
|
|
1773
1778
|
</span>
|
1774
1779
|
|
1775
1780
|
— <div class='inline'><p>optional schema to scope to.
|
1776
|
-
will be ignored if the adapter doesn
|
1781
|
+
will be ignored if the adapter doesn't support</p>
|
1777
1782
|
</div>
|
1778
1783
|
|
1779
1784
|
</li>
|
@@ -1939,7 +1944,6 @@ connection object or self</p>
|
|
1939
1944
|
<div class="discussion">
|
1940
1945
|
|
1941
1946
|
|
1942
|
-
|
1943
1947
|
</div>
|
1944
1948
|
</div>
|
1945
1949
|
<div class="tags">
|
@@ -1990,7 +1994,7 @@ connection object or self</p>
|
|
1990
1994
|
</div>
|
1991
1995
|
|
1992
1996
|
<div id="footer">
|
1993
|
-
Generated on
|
1997
|
+
Generated on Mon Aug 25 10:59:28 2025 by
|
1994
1998
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1995
1999
|
0.9.37 (ruby-3.4.4).
|
1996
2000
|
</div>
|
@@ -110,10 +110,13 @@
|
|
110
110
|
<div class="discussion">
|
111
111
|
<p>Snowflake adapter for executing SQL queries against Snowflake databases.</p>
|
112
112
|
|
113
|
-
<p>Supports two authentication modes
|
114
|
-
|
115
|
-
|
116
|
-
|
113
|
+
<p>Supports two authentication modes:</p>
|
114
|
+
|
115
|
+
<ul>
|
116
|
+
<li>Personal Access Token (pat)</li>
|
117
|
+
<li>Key Pair Authentication (kp)</li>
|
118
|
+
<li>OAuth 2.0 (oauth)</li>
|
119
|
+
</ul>
|
117
120
|
|
118
121
|
|
119
122
|
</div>
|
@@ -783,13 +786,19 @@ connection object or self</p>
|
|
783
786
|
|
784
787
|
|
785
788
|
—
|
786
|
-
<div class='inline'><p>return format type
|
787
|
-
|
788
|
-
|
789
|
-
|
790
|
-
|
791
|
-
|
792
|
-
|
789
|
+
<div class='inline'><p>return format type</p>
|
790
|
+
|
791
|
+
<ul>
|
792
|
+
<li>array returns array of array</li>
|
793
|
+
<li>object returns array of Hashes</li>
|
794
|
+
<li>csv returns as csv</li>
|
795
|
+
<li>native returns the native result from any clients used
|
796
|
+
|
797
|
+
<ul>
|
798
|
+
<li>For example: Postgres using pg client will return PG::Result</li>
|
799
|
+
<li>Http clients will returns the HTTP response object</li>
|
800
|
+
</ul></li>
|
801
|
+
</ul>
|
793
802
|
</div>
|
794
803
|
|
795
804
|
</li>
|
@@ -920,13 +929,19 @@ connection object or self</p>
|
|
920
929
|
|
921
930
|
|
922
931
|
—
|
923
|
-
<div class='inline'><p>return format type
|
924
|
-
|
925
|
-
|
926
|
-
|
927
|
-
|
928
|
-
|
929
|
-
|
932
|
+
<div class='inline'><p>return format type</p>
|
933
|
+
|
934
|
+
<ul>
|
935
|
+
<li>array returns array of array</li>
|
936
|
+
<li>object returns array of Hashes</li>
|
937
|
+
<li>csv returns as csv</li>
|
938
|
+
<li>native returns the native result from any clients used
|
939
|
+
|
940
|
+
<ul>
|
941
|
+
<li>For example: Postgres using pg client will return PG::Result</li>
|
942
|
+
<li>Http clients will returns the HTTP response object</li>
|
943
|
+
</ul></li>
|
944
|
+
</ul>
|
930
945
|
</div>
|
931
946
|
|
932
947
|
</li>
|
@@ -1069,7 +1084,7 @@ config only specified here.</p>
|
|
1069
1084
|
</span>
|
1070
1085
|
|
1071
1086
|
— <div class='inline'><p>optional catalog or equivalent name space.
|
1072
|
-
will be ignored if the adapter doesn
|
1087
|
+
will be ignored if the adapter doesn't support</p>
|
1073
1088
|
</div>
|
1074
1089
|
|
1075
1090
|
</li>
|
@@ -1082,7 +1097,7 @@ will be ignored if the adapter doesn’t support</p>
|
|
1082
1097
|
</span>
|
1083
1098
|
|
1084
1099
|
— <div class='inline'><p>optional schema to scope to.
|
1085
|
-
will be ignored if the adapter doesn
|
1100
|
+
will be ignored if the adapter doesn't support</p>
|
1086
1101
|
</div>
|
1087
1102
|
|
1088
1103
|
</li>
|
@@ -1379,7 +1394,7 @@ date_start, and date_end.</p>
|
|
1379
1394
|
|
1380
1395
|
|
1381
1396
|
—
|
1382
|
-
<div class='inline'><p>yields each chunk of data as it
|
1397
|
+
<div class='inline'><p>yields each chunk of data as it's processed</p>
|
1383
1398
|
</div>
|
1384
1399
|
|
1385
1400
|
</li>
|
@@ -1472,7 +1487,7 @@ the db name to correctly constrain to the target db.</p>
|
|
1472
1487
|
</span>
|
1473
1488
|
|
1474
1489
|
— <div class='inline'><p>optional catalog or equivalent name space.
|
1475
|
-
will be ignored if the adapter doesn
|
1490
|
+
will be ignored if the adapter doesn't support</p>
|
1476
1491
|
</div>
|
1477
1492
|
|
1478
1493
|
</li>
|
@@ -1485,7 +1500,7 @@ will be ignored if the adapter doesn’t support</p>
|
|
1485
1500
|
</span>
|
1486
1501
|
|
1487
1502
|
— <div class='inline'><p>optional schema to scope to.
|
1488
|
-
will be ignored if the adapter doesn
|
1503
|
+
will be ignored if the adapter doesn't support</p>
|
1489
1504
|
</div>
|
1490
1505
|
|
1491
1506
|
</li>
|
@@ -1652,7 +1667,7 @@ connection object or self</p>
|
|
1652
1667
|
</div>
|
1653
1668
|
|
1654
1669
|
<div id="footer">
|
1655
|
-
Generated on
|
1670
|
+
Generated on Mon Aug 25 10:59:28 2025 by
|
1656
1671
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1657
1672
|
0.9.37 (ruby-3.4.4).
|
1658
1673
|
</div>
|
@@ -313,8 +313,7 @@ extra_connection_params: {
|
|
313
313
|
|
314
314
|
|
315
315
|
|
316
|
-
<span class="summary_desc"><div class='inline'>
|
317
|
-
</div></span>
|
316
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
318
317
|
|
319
318
|
</li>
|
320
319
|
|
@@ -336,8 +335,7 @@ extra_connection_params: {
|
|
336
335
|
|
337
336
|
|
338
337
|
|
339
|
-
<span class="summary_desc"><div class='inline'>
|
340
|
-
</div></span>
|
338
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
341
339
|
|
342
340
|
</li>
|
343
341
|
|
@@ -520,8 +518,7 @@ extra_connection_params: {
|
|
520
518
|
|
521
519
|
|
522
520
|
|
523
|
-
<span class="summary_desc"><div class='inline'>
|
524
|
-
</div></span>
|
521
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
525
522
|
|
526
523
|
</li>
|
527
524
|
|
@@ -841,13 +838,19 @@ connection object or self</p>
|
|
841
838
|
|
842
839
|
|
843
840
|
—
|
844
|
-
<div class='inline'><p>return format type
|
845
|
-
|
846
|
-
|
847
|
-
|
848
|
-
|
849
|
-
|
850
|
-
|
841
|
+
<div class='inline'><p>return format type</p>
|
842
|
+
|
843
|
+
<ul>
|
844
|
+
<li>array returns array of array</li>
|
845
|
+
<li>object returns array of Hashes</li>
|
846
|
+
<li>csv returns as csv</li>
|
847
|
+
<li>native returns the native result from any clients used
|
848
|
+
|
849
|
+
<ul>
|
850
|
+
<li>For example: Postgres using pg client will return PG::Result</li>
|
851
|
+
<li>Http clients will returns the HTTP response object</li>
|
852
|
+
</ul></li>
|
853
|
+
</ul>
|
851
854
|
</div>
|
852
855
|
|
853
856
|
</li>
|
@@ -1201,9 +1204,9 @@ to the provided IO object.</p>
|
|
1201
1204
|
Pass in optional catalog and schema info.</p>
|
1202
1205
|
|
1203
1206
|
<p>Example:
|
1204
|
-
metadata(
|
1205
|
-
metadata(
|
1206
|
-
metadata(
|
1207
|
+
metadata("public.big_table")
|
1208
|
+
metadata("big_table")
|
1209
|
+
metadata("big_table",schema: "public")</p>
|
1207
1210
|
|
1208
1211
|
|
1209
1212
|
</div>
|
@@ -1223,7 +1226,7 @@ Pass in optional catalog and schema info.</p>
|
|
1223
1226
|
|
1224
1227
|
—
|
1225
1228
|
<div class='inline'><ul>
|
1226
|
-
|
1229
|
+
<li>table name</li>
|
1227
1230
|
</ul>
|
1228
1231
|
</div>
|
1229
1232
|
|
@@ -1262,7 +1265,7 @@ Pass in optional catalog and schema info.</p>
|
|
1262
1265
|
</span>
|
1263
1266
|
|
1264
1267
|
— <div class='inline'><p>optional catalog or equivalent name space.
|
1265
|
-
will be ignored if the adapter doesn
|
1268
|
+
will be ignored if the adapter doesn't support</p>
|
1266
1269
|
</div>
|
1267
1270
|
|
1268
1271
|
</li>
|
@@ -1275,7 +1278,7 @@ will be ignored if the adapter doesn’t support</p>
|
|
1275
1278
|
</span>
|
1276
1279
|
|
1277
1280
|
— <div class='inline'><p>optional schema to scope to.
|
1278
|
-
will be ignored if the adapter doesn
|
1281
|
+
will be ignored if the adapter doesn't support</p>
|
1279
1282
|
</div>
|
1280
1283
|
|
1281
1284
|
</li>
|
@@ -1511,7 +1514,7 @@ date_start, and date_end.</p>
|
|
1511
1514
|
</span>
|
1512
1515
|
|
1513
1516
|
— <div class='inline'><p>optional catalog or equivalent name space.
|
1514
|
-
will be ignored if the adapter doesn
|
1517
|
+
will be ignored if the adapter doesn't support</p>
|
1515
1518
|
</div>
|
1516
1519
|
|
1517
1520
|
</li>
|
@@ -1524,7 +1527,7 @@ will be ignored if the adapter doesn’t support</p>
|
|
1524
1527
|
</span>
|
1525
1528
|
|
1526
1529
|
— <div class='inline'><p>optional schema to scope to.
|
1527
|
-
will be ignored if the adapter doesn
|
1530
|
+
will be ignored if the adapter doesn't support</p>
|
1528
1531
|
</div>
|
1529
1532
|
|
1530
1533
|
</li>
|
@@ -1844,7 +1847,7 @@ config only specified here.</p>
|
|
1844
1847
|
</span>
|
1845
1848
|
|
1846
1849
|
— <div class='inline'><p>optional catalog or equivalent name space.
|
1847
|
-
will be ignored if the adapter doesn
|
1850
|
+
will be ignored if the adapter doesn't support</p>
|
1848
1851
|
</div>
|
1849
1852
|
|
1850
1853
|
</li>
|
@@ -1857,7 +1860,7 @@ will be ignored if the adapter doesn’t support</p>
|
|
1857
1860
|
</span>
|
1858
1861
|
|
1859
1862
|
— <div class='inline'><p>optional schema to scope to.
|
1860
|
-
will be ignored if the adapter doesn
|
1863
|
+
will be ignored if the adapter doesn't support</p>
|
1861
1864
|
</div>
|
1862
1865
|
|
1863
1866
|
</li>
|
@@ -2023,7 +2026,6 @@ connection object or self</p>
|
|
2023
2026
|
<div class="discussion">
|
2024
2027
|
|
2025
2028
|
|
2026
|
-
|
2027
2029
|
</div>
|
2028
2030
|
</div>
|
2029
2031
|
<div class="tags">
|
@@ -2074,7 +2076,7 @@ connection object or self</p>
|
|
2074
2076
|
</div>
|
2075
2077
|
|
2076
2078
|
<div id="footer">
|
2077
|
-
Generated on
|
2079
|
+
Generated on Mon Aug 25 10:59:28 2025 by
|
2078
2080
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
2079
2081
|
0.9.37 (ruby-3.4.4).
|
2080
2082
|
</div>
|