File pl_query_cursor.hpp¶

File List > cubrid > src > sp > pl_query_cursor.hpp
/*
 * Copyright 2008 Search Solution Corporation
 * Copyright 2016 CUBRID Corporation
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */

//
// pl_query_cursor.hpp
//

#ifndef _PL_QUERY_CURSOR_HPP_
#define _PL_QUERY_CURSOR_HPP_

#ident "$Id$"

#include <vector>

#include "dbtype_def.h"
#include "query_list.h" /* QUERY_ID, QFILE_LIST_ID */
#include "query_manager.h" /* QMGR_QUERY_ENTRY */

// thread_entry.hpp
namespace cubthread
{
  class entry;
}

namespace cubpl
{
  class query_cursor
  {
    public:
      query_cursor (cubthread::entry *thread_p, QUERY_ID qid, bool is_oid_included = false);
      ~query_cursor ();

      int open ();
      void close ();

      bool is_opened () const;

      int reset ();

      void change_owner (cubthread::entry *thread_p);

      int first ();
      int last ();

      SCAN_CODE cursor (int peek);

      SCAN_CODE next_row ();

      void clear ();

      QUERY_ID get_query_id ();
      int get_current_index ();
      std::vector<DB_VALUE> get_current_tuple ();
      OID *get_current_oid ();
      int get_tuple_value (int index, DB_VALUE &result);
      bool get_is_oid_included ();
      bool get_is_opened ();
      int get_fetch_count ();
      void set_fetch_count (int cnt);

      cubthread::entry *get_owner () const;

    private:
      cubthread::entry *m_thread; /* which thread owns this cursor */

      QUERY_ID m_query_id;      /* Query id for this cursor */
      QMGR_QUERY_ENTRY *m_query_entry; /* Query entry for this cursor */
      QFILE_LIST_SCAN_ID m_scan_id; /* scan on list_id */

      std::vector<DB_VALUE> m_current_tuple;
      int m_current_row_index;

      // bool is_updatable;     /* Cursor updatable ? */
      bool m_is_oid_included;       /* Cursor has first hidden oid col. */
      bool m_is_opened;

      int m_fetch_count; /* # of rows to fetch */

      unsigned int m_query_entry_no;
  };
}       // namespace cubmethod

using PL_QUERY_CURSOR = cubpl::query_cursor;

#endif              /* _PL_QUERY_CURSOR_HPP_ */