vtkSQLQuery.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
 
#ifndef vtkSQLQuery_h
#define vtkSQLQuery_h
 
#include "vtkIOSQLModule.h" // For export macro
#include "vtkRowQuery.h"
#include "vtkStdString.h" // for EscapeString()
#include "vtkVariant.h"   // For vtkVariant
 
VTK_ABI_NAMESPACE_BEGIN
class vtkSQLDatabase;
class vtkVariant;
class vtkVariantArray;
 
class VTKIOSQL_EXPORT vtkSQLQuery : public vtkRowQuery
{
public:
  vtkTypeMacro(vtkSQLQuery, vtkRowQuery);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  virtual bool SetQuery(const char* query);
  virtual const char* GetQuery();

  bool IsActive() override { return this->Active; }

  bool Execute() override = 0;

  virtual bool BeginTransaction() { return true; }
  virtual bool CommitTransaction() { return true; }
  virtual bool RollbackTransaction() { return true; }


  vtkGetObjectMacro(Database, vtkSQLDatabase);

 
  virtual bool BindParameter(int index, unsigned char value);
  virtual bool BindParameter(int index, unsigned short value);
  virtual bool BindParameter(int index, unsigned int value);
  virtual bool BindParameter(int index, unsigned long value);
  // The C and C++ standards leave it up to each compiler to decide
  // whether chars are signed or unsigned by default.  All the other
  // types are signed unless otherwise specified.
  virtual bool BindParameter(int index, signed char value);
  virtual bool BindParameter(int index, short value);
 
  virtual bool BindParameter(int index, int value);
 
  virtual bool BindParameter(int index, long value);
  virtual bool BindParameter(int index, unsigned long long value);
  virtual bool BindParameter(int index, long long value);
 
  virtual bool BindParameter(int index, float value);
  virtual bool BindParameter(int index, double value);
  virtual bool BindParameter(int index, const char* stringValue);
  virtual bool BindParameter(int index, const char* stringValue, size_t length);
 
  virtual bool BindParameter(int index, const vtkStdString& string);
 
  virtual bool BindParameter(int index, vtkVariant var);
  virtual bool BindParameter(int index, const void* data, size_t length);
  virtual bool ClearParameterBindings();

  virtual vtkStdString EscapeString(vtkStdString s, bool addSurroundingQuotes = true);

  char* EscapeString(const char* src, bool addSurroundingQuotes);
 
protected:
  vtkSQLQuery();
  ~vtkSQLQuery() override;

  void SetDatabase(vtkSQLDatabase* db);
 
  char* Query;
  vtkSQLDatabase* Database;
  bool Active;
 
private:
  vtkSQLQuery(const vtkSQLQuery&) = delete;
  void operator=(const vtkSQLQuery&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif // vtkSQLQuery_h