vtkSQLDatabase.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 vtkSQLDatabase_h
#define vtkSQLDatabase_h
 
#include "vtkIOSQLModule.h" // For export macro
#include "vtkObject.h"
 
#include "vtkStdString.h" // Because at least one method returns a vtkStdString
 
VTK_ABI_NAMESPACE_BEGIN
class vtkInformationObjectBaseKey;
class vtkSQLDatabaseSchema;
class vtkSQLQuery;
class vtkStringArray;
 
// This is a list of features that each database may or may not
// support.  As yet (April 2008) we don't provide access to most of
// them.
#define VTK_SQL_FEATURE_TRANSACTIONS 1000
#define VTK_SQL_FEATURE_QUERY_SIZE 1001
#define VTK_SQL_FEATURE_BLOB 1002
#define VTK_SQL_FEATURE_UNICODE 1003
#define VTK_SQL_FEATURE_PREPARED_QUERIES 1004
#define VTK_SQL_FEATURE_NAMED_PLACEHOLDERS 1005
#define VTK_SQL_FEATURE_POSITIONAL_PLACEHOLDERS 1006
#define VTK_SQL_FEATURE_LAST_INSERT_ID 1007
#define VTK_SQL_FEATURE_BATCH_OPERATIONS 1008
#define VTK_SQL_FEATURE_TRIGGERS 1009 // supported
 
// Default size for columns types which require a size to be specified
// (i.e., VARCHAR), when no size has been specified
#define VTK_SQL_DEFAULT_COLUMN_SIZE 32
 
class VTKIOSQL_EXPORT vtkSQLDatabase : public vtkObject
{
public:
  vtkTypeMacro(vtkSQLDatabase, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  virtual bool Open(const char* password) = 0;
 
  virtual void Close() = 0;
 
  virtual bool IsOpen() = 0;
 
  virtual VTK_NEWINSTANCE vtkSQLQuery* GetQueryInstance() = 0;
 
  virtual bool HasError() = 0;
 
  virtual const char* GetLastErrorText() = 0;
 
  virtual const char* GetDatabaseType() = 0;
 
  virtual vtkStringArray* GetTables() = 0;
 
  virtual vtkStringArray* GetRecord(const char* table) = 0;
 
  virtual bool IsSupported(int vtkNotUsed(feature)) { return false; }
 
  virtual vtkStdString GetURL() = 0;
 
  virtual vtkStdString GetTablePreamble(bool) { return vtkStdString(); }
 
  virtual vtkStdString GetColumnSpecification(
    vtkSQLDatabaseSchema* schema, int tblHandle, int colHandle);
 
  virtual vtkStdString GetIndexSpecification(
    vtkSQLDatabaseSchema* schema, int tblHandle, int idxHandle, bool& skipped);
 
  virtual vtkStdString GetTriggerSpecification(
    vtkSQLDatabaseSchema* schema, int tblHandle, int trgHandle);
 
  static VTK_NEWINSTANCE vtkSQLDatabase* CreateFromURL(const char* URL);
 
  virtual bool EffectSchema(vtkSQLDatabaseSchema*, bool dropIfExists = false);
 
  typedef vtkSQLDatabase* (*CreateFunction)(const char* URL);
 
 
  static void RegisterCreateFromURLCallback(CreateFunction callback);
  static void UnRegisterCreateFromURLCallback(CreateFunction callback);
  static void UnRegisterAllCreateFromURLCallbacks();
 
  static vtkInformationObjectBaseKey* DATABASE();
 
protected:
  vtkSQLDatabase();
  ~vtkSQLDatabase() override;
 
  virtual bool ParseURL(const char* url) = 0;
 
private:
  vtkSQLDatabase(const vtkSQLDatabase&) = delete;
  void operator=(const vtkSQLDatabase&) = delete;
 
 
  class vtkCallbackVector;
  static vtkCallbackVector* Callbacks;
};
 
VTK_ABI_NAMESPACE_END
#endif // vtkSQLDatabase_h