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