Teradata Package for Python Function Reference | 17.10 - wkb_geom_to_sql - Teradata Package for Python - Look here for syntax, methods and examples for the functions included in the Teradata Package for Python.

Teradata® Package for Python Function Reference

Product
Teradata Package for Python
Release Number
17.10
Published
April 2022
Language
English (United States)
Last Update
2022-08-19
lifecycle
previous
Product Category
Teradata Vantage
teradataml.geospatial.geodataframe.GeoDataFrame.wkb_geom_to_sql = wkb_geom_to_sql(self, column)
DESCRIPTION:
    Returns a specified Geometry value.
    Notes:
        *  Vantage provides this method because it is in the SQL/MM
          Spatial standard, where it is defined to implement transform
          functionality that allows importing the Geometry type to the server.
 
PARAMETERS:
    column:
        Required Argument.
        Specifies the geometry value specified in the well-known binary (WKB) format.
        The data type of "column" is BLOB. The maximum size of "column" is
        approximately 16 MB (the exact maximum is 16 MB - 1 KB), allowing
        for a representation of approximately one million points. For more
        information on WKB formats, see Well-Known Binary Format in SQL documentation.
        Types: str, ColumnExpression
 
SUPPORTED GEOMETRY TYPES:
    All Geometry types.
 
RAISES:
    TypeError, ValueError, TeradataMlException
 
RETURNS:
    GeoDataFrame
 
EXAMPLES:
    from teradataml import GeoDataFrame, load_example_data
    from teradataml import Point, LineString, Polygon
    # Load example data.
    load_example_data("geodataframe", "sample_shapes")
    # Create a GeoDataFrame.
    geodf = GeoDataFrame("sample_shapes")
    print(geodf)
    
    # Example 1: Get the WKB geometry in SQL format.
    # Let's select only few columns from GeoDataFrame.
    geodfbin = geodf.select(["skey", "points"]).assign(str_column=geodf.points.to_binary())
    geodfbin.wkb_geom_to_sql(column="str_column")