ST_CircularString type

Syntax

ST_CircularString type

Members

All members of the ST_CircularString type, including all inherited members.

Members of ST_CircularString:

• ST_CircularString( ST_Point , ST_Point , ST_Point , ST_Point ) – Constructs a circularstring value from a list of points in a specified spatial reference system.
• ST_CircularString() – Constructs a circularstring representing the empty set.
• ST_CircularString(LONG BINARY[, INT]) – Constructs a circularstring from Well Known Binary (WKB).
• ST_CircularString(LONG VARCHAR[, INT]) – Constructs a circularstring from a text representation.
• ST_NumPoints() – Returns the number of points defining the circularstring.
• ST_PointN(INT) – Returns the nth point in the circularstring.

Members of ST_Curve:

• ST_CurveToLine() – Returns the ST_LineString interpolation of an ST_Curve value.
• ST_EndPoint() – Returns an ST_Point value that is the end point of the ST_Curve value.
• ST_IsClosed() – Test if the ST_Curve value is closed. A curve is closed if the start and end points are coincident.
• ST_IsRing() – Tests if the ST_Curve value is a ring. A curve is a ring if it is closed and simple (no self intersections).
• ST_Length(VARCHAR(128)) – Returns the length measurement of the ST_Curve value. The result is measured in the units specified by the unit-name parameter.
• ST_StartPoint() – Returns an ST_Point value that is the start point of the ST_Curve value.

Members of ST_Geometry:

• ST_Affine(DOUBLE, DOUBLE, DOUBLE, DOUBLE, DOUBLE, DOUBLE, DOUBLE, DOUBLE, DOUBLE, DOUBLE, DOUBLE, DOUBLE) – Returns a new geometry that is the result of applying the specified 3-D affine transformation.
• ST_AsBinary(VARCHAR(128)) – Returns the WKB representation of an ST_Geometry value.
• ST_AsBitmap(INT, INT, ST_Point , ST_Point , VARCHAR(128)) – Returns a LONG VARBIT that is a bitmap representing a geometry value.
• ST_AsGeoJSON(VARCHAR(128)) – Returns a string representing a geometry in JSON format.
• ST_AsGML(VARCHAR(128)) – Returns the GML representation of an ST_Geometry value.
• ST_AsKML(VARCHAR(128)) – Returns the KML representation of an ST_Geometry value.
• ST_AsSVG(VARCHAR(128)) – Returns an SVG figure representing a geometry value.
• ST_AsSVGAggr( ST_Geometry , VARCHAR(128)) – Returns a complete or partial SVG document which renders the geometries in a group.
• ST_AsText(VARCHAR(128)) – Returns the text representation of an ST_Geometry value.
• ST_AsWKB(VARCHAR(128)) – Returns the WKB representation of an ST_Geometry value.
• ST_AsWKT(VARCHAR(128)) – Returns the WKT representation of an ST_Geometry value.
• ST_AsXML(VARCHAR(128)) – Returns the XML representation of an ST_Geometry value.
• ST_Boundary() – Returns the boundary of the geometry value.
• ST_Buffer(DOUBLE, VARCHAR(128)) – Returns the ST_Geometry value that represents all points whose distance from any point of an ST_Geometry value is less than or equal to a specified distance in the given units.
• ST_Contains( ST_Geometry ) – Tests if a geometry value spatially contains another geometry value.
• ST_ContainsFilter( ST_Geometry ) – An inexpensive test if a geometry might contain another.
• ST_ConvexHull() – Returns the convex hull of the geometry value.
• ST_ConvexHullAggr( ST_Geometry ) – Returns the convex hull for all of the geometries in a group
• ST_CoordDim() – Returns the number of coordinate dimensions stored with each point of the ST_Geometry value.
• ST_CoveredBy( ST_Geometry ) – Tests if a geometry value is spatially covered by another geometry value.
• ST_CoveredByFilter( ST_Geometry ) – An inexpensive test if a geometry might be covered by another.
• ST_Covers( ST_Geometry ) – Tests if a geometry value spatially covers another geometry value.
• ST_CoversFilter( ST_Geometry ) – An inexpensive test if a geometry might cover another.
• ST_Crosses( ST_Geometry ) – Tests if a geometry value crosses another geometry value.
• ST_Debug(VARCHAR(128)) – Returns a LONG BINARY that is debug information for the object.
• ST_Difference( ST_Geometry ) – Returns the geometry value that represents the point set difference of two geometries.
• ST_Dimension() – Returns the dimension of the ST_Geometry value. Points have dimension 0, lines have dimension 1, and surfaces have dimension 2. Any empty geometry has dimension -1.
• ST_Disjoint( ST_Geometry ) – Test if a geometry value is spatially disjoint from another value.
• ST_Distance( ST_Geometry , VARCHAR(128)) – Returns the smallest distance between the geometry-expression and the specified geometry value.
• ST_Distance_Spheroid( ST_Geometry , VARCHAR(128)) – Calculates the linear distance between geometries on the surface of the Earth.
• ST_Envelope() – Returns the bounding rectangle for the geometry value.
• ST_EnvelopeAggr( ST_Geometry ) – Returns the bounding rectangle for all of the geometries in a group
• ST_Equals( ST_Geometry ) – Tests if an ST_Geometry value is spatially equal to another ST_Geometry value.
• ST_EqualsFilter( ST_Geometry ) – An inexpensive test if a geometry is equal to another.
• ST_GeometryType() – Returns the name of the type of the ST_Geometry value.
• ST_GeometryTypeFromBaseType(VARCHAR(128)) – Parses a string defining the type string.
• ST_GeomFromBinary(LONG BINARY, INT) – Constructs a geometry from a binary string representation.
• ST_GeomFromShape(LONG BINARY[, INT]) – Parses a string containing an ESRI shape record and creates a geometry value of the appropriate type.
• ST_GeomFromText(LONG VARCHAR, INT) – Constructs a geometry from a character string representation.
• ST_GeomFromWKB(LONG BINARY, INT) – Parse a string containing a WKB or EWKB representation of a geometry and creates a geometry value of the appropriate type.
• ST_GeomFromWKT(LONG VARCHAR, INT) – Parses a string containing the WKT or EWKT representation of a geometry and create a geometry value of the appropriate type.
• ST_Intersection( ST_Geometry ) – Returns the geometry value that represents the point set intersection of two geometries.
• ST_IntersectionAggr( ST_Geometry ) – Returns the spatial intersection of all of the geometries in a group
• ST_Intersects( ST_Geometry ) – Test if a geometry value spatially intersects another value.
• ST_IntersectsFilter( ST_Geometry ) – An inexpensive test if the two geometries might intersect.
• ST_IntersectsRect( ST_Point , ST_Point ) – Test if a geometry intersects a rectangle.
• ST_Is3D() – Determines if the geometry value has Z coordinate values.
• ST_IsEmpty() – Determines whether the geometry value represents an empty set.
• ST_IsMeasured() – Determines if the geometry value has associated measure values.
• ST_IsSimple() – Determines whether the geometry value is simple (containing no self intersections or other irregularities).
• ST_IsValid() – Determines whether the geometry is a valid spatial object.
• ST_LatNorth() – Retrieves the northernmost latitude of a geometry.
• ST_LatSouth() – Retrieves the southernmost latitude of a geometry.
• ST_Length_Spheroid(VARCHAR(128)) – Calculates the linear length of a curve/multicurve on the surface of the Earth.
• ST_LinearHash() – Returns a binary string that is a linear hash of the geometry.
• ST_LinearUnHash(BINARY(32)[, INT]) – Returns a geometry representing the index hash.
• ST_LoadConfigurationData(VARCHAR(128)) – Returns binary configuration data. For internal use only.
• ST_LocateAlong(DOUBLE) – Returns the subset of the geometry value that is associated with the given measure value.
• ST_LocateBetween(DOUBLE, DOUBLE) – Returns the subset of the geometry value that is between the specified start measure and end measure.
• ST_LongEast() – Retrieves the longitude of the eastern boundary of a geometry.
• ST_LongWest() – Retrieves the longitude of the western boundary of a geometry.
• ST_MMax() – Retrieves the maximum M coordinate value of a geometry.
• ST_MMin() – Retrieves the minimum M coordinate value of a geometry.
• ST_OrderingEquals( ST_Geometry ) – Tests if a geometry is identical to another geometry.
• ST_Overlaps( ST_Geometry ) – Tests if a geometry value overlaps another geometry value.
• ST_Relate( ST_Geometry ) – Determines how a geometry value is spatially related to another geometry value by returning an intersection matrix. The ST_Relate method returns a 9-character string from the Dimensionally Extended 9 Intersection Model (DE-9IM) to describe the pair-wise relationship between two spatial data items. For example, the ST_Relate method determines if an intersection occurs between the geometries, and the geometry of the resulting intersection, if it exists.
• ST_Reverse() – Returns the geometry with the element order reversed.
• ST_Segmentize(DOUBLE) – Add points so that no line segment is longer than a specified distance.
• ST_Simplify(DOUBLE) – Remove points from curves so long as the maximum introduced error is less than a specified tolerance.
• ST_SnapToGrid( ST_Point , DOUBLE, DOUBLE, DOUBLE, DOUBLE) – Returns a copy of the geometry with all points snapped to the specified grid.
• ST_SRID(INT) – Changes the spatial reference system associated with the geometry without modifying any of the values.
• ST_SRIDFromBaseType(VARCHAR(128)) – Parses a string defining the type string.
• ST_SymDifference( ST_Geometry ) – Returns the geometry value that represents the point set symmetric difference of two geometries.
• ST_ToCircular() – Convert the geometry to a circularstring
• ST_ToCompound() – Converts the geometry to a compound curve.
• ST_ToCurve() – Converts the geometry to a curve.
• ST_ToCurvePoly() – Converts the geometry to a curve polygon.
• ST_ToGeomColl() – Converts the geometry to a geometry collection.
• ST_ToLineString() – Converts the geometry to a linestring.
• ST_ToMultiCurve() – Converts the geometry to a multicurve value.
• ST_ToMultiLine() – Converts the geometry to a multilinestring value.
• ST_ToMultiPoint() – Converts the geometry to a multi-point value.
• ST_ToMultiPolygon() – Converts the geometry to a multi-polygon value.
• ST_ToMultiSurface() – Converts the geometry to a multi-surface value.
• ST_ToPoint() – Converts the geometry to a point.
• ST_ToPolygon() – Converts the geometry to a polygon.
• ST_ToSurface() – Converts the geometry to a surface.
• ST_Touches( ST_Geometry ) – Tests if a geometry value spatially touches another geometry value.
• ST_Transform(INT) – Creates a copy of the geometry value transformed into the specified spatial reference system.
• ST_Union( ST_Geometry ) – Returns the geometry value that represents the point set union of two geometries.
• ST_UnionAggr( ST_Geometry ) – Returns the spatial union of all of the geometries in a group
• ST_Within( ST_Geometry ) – Tests if a geometry value is spatially contained within another geometry value.
• ST_WithinDistance( ST_Geometry , DOUBLE, VARCHAR(128)) – Test if two geometries are within a specified distance of each other.
• ST_WithinDistanceFilter( ST_Geometry , DOUBLE, VARCHAR(128)) – An inexpensive of whether two geometries might be within a specified distance of each other.
• ST_WithinFilter( ST_Geometry ) – An inexpensive test if a geometry might be within another.
• ST_XMax() – Retrieves the maximum X coordinate value of a geometry.
• ST_XMin() – Retrieves the minimum X coordinate value of a geometry.
• ST_YMax() – Retrieves the maximum Y coordinate value of a geometry.
• ST_YMin() – Retrieves the minimum Y coordinate value of a geometry.
• ST_ZMax() – Retrieves the maximum Z coordinate value of a geometry.
• ST_ZMin() – Retrieves the minimum Z coordinate value of a geometry.

Remarks

The ST_CircularString type is a subtype of ST_Curve that uses circular line segments between control points. The first three points define a segment as follows. The first point is the start point of the segment. The second point is any point on the segment other than the start and end point. The third point is the end point of the segment. Subsequent segments are defined by two points only (intermediate and end point). The start point is taken to be the end point of the preceding segment.A circularstring can be a complete circle with three points if the start and end points are coincident. In this case, the intermediate point is the midpoint of the segment.If the start, intermediate and end points are collinear, the segment is a straight line segment between the start and end point.A circularstring with exactly three points is a circular arc. A circular ring is a circularstring that is both closed and simple.Circularstrings are not allowed in round-Earth spatial reference systems. For example, attempting to create one for SRID 4326 returns an error.

Standards and compatibility

SQL/MM (ISO/IEC 13249-3: 2006) 7.3