Spatial Functions

Spatial 関数は、 geospatial データを扱うための機能を提供します。特定の関数の詳細については、 Open GIS specification または PostGIS manual を参照してください。

WKB およびWKT 形式のため、ほとんどのジオメトリ機能は2次元に制限されています。

There might be minor differences between CData Virtuality and pushdown results that will need to be further refined.

ST_GeomFromText

この関数は、WKT 形式でCLOB からジオメトリを返します。

Syntax

ST_GeomFromText(text [, srid])

text はCLOB です；
srid は空間参照識別子（SRID）を表すオプションの整数です。

戻り値はジオメトリです。

ST_GeogFromText

この関数は、CLOB から(E)WKT 形式のジオグラフィを返します。

Syntax

ST_GeogFromText(text)

text はCLOB です；
srid はオプションの整数です。

戻り値はジオグラフィです。

ST_GeomFromWKB/ST_GeomFromBinary

この関数は、WKB 形式のBLOB からジオメトリを返します。

Syntax

ST_GeomFromWKB(bin [, srid])

bin はCLOB です；
srid はオプションの整数です。

戻り値はジオメトリです。

ST_GeomFromEWKB

この関数は、EWKB 形式の BLOB からジオメトリを返します。

Syntax

ST_GeomFromEWKB(bin)

binはCLOB です；
srid はオプションの整数です。

戻り値はジオメトリです。このバージョンの変化は2次元でのみ動作します。

ST_GeogFromWKB

この関数は、(E)WKB 形式の BLOB からジオグラフィを返します。

Syntax

ST_GeomFromEWKB(bin)

bin はBLOB です。

戻り値はジオグラフィです。このバージョンのトランスレーターは、2次元でのみ動作します。

ST_GeomFromEWKT

この関数は、キャラクターラージオブジェクト（CLOB）からEWKT 形式のジオメトリを返します。

Syntax

ST_GeomFromEWKT(text)

text はBLOB です。

戻り値はジオメトリです。このバージョンのトランスレーターは、2次元でのみ動作します。

ST_GeomFromGeoJSON

この関数は、CLOB からジオメトリをGeoJSON 形式で返します。

Syntax

ST_GeomFromGeoJson(`text` [, srid])

text はCLOB です；
srid はオプションの整数です。

戻り値はジオメトリです。

ST_GeomFromGML

この関数は、CLOB からジオメトリをGML2 形式で返します。

Syntax

ST_GeomFromGML(text [, srid])

text はCLOB です；
srid はオプションの整数です。

戻り値はジオメトリです。

ST_AsText

Syntax

ST_AsText(geom)

geom はジオメトリです。

戻り値はWKT 形式の CLOB です。

ST_AsBinary

Syntax

ST_AsBinary(geo)

geo はジオメトリまたはジオグラフィです。

戻り値は WKB 形式のBLOB です。

ST_AsEWKB

Syntax

ST_AsText(geom)

geom はジオメトリです。

戻り値はWKT 形式のCLOB です。

ST_AsBinary

Syntax

ST_AsBinary(geo)

geo はジオメトリまたはジオグラフィです。

戻り値はWKB 形式のBLOB です。

ST_AsEWKB

Syntax

ST_AsEWKB(geom)

geom はジオメトリです。

戻り値はEWKB 形式のBLOB です。

ST_AsGeoJSON

Syntax

ST_AsGeoJSON(geom)

geom はジオメトリです。

戻り値はGeoJSON 値を持つCLOB です。

ST_AsGML

Syntax

ST_AsGML(geom)

geom はジオメトリです。

戻り値はGML2 の値を持つCLOB です。

ST_AsEWKT

Syntax

ST_AsEWKT(geo)

geom はジオメトリまたはジオグラフィです。

戻り値はEWKT 値のCLOB です。EWKT 値はWKT 値にSRID プレフィックスを付けたものです。

ST_AsKML

Syntax

ST_AsKML(geom)

geom はジオメトリです。

戻り値はKML 値のCLOB です。KML の値は実質的に簡略化されたGML の値であり、SRID 4326 に投影されます。

&&

この関数は、 geom1 および geom2 の境界ボックスが交差する場合にTRUE を返します。

Syntax

geom1 && geom2

geom1、 geom2 はジオメトリです。

戻り値はブール値です。

ST_Contains

この関数は、 geom1 が geom2 を含む場合にTRUE を返します。

Syntax

ST_Contains(geom1, geom2)

geom1、 geom2 はジオメトリです。

戻り値はブール値です。

ST_Crosses

この関数は、ジオメトリが交差する場合にTRUE を返します。

Syntax

ST_Crosses(geom1, geom2)

geom1、 geom2 はジオメトリです。

戻り値はブール値です。

ST_Disjoint

この関数は、ジオメトリが分離している場合にTRUE を返します。

Syntax

ST_Disjoint(geom1, geom2)

geom1、 geom2 はジオメトリです。

戻り値はブール値です。

ST_Distance

この関数は、2つのジオメトリ間の距離を返します。

Syntax

ST_Distance(geo1, geo2)

geom1、 geom2 は両方ともジオメトリまたはジオグラフィです。

戻り値はダブルです。ジオグラフィバリアントは評価のために押し下げる必要があります。

ST_DWithin

この関数は、ジオメトリが互いに所定の距離内にある場合に TRUE を返します。

Syntax

ST_DWithin(geom1, geom2, dist)

geom1、 geom2 はジオメトリです；
dist はダブルです。

戻り値はブール値です。

ST_Equals

この関数は、2つの形状が空間的に等しい場合に TRUE を返します。点と順序は違っても、どちらのジオメトリも他のジオメトリの外側にあるわけではありません。

Syntax

ST_Equals(geom1, geom2)

geom1、 geom2 はジオメトリです。

戻り値はブール値です。

ST_Intersects

この関数は、ジオメトリが交差する場合に TRUE を返します。

Syntax

ST_Intersects(geo1, geo2)

geo1、 geo2 は両方ともジオメトリまたはジオグラフィです。

戻り値はブール値です。ジオグラフィバリアントは評価のために押し下げる必要があります。

ST_OrderingEquals

この関数は、 geom1 と geom2 が同じ構造と点の並び順を持つ場合にTRUE を返します。

Syntax

ST_OrderingEquals(geom1, geom2)

geom1、 geom2 はジオメトリです。

戻り値はブール値です。

ST_Overlaps

この関数は、ジオメトリが重なっている場合にTRUE を返します。

Syntax

ST_Overlaps(geom1, geom2)

geom1、 geom2 はジオメトリです。

戻り値はブール値です。

ST_Relate

この関数は、geom1 とgeom2 の交差をテストまたは返します。

Syntax

ST_Relate(geom1, geom2, pattern)

geom1、 geom2 はジオメトリです；
patternは 9文字のDE-9IM パターン文字列です。

戻り値はブール値です。

ST_Relate(geom1, geom2)

geom1、 geom2 はジオメトリです。

戻り値は9文字のDE-9IM 交差文字列です。

ST_Touches

この関数は、ジオメトリが接触している場合にTRUE を返します。

Syntax

ST_Touches(geom1, geom2)

geom1、 geom2 はジオメトリです。

戻り値はブール値です。

ST_Within

この関数は、 geom1 が完全に geom2の中にある場合TRUE を返します。

Syntax

ST_Within(geom1, geom2)

geom1、 geom2 はジオメトリです。

戻り値はブール値です。

ST_Area

この関数 r はgeomの面積を返します。

Syntax

ST_Area(geom)

geom はジオメトリです。

戻り値はダブルです。

ST_CoordDim

この関数 r はgeomの座標寸法を返します。

Syntax

ST_CoordDim(geom)

geom はジオメトリです。

戻り値は0 から3 までの整数です。

ST_Dimension

この関数はgeom の次元を返します。

Syntax

ST_Dimension(geom)

geom はジオメトリです。

戻り値は0 から3 までの整数です。

ST_EndPoint

この関数は、LineStringgeomの終点を返します。 geom がLineString でない場合はNULL を返します。

Syntax

ST_EndPoint(geom)

geom はジオメトリです。

戻り値はジオメトリです。

ST_ExteriorRing

この関数は、多角形の外輪または外殻LineStringgeomを返します。 geom が多角形でない場合はNULL を返します。

Syntax

ST_ExteriorRing(geom)

geom はジオメトリです。

戻り値はジオメトリです。

ST_GeometryN

この関数は、geom の指定された1 ベースのインデックスにあるn 番目のジオメトリを返します。指定したインデックスのジオメトリが存在しない場合はNULL を返します。非コレクション型は最初のインデックスで自分自身を返します。

Syntax

ST_GeometryN(geom, index)

geom はジオメトリです；
index は整数です。

戻り値はジオメトリです。

ST_GeometryType

この関数は、 geom の型名をST_name として返します。名前はLineString、Polygon、Point などになります。

Syntax

ST_GeometryType(geom)

geom はジオメトリです。

戻り値は文字列です。

ST_HasArc

この関数は、ジオメトリが円形の文字列を持つかどうかをテストします。 FALSE を返します。これは、トランスレータが曲線ジオメトリタイプでは動作しないためです。

Syntax

ST_HasArc(geom)

geom はジオメトリです。

戻り値はジオメトリです。

ST_InteriorRingN

この関数は、geom の指定された1 ベースのインデックスにあるn 番目の内環 LinearString ジオメトリを返します。与えられたインデックスのジオメトリが存在しない場合、または geom がポリゴンでない場合はNULL を返します。

Syntax

ST_InteriorRingN(geom, index)

geom はジオメトリです；
index は整数です。

戻り値はジオメトリです。

ST_IsClosed

この関数は、LineString geom がクローズおよびFALSEで、 geom がLineStringでない場合にTRUE を返します。

Syntax

ST_IsClosed(geom)

geom はジオメトリです。

戻り値はブール値です。

ST_IsEmpty

この関数は、点の集合が空の場合はTRUE を返します。

Syntax

ST_IsEmpty(geom)

geom はジオメトリです。

戻り値はブール値です。

ST_IsRing

この関数は、LineString geom がリングの場合はTRUE を返し、 geom がLineString でない場合はFALSE を返します。

Syntax

ST_IsRing(geom)

geom はジオメトリです。

戻り値はブール値です。

ST_IsSimple

この関数は、 geom がシンプルな場合にTRUE を返します。

Syntax

ST_IsSimple(geom)

geom はジオメトリです。

戻り値はブール値です。

ST_IsValid

この関数は、 geom が有効な場合に TRUE を返します。

Syntax

ST_IsValid(geom)

geom はジオメトリです。

戻り値はブール値です。

ST_Length

この関数は、(Multi)LineStringの長さを返し、そうでない場合は0を返します。

Syntax

ST_Length(geo)

geo はジオメトリまたはジオグラフィです。

返り値はダブルです。ジオグラフィバリアントは評価のために押し下げられなければなりません。

ST_NumGeometries

この関数は、 geomのジオメトリの数を返します。ジオメトリコレクションでない場合は1を返します。

Syntax

ST_NumGeometries(geom)

geom はジオメトリです。

戻り値は整数です。

ST_NumInteriorRings

この関数は、ポリゴン形状の内部リングの数を返します。 geom が多角形でない場合はNULL を返します。

Syntax

ST_NumInteriorRings(geom)

geom はジオメトリです。

戻り値は整数です。

ST_NunPoints

この関数は、 geomの点の数を返します。

Syntax

ST_NunPoints(geom)

geom はジオメトリです。

戻り値は整数です。

ST_PointOnSurface

この関数は、geom の表面上にあることが保証された点を返します。

Syntax

ST_PointOnSurface(geom)

geom はジオメトリです。

戻り値は Point ジオメトリです。

ST_Perimeter

この関数は、(Multi)Polygongeom の外周を返します。 geom が(Multi)Polygonでない場合は0を返します。

Syntax

ST_Perimeter(geom)

geom はジオメトリです。

戻り値はダブルです。

ST_PointN

この関数は、geomにおいて、与えられた1 ベースのインデックスにおけるn 番目の点を返します。与えられたインデックスの点が存在しない場合、または geom がLineStringでない場合はNULL を返します。

Syntax

ST_PointN(geom, index)

geom はジオメトリです；
index は整数です。

戻り値はジオメトリです。

ST_SRID

この関数は、ジオメトリのSRID を返します。

Syntax

ST_SRID(geo)

geo はジオメトリまたはジオグラフィです。

戻り値は整数です。NULL でないジオメトリ上の未知の SRID に対しては、NULL ではなく0 が返されます。

ST_SetSRID

この関数は、指定されたジオメトリのSRID を設定します。

Syntax

ST_SetSRID(geo, srid)

geo はジオメトリまたはジオグラフィです；
srid は整数です。

戻り値は geoの値と同じです。SRID メタデータのみが変更されます。変換は行いません。

ST_StartPoint

この関数は、LineStringgeomの開始ポイントを返します。 geom がLineStringでない場合はNULL を返します。

Syntax

ST_StartPoint(geom)

geom はジオメトリです。

戻り値はジオメトリです。

ST_X

この関数は、X 座標の値、または点が空の場合はNULL を返します。ジオメトリが点でない場合に例外をスローします。

Syntax

ST_X(geom)

geom はジオメトリです。

戻り値はダブルです。

ST_Y

この関数は、Y 座標値を返します。ジオメトリが点でない場合に例外をスローします。

Syntax

ST_Y(geom)

geom はジオメトリです。

戻り値はダブルです。

ST_Z

この関数は、Z 座標の値、または点が空の場合はNULL を返します。ジオメトリが点でない場合に例外をスローします。通常、 null を返しますが、これはトランスレーターが2次元以上では動作しないからです。

Syntax

ST_Z(geom)

geom はジオメトリです。

戻り値はダブルです。

ST_Boundary

この関数は、与えられたジオメトリの境界を計算します。

Syntax

ST_Boundary(geom)

geom はジオメトリです。

戻り値はジオメトリです。

ST_Buffer

この関数は、 geomの距離内に点を持つジオメトリを計算します。

Syntax

ST_Buffer(geom, distance)

geom はジオメトリです；
distance はダブルです。

戻り値はジオメトリです。

ST_Centroid

この関数は、geom の幾何学的中心点を計算します。

Syntax

ST_Centroid(geom)

geom はジオメトリです。

戻り値はジオメトリです。

ST_ConvexHull

この関数は、ジオメトリのすべての点を含む最小の凸多角形を返します。

Syntax

ST_ConvexHull(geom)

geom はジオメトリです。

戻り値はジオメトリです。

ST_CurveToLine

この関数は、CircularString/CurvedPolygon をLineString/Polygon に変換します。CData Virtuality には現在実装されていません。

Syntax

ST_CurveToLine(geom)

geom はジオメトリです。

戻り値はジオメトリです。

ST_Difference

この関数は、 geom1 に含まれる点のうち、 geom2に含まれない点の点集合の閉包を計算します。

Syntax

ST_Difference(geom1, geom2)

geom1、 geom2 はジオメトリです。

戻り値はジオメトリです。

ST_Envelope

この関数は、与えられたジオメトリの2D 境界ボックスを計算します。

Syntax

ST_Envelope(geom)

geom はジオメトリです。

戻り値はジオメトリです。

ST_Force_2D

この関数は、Z 座標値が存在する場合、Z 座標値を削除します。

Syntax

ST_Force_2D(geom)

geom はジオメトリです。

戻り値はジオメトリです。

ST_Intersection

この関数は、 geom1 および geom2に含まれる点の点集合の交点を計算します。

Syntax

ST_Intersection(geom1, geom2)

geom1、 geom2 はジオメトリです。

戻り値はジオメトリです。

ST_Simplify

この関数は、Douglas-Peucker アルゴリズムを使用してジオメトリをシンプルにしますが、無効または空のジオメトリに簡素化しすぎる場合があります。

Syntax

ST_Simplify(geom, distanceTolerance)

geom はジオメトリです；
distanceTolerance はダブルです。

戻り値はジオメトリです。

ST_SimplifyPreserveTopology

この関数は、Douglas-Peucker アルゴリズムを使用してジオメトリをシンプルにします。常に有効なジオメトリを返します。

Syntax

ST_SimplifyPreserveTopology(geom, distanceTolerance)

geom はジオメトリです；
distanceTolerance はダブルです。

戻り値はジオメトリです。

ST_SnapToGrid

この関数は、ジオメトリのすべての点を指定されたサイズのグリッドにスナップします。

Syntax

ST_SnapToGrid(geom, size)

geom はジオメトリです；
size はダブルです。

戻り値はジオメトリです。

ST_SymDifference

この関数は、geom1 のうち、geom2 と交差しない部分を返します。

Syntax

ST_SymDifference(geom1, geom2)

geom1、 geom2 はジオメトリです。

戻り値はジオメトリです。

ST_Transform

この関数は、ある座標系から別の座標系にジオメトリ値を変換します。

Syntax

ST_Transform(geom, srid)

geom はジオメトリです；
srid は整数です。

戻り値はジオメトリです。 srid 値とジオメトリ値のSRID がSPATIAL_REF_SYS ビューに存在する必要があります。

ST_Union

この関数は、 geom1 および geom2のすべてを含む点集合を表すジオメトリを返します。

Syntax

ST_SymDifference(geom1, geom2)

geom1、 geom2 はジオメトリです。

戻り値はジオメトリです。

ST_Extent

この関数は、すべてのジオメトリ値の周りの2D 境界ボックスを計算します。すべての値は同じSRID を持つ必要があります。

Syntax

ST_Extent(geom)

geom はジオメトリです。

戻り値はジオメトリです。

ST_Point

この関数は、与えられた座標のPoint を返します。

Syntax

ST_Point(x, y)

x、 y はダブルです。

戻り値はPoint ジオメトリです。

ST_Polygon

この関数は、与えられたシェルとSRID を持つポリゴンを返します。

Syntax

ST_Polygon(geom, srid)

geom は線形環ジオメトリです；
srid は整数です。

戻り値はPolygon ジオメトリです。