GDAL

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