GeoAlchemy2 0.17.0__py3-none-any.whl → 0.18.0__py3-none-any.whl

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.
geoalchemy2/functions.pyi CHANGED
@@ -1,8 +1,10 @@
1
1
  # this file is automatically generated
2
2
  from typing import List
3
3
 
4
+ import sqlalchemy
4
5
  from sqlalchemy.sql import functions
5
6
  from sqlalchemy.sql.elements import ColumnElement
7
+ from sqlalchemy.sql.selectable import FromClause
6
8
 
7
9
  import geoalchemy2.types
8
10
 
@@ -13,8 +15,8 @@ class TableRowElement(ColumnElement):
13
15
  """The cache is disabled for this class."""
14
16
 
15
17
  def __init__(self, selectable: bool) -> None: ...
16
- @property # type: ignore[override]
17
- def _from_objects(self) -> List[bool]: ...
18
+ @property
19
+ def _from_objects(self) -> List[FromClause]: ...
18
20
 
19
21
  class ST_AsGeoJSON(GenericFunction):
20
22
  """
@@ -52,8 +54,12 @@ class Find_SRID(GenericFunction):
52
54
  Returns the SRID defined for a geometry column.
53
55
 
54
56
  see https://postgis.net/docs/Find_SRID.html
57
+
58
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
55
59
  """
56
60
 
61
+ type = sqlalchemy.sql.sqltypes.Integer()
62
+
57
63
  class Populate_Geometry_Columns(GenericFunction):
58
64
  """
59
65
  Ensures geometry columns are defined with type modifiers or have appropriate spatial constraints.
@@ -186,8 +192,12 @@ class GeometryType(GenericFunction):
186
192
  Returns the type of a geometry as text.
187
193
 
188
194
  see https://postgis.net/docs/GeometryType.html
195
+
196
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
189
197
  """
190
198
 
199
+ type = sqlalchemy.sql.sqltypes.String()
200
+
191
201
  class ST_Boundary(GenericFunction):
192
202
  """
193
203
  Returns the boundary of a geometry.
@@ -204,15 +214,23 @@ class ST_CoordDim(GenericFunction):
204
214
  Return the coordinate dimension of a geometry.
205
215
 
206
216
  see https://postgis.net/docs/ST_CoordDim.html
217
+
218
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
207
219
  """
208
220
 
221
+ type = sqlalchemy.sql.sqltypes.Integer()
222
+
209
223
  class ST_Dimension(GenericFunction):
210
224
  """
211
225
  Returns the topological dimension of a geometry.
212
226
 
213
227
  see https://postgis.net/docs/ST_Dimension.html
228
+
229
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
214
230
  """
215
231
 
232
+ type = sqlalchemy.sql.sqltypes.Integer()
233
+
216
234
  class ST_Dump(GenericFunction):
217
235
  """
218
236
  Returns a set of geometry_dump rows for the components of a geometry.
@@ -308,15 +326,23 @@ class ST_GeometryType(GenericFunction):
308
326
  Returns the SQL-MM type of a geometry as text.
309
327
 
310
328
  see https://postgis.net/docs/ST_GeometryType.html
329
+
330
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
311
331
  """
312
332
 
333
+ type = sqlalchemy.sql.sqltypes.String()
334
+
313
335
  class ST_HasArc(GenericFunction):
314
336
  """
315
337
  Tests if a geometry contains a circular arc
316
338
 
317
339
  see https://postgis.net/docs/ST_HasArc.html
340
+
341
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
318
342
  """
319
343
 
344
+ type = sqlalchemy.sql.sqltypes.Boolean()
345
+
320
346
  class ST_InteriorRingN(GenericFunction):
321
347
  """
322
348
  Returns the Nth interior ring (hole) of a Polygon.
@@ -334,31 +360,47 @@ class ST_IsPolygonCCW(GenericFunction):
334
360
  clockwise.
335
361
 
336
362
  see https://postgis.net/docs/ST_IsPolygonCCW.html
363
+
364
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
337
365
  """
338
366
 
367
+ type = sqlalchemy.sql.sqltypes.Boolean()
368
+
339
369
  class ST_IsPolygonCW(GenericFunction):
340
370
  """
341
371
  Tests if Polygons have exterior rings oriented clockwise and interior rings oriented counter-
342
372
  clockwise.
343
373
 
344
374
  see https://postgis.net/docs/ST_IsPolygonCW.html
375
+
376
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
345
377
  """
346
378
 
379
+ type = sqlalchemy.sql.sqltypes.Boolean()
380
+
347
381
  class ST_IsClosed(GenericFunction):
348
382
  """
349
383
  Tests if a LineStrings's start and end points are coincident. For a PolyhedralSurface tests if it is
350
384
  closed (volumetric).
351
385
 
352
386
  see https://postgis.net/docs/ST_IsClosed.html
387
+
388
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
353
389
  """
354
390
 
391
+ type = sqlalchemy.sql.sqltypes.Boolean()
392
+
355
393
  class ST_IsCollection(GenericFunction):
356
394
  """
357
395
  Tests if a geometry is a geometry collection type.
358
396
 
359
397
  see https://postgis.net/docs/ST_IsCollection.html
398
+
399
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
360
400
  """
361
401
 
402
+ type = sqlalchemy.sql.sqltypes.Boolean()
403
+
362
404
  class ST_IsEmpty(GenericFunction):
363
405
  """
364
406
  [geometry] Tests if a geometry is empty.
@@ -366,29 +408,45 @@ class ST_IsEmpty(GenericFunction):
366
408
  [raster] Returns true if the raster is empty (width = 0 and height = 0). Otherwise, returns false.
367
409
 
368
410
  see https://postgis.net/docs/ST_IsEmpty.html
411
+
412
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
369
413
  """
370
414
 
415
+ type = sqlalchemy.sql.sqltypes.Boolean()
416
+
371
417
  class ST_IsRing(GenericFunction):
372
418
  """
373
419
  Tests if a LineString is closed and simple.
374
420
 
375
421
  see https://postgis.net/docs/ST_IsRing.html
422
+
423
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
376
424
  """
377
425
 
426
+ type = sqlalchemy.sql.sqltypes.Boolean()
427
+
378
428
  class ST_IsSimple(GenericFunction):
379
429
  """
380
430
  Tests if a geometry has no points of self-intersection or self-tangency.
381
431
 
382
432
  see https://postgis.net/docs/ST_IsSimple.html
433
+
434
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
383
435
  """
384
436
 
437
+ type = sqlalchemy.sql.sqltypes.Boolean()
438
+
385
439
  class ST_M(GenericFunction):
386
440
  """
387
441
  Returns the M coordinate of a Point.
388
442
 
389
443
  see https://postgis.net/docs/ST_M.html
444
+
445
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
390
446
  """
391
447
 
448
+ type = sqlalchemy.sql.sqltypes.Float()
449
+
392
450
  class ST_MemSize(GenericFunction):
393
451
  """
394
452
  [geometry] Returns the amount of memory space a geometry takes.
@@ -396,64 +454,100 @@ class ST_MemSize(GenericFunction):
396
454
  [raster] Returns the amount of space (in bytes) the raster takes.
397
455
 
398
456
  see https://postgis.net/docs/ST_MemSize.html
457
+
458
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
399
459
  """
400
460
 
461
+ type = sqlalchemy.sql.sqltypes.Integer()
462
+
401
463
  class ST_NDims(GenericFunction):
402
464
  """
403
465
  Returns the coordinate dimension of a geometry.
404
466
 
405
467
  see https://postgis.net/docs/ST_NDims.html
468
+
469
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
406
470
  """
407
471
 
472
+ type = sqlalchemy.sql.sqltypes.Integer()
473
+
408
474
  class ST_NPoints(GenericFunction):
409
475
  """
410
476
  Returns the number of points (vertices) in a geometry.
411
477
 
412
478
  see https://postgis.net/docs/ST_NPoints.html
479
+
480
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
413
481
  """
414
482
 
483
+ type = sqlalchemy.sql.sqltypes.Integer()
484
+
415
485
  class ST_NRings(GenericFunction):
416
486
  """
417
487
  Returns the number of rings in a polygonal geometry.
418
488
 
419
489
  see https://postgis.net/docs/ST_NRings.html
490
+
491
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
420
492
  """
421
493
 
494
+ type = sqlalchemy.sql.sqltypes.Integer()
495
+
422
496
  class ST_NumGeometries(GenericFunction):
423
497
  """
424
498
  Returns the number of elements in a geometry collection.
425
499
 
426
500
  see https://postgis.net/docs/ST_NumGeometries.html
501
+
502
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
427
503
  """
428
504
 
505
+ type = sqlalchemy.sql.sqltypes.Integer()
506
+
429
507
  class ST_NumInteriorRings(GenericFunction):
430
508
  """
431
509
  Returns the number of interior rings (holes) of a Polygon.
432
510
 
433
511
  see https://postgis.net/docs/ST_NumInteriorRings.html
512
+
513
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
434
514
  """
435
515
 
516
+ type = sqlalchemy.sql.sqltypes.Integer()
517
+
436
518
  class ST_NumInteriorRing(GenericFunction):
437
519
  """
438
520
  Returns the number of interior rings (holes) of a Polygon. Aias for ST_NumInteriorRings
439
521
 
440
522
  see https://postgis.net/docs/ST_NumInteriorRing.html
523
+
524
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
441
525
  """
442
526
 
527
+ type = sqlalchemy.sql.sqltypes.Integer()
528
+
443
529
  class ST_NumPatches(GenericFunction):
444
530
  """
445
531
  Return the number of faces on a Polyhedral Surface. Will return null for non-polyhedral geometries.
446
532
 
447
533
  see https://postgis.net/docs/ST_NumPatches.html
534
+
535
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
448
536
  """
449
537
 
538
+ type = sqlalchemy.sql.sqltypes.Integer()
539
+
450
540
  class ST_NumPoints(GenericFunction):
451
541
  """
452
542
  Returns the number of points in a LineString or CircularString.
453
543
 
454
544
  see https://postgis.net/docs/ST_NumPoints.html
545
+
546
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
455
547
  """
456
548
 
549
+ type = sqlalchemy.sql.sqltypes.Integer()
550
+
457
551
  class ST_PatchN(GenericFunction):
458
552
  """
459
553
  Returns the Nth geometry (face) of a PolyhedralSurface.
@@ -505,36 +599,56 @@ class ST_Summary(GenericFunction):
505
599
  [raster] Returns a text summary of the contents of the raster.
506
600
 
507
601
  see https://postgis.net/docs/ST_Summary.html
602
+
603
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
508
604
  """
509
605
 
606
+ type = sqlalchemy.sql.sqltypes.String()
607
+
510
608
  class ST_X(GenericFunction):
511
609
  """
512
610
  Returns the X coordinate of a Point.
513
611
 
514
612
  see https://postgis.net/docs/ST_X.html
613
+
614
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
515
615
  """
516
616
 
617
+ type = sqlalchemy.sql.sqltypes.Float()
618
+
517
619
  class ST_Y(GenericFunction):
518
620
  """
519
621
  Returns the Y coordinate of a Point.
520
622
 
521
623
  see https://postgis.net/docs/ST_Y.html
624
+
625
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
522
626
  """
523
627
 
628
+ type = sqlalchemy.sql.sqltypes.Float()
629
+
524
630
  class ST_Z(GenericFunction):
525
631
  """
526
632
  Returns the Z coordinate of a Point.
527
633
 
528
634
  see https://postgis.net/docs/ST_Z.html
635
+
636
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
529
637
  """
530
638
 
639
+ type = sqlalchemy.sql.sqltypes.Float()
640
+
531
641
  class ST_Zmflag(GenericFunction):
532
642
  """
533
643
  Returns a code indicating the ZM coordinate dimension of a geometry.
534
644
 
535
645
  see https://postgis.net/docs/ST_Zmflag.html
646
+
647
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
536
648
  """
537
649
 
650
+ type = sqlalchemy.sql.sqltypes.Integer()
651
+
538
652
  class ST_AddPoint(GenericFunction):
539
653
  """
540
654
  Add a point to a LineString.
@@ -819,8 +933,12 @@ class ST_IsValid(GenericFunction):
819
933
  Tests if a geometry is well-formed in 2D.
820
934
 
821
935
  see https://postgis.net/docs/ST_IsValid.html
936
+
937
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
822
938
  """
823
939
 
940
+ type = sqlalchemy.sql.sqltypes.Boolean()
941
+
824
942
  class ST_IsValidDetail(GenericFunction):
825
943
  """
826
944
  Returns a valid_detail row stating if a geometry is valid, and if not a reason why and a location.
@@ -833,8 +951,12 @@ class ST_IsValidReason(GenericFunction):
833
951
  Returns text stating if a geometry is valid, or a reason for invalidity.
834
952
 
835
953
  see https://postgis.net/docs/ST_IsValidReason.html
954
+
955
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
836
956
  """
837
957
 
958
+ type = sqlalchemy.sql.sqltypes.String()
959
+
838
960
  class ST_SetSRID(GenericFunction):
839
961
  """
840
962
  [geometry] Set the SRID on a geometry to a particular integer value.
@@ -857,8 +979,12 @@ class ST_SRID(GenericFunction):
857
979
  [raster] Returns the spatial reference identifier of the raster as defined in spatial_ref_sys table.
858
980
 
859
981
  see https://postgis.net/docs/ST_SRID.html
982
+
983
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
860
984
  """
861
985
 
986
+ type = sqlalchemy.sql.sqltypes.Integer()
987
+
862
988
  class ST_Transform(GenericFunction):
863
989
  """
864
990
  [geometry] Return a new geometry with its coordinates transformed to a different spatial reference
@@ -1227,15 +1353,23 @@ class ST_AsEWKT(GenericFunction):
1227
1353
  Return the Well-Known Text (WKT) representation of the geometry with SRID meta data.
1228
1354
 
1229
1355
  see https://postgis.net/docs/ST_AsEWKT.html
1356
+
1357
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
1230
1358
  """
1231
1359
 
1360
+ type = sqlalchemy.sql.sqltypes.String()
1361
+
1232
1362
  class ST_AsText(GenericFunction):
1233
1363
  """
1234
1364
  Return the Well-Known Text (WKT) representation of the geometry/geography without SRID metadata.
1235
1365
 
1236
1366
  see https://postgis.net/docs/ST_AsText.html
1367
+
1368
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
1237
1369
  """
1238
1370
 
1371
+ type = sqlalchemy.sql.sqltypes.String()
1372
+
1239
1373
  class ST_AsBinary(GenericFunction):
1240
1374
  """
1241
1375
  [geometry] Return the Well-Known Binary (WKB) representation of the geometry/geography without SRID
@@ -1259,15 +1393,23 @@ class ST_AsHEXEWKB(GenericFunction):
1259
1393
  encoding.
1260
1394
 
1261
1395
  see https://postgis.net/docs/ST_AsHEXEWKB.html
1396
+
1397
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
1262
1398
  """
1263
1399
 
1400
+ type = sqlalchemy.sql.sqltypes.String()
1401
+
1264
1402
  class ST_AsEncodedPolyline(GenericFunction):
1265
1403
  """
1266
1404
  Returns an Encoded Polyline from a LineString geometry.
1267
1405
 
1268
1406
  see https://postgis.net/docs/ST_AsEncodedPolyline.html
1407
+
1408
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
1269
1409
  """
1270
1410
 
1411
+ type = sqlalchemy.sql.sqltypes.String()
1412
+
1271
1413
  class ST_AsGeobuf(GenericFunction):
1272
1414
  """
1273
1415
  Return a Geobuf representation of a set of rows.
@@ -1280,23 +1422,35 @@ class ST_AsGML(GenericFunction):
1280
1422
  Return the geometry as a GML version 2 or 3 element.
1281
1423
 
1282
1424
  see https://postgis.net/docs/ST_AsGML.html
1425
+
1426
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
1283
1427
  """
1284
1428
 
1429
+ type = sqlalchemy.sql.sqltypes.String()
1430
+
1285
1431
  class ST_AsKML(GenericFunction):
1286
1432
  """
1287
1433
  Return the geometry as a KML element. Several variants. Default version=2, default
1288
1434
  maxdecimaldigits=15
1289
1435
 
1290
1436
  see https://postgis.net/docs/ST_AsKML.html
1437
+
1438
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
1291
1439
  """
1292
1440
 
1441
+ type = sqlalchemy.sql.sqltypes.String()
1442
+
1293
1443
  class ST_AsLatLonText(GenericFunction):
1294
1444
  """
1295
1445
  Return the Degrees, Minutes, Seconds representation of the given point.
1296
1446
 
1297
1447
  see https://postgis.net/docs/ST_AsLatLonText.html
1448
+
1449
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
1298
1450
  """
1299
1451
 
1452
+ type = sqlalchemy.sql.sqltypes.String()
1453
+
1300
1454
  class ST_AsMVTGeom(GenericFunction):
1301
1455
  """
1302
1456
  Transform a geometry into the coordinate space of a Mapbox Vector Tile.
@@ -1341,16 +1495,24 @@ class ST_GeoHash(GenericFunction):
1341
1495
  Return a GeoHash representation of the geometry.
1342
1496
 
1343
1497
  see https://postgis.net/docs/ST_GeoHash.html
1498
+
1499
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
1344
1500
  """
1345
1501
 
1502
+ type = sqlalchemy.sql.sqltypes.String()
1503
+
1346
1504
  class ST_3DIntersects(GenericFunction):
1347
1505
  """
1348
1506
  Returns TRUE if the Geometries "spatially intersect" in 3D - only for points, linestrings, polygons,
1349
1507
  polyhedral surface (area).
1350
1508
 
1351
1509
  see https://postgis.net/docs/ST_3DIntersects.html
1510
+
1511
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
1352
1512
  """
1353
1513
 
1514
+ type = sqlalchemy.sql.sqltypes.Boolean()
1515
+
1354
1516
  class ST_Contains(GenericFunction):
1355
1517
  """
1356
1518
  [geometry] Returns true if and only if no points of B lie in the exterior of A, and at least one
@@ -1360,8 +1522,12 @@ class ST_Contains(GenericFunction):
1360
1522
  one point of the interior of rastB lies in the interior of rastA.
1361
1523
 
1362
1524
  see https://postgis.net/docs/ST_Contains.html
1525
+
1526
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
1363
1527
  """
1364
1528
 
1529
+ type = sqlalchemy.sql.sqltypes.Boolean()
1530
+
1365
1531
  class ST_ContainsProperly(GenericFunction):
1366
1532
  """
1367
1533
  [geometry] Returns true if B intersects the interior of A but not the boundary (or exterior). A does
@@ -1371,8 +1537,12 @@ class ST_ContainsProperly(GenericFunction):
1371
1537
  rastA.
1372
1538
 
1373
1539
  see https://postgis.net/docs/ST_ContainsProperly.html
1540
+
1541
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
1374
1542
  """
1375
1543
 
1544
+ type = sqlalchemy.sql.sqltypes.Boolean()
1545
+
1376
1546
  class ST_Covers(GenericFunction):
1377
1547
  """
1378
1548
  [geometry] Returns 1 (TRUE) if no point in Geometry B is outside Geometry A
@@ -1380,8 +1550,12 @@ class ST_Covers(GenericFunction):
1380
1550
  [raster] Return true if no points of raster rastB lie outside raster rastA.
1381
1551
 
1382
1552
  see https://postgis.net/docs/ST_Covers.html
1553
+
1554
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
1383
1555
  """
1384
1556
 
1557
+ type = sqlalchemy.sql.sqltypes.Boolean()
1558
+
1385
1559
  class ST_CoveredBy(GenericFunction):
1386
1560
  """
1387
1561
  [geometry] Returns 1 (TRUE) if no point in Geometry/Geography A is outside Geometry/Geography B
@@ -1389,23 +1563,35 @@ class ST_CoveredBy(GenericFunction):
1389
1563
  [raster] Return true if no points of raster rastA lie outside raster rastB.
1390
1564
 
1391
1565
  see https://postgis.net/docs/ST_CoveredBy.html
1566
+
1567
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
1392
1568
  """
1393
1569
 
1570
+ type = sqlalchemy.sql.sqltypes.Boolean()
1571
+
1394
1572
  class ST_Crosses(GenericFunction):
1395
1573
  """
1396
1574
  Returns TRUE if the supplied geometries have some, but not all, interior points in common.
1397
1575
 
1398
1576
  see https://postgis.net/docs/ST_Crosses.html
1577
+
1578
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
1399
1579
  """
1400
1580
 
1581
+ type = sqlalchemy.sql.sqltypes.Boolean()
1582
+
1401
1583
  class ST_LineCrossingDirection(GenericFunction):
1402
1584
  """
1403
1585
  Given 2 linestrings, returns a number between -3 and 3 denoting what kind of crossing behavior. 0 is
1404
1586
  no crossing.
1405
1587
 
1406
1588
  see https://postgis.net/docs/ST_LineCrossingDirection.html
1589
+
1590
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
1407
1591
  """
1408
1592
 
1593
+ type = sqlalchemy.sql.sqltypes.Integer()
1594
+
1409
1595
  class ST_Disjoint(GenericFunction):
1410
1596
  """
1411
1597
  [geometry] Returns TRUE if the Geometries do not "spatially intersect" - if they do not share any
@@ -1414,15 +1600,23 @@ class ST_Disjoint(GenericFunction):
1414
1600
  [raster] Return true if raster rastA does not spatially intersect rastB.
1415
1601
 
1416
1602
  see https://postgis.net/docs/ST_Disjoint.html
1603
+
1604
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
1417
1605
  """
1418
1606
 
1607
+ type = sqlalchemy.sql.sqltypes.Boolean()
1608
+
1419
1609
  class ST_Equals(GenericFunction):
1420
1610
  """
1421
1611
  Returns true if the given geometries represent the same geometry. Directionality is ignored.
1422
1612
 
1423
1613
  see https://postgis.net/docs/ST_Equals.html
1614
+
1615
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
1424
1616
  """
1425
1617
 
1618
+ type = sqlalchemy.sql.sqltypes.Boolean()
1619
+
1426
1620
  class ST_Intersects(GenericFunction):
1427
1621
  """
1428
1622
  [geometry] Returns TRUE if the Geometries/Geography "spatially intersect in 2D" - (share any portion
@@ -1432,16 +1626,24 @@ class ST_Intersects(GenericFunction):
1432
1626
  [raster] Return true if raster rastA spatially intersects raster rastB.
1433
1627
 
1434
1628
  see https://postgis.net/docs/ST_Intersects.html
1629
+
1630
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
1435
1631
  """
1436
1632
 
1633
+ type = sqlalchemy.sql.sqltypes.Boolean()
1634
+
1437
1635
  class ST_OrderingEquals(GenericFunction):
1438
1636
  """
1439
1637
  Returns true if the given geometries represent the same geometry and points are in the same
1440
1638
  directional order.
1441
1639
 
1442
1640
  see https://postgis.net/docs/ST_OrderingEquals.html
1641
+
1642
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
1443
1643
  """
1444
1644
 
1645
+ type = sqlalchemy.sql.sqltypes.Boolean()
1646
+
1445
1647
  class ST_Overlaps(GenericFunction):
1446
1648
  """
1447
1649
  [geometry] Returns TRUE if the Geometries share space, are of the same dimension, but are not
@@ -1451,15 +1653,23 @@ class ST_Overlaps(GenericFunction):
1451
1653
  other.
1452
1654
 
1453
1655
  see https://postgis.net/docs/ST_Overlaps.html
1656
+
1657
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
1454
1658
  """
1455
1659
 
1660
+ type = sqlalchemy.sql.sqltypes.Boolean()
1661
+
1456
1662
  class ST_PointInsideCircle(GenericFunction):
1457
1663
  """
1458
1664
  Is the point geometry inside the circle defined by center_x, center_y, radius
1459
1665
 
1460
1666
  see https://postgis.net/docs/ST_PointInsideCircle.html
1667
+
1668
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
1461
1669
  """
1462
1670
 
1671
+ type = sqlalchemy.sql.sqltypes.Boolean()
1672
+
1463
1673
  class ST_Relate(GenericFunction):
1464
1674
  """
1465
1675
  Returns true if this Geometry is spatially related to anotherGeometry, by testing for intersections
@@ -1468,15 +1678,23 @@ class ST_Relate(GenericFunction):
1468
1678
  intersectionMatrixPattern that relates the 2 geometries.
1469
1679
 
1470
1680
  see https://postgis.net/docs/ST_Relate.html
1681
+
1682
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
1471
1683
  """
1472
1684
 
1685
+ type = sqlalchemy.sql.sqltypes.Boolean()
1686
+
1473
1687
  class ST_RelateMatch(GenericFunction):
1474
1688
  """
1475
1689
  Returns true if intersectionMattrixPattern1 implies intersectionMatrixPattern2
1476
1690
 
1477
1691
  see https://postgis.net/docs/ST_RelateMatch.html
1692
+
1693
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
1478
1694
  """
1479
1695
 
1696
+ type = sqlalchemy.sql.sqltypes.Boolean()
1697
+
1480
1698
  class ST_Touches(GenericFunction):
1481
1699
  """
1482
1700
  [geometry] Returns TRUE if the geometries have at least one point in common, but their interiors do
@@ -1486,8 +1704,12 @@ class ST_Touches(GenericFunction):
1486
1704
  do not intersect.
1487
1705
 
1488
1706
  see https://postgis.net/docs/ST_Touches.html
1707
+
1708
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
1489
1709
  """
1490
1710
 
1711
+ type = sqlalchemy.sql.sqltypes.Boolean()
1712
+
1491
1713
  class ST_Within(GenericFunction):
1492
1714
  """
1493
1715
  [geometry] Returns true if the geometry A is completely inside geometry B
@@ -1496,22 +1718,34 @@ class ST_Within(GenericFunction):
1496
1718
  one point of the interior of rastA lies in the interior of rastB.
1497
1719
 
1498
1720
  see https://postgis.net/docs/ST_Within.html
1721
+
1722
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
1499
1723
  """
1500
1724
 
1725
+ type = sqlalchemy.sql.sqltypes.Boolean()
1726
+
1501
1727
  class ST_3DDWithin(GenericFunction):
1502
1728
  """
1503
1729
  For 3d (z) geometry type Returns true if two geometries 3d distance is within number of units.
1504
1730
 
1505
1731
  see https://postgis.net/docs/ST_3DDWithin.html
1732
+
1733
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
1506
1734
  """
1507
1735
 
1736
+ type = sqlalchemy.sql.sqltypes.Boolean()
1737
+
1508
1738
  class ST_3DDFullyWithin(GenericFunction):
1509
1739
  """
1510
1740
  Returns true if all of the 3D geometries are within the specified distance of one another.
1511
1741
 
1512
1742
  see https://postgis.net/docs/ST_3DDFullyWithin.html
1743
+
1744
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
1513
1745
  """
1514
1746
 
1747
+ type = sqlalchemy.sql.sqltypes.Boolean()
1748
+
1515
1749
  class ST_DFullyWithin(GenericFunction):
1516
1750
  """
1517
1751
  [geometry] Returns true if all of the geometries are within the specified distance of one another
@@ -1520,8 +1754,12 @@ class ST_DFullyWithin(GenericFunction):
1520
1754
  other.
1521
1755
 
1522
1756
  see https://postgis.net/docs/ST_DFullyWithin.html
1757
+
1758
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
1523
1759
  """
1524
1760
 
1761
+ type = sqlalchemy.sql.sqltypes.Boolean()
1762
+
1525
1763
  class ST_DWithin(GenericFunction):
1526
1764
  """
1527
1765
  [geometry] Returns true if the geometries are within the specified distance of one another. For
@@ -1532,30 +1770,46 @@ class ST_DWithin(GenericFunction):
1532
1770
  [raster] Return true if rasters rastA and rastB are within the specified distance of each other.
1533
1771
 
1534
1772
  see https://postgis.net/docs/ST_DWithin.html
1773
+
1774
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
1535
1775
  """
1536
1776
 
1777
+ type = sqlalchemy.sql.sqltypes.Boolean()
1778
+
1537
1779
  class ST_Area(GenericFunction):
1538
1780
  """
1539
1781
  Returns the area of a polygonal geometry.
1540
1782
 
1541
1783
  see https://postgis.net/docs/ST_Area.html
1784
+
1785
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
1542
1786
  """
1543
1787
 
1788
+ type = sqlalchemy.sql.sqltypes.Float()
1789
+
1544
1790
  class ST_Azimuth(GenericFunction):
1545
1791
  """
1546
1792
  Returns the north-based azimuth as the angle in radians measured clockwise from the vertical on
1547
1793
  pointA to pointB.
1548
1794
 
1549
1795
  see https://postgis.net/docs/ST_Azimuth.html
1796
+
1797
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
1550
1798
  """
1551
1799
 
1800
+ type = sqlalchemy.sql.sqltypes.Float()
1801
+
1552
1802
  class ST_Angle(GenericFunction):
1553
1803
  """
1554
1804
  Returns the angle between 3 points, or between 2 vectors (4 points or 2 lines).
1555
1805
 
1556
1806
  see https://postgis.net/docs/ST_Angle.html
1807
+
1808
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
1557
1809
  """
1558
1810
 
1811
+ type = sqlalchemy.sql.sqltypes.Float()
1812
+
1559
1813
  class ST_ClosestPoint(GenericFunction):
1560
1814
  """
1561
1815
  Returns the 2D point on g1 that is closest to g2. This is the first point of the shortest line.
@@ -1583,72 +1837,112 @@ class ST_Distance(GenericFunction):
1583
1837
  Returns the distance between two geometry or geography values.
1584
1838
 
1585
1839
  see https://postgis.net/docs/ST_Distance.html
1840
+
1841
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
1586
1842
  """
1587
1843
 
1844
+ type = sqlalchemy.sql.sqltypes.Float()
1845
+
1588
1846
  class ST_3DDistance(GenericFunction):
1589
1847
  """
1590
1848
  Returns the 3D cartesian minimum distance (based on spatial ref) between two geometries in projected
1591
1849
  units.
1592
1850
 
1593
1851
  see https://postgis.net/docs/ST_3DDistance.html
1852
+
1853
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
1594
1854
  """
1595
1855
 
1856
+ type = sqlalchemy.sql.sqltypes.Float()
1857
+
1596
1858
  class ST_DistanceSphere(GenericFunction):
1597
1859
  """
1598
1860
  Returns minimum distance in meters between two lon/lat geometries using a spherical earth model.
1599
1861
 
1600
1862
  see https://postgis.net/docs/ST_DistanceSphere.html
1863
+
1864
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
1601
1865
  """
1602
1866
 
1867
+ type = sqlalchemy.sql.sqltypes.Float()
1868
+
1603
1869
  class ST_DistanceSpheroid(GenericFunction):
1604
1870
  """
1605
1871
  Returns the minimum distance between two lon/lat geometries using a spheroidal earth model.
1606
1872
 
1607
1873
  see https://postgis.net/docs/ST_DistanceSpheroid.html
1874
+
1875
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
1608
1876
  """
1609
1877
 
1878
+ type = sqlalchemy.sql.sqltypes.Float()
1879
+
1610
1880
  class ST_FrechetDistance(GenericFunction):
1611
1881
  """
1612
1882
  Returns the Fréchet distance between two geometries.
1613
1883
 
1614
1884
  see https://postgis.net/docs/ST_FrechetDistance.html
1885
+
1886
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
1615
1887
  """
1616
1888
 
1889
+ type = sqlalchemy.sql.sqltypes.Float()
1890
+
1617
1891
  class ST_HausdorffDistance(GenericFunction):
1618
1892
  """
1619
1893
  Returns the Hausdorff distance between two geometries.
1620
1894
 
1621
1895
  see https://postgis.net/docs/ST_HausdorffDistance.html
1896
+
1897
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
1622
1898
  """
1623
1899
 
1900
+ type = sqlalchemy.sql.sqltypes.Float()
1901
+
1624
1902
  class ST_Length(GenericFunction):
1625
1903
  """
1626
1904
  Returns the 2D length of a linear geometry.
1627
1905
 
1628
1906
  see https://postgis.net/docs/ST_Length.html
1907
+
1908
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
1629
1909
  """
1630
1910
 
1911
+ type = sqlalchemy.sql.sqltypes.Float()
1912
+
1631
1913
  class ST_Length2D(GenericFunction):
1632
1914
  """
1633
1915
  Returns the 2D length of a linear geometry. Alias for ST_Length
1634
1916
 
1635
1917
  see https://postgis.net/docs/ST_Length2D.html
1918
+
1919
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
1636
1920
  """
1637
1921
 
1922
+ type = sqlalchemy.sql.sqltypes.Float()
1923
+
1638
1924
  class ST_3DLength(GenericFunction):
1639
1925
  """
1640
1926
  Returns the 3D length of a linear geometry.
1641
1927
 
1642
1928
  see https://postgis.net/docs/ST_3DLength.html
1929
+
1930
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
1643
1931
  """
1644
1932
 
1933
+ type = sqlalchemy.sql.sqltypes.Float()
1934
+
1645
1935
  class ST_LengthSpheroid(GenericFunction):
1646
1936
  """
1647
1937
  Returns the 2D or 3D length/perimeter of a lon/lat geometry on a spheroid.
1648
1938
 
1649
1939
  see https://postgis.net/docs/ST_LengthSpheroid.html
1940
+
1941
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
1650
1942
  """
1651
1943
 
1944
+ type = sqlalchemy.sql.sqltypes.Float()
1945
+
1652
1946
  class ST_LongestLine(GenericFunction):
1653
1947
  """
1654
1948
  Returns the 2D longest line between two geometries.
@@ -1676,23 +1970,35 @@ class ST_MaxDistance(GenericFunction):
1676
1970
  Returns the 2D largest distance between two geometries in projected units.
1677
1971
 
1678
1972
  see https://postgis.net/docs/ST_MaxDistance.html
1973
+
1974
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
1679
1975
  """
1680
1976
 
1977
+ type = sqlalchemy.sql.sqltypes.Float()
1978
+
1681
1979
  class ST_3DMaxDistance(GenericFunction):
1682
1980
  """
1683
1981
  Returns the 3D cartesian maximum distance (based on spatial ref) between two geometries in projected
1684
1982
  units.
1685
1983
 
1686
1984
  see https://postgis.net/docs/ST_3DMaxDistance.html
1985
+
1986
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
1687
1987
  """
1688
1988
 
1989
+ type = sqlalchemy.sql.sqltypes.Float()
1990
+
1689
1991
  class ST_MinimumClearance(GenericFunction):
1690
1992
  """
1691
1993
  Returns the minimum clearance of a geometry, a measure of a geometry's robustness.
1692
1994
 
1693
1995
  see https://postgis.net/docs/ST_MinimumClearance.html
1996
+
1997
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
1694
1998
  """
1695
1999
 
2000
+ type = sqlalchemy.sql.sqltypes.Float()
2001
+
1696
2002
  class ST_MinimumClearanceLine(GenericFunction):
1697
2003
  """
1698
2004
  Returns the two-point LineString spanning a geometry's minimum clearance.
@@ -1709,22 +2015,34 @@ class ST_Perimeter(GenericFunction):
1709
2015
  Returns the length of the boundary of a polygonal geometry or geography.
1710
2016
 
1711
2017
  see https://postgis.net/docs/ST_Perimeter.html
2018
+
2019
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
1712
2020
  """
1713
2021
 
2022
+ type = sqlalchemy.sql.sqltypes.Float()
2023
+
1714
2024
  class ST_Perimeter2D(GenericFunction):
1715
2025
  """
1716
2026
  Returns the 2D perimeter of a polygonal geometry. Alias for ST_Perimeter.
1717
2027
 
1718
2028
  see https://postgis.net/docs/ST_Perimeter2D.html
2029
+
2030
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
1719
2031
  """
1720
2032
 
2033
+ type = sqlalchemy.sql.sqltypes.Float()
2034
+
1721
2035
  class ST_3DPerimeter(GenericFunction):
1722
2036
  """
1723
2037
  Returns the 3D perimeter of a polygonal geometry.
1724
2038
 
1725
2039
  see https://postgis.net/docs/ST_3DPerimeter.html
2040
+
2041
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
1726
2042
  """
1727
2043
 
2044
+ type = sqlalchemy.sql.sqltypes.Float()
2045
+
1728
2046
  class ST_Project(GenericFunction):
1729
2047
  """
1730
2048
  Returns a point projected from a start point by a distance and bearing (azimuth).
@@ -2308,8 +2626,12 @@ class ST_ClusterDBSCAN(GenericFunction):
2308
2626
  Window function that returns a cluster id for each input geometry using the DBSCAN algorithm.
2309
2627
 
2310
2628
  see https://postgis.net/docs/ST_ClusterDBSCAN.html
2629
+
2630
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
2311
2631
  """
2312
2632
 
2633
+ type = sqlalchemy.sql.sqltypes.Integer()
2634
+
2313
2635
  class ST_ClusterIntersecting(GenericFunction):
2314
2636
  """
2315
2637
  Aggregate function that clusters the input geometries into connected sets.
@@ -2326,8 +2648,12 @@ class ST_ClusterKMeans(GenericFunction):
2326
2648
  Window function that returns a cluster id for each input geometry using the K-means algorithm.
2327
2649
 
2328
2650
  see https://postgis.net/docs/ST_ClusterKMeans.html
2651
+
2652
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
2329
2653
  """
2330
2654
 
2655
+ type = sqlalchemy.sql.sqltypes.Integer()
2656
+
2331
2657
  class ST_ClusterWithin(GenericFunction):
2332
2658
  """
2333
2659
  Aggregate function that clusters the input geometries by separation distance.
@@ -2406,43 +2732,67 @@ class ST_XMax(GenericFunction):
2406
2732
  Returns the X maxima of a 2D or 3D bounding box or a geometry.
2407
2733
 
2408
2734
  see https://postgis.net/docs/ST_XMax.html
2735
+
2736
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
2409
2737
  """
2410
2738
 
2739
+ type = sqlalchemy.sql.sqltypes.Float()
2740
+
2411
2741
  class ST_XMin(GenericFunction):
2412
2742
  """
2413
2743
  Returns the X minima of a 2D or 3D bounding box or a geometry.
2414
2744
 
2415
2745
  see https://postgis.net/docs/ST_XMin.html
2746
+
2747
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
2416
2748
  """
2417
2749
 
2750
+ type = sqlalchemy.sql.sqltypes.Float()
2751
+
2418
2752
  class ST_YMax(GenericFunction):
2419
2753
  """
2420
2754
  Returns the Y maxima of a 2D or 3D bounding box or a geometry.
2421
2755
 
2422
2756
  see https://postgis.net/docs/ST_YMax.html
2757
+
2758
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
2423
2759
  """
2424
2760
 
2761
+ type = sqlalchemy.sql.sqltypes.Float()
2762
+
2425
2763
  class ST_YMin(GenericFunction):
2426
2764
  """
2427
2765
  Returns the Y minima of a 2D or 3D bounding box or a geometry.
2428
2766
 
2429
2767
  see https://postgis.net/docs/ST_YMin.html
2768
+
2769
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
2430
2770
  """
2431
2771
 
2772
+ type = sqlalchemy.sql.sqltypes.Float()
2773
+
2432
2774
  class ST_ZMax(GenericFunction):
2433
2775
  """
2434
2776
  Returns the Z maxima of a 2D or 3D bounding box or a geometry.
2435
2777
 
2436
2778
  see https://postgis.net/docs/ST_ZMax.html
2779
+
2780
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
2437
2781
  """
2438
2782
 
2783
+ type = sqlalchemy.sql.sqltypes.Float()
2784
+
2439
2785
  class ST_ZMin(GenericFunction):
2440
2786
  """
2441
2787
  Returns the Z minima of a 2D or 3D bounding box or a geometry.
2442
2788
 
2443
2789
  see https://postgis.net/docs/ST_ZMin.html
2790
+
2791
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
2444
2792
  """
2445
2793
 
2794
+ type = sqlalchemy.sql.sqltypes.Float()
2795
+
2446
2796
  class ST_LineInterpolatePoint(GenericFunction):
2447
2797
  """
2448
2798
  Returns a point interpolated along a line. Second argument is a float8 between 0 and 1 representing
@@ -2484,8 +2834,12 @@ class ST_LineLocatePoint(GenericFunction):
2484
2834
  given Point, as a fraction of total 2d line length.
2485
2835
 
2486
2836
  see https://postgis.net/docs/ST_LineLocatePoint.html
2837
+
2838
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
2487
2839
  """
2488
2840
 
2841
+ type = sqlalchemy.sql.sqltypes.Float()
2842
+
2489
2843
  class ST_LineSubstring(GenericFunction):
2490
2844
  """
2491
2845
  Return a linestring being a substring of the input one starting and ending at the given fractions of
@@ -2539,8 +2893,12 @@ class ST_InterpolatePoint(GenericFunction):
2539
2893
  Return the value of the measure dimension of a geometry at the point closed to the provided point.
2540
2894
 
2541
2895
  see https://postgis.net/docs/ST_InterpolatePoint.html
2896
+
2897
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
2542
2898
  """
2543
2899
 
2900
+ type = sqlalchemy.sql.sqltypes.Float()
2901
+
2544
2902
  class ST_AddMeasure(GenericFunction):
2545
2903
  """
2546
2904
  Return a derived geometry with measure elements linearly interpolated between the start and end
@@ -2558,36 +2916,56 @@ class ST_IsValidTrajectory(GenericFunction):
2558
2916
  Returns true if the geometry is a valid trajectory.
2559
2917
 
2560
2918
  see https://postgis.net/docs/ST_IsValidTrajectory.html
2919
+
2920
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
2561
2921
  """
2562
2922
 
2923
+ type = sqlalchemy.sql.sqltypes.Boolean()
2924
+
2563
2925
  class ST_ClosestPointOfApproach(GenericFunction):
2564
2926
  """
2565
2927
  Returns the measure at which points interpolated along two trajectories are closest.
2566
2928
 
2567
2929
  see https://postgis.net/docs/ST_ClosestPointOfApproach.html
2930
+
2931
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
2568
2932
  """
2569
2933
 
2934
+ type = sqlalchemy.sql.sqltypes.Float()
2935
+
2570
2936
  class ST_DistanceCPA(GenericFunction):
2571
2937
  """
2572
2938
  Returns the distance between the closest point of approach of two trajectories.
2573
2939
 
2574
2940
  see https://postgis.net/docs/ST_DistanceCPA.html
2941
+
2942
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
2575
2943
  """
2576
2944
 
2945
+ type = sqlalchemy.sql.sqltypes.Float()
2946
+
2577
2947
  class ST_CPAWithin(GenericFunction):
2578
2948
  """
2579
2949
  Returns true if the closest point of approach of two trajectories is within the specified distance.
2580
2950
 
2581
2951
  see https://postgis.net/docs/ST_CPAWithin.html
2952
+
2953
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
2582
2954
  """
2583
2955
 
2956
+ type = sqlalchemy.sql.sqltypes.Boolean()
2957
+
2584
2958
  class postgis_sfcgal_version(GenericFunction):
2585
2959
  """
2586
2960
  Returns the version of SFCGAL in use
2587
2961
 
2588
2962
  see https://postgis.net/docs/postgis_sfcgal_version.html
2963
+
2964
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
2589
2965
  """
2590
2966
 
2967
+ type = sqlalchemy.sql.sqltypes.String()
2968
+
2591
2969
  class ST_Extrude(GenericFunction):
2592
2970
  """
2593
2971
  Extrude a surface to a related volume
@@ -2626,15 +3004,34 @@ class ST_IsPlanar(GenericFunction):
2626
3004
  Check if a surface is or not planar
2627
3005
 
2628
3006
  see https://postgis.net/docs/ST_IsPlanar.html
3007
+
3008
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
2629
3009
  """
2630
3010
 
3011
+ type = sqlalchemy.sql.sqltypes.Boolean()
3012
+
2631
3013
  class ST_Orientation(GenericFunction):
2632
3014
  """
2633
3015
  Determine surface orientation
2634
3016
 
2635
3017
  see https://postgis.net/docs/ST_Orientation.html
3018
+
3019
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
2636
3020
  """
2637
3021
 
3022
+ type = sqlalchemy.sql.sqltypes.Integer()
3023
+
3024
+ class CG_Orientation(GenericFunction):
3025
+ """
3026
+ Determine surface orientation
3027
+
3028
+ see https://postgis.net/docs/CG_Orientation.html
3029
+
3030
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
3031
+ """
3032
+
3033
+ type = sqlalchemy.sql.sqltypes.Integer()
3034
+
2638
3035
  class ST_ForceLHR(GenericFunction):
2639
3036
  """
2640
3037
  Force LHR orientation
@@ -2706,8 +3103,23 @@ class ST_3DArea(GenericFunction):
2706
3103
  Computes area of 3D surface geometries. Will return 0 for solids.
2707
3104
 
2708
3105
  see https://postgis.net/docs/ST_3DArea.html
3106
+
3107
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
2709
3108
  """
2710
3109
 
3110
+ type = sqlalchemy.sql.sqltypes.Float()
3111
+
3112
+ class CG_3DArea(GenericFunction):
3113
+ """
3114
+ Computes area of 3D surface geometries. Will return 0 for solids.
3115
+
3116
+ see https://postgis.net/docs/CG_3DArea.html
3117
+
3118
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
3119
+ """
3120
+
3121
+ type = sqlalchemy.sql.sqltypes.Float()
3122
+
2711
3123
  class ST_Tesselate(GenericFunction):
2712
3124
  """
2713
3125
  Perform surface Tessellation of a polygon or polyhedralsurface and returns as a TIN or collection of
@@ -2725,8 +3137,12 @@ class ST_Volume(GenericFunction):
2725
3137
  Computes the volume of a 3D solid. If applied to surface (even closed) geometries will return 0.
2726
3138
 
2727
3139
  see https://postgis.net/docs/ST_Volume.html
3140
+
3141
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
2728
3142
  """
2729
3143
 
3144
+ type = sqlalchemy.sql.sqltypes.Float()
3145
+
2730
3146
  class ST_MakeSolid(GenericFunction):
2731
3147
  """
2732
3148
  Cast the geometry into a solid. No check is performed. To obtain a valid solid, the input geometry
@@ -2744,143 +3160,234 @@ class ST_IsSolid(GenericFunction):
2744
3160
  Test if the geometry is a solid. No validity check is performed.
2745
3161
 
2746
3162
  see https://postgis.net/docs/ST_IsSolid.html
3163
+
3164
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
2747
3165
  """
2748
3166
 
3167
+ type = sqlalchemy.sql.sqltypes.Boolean()
3168
+
3169
+ class CG_IsSolid(GenericFunction):
3170
+ """
3171
+ Test if the geometry is a solid. No validity check is performed.
3172
+
3173
+ see https://postgis.net/docs/CG_IsSolid.html
3174
+
3175
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
3176
+ """
3177
+
3178
+ type = sqlalchemy.sql.sqltypes.Boolean()
3179
+
2749
3180
  class AddAuth(GenericFunction):
2750
3181
  """
2751
3182
  Adds an authorization token to be used in the current transaction.
2752
3183
 
2753
3184
  see https://postgis.net/docs/AddAuth.html
3185
+
3186
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
2754
3187
  """
2755
3188
 
3189
+ type = sqlalchemy.sql.sqltypes.Boolean()
3190
+
2756
3191
  class CheckAuth(GenericFunction):
2757
3192
  """
2758
3193
  Creates a trigger on a table to prevent/allow updates and deletes of rows based on authorization
2759
3194
  token.
2760
3195
 
2761
3196
  see https://postgis.net/docs/CheckAuth.html
3197
+
3198
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
2762
3199
  """
2763
3200
 
3201
+ type = sqlalchemy.sql.sqltypes.Integer()
3202
+
2764
3203
  class DisableLongTransactions(GenericFunction):
2765
3204
  """
2766
3205
  Disables long transaction support.
2767
3206
 
2768
3207
  see https://postgis.net/docs/DisableLongTransactions.html
3208
+
3209
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
2769
3210
  """
2770
3211
 
3212
+ type = sqlalchemy.sql.sqltypes.String()
3213
+
2771
3214
  class EnableLongTransactions(GenericFunction):
2772
3215
  """
2773
3216
  Enables long transaction support.
2774
3217
 
2775
3218
  see https://postgis.net/docs/EnableLongTransactions.html
3219
+
3220
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
2776
3221
  """
2777
3222
 
3223
+ type = sqlalchemy.sql.sqltypes.String()
3224
+
2778
3225
  class LockRow(GenericFunction):
2779
3226
  """
2780
3227
  Sets lock/authorization for a row in a table.
2781
3228
 
2782
3229
  see https://postgis.net/docs/LockRow.html
3230
+
3231
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
2783
3232
  """
2784
3233
 
3234
+ type = sqlalchemy.sql.sqltypes.Integer()
3235
+
2785
3236
  class UnlockRows(GenericFunction):
2786
3237
  """
2787
3238
  Removes all locks held by an authorization token.
2788
3239
 
2789
3240
  see https://postgis.net/docs/UnlockRows.html
3241
+
3242
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
2790
3243
  """
2791
3244
 
3245
+ type = sqlalchemy.sql.sqltypes.Integer()
3246
+
2792
3247
  class PostGIS_Extensions_Upgrade(GenericFunction):
2793
3248
  """
2794
3249
  Packages and upgrades postgis extensions (e.g. postgis_raster, postgis_topology, postgis_sfcgal) to
2795
3250
  latest available version.
2796
3251
 
2797
3252
  see https://postgis.net/docs/PostGIS_Extensions_Upgrade.html
3253
+
3254
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
2798
3255
  """
2799
3256
 
3257
+ type = sqlalchemy.sql.sqltypes.String()
3258
+
2800
3259
  class PostGIS_Full_Version(GenericFunction):
2801
3260
  """
2802
3261
  Reports full postgis version and build configuration infos.
2803
3262
 
2804
3263
  see https://postgis.net/docs/PostGIS_Full_Version.html
3264
+
3265
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
2805
3266
  """
2806
3267
 
3268
+ type = sqlalchemy.sql.sqltypes.String()
3269
+
2807
3270
  class PostGIS_GEOS_Version(GenericFunction):
2808
3271
  """
2809
3272
  Returns the version number of the GEOS library.
2810
3273
 
2811
3274
  see https://postgis.net/docs/PostGIS_GEOS_Version.html
3275
+
3276
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
2812
3277
  """
2813
3278
 
3279
+ type = sqlalchemy.sql.sqltypes.String()
3280
+
2814
3281
  class PostGIS_Liblwgeom_Version(GenericFunction):
2815
3282
  """
2816
3283
  Returns the version number of the liblwgeom library. This should match the version of PostGIS.
2817
3284
 
2818
3285
  see https://postgis.net/docs/PostGIS_Liblwgeom_Version.html
3286
+
3287
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
2819
3288
  """
2820
3289
 
3290
+ type = sqlalchemy.sql.sqltypes.String()
3291
+
2821
3292
  class PostGIS_LibXML_Version(GenericFunction):
2822
3293
  """
2823
3294
  Returns the version number of the libxml2 library.
2824
3295
 
2825
3296
  see https://postgis.net/docs/PostGIS_LibXML_Version.html
3297
+
3298
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
2826
3299
  """
2827
3300
 
3301
+ type = sqlalchemy.sql.sqltypes.String()
3302
+
2828
3303
  class PostGIS_Lib_Build_Date(GenericFunction):
2829
3304
  """
2830
3305
  Returns build date of the PostGIS library.
2831
3306
 
2832
3307
  see https://postgis.net/docs/PostGIS_Lib_Build_Date.html
3308
+
3309
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
2833
3310
  """
2834
3311
 
3312
+ type = sqlalchemy.sql.sqltypes.String()
3313
+
2835
3314
  class PostGIS_Lib_Version(GenericFunction):
2836
3315
  """
2837
3316
  Returns the version number of the PostGIS library.
2838
3317
 
2839
3318
  see https://postgis.net/docs/PostGIS_Lib_Version.html
3319
+
3320
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
2840
3321
  """
2841
3322
 
3323
+ type = sqlalchemy.sql.sqltypes.String()
3324
+
2842
3325
  class PostGIS_PROJ_Version(GenericFunction):
2843
3326
  """
2844
3327
  Returns the version number of the PROJ4 library.
2845
3328
 
2846
3329
  see https://postgis.net/docs/PostGIS_PROJ_Version.html
3330
+
3331
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
2847
3332
  """
2848
3333
 
3334
+ type = sqlalchemy.sql.sqltypes.String()
3335
+
2849
3336
  class PostGIS_Wagyu_Version(GenericFunction):
2850
3337
  """
2851
3338
  Returns the version number of the internal Wagyu library.
2852
3339
 
2853
3340
  see https://postgis.net/docs/PostGIS_Wagyu_Version.html
3341
+
3342
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
2854
3343
  """
2855
3344
 
3345
+ type = sqlalchemy.sql.sqltypes.String()
3346
+
2856
3347
  class PostGIS_Scripts_Build_Date(GenericFunction):
2857
3348
  """
2858
3349
  Returns build date of the PostGIS scripts.
2859
3350
 
2860
3351
  see https://postgis.net/docs/PostGIS_Scripts_Build_Date.html
3352
+
3353
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
2861
3354
  """
2862
3355
 
3356
+ type = sqlalchemy.sql.sqltypes.String()
3357
+
2863
3358
  class PostGIS_Scripts_Installed(GenericFunction):
2864
3359
  """
2865
3360
  Returns version of the postgis scripts installed in this database.
2866
3361
 
2867
3362
  see https://postgis.net/docs/PostGIS_Scripts_Installed.html
3363
+
3364
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
2868
3365
  """
2869
3366
 
3367
+ type = sqlalchemy.sql.sqltypes.String()
3368
+
2870
3369
  class PostGIS_Scripts_Released(GenericFunction):
2871
3370
  """
2872
3371
  Returns the version number of the postgis.sql script released with the installed postgis lib.
2873
3372
 
2874
3373
  see https://postgis.net/docs/PostGIS_Scripts_Released.html
3374
+
3375
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
2875
3376
  """
2876
3377
 
3378
+ type = sqlalchemy.sql.sqltypes.String()
3379
+
2877
3380
  class PostGIS_Version(GenericFunction):
2878
3381
  """
2879
3382
  Returns PostGIS version number and compile-time options.
2880
3383
 
2881
3384
  see https://postgis.net/docs/PostGIS_Version.html
3385
+
3386
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
2882
3387
  """
2883
3388
 
3389
+ type = sqlalchemy.sql.sqltypes.String()
3390
+
2884
3391
  class PostGIS_AddBBox(GenericFunction):
2885
3392
  """
2886
3393
  Add bounding box to the geometry.
@@ -2908,8 +3415,12 @@ class PostGIS_HasBBox(GenericFunction):
2908
3415
  Returns TRUE if the bbox of this geometry is cached, FALSE otherwise.
2909
3416
 
2910
3417
  see https://postgis.net/docs/PostGIS_HasBBox.html
3418
+
3419
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
2911
3420
  """
2912
3421
 
3422
+ type = sqlalchemy.sql.sqltypes.Boolean()
3423
+
2913
3424
  class ST_AddBand(GenericFunction):
2914
3425
  """
2915
3426
  Returns a raster with the new band(s) of given type added with given initial value in the given
@@ -3010,15 +3521,23 @@ class ST_GeoReference(GenericFunction):
3010
3521
  is GDAL.
3011
3522
 
3012
3523
  see https://postgis.net/docs/RT_ST_GeoReference.html
3524
+
3525
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
3013
3526
  """
3014
3527
 
3528
+ type = sqlalchemy.sql.sqltypes.String()
3529
+
3015
3530
  class ST_Height(GenericFunction):
3016
3531
  """
3017
3532
  Returns the height of the raster in pixels.
3018
3533
 
3019
3534
  see https://postgis.net/docs/RT_ST_Height.html
3535
+
3536
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
3020
3537
  """
3021
3538
 
3539
+ type = sqlalchemy.sql.sqltypes.Integer()
3540
+
3022
3541
  class ST_MetaData(GenericFunction):
3023
3542
  """
3024
3543
  Returns basic meta data about a raster object such as pixel size, rotation (skew), upper, lower
@@ -3032,36 +3551,56 @@ class ST_NumBands(GenericFunction):
3032
3551
  Returns the number of bands in the raster object.
3033
3552
 
3034
3553
  see https://postgis.net/docs/RT_ST_NumBands.html
3554
+
3555
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
3035
3556
  """
3036
3557
 
3558
+ type = sqlalchemy.sql.sqltypes.Integer()
3559
+
3037
3560
  class ST_PixelHeight(GenericFunction):
3038
3561
  """
3039
3562
  Returns the pixel height in geometric units of the spatial reference system.
3040
3563
 
3041
3564
  see https://postgis.net/docs/RT_ST_PixelHeight.html
3565
+
3566
+ Return type: :class:`sqlalchemy.sql.sqltypes.Double`.
3042
3567
  """
3043
3568
 
3569
+ type = sqlalchemy.sql.sqltypes.Double()
3570
+
3044
3571
  class ST_PixelWidth(GenericFunction):
3045
3572
  """
3046
3573
  Returns the pixel width in geometric units of the spatial reference system.
3047
3574
 
3048
3575
  see https://postgis.net/docs/RT_ST_PixelWidth.html
3576
+
3577
+ Return type: :class:`sqlalchemy.sql.sqltypes.Double`.
3049
3578
  """
3050
3579
 
3580
+ type = sqlalchemy.sql.sqltypes.Double()
3581
+
3051
3582
  class ST_ScaleX(GenericFunction):
3052
3583
  """
3053
3584
  Returns the X component of the pixel width in units of coordinate reference system.
3054
3585
 
3055
3586
  see https://postgis.net/docs/RT_ST_ScaleX.html
3587
+
3588
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
3056
3589
  """
3057
3590
 
3591
+ type = sqlalchemy.sql.sqltypes.Float()
3592
+
3058
3593
  class ST_ScaleY(GenericFunction):
3059
3594
  """
3060
3595
  Returns the Y component of the pixel height in units of coordinate reference system.
3061
3596
 
3062
3597
  see https://postgis.net/docs/RT_ST_ScaleY.html
3598
+
3599
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
3063
3600
  """
3064
3601
 
3602
+ type = sqlalchemy.sql.sqltypes.Float()
3603
+
3065
3604
  class ST_RasterToWorldCoord(GenericFunction):
3066
3605
  """
3067
3606
  Returns the raster's upper left corner as geometric X and Y (longitude and latitude) given a column
@@ -3076,58 +3615,90 @@ class ST_RasterToWorldCoordX(GenericFunction):
3076
3615
  rows starts at 1.
3077
3616
 
3078
3617
  see https://postgis.net/docs/RT_ST_RasterToWorldCoordX.html
3618
+
3619
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
3079
3620
  """
3080
3621
 
3622
+ type = sqlalchemy.sql.sqltypes.Float()
3623
+
3081
3624
  class ST_RasterToWorldCoordY(GenericFunction):
3082
3625
  """
3083
3626
  Returns the geometric Y coordinate upper left corner of a raster, column and row. Numbering of
3084
3627
  columns and rows starts at 1.
3085
3628
 
3086
3629
  see https://postgis.net/docs/RT_ST_RasterToWorldCoordY.html
3630
+
3631
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
3087
3632
  """
3088
3633
 
3634
+ type = sqlalchemy.sql.sqltypes.Float()
3635
+
3089
3636
  class ST_Rotation(GenericFunction):
3090
3637
  """
3091
3638
  Returns the rotation of the raster in radian.
3092
3639
 
3093
3640
  see https://postgis.net/docs/RT_ST_Rotation.html
3641
+
3642
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
3094
3643
  """
3095
3644
 
3645
+ type = sqlalchemy.sql.sqltypes.Float()
3646
+
3096
3647
  class ST_SkewX(GenericFunction):
3097
3648
  """
3098
3649
  Returns the georeference X skew (or rotation parameter).
3099
3650
 
3100
3651
  see https://postgis.net/docs/RT_ST_SkewX.html
3652
+
3653
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
3101
3654
  """
3102
3655
 
3656
+ type = sqlalchemy.sql.sqltypes.Float()
3657
+
3103
3658
  class ST_SkewY(GenericFunction):
3104
3659
  """
3105
3660
  Returns the georeference Y skew (or rotation parameter).
3106
3661
 
3107
3662
  see https://postgis.net/docs/RT_ST_SkewY.html
3663
+
3664
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
3108
3665
  """
3109
3666
 
3667
+ type = sqlalchemy.sql.sqltypes.Float()
3668
+
3110
3669
  class ST_UpperLeftX(GenericFunction):
3111
3670
  """
3112
3671
  Returns the upper left X coordinate of raster in projected spatial ref.
3113
3672
 
3114
3673
  see https://postgis.net/docs/RT_ST_UpperLeftX.html
3674
+
3675
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
3115
3676
  """
3116
3677
 
3678
+ type = sqlalchemy.sql.sqltypes.Float()
3679
+
3117
3680
  class ST_UpperLeftY(GenericFunction):
3118
3681
  """
3119
3682
  Returns the upper left Y coordinate of raster in projected spatial ref.
3120
3683
 
3121
3684
  see https://postgis.net/docs/RT_ST_UpperLeftY.html
3685
+
3686
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
3122
3687
  """
3123
3688
 
3689
+ type = sqlalchemy.sql.sqltypes.Float()
3690
+
3124
3691
  class ST_Width(GenericFunction):
3125
3692
  """
3126
3693
  Returns the width of the raster in pixels.
3127
3694
 
3128
3695
  see https://postgis.net/docs/RT_ST_Width.html
3696
+
3697
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
3129
3698
  """
3130
3699
 
3700
+ type = sqlalchemy.sql.sqltypes.Integer()
3701
+
3131
3702
  class ST_WorldToRasterCoord(GenericFunction):
3132
3703
  """
3133
3704
  Returns the upper left corner as column and row given geometric X and Y (longitude and latitude) or
@@ -3142,16 +3713,24 @@ class ST_WorldToRasterCoordX(GenericFunction):
3142
3713
  represented in world spatial reference system of raster.
3143
3714
 
3144
3715
  see https://postgis.net/docs/RT_ST_WorldToRasterCoordX.html
3716
+
3717
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
3145
3718
  """
3146
3719
 
3720
+ type = sqlalchemy.sql.sqltypes.Integer()
3721
+
3147
3722
  class ST_WorldToRasterCoordY(GenericFunction):
3148
3723
  """
3149
3724
  Returns the row in the raster of the point geometry (pt) or a X and Y world coordinate (xw, yw)
3150
3725
  represented in world spatial reference system of raster.
3151
3726
 
3152
3727
  see https://postgis.net/docs/RT_ST_WorldToRasterCoordY.html
3728
+
3729
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
3153
3730
  """
3154
3731
 
3732
+ type = sqlalchemy.sql.sqltypes.Integer()
3733
+
3155
3734
  class ST_BandMetaData(GenericFunction):
3156
3735
  """
3157
3736
  Returns basic meta data for a specific raster band. band num 1 is assumed if none-specified.
@@ -3164,58 +3743,90 @@ class ST_BandNoDataValue(GenericFunction):
3164
3743
  Returns the value in a given band that represents no data. If no band num 1 is assumed.
3165
3744
 
3166
3745
  see https://postgis.net/docs/RT_ST_BandNoDataValue.html
3746
+
3747
+ Return type: :class:`sqlalchemy.sql.sqltypes.Double`.
3167
3748
  """
3168
3749
 
3750
+ type = sqlalchemy.sql.sqltypes.Double()
3751
+
3169
3752
  class ST_BandIsNoData(GenericFunction):
3170
3753
  """
3171
3754
  Returns true if the band is filled with only nodata values.
3172
3755
 
3173
3756
  see https://postgis.net/docs/RT_ST_BandIsNoData.html
3757
+
3758
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
3174
3759
  """
3175
3760
 
3761
+ type = sqlalchemy.sql.sqltypes.Boolean()
3762
+
3176
3763
  class ST_BandPath(GenericFunction):
3177
3764
  """
3178
3765
  Returns system file path to a band stored in file system. If no bandnum specified, 1 is assumed.
3179
3766
 
3180
3767
  see https://postgis.net/docs/RT_ST_BandPath.html
3768
+
3769
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
3181
3770
  """
3182
3771
 
3772
+ type = sqlalchemy.sql.sqltypes.String()
3773
+
3183
3774
  class ST_BandFileSize(GenericFunction):
3184
3775
  """
3185
3776
  Returns the file size of a band stored in file system. If no bandnum specified, 1 is assumed.
3186
3777
 
3187
3778
  see https://postgis.net/docs/RT_ST_BandFileSize.html
3779
+
3780
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
3188
3781
  """
3189
3782
 
3783
+ type = sqlalchemy.sql.sqltypes.Integer()
3784
+
3190
3785
  class ST_BandFileTimestamp(GenericFunction):
3191
3786
  """
3192
3787
  Returns the file timestamp of a band stored in file system. If no bandnum specified, 1 is assumed.
3193
3788
 
3194
3789
  see https://postgis.net/docs/RT_ST_BandFileTimestamp.html
3790
+
3791
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
3195
3792
  """
3196
3793
 
3794
+ type = sqlalchemy.sql.sqltypes.Integer()
3795
+
3197
3796
  class ST_BandPixelType(GenericFunction):
3198
3797
  """
3199
3798
  Returns the type of pixel for given band. If no bandnum specified, 1 is assumed.
3200
3799
 
3201
3800
  see https://postgis.net/docs/RT_ST_BandPixelType.html
3801
+
3802
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
3202
3803
  """
3203
3804
 
3805
+ type = sqlalchemy.sql.sqltypes.String()
3806
+
3204
3807
  class ST_MinPossibleValue(GenericFunction):
3205
3808
  """
3206
3809
  Returns the minimum value this pixeltype can store.
3207
3810
 
3208
3811
  see https://postgis.net/docs/ST_MinPossibleValue.html
3812
+
3813
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
3209
3814
  """
3210
3815
 
3816
+ type = sqlalchemy.sql.sqltypes.Integer()
3817
+
3211
3818
  class ST_HasNoBand(GenericFunction):
3212
3819
  """
3213
3820
  Returns true if there is no band with given band number. If no band number is specified, then band
3214
3821
  number 1 is assumed.
3215
3822
 
3216
3823
  see https://postgis.net/docs/RT_ST_HasNoBand.html
3824
+
3825
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
3217
3826
  """
3218
3827
 
3828
+ type = sqlalchemy.sql.sqltypes.Boolean()
3829
+
3219
3830
  class ST_PixelAsPolygon(GenericFunction):
3220
3831
  """
3221
3832
  Returns the polygon geometry that bounds the pixel for a particular row and column.
@@ -3283,16 +3894,24 @@ class ST_Value(GenericFunction):
3283
3894
  exclude_nodata_value is not passed in then reads it from metadata of raster.
3284
3895
 
3285
3896
  see https://postgis.net/docs/RT_ST_Value.html
3897
+
3898
+ Return type: :class:`sqlalchemy.sql.sqltypes.Double`.
3286
3899
  """
3287
3900
 
3901
+ type = sqlalchemy.sql.sqltypes.Double()
3902
+
3288
3903
  class ST_NearestValue(GenericFunction):
3289
3904
  """
3290
3905
  Returns the nearest non-NODATA value of a given band's pixel specified by a columnx and rowy or a
3291
3906
  geometric point expressed in the same spatial reference coordinate system as the raster.
3292
3907
 
3293
3908
  see https://postgis.net/docs/RT_ST_NearestValue.html
3909
+
3910
+ Return type: :class:`sqlalchemy.sql.sqltypes.Double`.
3294
3911
  """
3295
3912
 
3913
+ type = sqlalchemy.sql.sqltypes.Double()
3914
+
3296
3915
  class ST_Neighborhood(GenericFunction):
3297
3916
  """
3298
3917
  Returns a 2-D double precision array of the non-NODATA values around a given band's pixel specified
@@ -3499,8 +4118,12 @@ class ST_Count(GenericFunction):
3499
4118
  equal to the nodata value.
3500
4119
 
3501
4120
  see https://postgis.net/docs/RT_ST_Count.html
4121
+
4122
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
3502
4123
  """
3503
4124
 
4125
+ type = sqlalchemy.sql.sqltypes.Integer()
4126
+
3504
4127
  class ST_CountAgg(GenericFunction):
3505
4128
  """
3506
4129
  Aggregate. Returns the number of pixels in a given band of a set of rasters. If no band is specified
@@ -3508,8 +4131,12 @@ class ST_CountAgg(GenericFunction):
3508
4131
  equal to the NODATA value.
3509
4132
 
3510
4133
  see https://postgis.net/docs/RT_ST_CountAgg.html
4134
+
4135
+ Return type: :class:`sqlalchemy.sql.sqltypes.Integer`.
3511
4136
  """
3512
4137
 
4138
+ type = sqlalchemy.sql.sqltypes.Integer()
4139
+
3513
4140
  class ST_Histogram(GenericFunction):
3514
4141
  """
3515
4142
  Returns a set of record summarizing a raster or raster coverage data distribution separate bin
@@ -3583,15 +4210,23 @@ class ST_AsWKB(GenericFunction):
3583
4210
  Return the Well-Known Binary (WKB) representation of the raster.
3584
4211
 
3585
4212
  see https://postgis.net/docs/RT_ST_AsBinary.html
4213
+
4214
+ Return type: :class:`sqlalchemy.sql.sqltypes.LargeBinary`.
3586
4215
  """
3587
4216
 
4217
+ type = sqlalchemy.sql.sqltypes.LargeBinary()
4218
+
3588
4219
  class ST_AsHexWKB(GenericFunction):
3589
4220
  """
3590
4221
  Return the Well-Known Binary (WKB) in Hex representation of the raster.
3591
4222
 
3592
4223
  see https://postgis.net/docs/RT_ST_AsHexWKB.html
4224
+
4225
+ Return type: :class:`sqlalchemy.sql.sqltypes.LargeBinary`.
3593
4226
  """
3594
4227
 
4228
+ type = sqlalchemy.sql.sqltypes.LargeBinary()
4229
+
3595
4230
  class ST_AsGDALRaster(GenericFunction):
3596
4231
  """
3597
4232
  Return the raster tile in the designated GDAL Raster format. Raster formats are one of those
@@ -3599,8 +4234,12 @@ class ST_AsGDALRaster(GenericFunction):
3599
4234
  library.
3600
4235
 
3601
4236
  see https://postgis.net/docs/RT_ST_AsGDALRaster.html
4237
+
4238
+ Return type: :class:`sqlalchemy.sql.sqltypes.LargeBinary`.
3602
4239
  """
3603
4240
 
4241
+ type = sqlalchemy.sql.sqltypes.LargeBinary()
4242
+
3604
4243
  class ST_AsJPEG(GenericFunction):
3605
4244
  """
3606
4245
  Return the raster tile selected bands as a single Joint Photographic Exports Group (JPEG) image
@@ -3608,8 +4247,12 @@ class ST_AsJPEG(GenericFunction):
3608
4247
  If only 3 bands then all 3 bands are used and mapped to RGB.
3609
4248
 
3610
4249
  see https://postgis.net/docs/RT_ST_AsJPEG.html
4250
+
4251
+ Return type: :class:`sqlalchemy.sql.sqltypes.LargeBinary`.
3611
4252
  """
3612
4253
 
4254
+ type = sqlalchemy.sql.sqltypes.LargeBinary()
4255
+
3613
4256
  class ST_AsPNG(GenericFunction):
3614
4257
  """
3615
4258
  Return the raster tile selected bands as a single portable network graphics (PNG) image (byte
@@ -3618,16 +4261,24 @@ class ST_AsPNG(GenericFunction):
3618
4261
  RGBA space.
3619
4262
 
3620
4263
  see https://postgis.net/docs/RT_ST_AsPNG.html
4264
+
4265
+ Return type: :class:`sqlalchemy.sql.sqltypes.LargeBinary`.
3621
4266
  """
3622
4267
 
4268
+ type = sqlalchemy.sql.sqltypes.LargeBinary()
4269
+
3623
4270
  class ST_AsTIFF(GenericFunction):
3624
4271
  """
3625
4272
  Return the raster selected bands as a single TIFF image (byte array). If no band is specified or any
3626
4273
  of specified bands does not exist in the raster, then will try to use all bands.
3627
4274
 
3628
4275
  see https://postgis.net/docs/RT_ST_AsTIFF.html
4276
+
4277
+ Return type: :class:`sqlalchemy.sql.sqltypes.LargeBinary`.
3629
4278
  """
3630
4279
 
4280
+ type = sqlalchemy.sql.sqltypes.LargeBinary()
4281
+
3631
4282
  class ST_Clip(GenericFunction):
3632
4283
  """
3633
4284
  Returns the raster clipped by the input geometry. If band number not is specified, all bands are
@@ -3673,8 +4324,12 @@ class ST_MapAlgebra(GenericFunction):
3673
4324
  and one or more user-specified SQL expressions.
3674
4325
 
3675
4326
  see https://postgis.net/docs/RT_ST_MapAlgebra.html
4327
+
4328
+ Return type: :class:`geoalchemy2.types.Raster`.
3676
4329
  """
3677
4330
 
4331
+ type = geoalchemy2.types.Raster()
4332
+
3678
4333
  class ST_MapAlgebraExpr(GenericFunction):
3679
4334
  """
3680
4335
  [raster] 1 raster band version: Creates a new one band raster formed by applying a valid PostgreSQL
@@ -3894,15 +4549,23 @@ class ST_SameAlignment(GenericFunction):
3894
4549
  grid without cutting into pixels) and false if they don't with notice detailing issue.
3895
4550
 
3896
4551
  see https://postgis.net/docs/RT_ST_SameAlignment.html
4552
+
4553
+ Return type: :class:`sqlalchemy.sql.sqltypes.Boolean`.
3897
4554
  """
3898
4555
 
4556
+ type = sqlalchemy.sql.sqltypes.Boolean()
4557
+
3899
4558
  class ST_NotSameAlignmentReason(GenericFunction):
3900
4559
  """
3901
4560
  Returns text stating if rasters are aligned and if not aligned, a reason why.
3902
4561
 
3903
4562
  see https://postgis.net/docs/RT_ST_NotSameAlignmentReason.html
4563
+
4564
+ Return type: :class:`sqlalchemy.sql.sqltypes.String`.
3904
4565
  """
3905
4566
 
4567
+ type = sqlalchemy.sql.sqltypes.String()
4568
+
3906
4569
  class ST_Distance_Sphere(GenericFunction):
3907
4570
  """
3908
4571
  Returns minimum distance in meters between two lon/lat geometries. Uses a spherical earth and radius
@@ -3910,4 +4573,8 @@ class ST_Distance_Sphere(GenericFunction):
3910
4573
  to 1.5 only implemented for points.
3911
4574
 
3912
4575
  see https://postgis.net/docs/ST_Distance_Sphere.html
4576
+
4577
+ Return type: :class:`sqlalchemy.sql.sqltypes.Float`.
3913
4578
  """
4579
+
4580
+ type = sqlalchemy.sql.sqltypes.Float()