第7章 PostGIS リファレンス

第7章 PostGIS リファレンス
戻る		次へ


PostGIS は、既存の名前付け方針から SQL-MM 中心の方針への切り替えを開始しています。結果として、ユーザーが知っていて愛用している関数の多くが標準空間型 (ST) プレフィクスを使うように名前変更されました。以前の関数はまだ有効ですが、更新された等価な関数があるものについては、この文書の一覧から外しています (訳注: 非推奨関数は PostGIS 2.0では基本的に外れています)。これらの関数は非推奨であり、将来のリリースでは削除されますので、使わないでください。

7.1. PostGIS Geometry/Geography/Box データ型

概要

このセクションでは、空間データを表現するために PostGIS とともにインストールされたカスタム PostgreSQL データ型の一覧を示します。

データ型ごとに、型キャストの振舞いが記述されています。型キャストによって、あるデータ型の値が他のデータ型に変換されます。PostgreSQL では、型を変換するために使われる関数に加えて、ユーザー定義型のキャストの振舞いの定義が可能です。キャストは自動的な振舞いを持つことができ、それによって、関数の引数をその関数が対応する型に自動的に変換できます。

キャストには 明示的な 振舞いがあります。この振舞は、キャストは CAST(myval As sometype) または myval::sometype という書式で指定されます。与えられた型に対応していないオーバロード関数を使うときに発生するあいまいなキャストの問題は、明示的なキャストによって回避できます。例えば、関数は box2d または box3d を受け付けるがジオメトリーを受け付けない場合です。ジオメトリーはボックス型の両方への自動キャストが可能なため、「あいまいな関数」エラーが発生します。このエラーを防ぐには、求められるボックス型への明示的なキャストを使用します。

全てのデータ型は text にキャストできます。このため、明示的に指定する必要はありません。

box2d — 2次元バウンディングボックスを表現する型。
box3d — 3次元バウンディングボックスを表現する型。
geometry — 平面座標系を持つ空間地物を表現する型。
geometry_dump — 複雑なジオメトリーの部品を記述するために使われる複合型です。
geography — 地理座標系 (回転楕円体) 座標系を持つ空間地物を表現する型です。

7.2. テーブル管理関数

概要

これらの関数は、ジオメトリーカラムを含むテーブルの定義を支援します。

AddGeometryColumn — ジオメトリーカラムを既存のテーブルに追加します。
DropGeometryColumn — ジオメトリーカラムを空間テーブルから除去します。
DropGeometryTable — テーブルと geometry_columns の当該テーブルへの参照の全てを削除します。
Find_SRID — ジオメトリーカラムで定義されている SRID を返します。
Populate_Geometry_Columns — ジオメトリーカラムが型修飾子で定義されるか、適切な空間制約を持つようにします。
UpdateGeometrySRID — ジオメトリーカラム内の全ての地物の SRID を更新し、テーブルのメタデータを更新します。

7.3. ジオメトリーコンストラクタ

概要

これらの関数は、ジオメトリーまたはジオグラフィーの値を生成します。プリミティブ、座標値列、既存のジオメトリーを組み立てて、これに続く分析に使うのに適切な空間オブジェクトにします。

ST_Collect — ジオメトリーの集合からジオメトリーコレクションまたはマルチ系ジオメトリーを生成します。
ST_LineFromMultiPoint — マルチポイントジオメトリーからラインストリングを生成します。
ST_MakeEnvelope — 座標値の最小値と最大値から矩形ポリゴンを生成します。
ST_MakeLine — POINT、MULTIPOINT、LINESTRING から LINESTRING を生成します。
ST_MakePoint — 2次元、3次元 (XYZ)、4次元のポイントを生成します。
ST_MakePointM — X, Y, M 値からポイントを生成します。
ST_MakePolygon — 外側リングと任意の穴リストとでポリゴンまたは曲線ポリゴンを生成します。
ST_Point — X, Y と SRID の値からポイントを生成します。
ST_PointZ — X, Y, Z と SRID の値からポイントを生成します。
ST_PointM — X, Y, M と SRID の値からポイントを生成します。
ST_PointZM — X, Y, Z, M と SRID の値からポイントを生成します。
ST_Polygon — ラインストリングから指定した SRID を持つポリゴンを生成します。
ST_TileEnvelope — Web メルカトル (SRID:3857) 上で XYZ タイルを使った矩形ポリゴンを生成します。
ST_HexagonGrid — 引数ジオメトリーの境界を完全にカバーする六角形とセルインデックスを返します。
ST_Hexagon — 与えられたエッジサイズと六角形グリッド空間内のセル座標を使って単一の六角形を返します。
ST_SquareGrid — 引数ジオメトリーの境界を完全にカバーするグリッド正方形とセルインデックスを返します。
ST_Square — 与えられたエッジサイズと六角形グリッド空間内のセル座標を使って単一の正方形を返します。
ST_Letters — デフォルトの開始位置を原点とし、デフォルトの高さを 100とする、ジオメトリーとして描画された文字を返します。
ST_MakeNurbsCurve — 制御点から NURBS (非一様有理 B スプライン) 曲線を生成します。任意で重みとノットベクトルを与えられます。

7.4. ジオメトリーアクセサー

概要

これらの関数は既存のジオメトリーを変更せずに、その構造情報を見せるものです。ジオメトリータイプ、次元、座標要素のようなメタデータへのアクセスを提供していて、空間数式は、複雑なオブジェクトを制御された手法で問合せをすることができます。

GeometryType — ジオメトリーのタイプを文字列で返します。
ST_Boundary — ジオメトリーの境界を返します。
ST_BoundingDiagonal — ジオメトリーのバウンディングボックスの対角線を返します。
ST_CoordDim — ジオメトリーの座標次元を返します。
ST_Dimension — ジオメトリーの幾何次元を返します。
ST_Dump — ジオメトリーの要素となる geometry_dump 行の集合を返します。
ST_DumpPoints — ジオメトリー内の座標の行である geometry_dump 行の集合を返します。
ST_DumpSegments — ジオメトリー内の辺の行である geometry_dump 行の集合を返します。
ST_DumpRings — ポリゴンのリングごとの geometry_dump 行の集合を返します。
ST_EndPoint — LINESTRING, CIRCULARLINESTRING, NURMSCURVE の最後のポイントを返します。
ST_Envelope — ジオメトリーのバウンディングボックスを表現するジオメトリーを返します。
ST_ExteriorRing — ポリゴンの外側リングを表現するラインストリングを返します。
ST_GeometryN — ジオメトリーコレクションの要素を一つ返します。
ST_GeometryType — ジオメトリーの SQL-MM 型を文字列で返します。
ST_HasArc — ジオメトリーに円弧が含まれているかどうかテストします。
ST_InteriorRingN — ポリゴンの N番目の内側リング (穴) を返します。
ST_NumCurves — 複合曲線内の曲線の数を返します。
ST_CurveN — 複合曲線のＮ番目の曲線ジオメトリーを返します。
ST_IsClosed — ラインストリングの始点と終点が一致しているかをテストします。多面体サーフェスについては閉じているか (立体であるか) をテストします。
ST_IsCollection — ジオメトリーのタイプがジオメトリーコレクションかをテストします。
ST_IsEmpty — ジオメトリーが空かをテストします。
ST_IsPolygonCCW — ポリゴンが反時計回りの外側リングを持っていて、時計回りの内側リングを持っているかをテストします。
ST_IsPolygonCW — ポリゴンが時計回りの外側リングを持っていて、反時計回りの内側リングを持っているかをテストします。
ST_IsRing — ラインストリングが閉じていてかつ単純であるかをテストします。
ST_IsSimple — ジオメトリーが自己インタセクトまたは自己接触となるポイントが無いかをテストします。
ST_IsSimpleDetail — Report locations of self-intersection or self-tangency, if any.
ST_M — ポイントの M 値を返します。
ST_MemSize — ジオメトリーが取るメモリ空間の合計を返します。
ST_NDims — ジオメトリーの座標次元を返します。
ST_NPoints — ジオメトリーのポイント (頂点) の数を返します。
ST_NRings — ポリゴンジオメトリーのリング数を返します。
ST_NumGeometries — ジオメトリーコレクションの要素数を返します。
ST_NumInteriorRings — ポリゴンの内側リング (穴) の数を返します。
ST_NumInteriorRing — POLYGON の内側リング (穴) の数を返します。ST_NumInteriorRings の別名です。
ST_NumPatches — POLYHEDRALSURFACE または TIN のフェイスの数を返します。
ST_NumPoints — ラインストリングまたは曲線ストリングのポイント数を返します。
ST_PatchN — POLYHEDRALSURFACE または TIN の N番目のフェイスを返します。
ST_PointN — ジオメトリーの最初のラインストリングまたは曲線ストリングの N番目のポイントを返します。
ST_Points — ジオメトリーの全ての座標を含むマルチポイントを返します。
ST_StartPoint — LINESTRING, CIRCULARSTRING, NURBSCURVE の最初のポイントを返します。
ST_StartM — LINESTRING, CIRCULARLINESTRING, NURBSCURVE の最初のポイントの M 値を返します。
ST_EndM — LINESTRING, CIRCULARSTRING, NURBSCURVE の最後のポイントの M 値を返します。
ST_SetStartM — LINESTRING, CIRCULARSTRING, NURBSCURVE の最初のポイントの M 値を設定します。
ST_SetEndM — LINESTRING, CIRCULARSTRING, NURBSCURVE の終端の M 値を設定します。
ST_Summary — ジオメトリーについての要約文を返します。
ST_X — ポイントの X 値を返します。
ST_Y — ポイントの Y 値を返します。
ST_Z — ポイントの Z 値を返します。
ST_ZMFlag — ジオメトリーの ZM 座標次元を示す符号を返します。
ST_HasZ — ジオメトリーが Z 値を持っているかどうかを調べます。
ST_HasM — ジオメトリーが M 値をもっているかどうかを調べます。
ST_ControlPoints — NURBS 曲線から制御点を MULTIPOINT で返します。
ST_Degree — NURBS 曲線の多項式次数を返します。
ST_Weights — 有理 NURBS 曲線の重み配列を返します。
ST_Knots — NURBS 曲線のノットベクトル (knot vector) を返します。
ST_NumControlPoints — NURBS 曲線内の制御点の数を返します。
ST_NurbsCurveIsRational — NURBS 曲線が有理である (重みをもつ) かを調べます。
ST_IsNurbsCurve — ジオメトリーが NURBS 曲線であるかどうかを調べます。
ST_Evaluate — NURBS 曲線を指定したパラメーター値の位置で評価し、結果ポイントを返します。
ST_NurbsToLineString — 一様抽出によって NURBS 曲線を LINESTRING に変換します。

7.5. ジオメトリーエディタ

概要

これらの関数は、タイプ、構造または頂点の変更によって編集されたジオメトリーを生成します。

ST_AddPoint — ラインストリングにポイントを追加します。
ST_CollectionExtract — ジオメトリーコレクションを与えると、指定されたタイプの要素だけからなるマルチジオメトリーを返します。
ST_CollectionHomogenize — ジオメトリーコレクションを与えると、最も単純な表現を返します。
ST_CurveToLine — 曲線を含むジオメトリーを線ジオメトリーに変換します。
ST_Scroll — 閉じた LINESTRING の開始点を変更する。
ST_FlipCoordinates — X 値と Y 値を入れ替えたジオメトリーを返します。
ST_Force2D — ジオメトリーを 2次元モードに強制します。
ST_Force3D — ジオメトリーを XYZ モードに強制します。これは ST_Force3DZ の別名です。
ST_Force3DZ — ジオメトリーを XYZ モードに強制します。
ST_Force3DM — ジオメトリーを XYM モードに強制します。
ST_Force4D — ジオメトリーを XYZM モードに強制します。
ST_ForceCollection — ジオメトリーをジオメトリーコレクションに変換します。
ST_ForceCurve — 該当する場合は、ジオメトリーを曲線タイプに変換します。
ST_ForcePolygonCCW — 全ての外側リングを反時計回りに、全ての内側リングを時計回りに、それぞれ強制します。
ST_ForcePolygonCW — 全ての外側リングを時計回りに、全ての内側リングを反時計回りに、それぞれ強制します。
ST_ForceSFS — ジオメトリーを SFS 1.1 または 1.2 のジオメトリータイプに強制します。
ST_ForceRHR — ポリゴンの頂点の方向を右回りに強制します。
ST_LineExtend — 指定距離ぶん前後に延長されたラインを返します。
ST_LineToCurve — 曲線を含むジオメトリーを線ジオメトリーに変換します。
ST_Multi — マルチ系ジオメトリーを返します。
ST_Normalize — 標準的な形式に変えたジオメトリーを返します。
ST_Project — 始点から距離と方位で算出されたポイントを返します。
ST_QuantizeCoordinates — 座標値の最下位ビットを 0にします。
ST_RemovePoint — ラインストリングからポイントを削除します。
ST_RemoveRepeatedPoints — 重複ポイントを除いたジオメトリーを返します。
ST_RemoveIrrelevantPointsForView — 指定した矩形表示範囲での描画に関係のないジオメトリーのポイントを削除します。
ST_RemoveSmallParts — ジオメトリーの全ての小さな部位 (ポリゴンのリングまたはラインストリング)を削除します。
ST_Reverse — 頂点の順序を逆にしたジオメトリーを返します。
ST_Segmentize — 与えた長さを超える線分を持たないよう変更したジオメトリー/ジオグラフィを返します。
ST_SetPoint — ラインストリングのポイントを与えられたポイントに置き換えます。
ST_ShiftLongitude — 経度座標値を-180度から 180度の範囲と 0度から 360度の範囲との二つの範囲を行き来するようシフトします。
ST_WrapX — ジオメトリーを X 値で回り込ませます。
ST_SnapToGrid — 入力ジオメトリーの全ての点を規則的なグリッドにスナップします。
ST_Snap — 入力ジオメトリーの辺と頂点を参照ジオメトリーの頂点にスナップします。
ST_SwapOrdinates — 与えられたジオメトリーにおいて与えられた座標の値を入れ替えたジオメトリーを返します。

7.6. ジオメトリー検証

概要

これらの関数は、ジオメトリーが OGC SFS 標準として妥当かどうかをテストします。また、不正となった場合の種類と位置に関する情報の提供も行います。不正なジオメトリーから妥当なジオメトリーを生成する機能もあります。

ST_IsValid — ジオメトリーが 2次元で整形されているかのテスト。
ST_IsValidDetail — ジオメトリーが妥当か、妥当でないなら理由と位置をそれぞれ示す valid_detail 行を返します。
ST_IsValidReason — ジオメトリーが妥当か否かを示す文字列を返し、不正な場合は理由を返します。
ST_MakeValid — 頂点を失うことなしに不正なジオメトリーを妥当なジオメトリーにしようと試みます。

7.7. 空間参照系関数

概要

これらの関数は spatial_ref_sys テーブルで定義されているジオメトリーの空間参照系と連携します。

ST_InverseTransformPipeline — 定義した座標変換パイプラインの逆変換を使って、異なる空間参照系に座標値を変換した新しいジオメトリーを返します。
ST_SetSRID — ジオメトリーに SRID を設定します。
ST_SRID — ジオメトリーの空間参照系識別子を返します。
ST_Transform — 異なる空間参照系に投影変換された新しいジオメトリーを返します。
ST_TransformPipeline — 定義されている座標変換パイプラインを使用して異なる空間参照系に変換された新しいジオメトリーを返します。
postgis_srs_codes — 指定した機関に関連付けられた SRS コードの一覧を返します。
postgis_srs — 求める機関と空間参照識別子に関するメタデータレコードを返します。
postgis_srs_all — Proj データベース内のあらゆる空間参照系のメタデータレコードを返します。
postgis_srs_search — bounds パラメーターを完全に含む適用範囲を持つ投影座標系のメタデータレコードを返します。

7.8. ジオメトリー入力

概要

これらの関数によって、様々な文字列形式やバイナリ形式からジオメトリーオブジェクトを生成できます。

7.8.1. Well-Known Text (WKT)

ST_BdPolyFromText — マルチラインストリングの Well-Known Text 表現による、閉じたラインストリングの任意のコレクションからポリゴンを生成します。
ST_BdMPolyFromText — マルチラインストリングの Well-Known Text 表現による、閉じたラインストリングの任意のコレクションからマルチポリゴンを構築します。
ST_GeogFromText — Well-Known Text 表現または拡張 WKT から指定したジオグラフィ値を返します。
ST_GeographyFromText — Well-Known Text 表現または拡張 WKT から指定したジオグラフィ値を返します。
ST_GeomCollFromText — WKT 表現と与えられた SRID からジオメトリーのコレクションを生成します。SRID が与えられていない場合は 0とします。
ST_GeomFromEWKT — 拡張 Well-Known Text 表現 (EWKT) から指定された ST_Geometry 値を返します。
ST_GeomFromMARC21 — MARC21/XML 地理データを入力に取り、PostGIS ジオメトリーオブジェクトを返します。
ST_GeometryFromText — Well-Known Text (WKT) からジオメトリーを返します。ST_GeomFromText の別名です。
ST_GeomFromText — Well-Known Text 表現 (WKT) から指定した ST_Geometry を返します。
ST_LineFromText — WKT 表現と与えられた SRID からジオメトリーを生成します。SRID が与えられていない場合は 0 (不明) となります。
ST_MLineFromText — WKT 表現から指定した ST_MultiLineString 値を返します。
ST_MPointFromText — Well-Known Text (WKT) 表現と与えられた SRID からジオメトリーを生成します。SRID を与えない場合は 0 (不明) となります。
ST_MPolyFromText — Well-Known Text (WKT) 表現と与えられた SRID からマルチポリゴンを生成します。SRID が与えられていない場合は 0 (不明) となります。
ST_PointFromText — WKT と与えられた SRID からポイントジオメトリーを生成します。SRID が与えられていない場合は 0 (不明) とします。
ST_PolygonFromText — Well-Known Text (WKT) 表現と与えられた SRID からジオメトリーを生成します。SRID を与えない場合は 0 (不明) となります。
ST_WKTToSQL — Well-Known Text (WKT) からジオメトリーを返します。ST_GeomFromText の SQL/MM 用の別名です。

7.8.2. Well-Known Binary (WKB)

ST_GeogFromWKB — Well-Known Binary ジオメトリー表現 (WKB) または拡張 WKB(EWKB) からジオグラフィインスタンスを生成します。
ST_GeomFromEWKB — 拡張 Well-Known Binary 表現 (EWKB) から指定した ST_Geometry 値を返します。
ST_GeomFromWKB — Well-Knwon Binary ジオメトリー表現 (WKB) と任意パラメーターの SRID からジオメトリーインスタンスを生成します。
ST_LineFromWKB — LINESTRING を WKB 表現から生成し、SRID を与えた場合にはそれを付けます。
ST_LinestringFromWKB — LINESTRING を WKB 表現から生成し、SRID を与えた場合にはそれを付けます。
ST_PointFromWKB — WKB と与えられた SRID からジオメトリーを生成します。
ST_WKBToSQL — Well-Known Binary (WKB) からジオメトリーを返します。ST_GeomFromWKB の SRID を除いた形式の SQL/MM 用の別名です。

7.8.3. その他の書式

ST_Box2dFromGeoHash — GeoHash 文字列から BOX2D を返します。
ST_GeomFromGeoHash — GeoHash 文字列からジオメトリーを返します。
ST_GeomFromGML — GML 表現から PostGIS ジオメトリーオブジェクトを出力します。
ST_GeomFromGeoJSON — ジオメトリーの GeoJSON 表現を入力として、PostGIS ジオメトリーオブジェクトを出力します。
ST_GeomFromKML — ジオメトリーの KML 表現の入力をとり、PostGIS ジオメトリーオブジェクトを出力します。
ST_GeomFromTWKB — TWKB ("Tiny Well-Known Binary") ジオメトリー表現からジオメトリーインスタンスを生成します。
ST_GMLToSQL — GML からジオメトリーを返します。ST_GeomFromGML の別名です。
ST_LineFromEncodedPolyline — エンコード化ポリラインからラインストリングを生成します。
ST_PointFromGeoHash — GeoHash 文字列からポイントを返します。
ST_FromFlatGeobufToTable — FlatGeobuf データの構造に基づいてテーブルを生成します。
ST_FromFlatGeobuf — FlatGeobuf データを読みます。

7.9. ジオメトリー出力

概要

これらの関数は、ジオメトリーオブジェクトを様々な文字列形式やバイナリ形式に変換するものです。

7.9.1. Well-Known Text (WKT)

ST_AsEWKT — ジオメトリーの SRID メタデータが付いた Well-Known Text (WKT) 表現を返します。
ST_AsText — ジオメトリー/ジオグラフィの SRID メタデータのない Well-Known Text (WKT) 表現を返します。

7.9.2. Well-Known Binary (WKB)

ST_AsBinary — ジオメトリー/ジオグラフィの、SRID メタデータを持たない OGC/ISO Well-Known バイナリ (WKB) 表現を返します。
ST_AsEWKB — ジオメトリーの、SRID メタデータを持つ Extended Well-Known バイナリ (EWKB) 表現を返します。
ST_AsHEXEWKB — ジオメトリーの HEXEWKB 表現を (文字列として) 返します。リトルエンディアン (NDR) またはビッグエンディアン (XDR) のどちらかのエンコーディングを使います。

7.9.3. その他の書式

ST_AsEncodedPolyline — ラインストリングジオメトリーから符号化したポリラインを返します。
ST_AsFlatGeobuf — 行の集合の FlatGeobuf 表現を返します。
ST_AsGeobuf — 行集合の Geobuf 表現を返します。
ST_AsGeoJSON — GeoJSON 形式のジオメトリーまたは地物を返します。
ST_AsGML — GML 第 2版または第 3版としてジオメトリーを返します。
ST_AsKML — ジオメトリーを KML 要素として返します。
ST_AsLatLonText — 与えられたポイントの度・分・秒表現を返します。
ST_AsMARC21 — ジオメトリーを、地理データフィールド (034) を持つ MARC21/XML データとして返します。
ST_AsMVTGeom — ジオメトリーを MVT タイルの座標空間に変換します。
ST_AsMVT — 行集合の MVT 表現を返す集約関数です。
ST_AsSVG — ジオメトリーから SVG パスデータを返します。
ST_AsTWKB — TWKB (Tiny Well-Known Binary) としてジオメトリーを出力します。
ST_AsX3D — ジオメトリーを X3D ノード要素書式 (ISO-IEC-19776-1.2-X3DEncodings-XML) で返します。
ST_GeoHash — ジオメトリーの GeoHash 表現を返します。

7.10. 演算子

概要

ここでは PostGIS で定義されている空間演算子について記述しています。演算子はバウンディングボックスの相互作用および空間関係に関する簡潔な記号による述語で関数を補うものです。関連する関数と同じ処理ルールに従って動作しますが、SQL 式での利用やインデックス対応のフィルタリングでの利用に最適化されています。

7.10.1. バウンディングボックス演算子

&& — A の 2次元バウンディングボックスが B の 2次元バウンディングボックスとインタセクトする場合に TRUE を返します。
&&(geometry,box2df) — ジオメトリーの (キャッシュされている) 2次元バウンディングボックスが単精度浮動小数点数による 2次元バウンディングボックスとインタセクトする場合に TRUE を返します。
&&(box2df,geometry) — 単精度浮動小数点数による 2次元バウンディングボックスがジオメトリーの (キャッシュされている) 2次元バウンディングボックスとインタセクトする場合に TRUE を返します。
&&(box2df,box2df) — 二つの単精度浮動小数点数による 2次元バウンディングボックス (BOX2DF) が相互にインタセクトする場合に TRUE を返します。
&&& — A の n 次元バウンディングボックスが B の n 次元バウンディングボックスとインタセクトする場合に TRUE を返します。
&&&(geometry,gidx) — ジオメトリーの (キャッシュされている) n 次元バウンディングボックスが単精度浮動小数点数による n 次元バウンディングボックス (GIDX) とインタセクトする場合に TRUE を返します。
&&&(gidx,geometry) — 単精度浮動小数点数による n 次元バウンディングボックス (GIDX) がジオメトリーの (キャッシュされている) n 次元バウンディングボックスとインタセクトする場合に TRUE を返します。
&&&(gidx,gidx) — 二つの単精度浮動小数点数による n 次元バウンディングボックス (GIDX) が相互にインタセクトする場合に TRUE を返します。
&< — A のバウンディングボックスが B のバウンディングボックスをオーバラップするか、B のバウンディングボックスの左にある場合に TRUE を返します。
&<| — A のバウンディングボックスが B のバウンディングボックスをオーバラップするか、B のバウンディングボックスの下にある場合に TRUE を返します。
&> — A のバウンディングボックスが B のバウンディングボックスをオーバラップするか、B のバウンディングボックスの右にある場合に TRUE を返します。
<< — A のバウンディングボックスが、厳密に B のバウンディングボックスの左にある場合に TRUE を返します。
<<| — A のバウンディングボックスが、厳密に B のバウンディングボックスの下にある場合に TRUE を返します。
= — ジオメトリー/ジオグラフィ A の座標と座標の並び順がジオメトリー/ジオグラフィ B と同じ場合に TRUE を返します。
>> — A のバウンディングボックスが、厳密に B のバウンディングボックスの右にある場合に TRUE を返します。
@ — A のバウンディングボックスが B のバウンディングボックスに含まれている場合に TRUE を返します。
@(geometry,box2df) — ジオメトリーの 2次元バウンディングボックスが単精度浮動小数点数による 2次元バウンディングボックス (BOX2DF) に包含される場合に TRUE を返します。
@(box2df,geometry) — 単精度浮動小数点数による 2次元バウンディングボックス (BOX2DF) がジオメトリーの 2次元バウンディングボックスに包含される場合に TRUE を返します。
@(box2df,box2df) — 二つの単精度浮動小数点数による n 次元バウンディングボックス (GIDX) の一方がもう一方を包含する場合に TRUE を返します。
|&> — A のバウンディングボックスが B のバウンディングボックスをオーバラップするか、B のバウンディングボックスの上にある場合に TRUE を返します。
|>> — A のバウンディングボックスが、厳密に B のバウンディングボックスの上にある場合に TRUE を返します。
~ — A のバウンディングボックスが B のバウンディングボックスを含む場合に TRUE を返します。
~(geometry,box2df) — ジオメトリーの (キャッシュされている) 2次元バウンディングボックスが単精度浮動小数点数による n 次元バウンディングボックス (GIDX) を包含する場合に TRUE を返します。
~(box2df,geometry) — 単精度浮動小数点数による 2次元バウンディングボックス (BOX2DF) をジオメトリーの (キャッシュされている) 2次元バウンディングボックスが包含する場合に TRUE を返します。
~(box2df,box2df) — 二つの単精度浮動小数点数による 2次元バウンディングボックス (BOX2DF) の一方がもう一方を包含する場合に TRUE を返します。
~= — A のバウンディングボックスが B のバウンディングボックスと同じ場合に TRUE を返します。

7.10.2. 距離演算子

<-> — A と B の 2次元距離を返します。
|=| — A トラジェクトリと B トラジェクトリとの最接近する時の距離を返します。
<#> — A のバウンディングボックスと B のバウンディングボックスの 2次元距離を返します。
<<->> — A と B の間またはそれらのバウンディングボックスの間の n 次元距離を返します

7.11. 空間関係関数

概要

これらの関数は、ジオメトリー間の空間的な関係を判定します。

7.11.1. トポロジー関係関数

ST_3DIntersects — 二つのジオメトリーが 3次元空間において空間的にインタセクトするかどうかをテストします。ポイント、ラインストリング、ポリゴン、多面体サーフェス (面) についてのみ動作します。
ST_Contains — B の全てのポイントが A 内にあり、かつ、双方の内部に共有点が存在するかどうかをテストします。
ST_ContainsProperly — B の全てのポイントが A の内部にあるかをテストします。
ST_CoveredBy — A の全てのポイントが B 内にあるかをテストします。
ST_Covers — B の全ての点が A 内にあるかをテストします。
ST_Crosses — 二つのジオメトリーが内部に共有ポイントを持ち、かつそれだけにならないようになっているかテストします。
ST_Disjoint — 二つのジオメトリーが共有点を持たないようになっているかテストします。
ST_Equals — 二つのジオメトリーが同じ点集合になっているかテストします。
ST_Intersects — 二つのジオメトリーがインタセクトしている (少なくとも一つの共有点がある) かどうかテストします。
ST_LineCrossingDirection — 二つのラインストリングがどのように交差しているかを示す数字を返します。
ST_OrderingEquals — 二つのジオメトリーが同じジオメトリーを表現し、かつ点の並び順が同じかどうかをテストします。
ST_Overlaps — 二つのジオメトリーが同じ次元を持ち、インタセクトして、かつ相手と重ならない点少なくとも一つあるかをテストします。
ST_Relate — 二つのジオメトリーが与えられた交差行列パターンに合致するトポロジー関係があるかどうかを見るか、交差行列を計算するかします。
ST_RelateMatch — DE-9IM 交差行列が交差行列パターンに合致するかどうかを見ます。
ST_Touches — 二つのジオメトリーが少なくとも一つの共有点を持ち、かつ内部でインタセクトしていないようになっているかテストします。
ST_Within — A の全てのポイントが B 内にあり、かつ両方の内部が共有点を持つかどうかをテストします。

7.11.2. 距離関係関数

ST_3DDWithin — 二つの 3次元ジオメトリーが与えらえれた 3次元距離内にあるかどうかをテストします。
ST_3DDFullyWithin — 二つの 3次元ジオメトリーが完全に与えらえれた 3次元距離内にあるかどうかをテストします。
ST_DFullyWithin — ジオメトリーが完全に他のジオメトリーの指定距離内にあるかどうかをテストします
ST_DWithin — 二つのジオメトリーが与えらえれた距離内にあるかどうかをテストします。
ST_PointInsideCircle — ポイントジオメトリーが中心と半径で定められた円の内側にあるかをテストします。

7.12. 計測関数

概要

この関数は、距離、面積、角度の測定値を計算します。測定値から決定されるジオメトリー値を計算する関数もあります。

ST_Area — ポリゴンジオメトリーの面積を返します。
ST_Azimuth — 北を基準とした 2点間の線の方位角を返します。
ST_Angle — 3点もしくは 4点、または 2線で定義される二つのベクター間の角度を返します。
ST_ClosestPoint — g1 上にある、g2 と最近傍となる 2次元ポイントを返します。これは、あるジオメトリーから他のジオメトリーへの最短ラインの一つ目のポイントです。
ST_3DClosestPoint — g1 上の、g2 に最も近い 3次元ポイントを返します。これは 3次元の最短ラインの始点です。
ST_Distance — 二つのジオメトリー値またはジオグラフィ値間の距離を返します。
ST_3DDistance — 投影座標系の単位で、二つのジオメトリー間の 3次元デカルト距離の最小値を返します (空間参照系に基づきます)。
ST_DistanceSphere — 球面の地球モデルを使って、二つの経度/緯度ジオメトリーの最小距離をメートル単位で返します。
ST_DistanceSpheroid — 回転楕円体面の地球モデルを使って、二つの経度/緯度ジオメトリーの最小距離を返します。
ST_FrechetDistance — 二つのジオメトリーのフレシェ距離を返します。
ST_HausdorffDistance — 二つのジオメトリー間のハウスドルフ距離を返します。
ST_Length — 線系ジオメトリーの 2次元長を返します。
ST_Length2D — LINESTRING または MULTILINESTRING に対して、ジオメトリーの 2次元長を返します。これは ST_Length の別名です。
ST_3DLength — 線ジオメトリーの 3次元長を返します。
ST_LengthSpheroid — 回転楕円体面上の経度緯度のジオメトリーの 2次元または 3次元の長さ/周長を返します。
ST_LongestLine — 二つのジオメトリー間の 2次元最長ラインを返します。
ST_3DLongestLine — 二つのジオメトリー間の 3次元最長ラインを返します。
ST_MaxDistance — 二つのジオメトリー間の 2次元最長距離を空間参照系の単位で返します。
ST_3DMaxDistance — 二つのジオメトリー間の 3次元最大デカルト距離 (空間参照系に基づく) を空間参照系の単位で返します。
ST_MinimumClearance — ジオメトリーのクリアランスの最小値を返します。この値はジオメトリーのロバスト性を示すものです。
ST_MinimumClearanceLine — ジオメトリーの最小クリアランスを示す、2点のラインストリングを返します。
ST_Perimeter — ポリゴンジオメトリーまたはジオグラフィの境界の長さを返します。
ST_Perimeter2D — ポリゴンジオメトリーの 2次元周長を返します。ST_Perimeter の別名です。
ST_3DPerimeter — ポリゴンジオメトリーの 3次元周長を返します。
ST_ShortestLine — 二つのジオメトリーの 3次元の最短ラインを返します。
ST_3DShortestLine — 二つのジオメトリーの 3次元の最短ラインを返します。

7.13. 重ね合わせ関数

概要

これらの関数は、二つのジオメトリーの重ね合わせから生まれる結果を計算するものです。ポイント集合理論の真偽値演算を行うものもあります。関連する関数もいくつか提供されています。

ST_ClipByBox2D — 長方形内に落ちるジオメトリーの一部を返します。
ST_Difference — ジオメトリー B とインタセクトしていないジオメトリー A の一部を表現するジオメトリーを計算します。
ST_Intersection — ジオメトリー A とジオメトリー B の共通部分を表現するジオメトリーを返します。
ST_MemUnion — ジオメトリーを結合する集約関数で、メモリを効率的に使いますが処理時間のかかるものです。
ST_Node — ラインストリングの集合にノードを作成します。
ST_Split — ジオメトリーを他のジオメトリーで分割してできたジオメトリーのコレクションを返します。
ST_Subdivide — ジオメトリーの線の分割を計算します。
ST_SymDifference — ジオメトリー A とジオメトリー B がインタセクトしていない部分を表現するジオメトリーを返します。
ST_UnaryUnion — 単一のジオメトリーの要素の結合を計算します。
ST_Union — 入力ジオメトリーのポイント集合の結合を表現するジオメトリーを返します。

7.14. ジオメトリー処理関数

概要

これらの関数は幾何的構造の計算、すなわちジオメトリーのサイズや形状を変更します。

ST_Buffer — あるジオメトリーからの距離が指定された距離以下となる点全ての集合となるジオメトリーを返します。
ST_BuildArea — 与えられたジオメトリーの構成ラインワークから面ジオメトリーを生成します。
ST_Centroid — ジオメトリーの幾何学的重心を返します。
ST_ChaikinSmoothing — チャイキンのアルゴリズムを使って、与えられたジオメトリーの平滑化されたものを返します。
ST_CatmullRomSmoothing — Catmull-Rom スプライン曲線を用いて平滑化されたジオメトリーを返します。
ST_ConcaveHull — 全ての入力ジオメトリーの頂点を含む凹ジオメトリーを計算します。
ST_ConvexHull — ジオメトリーの凸包を計算します。
ST_DelaunayTriangles — ジオメトリーの頂点のドローネ三角形を返します。
ST_FilterByM — M 値に基づいて頂点を削除します。
ST_GeneratePoints — ポリゴン内やマルチポリゴン内にランダムなマルチポイントを生成します。
ST_GeometricMedian — マルチポイントの幾何学的中央値を返します。
ST_LineMerge — MULTILINESTRING を縫い合わせて形成したラインを返します。
ST_MaximumInscribedCircle — ジオメトリーに含まれる最大の円を計算します。
ST_LargestEmptyCircle — ジオメトリーとオーバラップしない最大の円を計算します。
ST_MinimumBoundingCircle — 入力ジオメトリーを含む最小の円を返します。
ST_MinimumBoundingRadius — ジオメトリーを完全に包含する最小円の中心ポイントと半径を返します。
ST_OrientedEnvelope — ジオメトリーを囲む最小の回転四角形を返します。
ST_OffsetCurve — 与えられた距離と方面に入力ラインをずらしたラインを返します。
ST_PointOnSurface — ポリゴン内またはジオメトリー上にあるのが保証されたポイントを返します。
ST_Polygonize — ジオメトリー集合のラインワークから形成されるポリゴンのコレクションを計算します。
ST_ReducePrecision — 全ての与えられたグリッド許容値に丸められたポイントからなる妥当なジオメトリーを返します。
ST_SharedPaths — 二つの LINESTRING/MULTILINESTRING の入力が共有するパスのコレクションを返します。
ST_Simplify — Douglas-Peuker アルゴリズムを使用して、簡略化したジオメトリーを返します。
ST_SimplifyPreserveTopology — Douglas-Peucker アルゴリズムを使用して、簡略化した妥当なジオメトリーを返します。
ST_SimplifyPolygonHull — ポリゴンジオメトリーに対してトポロジーを保存した状態で簡略化した外側または内側の凹包を計算します。
ST_SimplifyVW — Visvalingam-Whyatt アルゴリズムを使用して、入力ジオメトリーを簡略化したジオメトリーを返します。
ST_SetEffectiveArea — Visvalingam-Whyatt アルゴリズムを使って有効範囲となる個々の頂点を置きます。
ST_TriangulatePolygon — ポリゴンの制約付きドロネー三角分割を計算します。
ST_VoronoiLines — ジオメトリーの頂点からボロノイ図のセルを返します。
ST_VoronoiPolygons — ジオメトリーの頂点からボロノイ図のセルを返します。

7.15. カバレッジ

概要

これらの関数は「暗黙的なカバレッジ」を形成するポリゴンジオメトリーの集合で動作します。妥当なカバレッジを形成するには、ポリゴンはオーバラップしてはいけませんし、隣接するエッジの頂点が確実に合致していなければいけません。カバレッジは処理が速く、かつ、エッジを変更してもウィンドウパーティション内のカバレッジのトポロジーを保持するウィンドウ関数で操作できます。

ST_CoverageInvalidEdges — ポリゴンが妥当なカバレッジの形成に失敗する位置を検索するウィンドウ関数。
ST_CoverageClean — きれいな (エッジが合致し、オーバーラップがなく、隙間がない) ポリゴンカバレッジを、きれいでない入力から計算します。
ST_CoverageSimplify — ポリゴンカバレッジのエッジを簡略化するウィンドウ関数。
ST_CoverageEdges — ポリゴンカバレッジの重複の無いエッジを計算します。
ST_CoverageUnion — 共有しているエッジを除去することでカバレッジを形成するポリゴンの集合の結合を計算します。

7.16. アフィン変換

概要

これらの関数はアフィン変換を使用してジオメトリーの位置と形状を変更するものです。

ST_Affine — ジオメトリーに 3次元アフィン変換を適用します。
ST_Rotate — ジオメトリーを原点について回転させます。
ST_RotateX — ジオメトリーを X 軸について回転させます。
ST_RotateY — ジオメトリーを Y 軸について回転させます。
ST_RotateZ — ジオメトリーを Z 軸について回転させます。
ST_Scale — 与えた係数でジオメトリーを拡大縮小します。
ST_Translate — 与えられたオフセットでジオメトリーを変換します。
ST_TransScale — 与えられた係数とオフセットでジオメトリーを変換します。

7.17. クラスタリング関数

概要

これらの関数はジオメトリー集合に対するクラスタリングアルゴリズムを実装したものです。

ST_ClusterDBSCAN — 入力ジオメトリーごとに DBSCAN アルゴリズムを使ってクラスタ番号を返すウィンドウ関数です。
ST_ClusterIntersecting — 入力ジオメトリーを接続関係にある集合にクラスタリングする集約関数です。
ST_ClusterIntersectingWin — 入力ジオメトリーごとに接続された集合にクラスタリングを行い、クラスタ ID を返すウィンドウ関数です。
ST_ClusterRelateWin — ジオメトリーが接続するかどうかを判定する空間関係パターンを使って、入力ジオメトリーを接続されたジオメトリー集合にクラスタリングして、クラスター識別子を返すウィンドウ関数です。
ST_MinimumSpanningTree — 最小全域木アルゴリズムを使って入力ジオメトリーを接続された木にクラスタリングを行い、入力ジオメトリーごとに木 ID を返すウィンドウ関数です。
ST_ClusterKMeans — 入力ジオメトリーごとに k 平均法アルゴリズムを使ってクラスタ番号を返すウィンドウ関数です。
ST_ClusterWithin — 分離距離でジオメトリーのクラスタリングを行う集約関数です。
ST_ClusterWithinWin — 入力ジオメトリーごとに分離距離を使ったクラスタリングを行い、クラスタ ID を返すウィンドウ関数です。

7.18. バウンディングボックス関数

概要

これらの関数は、バウンディングボックスを生成または操作します。自動キャストまたは明示的なキャストを使って、ジオメトリー値を提供し、受け付けます。

「PostGIS ボックス関数」を参照して下さい。

Box2D — ジオメトリーの 2次元範囲を表現する BOX2D を返します。
Box3D — ジオメトリーの 3次元範囲を表現する BOX3D を返します。
ST_EstimatedExtent — 空間テーブルの推定範囲を返します。
ST_Expand — 他のバウンディングボックスまたはジオメトリーから拡張されたバウンディングボックスを返します。
ST_Extent — ジオメトリーのバウンディングボックスを返す集約関数です。
ST_3DExtent — ジオメトリーの 3次元バウンディングボックスを返す集約関数です。
ST_MakeBox2D — 二つの 2次元のポイントジオメトリーで定義される BOX2D を生成します。
ST_3DMakeBox — 二つの 3次元のポイントジオメトリーで定義される BOX3D を生成します。
ST_XMax — 2次元または 3次元のバウンディングボックスまたはジオメトリーの X の最大値を返します。
ST_XMin — 2次元または 3次元のバウンディングボックスまたはジオメトリーの X の最小値を返します。
ST_YMax — 2次元または 3次元のバウンディングボックスまたはジオメトリーの Y の最大値を返します。
ST_YMin — 2次元または 3次元のバウンディングボックスまたはジオメトリーの Y の最小値を返します。
ST_ZMax — 2次元または 3次元のバウンディングボックスまたはジオメトリーの Z の最大値を返します。
ST_ZMin — 2次元または 3次元のバウンディングボックスまたはジオメトリーの Z の最小値を返します。
ST_XSize — 2次元または 3次元のバウンディングボックスまたはジオメトリーの X 方向のサイズを返します。
ST_YSize — 2次元または 3次元のバウンディングボックスまたはジオメトリーの Y 方向のサイズを返します。
ST_ZSize — 2次元または 3次元のバウンディングボックスまたはジオメトリーの Z 方向のサイズを返します。
ST_MMin — ジオメトリーの M 値の最小値を返します。
ST_MMax — M 値の最大値を返します。
ST_MSize — ジオメトリーの M 値のサイズを返します。

7.19. 線型参照

概要

これらの関数は、測定とイベント (地物に沿った計測値) の位置特定を行います。これらの関数は、ルートに沿った割合や計測値としての位置表現とこれらの計測値の座標への変換との古典的な線形参照の処理に対応します。

ST_LineInterpolatePoint — ラインに沿って、割合で示された位置の補間ポイントを返します。
ST_3DLineInterpolatePoint — 3次元ラインに沿って、割合で示された位置の補間ポイントを返します。
ST_LineInterpolatePoints — ラインに沿って、割合で示された複数の位置の補間ポイントを返します。
ST_LineLocatePoint — ポイントに最も近いライン上のポイントの位置を割合で返します。
ST_LineSubstring — 二つの割合位置からラインの一部を返します。
ST_LocateAlong — M 値に一致するジオメトリー上のポイントを返します。
ST_LocateBetween — M 値の範囲に合致する部分ジオメトリーを返します。
ST_LocateBetweenElevations — 標高 (Z 値) 範囲にある部分ジオメトリーを返します。
ST_InterpolatePoint — ジオメトリーのポイントに最も近いポイント上の補間 M 値を返します。
ST_3DInterpolatePoint — 3次元で最も近いジオメトリーの補間 M 値を返します。
ST_AddMeasure — ラインに沿った M 値を補間します。

7.20. トラジェクトリ関数

概要

これらの関数はトラジェクトリで動作します。トラジェクトリは、M 値が座標ごとに増加していく線形ジオメトリーです。時空間データは M 値を相対時間 (エポック等) としてモデル化できます。

ST_IsValidTrajectory — ジオメトリーが妥当なトラジェクトリであるかどうかをテストします。
ST_ClosestPointOfApproach — 二つのトラジェクトリの最接近時の距離を返します。
ST_DistanceCPA — 二つのトラジェクトリの最接近する時の距離を返します。
ST_CPAWithin — 二つのトラジェクトリの最接近時の距離が指定距離内であるかどうかをテストします。

7.21. バージョン関数

概要

これらの関数は PostGIS のバージョンを報告したりアップグレードします。

PostGIS_Extensions_Upgrade — PostGIS エクステンション (例: postgis_raster, postgis_topology, postgis_sfcgal) について、指定したバージョンまたは最新版にパッケージ化し、アップグレードします。
PostGIS_Full_Version — 完全な PostGIS のバージョン情報とコンフィギュレーション情報を報告します。
PostGIS_GEOS_Version — GEOS ライブラリのバージョン番号を返します。
PostGIS_GEOS_Compiled_Version — PostGIS のビルドに使われた GEOS ライブラリのバージョン番号を返します。
PostGIS_Liblwgeom_Version — liblwgeom ライブラリのバージョン番号を返します。PostGIS のバージョンと同じになるべきものです。
PostGIS_LibXML_Version — LibXML2 ライブラリのバージョン番号を返します。
PostGIS_LibJSON_Version — libjson-c ライブラリのバージョン番号を返します。
PostGIS_Lib_Build_Date — PostGIS ライブラリのビルド日付を返します。
PostGIS_Lib_Version — PostGIS のバージョン番号を返します。
PostGIS_PROJ_Version — PROJ4 のバージョン番号を返します。
PostGIS_PROJ_Compiled_Version — PostGIS のビルドに使われた PROJ ライブラリのバージョン番号を返します。
PostGIS_Wagyu_Version — 内部の Wagyu ライブラリのバージョン番号を返します。
PostGIS_Scripts_Build_Date — PostGIS スクリプトのビルド日付を返します。
PostGIS_Scripts_Installed — このデータベースにインストールした PostGIS スクリプトのバージョンを返します。
PostGIS_Scripts_Released — インストールした PostGIS ライブラリとともにリリースされた postgis.sql スクリプトのバージョン番号を返します。
PostGIS_Version — PostGIS バージョン番号とコンパイルオプションを返します。

7.22. Grand Unified Custom 変数 (GUC)

概要

本節では、PostGIS GUC (Grand Unified Custom) 変数の一覧を上げます。これらは、グローバル、データベースごと、セッションごと、またはトランザクションごとに設定できます。グローバルまたはデータベースごとの設定が最善です。

その他の使用例については SQL SET と SQL ALTER SYSTEM を参照して下さい

postgis.gdal_datapath — GDAL の GDAL_DATA オプションの値を設定するためのコンフィギュレーションオプションです。設定しない場合には、GDAL_DATA 環境変数が使われます。
postgis.gdal_enabled_drivers — PostGIS 環境で GDAL ドライバーを有効にするコンフィギュレーションオプションです。GDAL コンフィギュレーション変数 GDAL_SKIP に影響を与えます。
postgis.enable_outdb_rasters — データベース外ラスターのバンドにアクセスできるようにする、真偽型のコンフィギュレーションオプション。
postgis.gdal_vsi_options — データベース外ラスターを操作する時に使用するオプションを設定するためのコンフィギュレーション。
postgis.gdal_cpl_debug — GDAL デバッグメッセージのログを取るか取らないかを設定する真偽値。

7.23. トラブルシューティング関数

概要

これらの関数はトラブルシューティングとジオメトリーデータの修復を行うためのものです。ジオメトリーデータが、通常の環境では発生しえない出来事によって破損している場合のみ有効です。

PostGIS_AddBBox — ジオメトリーにバウンディングボックスを追加します。
PostGIS_DropBBox — ジオメトリーからバウンディングボックスのキャッシュを削除します。
PostGIS_HasBBox — ジオメトリーのバウンディングボックスがキャッシュされている場合には TRUE を返し、他の場合には FALSE を返します。