vtkMySQLDatabase.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 vtkMySQLDatabase_h
#define vtkMySQLDatabase_h
 
#include "vtkIOMySQLModule.h" // For export macro
#include "vtkSQLDatabase.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkSQLQuery;
class vtkMySQLQuery;
class vtkStringArray;
class vtkMySQLDatabasePrivate;
 
class VTKIOMYSQL_EXPORT vtkMySQLDatabase : public vtkSQLDatabase
{
 
  friend class vtkMySQLQuery;
 
public:
  vtkTypeMacro(vtkMySQLDatabase, vtkSQLDatabase);
  void PrintSelf(ostream& os, vtkIndent indent) override;
  static vtkMySQLDatabase* New();
 
  bool Open(const char* password = nullptr) override;
 
  void Close() override;
 
  bool IsOpen() override;
 
  vtkSQLQuery* GetQueryInstance() override;
 
  vtkStringArray* GetTables() override;
 
  vtkStringArray* GetRecord(const char* table) override;
 
  bool IsSupported(int feature) override;
 
  bool HasError() override;
 
  const char* GetLastErrorText() override;
 
 
  const char* GetDatabaseType() override { return this->DatabaseType; }
 
 
  vtkSetStringMacro(HostName);
  vtkGetStringMacro(HostName);
 
 
  vtkSetStringMacro(User);
  vtkGetStringMacro(User);
 
 
  vtkSetStringMacro(Password);
 
 
  vtkSetStringMacro(DatabaseName);
  vtkGetStringMacro(DatabaseName);
 
 
  vtkSetMacro(Reconnect, int);
  vtkGetMacro(Reconnect, int);
  vtkBooleanMacro(Reconnect, int);
 
 
  vtkSetClampMacro(ServerPort, int, 0, VTK_INT_MAX);
  vtkGetMacro(ServerPort, int);
 
  vtkStdString GetURL() override;
 
  vtkStdString GetTablePreamble(bool b) override { return b ? vtkStdString() : "IF NOT EXISTS "; }
 
  vtkStdString GetColumnSpecification(
    vtkSQLDatabaseSchema* schema, int tblHandle, int colHandle) override;
 
  vtkStdString GetIndexSpecification(
    vtkSQLDatabaseSchema* schema, int tblHandle, int idxHandle, bool& skipped) override;
 
  bool CreateDatabase(const char* dbName, bool dropExisting);
 
  bool DropDatabase(const char* dbName);
 
  bool ParseURL(const char* url) override;
 
protected:
  vtkMySQLDatabase();
  ~vtkMySQLDatabase() override;
 
private:
  // We want this to be private, a user of this class
  // should not be setting this for any reason
  vtkSetStringMacro(DatabaseType);
 
  vtkStringArray* Tables;
  vtkStringArray* Record;
 
  char* DatabaseType;
  char* HostName;
  char* User;
  char* Password;
  char* DatabaseName;
  int ServerPort;
  int Reconnect;
 
  vtkMySQLDatabasePrivate* const Private;
 
  vtkMySQLDatabase(const vtkMySQLDatabase&) = delete;
  void operator=(const vtkMySQLDatabase&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif // vtkMySQLDatabase_h