GDAL

ogr_gensql.h
1/******************************************************************************
2 * $Id$
3 *
4 * Project: OpenGIS Simple Features Reference Implementation
5 * Purpose: Classes related to generic implementation of ExecuteSQL().
6 * Author: Frank Warmerdam, warmerdam@pobox.com
7 *
8 ******************************************************************************
9 * Copyright (c) 2002, Frank Warmerdam
10 * Copyright (c) 2010-2013, Even Rouault <even dot rouault at spatialys.com>
11 *
12 * SPDX-License-Identifier: MIT
13 ****************************************************************************/
14
15#ifndef OGR_GENSQL_H_INCLUDED
16#define OGR_GENSQL_H_INCLUDED
17
18#include "ogrsf_frmts.h"
19#include "ogr_swq.h"
20#include "cpl_hash_set.h"
21#include "cpl_string.h"
22
23#include <vector>
24
27#define GEOM_FIELD_INDEX_TO_ALL_FIELD_INDEX(poFDefn, iGeom) \
28 ((poFDefn)->GetFieldCount() + SPECIAL_FIELD_COUNT + (iGeom))
29
30#define IS_GEOM_FIELD_INDEX(poFDefn, idx) \
31 (((idx) >= (poFDefn)->GetFieldCount() + SPECIAL_FIELD_COUNT) && \
32 ((idx) < (poFDefn)->GetFieldCount() + SPECIAL_FIELD_COUNT + \
33 (poFDefn)->GetGeomFieldCount()))
34
35#define ALL_FIELD_INDEX_TO_GEOM_FIELD_INDEX(poFDefn, idx) \
36 ((idx) - ((poFDefn)->GetFieldCount() + SPECIAL_FIELD_COUNT))
37
38/************************************************************************/
39/* OGRGenSQLResultsLayer */
40/************************************************************************/
41
42 class swq_select;
43
44 class OGRGenSQLResultsLayer final : public OGRLayer
45{
46 private:
47 GDALDataset *m_poSrcDS = nullptr;
48 OGRLayer *m_poSrcLayer = nullptr;
49 std::unique_ptr<swq_select> m_pSelectInfo{};
50
51 std::string m_osInitialWHERE{};
52 bool m_bForwardWhereToSourceLayer = true;
53 bool m_bEOF = false;
54
55 // Array of source layers (owned by m_poSrcDS or m_apoExtraDS)
56 std::vector<OGRLayer *> m_apoTableLayers{};
57
58 // Array of extra datasets when referencing a table/layer by a dataset name
59 std::vector<std::unique_ptr<GDALDataset, GDALDatasetUniquePtrReleaser>>
60 m_apoExtraDS{};
61
62 OGRFeatureDefn *m_poDefn = nullptr;
63
64 std::vector<int> m_anGeomFieldToSrcGeomField{};
65
66 std::vector<GIntBig> m_anFIDIndex{};
67 bool m_bOrderByValid = false;
68
69 GIntBig m_nNextIndexFID = 0;
70 std::unique_ptr<OGRFeature> m_poSummaryFeature{};
71
72 int m_iFIDFieldIndex = 0;
73
74 GIntBig m_nIteratedFeatures = -1;
75 std::vector<std::string> m_aosDistinctList{};
76
77 bool PrepareSummary();
78
79 std::unique_ptr<OGRFeature> TranslateFeature(std::unique_ptr<OGRFeature>);
80 void CreateOrderByIndex();
81 void ReadIndexFields(OGRFeature *poSrcFeat, int nOrderItems,
82 OGRField *pasIndexFields);
83 void SortIndexSection(const OGRField *pasIndexFields, GIntBig *panMerged,
84 size_t nStart, size_t nEntries);
85 void FreeIndexFields(OGRField *pasIndexFields, size_t l_nIndexSize);
86 int Compare(const OGRField *pasFirst, const OGRField *pasSecond);
87
88 void ClearFilters();
89 void ApplyFiltersToSource();
90
91 void FindAndSetIgnoredFields();
92 void ExploreExprForIgnoredFields(swq_expr_node *expr, CPLHashSet *hSet);
93 void AddFieldDefnToSet(int iTable, int iColumn, CPLHashSet *hSet);
94
95 int ContainGeomSpecialField(swq_expr_node *expr);
96
97 void InvalidateOrderByIndex();
98
99 int MustEvaluateSpatialFilterOnGenSQL();
100
101 CPL_DISALLOW_COPY_ASSIGN(OGRGenSQLResultsLayer)
102
103 public:
104 OGRGenSQLResultsLayer(GDALDataset *poSrcDS,
105 std::unique_ptr<swq_select> &&pSelectInfo,
106 const OGRGeometry *poSpatFilter, const char *pszWHERE,
107 const char *pszDialect);
108 virtual ~OGRGenSQLResultsLayer();
109
110 virtual OGRGeometry *GetSpatialFilter() override;
111
112 virtual void ResetReading() override;
113 virtual OGRFeature *GetNextFeature() override;
114 virtual OGRErr SetNextByIndex(GIntBig nIndex) override;
115 virtual OGRFeature *GetFeature(GIntBig nFID) override;
116
117 virtual OGRFeatureDefn *GetLayerDefn() override;
118
119 virtual GIntBig GetFeatureCount(int bForce = TRUE) override;
120
121 virtual OGRErr GetExtent(OGREnvelope *psExtent, int bForce = TRUE) override
122 {
123 return GetExtent(0, psExtent, bForce);
124 }
125
126 virtual OGRErr GetExtent(int iGeomField, OGREnvelope *psExtent,
127 int bForce = TRUE) override;
128
129 virtual int TestCapability(const char *) override;
130
131 virtual void SetSpatialFilter(OGRGeometry *poGeom) override
132 {
133 SetSpatialFilter(0, poGeom);
134 }
135
136 virtual void SetSpatialFilter(int iGeomField, OGRGeometry *) override;
137 virtual OGRErr SetAttributeFilter(const char *) override;
138
139 bool GetArrowStream(struct ArrowArrayStream *out_stream,
140 CSLConstList papszOptions = nullptr) override;
141
142 int GetArrowSchema(struct ArrowArrayStream *stream,
143 struct ArrowSchema *out_schema) override;
144
145 protected:
146 friend struct OGRGenSQLResultsLayerArrowStreamPrivateData;
147
148 int GetArrowSchemaForwarded(struct ArrowArrayStream *stream,
149 struct ArrowSchema *out_schema) const;
150
151 int GetNextArrowArray(struct ArrowArrayStream *stream,
152 struct ArrowArray *out_array) override;
153
154 int GetNextArrowArrayForwarded(struct ArrowArrayStream *stream,
155 struct ArrowArray *out_array);
156};
157
160#endif /* ndef OGR_GENSQL_H_INCLUDED */
GDALDataset
A set of associated raster bands, usually from one file.
Definition: gdal_priv.h:495
OGREnvelope
Simple container for a bounding region (rectangle)
Definition: ogr_core.h:45
OGRFeatureDefn
Definition of a feature class or feature layer.
Definition: ogr_feature.h:501
OGRFeature
A simple feature, including geometry and attributes.
Definition: ogr_feature.h:877
OGRGeometry
Abstract base class for all geometry classes.
Definition: ogr_geometry.h:361
OGRLayer
This class represents a layer of simple features, with access methods.
Definition: ogrsf_frmts.h:58
OGRLayer::SetSpatialFilter
virtual void SetSpatialFilter(OGRGeometry *)
Set a new spatial filter.
Definition: ogrlayer.cpp:1472
OGRLayer::GetFeatureCount
virtual GIntBig GetFeatureCount(int bForce=TRUE)
Fetch the feature count in this layer.
Definition: ogrlayer.cpp:158
OGRLayer::GetExtent
virtual OGRErr GetExtent(OGREnvelope *psExtent, int bForce=TRUE)
Fetch the extent of this layer.
Definition: ogrlayer.cpp:196
OGRLayer::GetArrowStream
virtual bool GetArrowStream(struct ArrowArrayStream *out_stream, CSLConstList papszOptions=nullptr)
Get a Arrow C stream.
Definition: ogrlayerarrow.cpp:2445
OGRLayer::GetNextFeature
virtual OGRFeature * GetNextFeature()=0
Fetch the next available feature from this layer.
OGRLayer::GetNextArrowArray
virtual int GetNextArrowArray(struct ArrowArrayStream *, struct ArrowArray *out_array)
Default implementation of the ArrowArrayStream::get_next() callback.
Definition: ogrlayerarrow.cpp:1826
OGRLayer::GetLayerDefn
virtual OGRFeatureDefn * GetLayerDefn()=0
Fetch the schema information for this layer.
OGRLayer::ResetReading
virtual void ResetReading()=0
Reset feature reading to start on the first feature.
OGRLayer::SetNextByIndex
virtual OGRErr SetNextByIndex(GIntBig nIndex)
Move read cursor to the nIndex'th feature in the current resultset.
Definition: ogrlayer.cpp:583
OGRLayer::SetAttributeFilter
virtual OGRErr SetAttributeFilter(const char *)
Set a new attribute query.
Definition: ogrlayer.cpp:421
OGRLayer::GetFeature
virtual OGRFeature * GetFeature(GIntBig nFID)
Fetch a feature by its identifier.
Definition: ogrlayer.cpp:529
OGRLayer::GetArrowSchema
virtual int GetArrowSchema(struct ArrowArrayStream *, struct ArrowSchema *out_schema)
Default implementation of the ArrowArrayStream::get_schema() callback.
Definition: ogrlayerarrow.cpp:374
OGRLayer::GetSpatialFilter
virtual OGRGeometry * GetSpatialFilter()
This method returns the current spatial filter for this layer.
Definition: ogrlayer.cpp:1403
OGRLayer::TestCapability
virtual int TestCapability(const char *)=0
Test if this layer supported the named capability.
cpl_hash_set.h
Hash set implementation.
CPLHashSet
struct _CPLHashSet CPLHashSet
Opaque type for a hash set.
Definition: cpl_hash_set.h:36
CPL_DISALLOW_COPY_ASSIGN
#define CPL_DISALLOW_COPY_ASSIGN(ClassName)
Helper to remove the copy and assignment constructors so that the compiler will not generate the defa...
Definition: cpl_port.h:1030
CSLConstList
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1179
GIntBig
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:199
cpl_string.h
Various convenience functions for working with strings and string lists.
OGRErr
int OGRErr
Type for a OGR error.
Definition: ogr_core.h:371
ogrsf_frmts.h
Classes related to registration of format support, and opening datasets.
OGRField
OGRFeature field attribute value union.
Definition: ogr_core.h:905