SqlGeography Class
The SqlGeography type represents data in a geodetic (round earth) coordinate system.
Inheritance Hierarchy
System.Object
Microsoft.SqlServer.Types.SqlGeography
Namespace: Microsoft.SqlServer.Types
Assembly: Microsoft.SqlServer.Types (in Microsoft.SqlServer.Types.dll)
Syntax
'Declaration
<SerializableAttribute> _
<SqlUserDefinedTypeAttribute(Format.UserDefined, IsByteOrdered := False, _
MaxByteSize := , IsFixedLength := False)> _
<CLSCompliantAttribute(True)> _
Public NotInheritable Class SqlGeography _
Implements INullable, IBinarySerialize, ISqlSpatialGridIndexable
'Usage
Dim instance As SqlGeography
[SerializableAttribute]
[SqlUserDefinedTypeAttribute(Format.UserDefined, IsByteOrdered = false,
MaxByteSize = , IsFixedLength = false)]
[CLSCompliantAttribute(true)]
public sealed class SqlGeography : INullable,
IBinarySerialize, ISqlSpatialGridIndexable
[SerializableAttribute]
[SqlUserDefinedTypeAttribute(Format::UserDefined, IsByteOrdered = false,
MaxByteSize = , IsFixedLength = false)]
[CLSCompliantAttribute(true)]
public ref class SqlGeography sealed : INullable,
IBinarySerialize, ISqlSpatialGridIndexable
[<>]
[<SerializableAttribute>]
[<SqlUserDefinedTypeAttribute(Format.UserDefined, IsByteOrdered = false,
MaxByteSize = , IsFixedLength = false)>]
[<CLSCompliantAttribute(true)>]
type SqlGeography =
class
interface INullable
interface IBinarySerialize
interface ISqlSpatialGridIndexable
end
public final class SqlGeography implements INullable, IBinarySerialize, ISqlSpatialGridIndexable
The SqlGeography type exposes the following members.
Constructors
Name | Description | |
---|---|---|
SqlGeography | Initializes a new instance of the SqlGeography class. |
Top
Properties
Name | Description | |
---|---|---|
HasM | Returns true if at least one point in a spatial object contains value M; otherwise returns false. This property is read-only. | |
HasZ | Returns true if at least one point in a spatial object contains value Z; otherwise returns false. This property is read-only. | |
IsNull | Determines whether the SqlGeography instance is null. | |
Lat | Returns the latitude property of the geography instance. | |
Long | Returns the longitude property of the geography instance. | |
M | Returns the M (measure) value of the geography instance. | |
Null | Returns a read-only property providing a null instance of the SqlGeography type. | |
STSrid | Gets or sets id is an integer representing the Spatial Reference Identifier (SRID) of the instance. | |
Z | Gets the Z (elevation) value of the instance. The semantics of the elevation value are user-defined. |
Top
Methods
Name | Description | |
---|---|---|
AsBinaryZM | Returns the Open Geospatial Consortium (OGC) Well-Known Binary (WKB) representation of a SqlGeography instance augmented with any Z (elevation) and M (measure) values carried by the instance. | |
AsGml | Returns the Geography Markup Language (GML) representation of a SqlGeography instance. | |
AsTextZM | Returns the Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation of a SqlGeography instance augmented with any Z (elevation) and M (measure) values carried by the instance. | |
BufferWithCurves | Returns a SqlGeography instance that represents the set of all points whose distance from the calling SqlGeography instance is less than or equal to the distance parameter. | |
BufferWithTolerance | Returns a geometric object representing the union of all point values whose distance from a SqlGeography instance is less than or equal to a specified value, allowing for a specified tolerance. | |
CurveToLineWithTolerance | Returns a polygonal approximation of a SqlGeography instance that contains circular arc segments. | |
Deserialize | Returns a constructed SqlGeometry from an internal SQL Server format for spatial data. Can be used for sending spatial data over the network or reading them from files. | |
EnvelopeAngle | Returns the maximum angle between the point returned by EnvelopeCenter() and a point in the SqlGeography instance in degrees. | |
EnvelopeCenter | Returns a point that can be used as the center of a bounding circle for the geography instance. | |
Equals | (Inherited from Object.) | |
Filter | Offers a fast, index-only intersection method to determine if a geography instance intersects another SqlGeography instance, assuming an index is available. | |
Finalize | (Inherited from Object.) | |
GeomFromGml | Constructs a SqlGeography instance given a representation in the SQL Server subset of the Geography Markup Language (GML). | |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
InstanceOf | Tests if the SqlGeography instance is the same as the specified type. | |
IsValidDetailed | Returns a message to help identify validity issues with a spatial object. | |
MakeValid | Converts a geography instance that is not valid into a valid geography instance with a valid Open Geospatial Consortium (OGC) type. | |
MemberwiseClone | (Inherited from Object.) | |
MinDbCompatibilityLevel | Returns the minimum database compatibility that accepts the SqlGeography type. | |
NumRings | Returns the total number of rings in a Polygon instance. | |
Parse | Returns a SqlGeography instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation. | |
Point | Constructs a SqlGeography instance representing a Point instance from its x and y values and a spatial reference ID (SRID). | |
Populate(IGeographySink) | Obsolete. Applies a geography type call sequence to IGeographySink object. The call sequence is a set of figures, lines, and points for geography types. | |
Populate(IGeographySink110) | Applies a geography type call sequence to IGeographySink object. | |
Read | Reads a binary representation of a geography type into a SqlGeometry object. | |
Reduce | Returns an approximation of the given geography instance produced by running the Douglas-Peucker algorithm on the instance with the given tolerance. | |
ReorientObject | Returns a geography instance with interchanged interior regions and exterior regions. | |
RingN | Returns the specified ring of the SqlGeography instance: 1 ≤ n ≤ NumRings(). | |
Serialize | Used for sending spatial data across the network. | |
ShortestLineTo | Returns the shortest distance between the two SqlGeographyinstances. | |
STArea | Returns the total surface area of a SqlGeography instance. | |
STAsBinary | Returns the Open Geospatial Consortium (OGC) Well-Known Binary (WKB) representation of a SqlGeography instance. | |
STAsText | Returns the Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation of a SqlGeography instance. | |
STBuffer | Returns a geography object that represents the union of all points whose distance from a SqlGeography instance is less than or equal to a specified value. | |
STContains | Specifies whether the calling SqlGeography instance spatially contains the SqlGeography instance passed to the method. | |
STConvexHull | Returns an object that represents the convex hull of a SqlGeography instance. | |
STCurveN | Returns the curve specified from a SqlGeography instance that is a LineString, CircularString, or CompoundCurve. | |
STCurveToLine | Returns a polygonal approximation of a SqlGeography instance that contains circular arc segments. | |
STDifference | Returns an object representing the points from one SqlGeography instance that do not lie within another SqlGeography instance. | |
STDimension | Returns the maximum dimension of a SqlGeography instance | |
STDisjoint | Determines whether the calling SqlGeography instance is spatially disjoint from the specified SqlGeography instance. | |
STDistance | Returns the shortest distance between a point in a SqlGeography instance and a point in another SqlGeography instance. | |
STEndPoint | Returns the end point of a SqlGeography instance. | |
STEquals | Determines whether the specified SqlGeography instance has the same point set as the calling SqlGeography instance. | |
STGeomCollFromText | Returns a geography instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation, augmented with any Z (elevation) and M (measure) values carried by the instance. | |
STGeomCollFromWKB | Returns a GeometryCollection instance from an Open Geospatial Consortium (OGC) Well-Known Binary (WKB) representation. | |
STGeometryN | Returns a specified geography element in a GeometryCollection or one of its subtypes. | |
STGeometryType | Returns the Open Geospatial Consortium (OGC) type name represented by a geography instance. | |
STGeomFromText | Returns a SqlGeography instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation augmented with any Z (elevation) and M (measure) values carried by the instance. | |
STGeomFromWKB | Returns a SqlGeography instance from an Open Geospatial Consortium (OGC) Well-Known Binary (WKB) representation. | |
STIntersection | Returns an object representing the points where a SqlGeography instance intersects another SqlGeography instance. | |
STIntersects | Determines whether the current SqlGeography instance intersects with the specified SqlGeography. | |
STIsClosed | Determines whether the calling SqlGeography instance is closed. | |
STIsEmpty | Determines whether the SqlGeography instance is empty. | |
STIsValid | Specifies whether a geography instance is well-formed and recognized as a valid geography object based on its Open Geospatial Consortium (OGC) type. | |
STLength | Returns the total length of the elements in a SqlGeography instance or the SqlGeography instances within a GeometryCollection. | |
STLineFromText | Returns a SqlGeography instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation, augmented with any Z (elevation) and M (measure) values carried by the instance. | |
STLineFromWKB | Returns a SqlGeography instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation, augmented with any Z (elevation) and M (measure) values carried by the instance. | |
STMLineFromText | Returns a SqlGeography instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation, augmented with any Z (elevation) and M (measure) values carried by the instance. | |
STMLineFromWKB | Returns a SqlGeography MultiLineString instance from an Open Geospatial Consortium (OGC) Well-Known Binary (WKB) representation. | |
STMPointFromText | Returns a SqlGeography instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation, augmented with any Z (elevation) and M (measure) values carried by the instance. | |
STMPointFromWKB | Returns a SqlGeography MultiPoint instance from an Open Geospatial Consortium (OGC) Well-Known Binary (WKB) representation. | |
STMPolyFromText | Returns a SqlGeography instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation, augmented with any Z (elevation) and M (measure) values carried by the instance. | |
STMPolyFromWKB | Returns a SqlGeography MultiPolygon instance from an Open Geospatial Consortium (OGC) Well-Known Binary (WKB) representation. | |
STNumCurves | Returns the number of curves in a one-dimensional SqlGeography instance. | |
STNumGeometries | Returns the number of geometries that make up a SqlGeography instance. | |
STNumPoints | Returns the total number of points in each of the figures in a SqlGeography instance | |
STOverlaps | Returns 1 if a SqlGeography instance spatially overlaps another SqlGeography instance, or 0 if it does not. | |
STPointFromText | Returns a SqlGeography instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation, augmented with any Z (elevation) and M (measure) values carried by the instance. | |
STPointFromWKB | Returns a SqlGeography Point instance from an Open Geospatial Consortium (OGC) Well-Known Binary (WKB) representation. | |
STPointN | Returns the specified point in a SqlGeography instance. | |
STPolyFromText | Returns a SqlGeography instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation augmented with any Z (elevation) and M (measure) values carried by the instance. | |
STPolyFromWKB | Returns a SqlGeography Polygon instance from an Open Geospatial Consortium (OGC) Well-Known Binary (WKB) representation. | |
STStartPoint | Returns the start point of a SqlGeography instance. | |
STSymDifference | Returns an object representing all points that are either in one SqlGeography instance or another SqlGeography instance, but not those points that lie in both instances. | |
STUnion | Returns an object representing the union of a SqlGeography instance with another SqlGeography instance. | |
STWithin | Returns 1 if a SqlGeography instance is spatially within another SqlGeography instance; otherwise, returns 0. | |
ToString | Returns the Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation of a SqlGeography instance augmented with any Z (elevation) and M (measure) values carried by the instance. (Overrides Object.ToString().) | |
Write | Writes a SqlGeography object to a binary stream. |
Top
Explicit Interface Implementations
Name | Description | |
---|---|---|
ISqlSpatialGridIndexable.BufferForDistanceQuery | Returns the buffer for distance query for the SQL Geography. | |
ISqlSpatialGridIndexable.GetBoundingBoxCorners | Returns a value for the bounding box corners for the SQL Geography. | |
ISqlSpatialGridIndexable.GetGridCoverage | Returns the grid coverage of the SQL Geography. | |
ISqlSpatialGridIndexable.InteriorBufferForDistanceQuery | Gets the interior buffer for distance query for the SQL Geography. |
Top
Remarks
SQL Server supports a set of methods for the geography spatial data type. These methods include methods on geography that are defined by the Open Geospatial Consortium (OGC) standard and a set of Microsoft extensions to that standard.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.