aboutsummaryrefslogtreecommitdiff
path: root/odb/pgsql/statement.hxx
blob: e5c084def4959cb20f5f62c3b96b0f219b80c4ee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
// file      : odb/pgsql/statement.hxx
// copyright : Copyright (c) 2005-2019 Code Synthesis Tools CC
// license   : GNU GPL v2; see accompanying LICENSE file

#ifndef ODB_PGSQL_STATEMENT_HXX
#define ODB_PGSQL_STATEMENT_HXX

#include <odb/pre.hxx>

#include <string>
#include <cstddef>  // std::size_t

#include <odb/statement.hxx>

#include <odb/pgsql/version.hxx>
#include <odb/pgsql/forward.hxx>
#include <odb/pgsql/binding.hxx>
#include <odb/pgsql/pgsql-fwd.hxx> // PGresult
#include <odb/pgsql/connection.hxx>
#include <odb/pgsql/auto-handle.hxx>

#include <odb/pgsql/details/export.hxx>

namespace odb
{
  namespace pgsql
  {
    class connection;

    class LIBODB_PGSQL_EXPORT statement: public odb::statement
    {
    public:
      typedef pgsql::connection connection_type;

      virtual
      ~statement () = 0;

      const char*
      name () const
      {
        return name_;
      }

      virtual const char*
      text () const;

      virtual connection_type&
      connection ()
      {
        return conn_;
      }

      // A statement can be empty. This is used to handle situations
      // where a SELECT or UPDATE statement ends up not having any
      // columns after processing. An empty statement cannot be
      // executed.
      //
      bool
      empty () const
      {
        return *text_ == '\0';
      }

      void
      deallocate ();

      // Adapt an ODB binding to a native PostgreSQL parameter binding.
      //
      static void
      bind_param (native_binding&, const binding&);

      // Populate an ODB binding given a PostgreSQL result. If the truncated
      // argument is true, then only truncated columns are extracted. Return
      // true if all the data was extracted successfully and false if one or
      // more columns were truncated.
      //
      static bool
      bind_result (bind*,
                   std::size_t count,
                   PGresult*,
                   std::size_t row,
                   bool truncated = false);

    protected:
      // We keep two versions to take advantage of std::string COW.
      //
      statement (connection_type&,
                 const std::string& name,
                 const std::string& text,
                 statement_kind,
                 const binding* process,
                 bool optimize,
                 const Oid* types,
                 std::size_t types_count);

      statement (connection_type&,
                 const char* name,
                 const char* text,
                 statement_kind,
                 const binding* process,
                 bool optimize,
                 bool copy_name_text,
                 const Oid* types,
                 std::size_t types_count);

    private:
      void
      init (statement_kind,
            const binding* process,
            bool optimize,
            const Oid* types,
            std::size_t types_count);

    protected:
      connection_type& conn_;

      std::string name_copy_;
      const char* name_;

      std::string text_copy_;
      const char* text_;

    private:
      bool deallocated_;
    };

    class LIBODB_PGSQL_EXPORT select_statement: public statement
    {
    public:
      virtual
      ~select_statement ();

      select_statement (connection_type& conn,
                        const std::string& name,
                        const std::string& text,
                        bool process_text,
                        bool optimize_text,
                        const Oid* types,
                        std::size_t types_count,
                        binding& param,
                        native_binding& native_param,
                        binding& result);

      select_statement (connection_type& conn,
                        const char* name,
                        const char* stmt,
                        bool process_text,
                        bool optimize_text,
                        const Oid* types,
                        std::size_t types_count,
                        binding& param,
                        native_binding& native_param,
                        binding& result,
                        bool copy_name_text = true);

      select_statement (connection_type& conn,
                        const std::string& name,
                        const std::string& text,
                        bool process_text,
                        bool optimize_text,
                        binding& result);

      select_statement (connection_type& conn,
                        const char* name,
                        const char* text,
                        bool process_text,
                        bool optimize_text,
                        binding& result,
                        bool copy_name_text = true);

      select_statement (connection_type& conn,
                        const std::string& name,
                        const std::string& text,
                        bool process_text,
                        bool optimize_text,
                        const Oid* types,
                        std::size_t types_count,
                        native_binding& native_param,
                        binding& result);

      // Common select interface expected by the generated code.
      //
    public:
      enum result
      {
        success,
        no_data,
        truncated
      };

      void
      execute ();

      void
      cache () const
      {
      }

      std::size_t
      result_size () const
      {
        return row_count_;
      }

      // Load next row columns into bound buffers.
      //
      result
      fetch ()
      {
        return next () ? load () : no_data;
      }

      // Reload truncated columns into bound buffers.
      //
      void
      refetch ()
      {
        reload ();
      }

      // Free the result set.
      //
      void
      free_result ();

      // Finer grained control of PostgreSQL-specific interface that
      // splits fetch() into next() and load().
      //
    public:
      bool
      next ();

      result
      load ();

      void
      reload ();

    private:
      select_statement (const select_statement&);
      select_statement& operator= (const select_statement&);

    private:
      binding* param_;
      native_binding* native_param_;

      binding& result_;

      auto_handle<PGresult> handle_;
      std::size_t row_count_;
      std::size_t current_row_;
    };

    struct LIBODB_PGSQL_EXPORT auto_result
    {
      explicit auto_result (select_statement& s): s_ (s) {}
      ~auto_result () {s_.free_result ();}

    private:
      auto_result (const auto_result&);
      auto_result& operator= (const auto_result&);

    private:
      select_statement& s_;
    };

    class LIBODB_PGSQL_EXPORT insert_statement: public statement
    {
    public:
      virtual
      ~insert_statement ();

      insert_statement (connection_type& conn,
                        const std::string& name,
                        const std::string& text,
                        bool process_text,
                        const Oid* types,
                        std::size_t types_count,
                        binding& param,
                        native_binding& native_param,
                        binding* returning);

      insert_statement (connection_type& conn,
                        const char* name,
                        const char* text,
                        bool process_text,
                        const Oid* types,
                        std::size_t types_count,
                        binding& param,
                        native_binding& native_param,
                        binding* returning,
                        bool copy_name_text = true);

      // Return true if successful and false if the row is a duplicate.
      // All other errors are reported by throwing exceptions.
      //
      bool
      execute ();

    private:
      insert_statement (const insert_statement&);
      insert_statement& operator= (const insert_statement&);

    private:
      binding& param_;
      native_binding& native_param_;
      binding* returning_;
    };

    class LIBODB_PGSQL_EXPORT update_statement: public statement
    {
    public:
      virtual
      ~update_statement ();

      update_statement (connection_type& conn,
                        const std::string& name,
                        const std::string& text,
                        bool process_text,
                        const Oid* types,
                        std::size_t types_count,
                        binding& param,
                        native_binding& native_param);

      update_statement (connection_type& conn,
                        const char* name,
                        const char* text,
                        bool process_text,
                        const Oid* types,
                        std::size_t types_count,
                        binding& param,
                        native_binding& native_param,
                        bool copy_name_text = true);

      unsigned long long
      execute ();

    private:
      update_statement (const update_statement&);
      update_statement& operator= (const update_statement&);

    private:
      binding& param_;
      native_binding& native_param_;
    };

    class LIBODB_PGSQL_EXPORT delete_statement: public statement
    {
    public:
      virtual
      ~delete_statement ();

      delete_statement (connection_type& conn,
                        const std::string& name,
                        const std::string& text,
                        const Oid* types,
                        std::size_t types_count,
                        binding& param,
                        native_binding& native_param);

      delete_statement (connection_type& conn,
                        const char* name,
                        const char* text,
                        const Oid* types,
                        std::size_t types_count,
                        binding& param,
                        native_binding& native_param,
                        bool copy_name_text = true);

      delete_statement (connection_type& conn,
                        const std::string& name,
                        const std::string& text,
                        const Oid* types,
                        std::size_t types_count,
                        native_binding& native_param);

      unsigned long long
      execute ();

    private:
      delete_statement (const delete_statement&);
      delete_statement& operator= (const delete_statement&);

    private:
      binding* param_;
      native_binding& native_param_;
    };
  }
}

#include <odb/post.hxx>

#endif // ODB_PGSQL_STATEMENT_HXX