vtkMySQLDatabase.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkMySQLDatabase.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
/*-------------------------------------------------------------------------
  Copyright 2008 Sandia Corporation.
  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
  the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------*/
#ifndef vtkMySQLDatabase_h
#define vtkMySQLDatabase_h
 
#include "vtkIOMySQLModule.h" // For export macro
#include "vtkSQLDatabase.h"
 
class vtkSQLQuery;
class vtkMySQLQuery;
class vtkStringArray;
class vtkMySQLDatabasePrivate;
 
class VTKIOMYSQL_EXPORT vtkMySQLDatabase : public vtkSQLDatabase
{
//BTX
  friend class vtkMySQLQuery;
//ETX
 
public:
  vtkTypeMacro(vtkMySQLDatabase, vtkSQLDatabase);
  void PrintSelf(ostream& os, vtkIndent indent);
  static vtkMySQLDatabase *New();
 
  bool Open( const char* password = 0 );
 
  void Close();
 
  bool IsOpen();
 
  vtkSQLQuery* GetQueryInstance();
 
  vtkStringArray* GetTables();
 
  vtkStringArray* GetRecord(const char *table);
 
  bool IsSupported(int feature);
 
  bool HasError();
 
  const char* GetLastErrorText();
 
 
  vtkGetStringMacro(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);
 
  virtual vtkStdString GetURL();
 
  virtual vtkStdString GetTablePreamble( bool b ) { return b ? vtkStdString() :"IF NOT EXISTS "; }
 
 
  virtual vtkStdString GetColumnSpecification( vtkSQLDatabaseSchema* schema,
                                               int tblHandle,
                                               int colHandle );
 
 
  virtual vtkStdString GetIndexSpecification( vtkSQLDatabaseSchema* schema,
                                              int tblHandle,
                                              int idxHandle,
                                              bool& skipped );
 
  bool CreateDatabase( const char* dbName, bool dropExisting );
 
  bool DropDatabase( const char* dbName );
 
  virtual bool ParseURL(const char* url);
 
protected:
  vtkMySQLDatabase();
  ~vtkMySQLDatabase();
 
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;
 
//BTX
  vtkMySQLDatabasePrivate* const Private;
//ETX
 
  vtkMySQLDatabase(const vtkMySQLDatabase &); // Not implemented.
  void operator=(const vtkMySQLDatabase &); // Not implemented.
};
 
#endif // vtkMySQLDatabase_h