VTK  9.1.0
vtkMySQLDatabase.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkMySQLDatabase.h
5
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13
14=========================================================================*/
15/*-------------------------------------------------------------------------
16 Copyright 2008 Sandia Corporation.
17 Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
18 the U.S. Government retains certain rights in this software.
19-------------------------------------------------------------------------*/
36#ifndef vtkMySQLDatabase_h
37#define vtkMySQLDatabase_h
38
39#include "vtkIOMySQLModule.h" // For export macro
40#include "vtkSQLDatabase.h"
41
42class vtkSQLQuery;
43class vtkMySQLQuery;
44class vtkStringArray;
46
47class VTKIOMYSQL_EXPORT vtkMySQLDatabase : public vtkSQLDatabase
48{
49
50 friend class vtkMySQLQuery;
51
52public:
54 void PrintSelf(ostream& os, vtkIndent indent) override;
56
62 bool Open(const char* password = nullptr) override;
63
67 void Close() override;
68
72 bool IsOpen() override;
73
78
83
87 vtkStringArray* GetRecord(const char* table) override;
88
92 bool IsSupported(int feature) override;
93
97 bool HasError() override;
98
102 const char* GetLastErrorText() override;
103
105
108 const char* GetDatabaseType() override { return this->DatabaseType; }
110
112
115 vtkSetStringMacro(HostName);
116 vtkGetStringMacro(HostName);
118
120
123 vtkSetStringMacro(User);
124 vtkGetStringMacro(User);
126
128
131 vtkSetStringMacro(Password);
133
135
138 vtkSetStringMacro(DatabaseName);
139 vtkGetStringMacro(DatabaseName);
141
143
148 vtkSetMacro(Reconnect, int);
149 vtkGetMacro(Reconnect, int);
150 vtkBooleanMacro(Reconnect, int);
152
154
157 vtkSetClampMacro(ServerPort, int, 0, VTK_INT_MAX);
158 vtkGetMacro(ServerPort, int);
160
165
172 vtkStdString GetTablePreamble(bool b) override { return b ? vtkStdString() : "IF NOT EXISTS "; }
173
186 vtkSQLDatabaseSchema* schema, int tblHandle, int colHandle) override;
187
199 vtkSQLDatabaseSchema* schema, int tblHandle, int idxHandle, bool& skipped) override;
200
205 bool CreateDatabase(const char* dbName, bool dropExisting);
206
211 bool DropDatabase(const char* dbName);
212
218 bool ParseURL(const char* url) override;
219
220protected:
223
224private:
225 // We want this to be private, a user of this class
226 // should not be setting this for any reason
227 vtkSetStringMacro(DatabaseType);
228
229 vtkStringArray* Tables;
230 vtkStringArray* Record;
231
232 char* DatabaseType;
233 char* HostName;
234 char* User;
235 char* Password;
236 char* DatabaseName;
237 int ServerPort;
238 int Reconnect;
239
240 vtkMySQLDatabasePrivate* const Private;
241
242 vtkMySQLDatabase(const vtkMySQLDatabase&) = delete;
243 void operator=(const vtkMySQLDatabase&) = delete;
244};
245
246#endif // vtkMySQLDatabase_h
a simple class to control print indentation
Definition: vtkIndent.h:113
maintain a connection to a MySQL database
const char * GetLastErrorText() override
Get the last error text from the database.
static vtkMySQLDatabase * New()
bool IsOpen() override
Return whether the database has an open connection.
bool DropDatabase(const char *dbName)
Drop a database if it exists.
vtkStdString GetIndexSpecification(vtkSQLDatabaseSchema *schema, int tblHandle, int idxHandle, bool &skipped) override
Return the SQL string with the syntax to create an index inside a "CREATE TABLE" SQL statement.
bool CreateDatabase(const char *dbName, bool dropExisting)
Create a new database, optionally dropping any existing database of the same name.
vtkStringArray * GetRecord(const char *table) override
Get the list of fields for a particular table.
vtkStringArray * GetTables() override
Get the list of tables from the database.
bool HasError() override
Did the last operation generate an error.
const char * GetDatabaseType() override
String representing database type (e.g.
bool Open(const char *password=nullptr) override
Open a new connection to the database.
vtkStdString GetTablePreamble(bool b) override
Return the SQL string with the syntax of the preamble following a "CREATE TABLE" SQL statement.
vtkSQLQuery * GetQueryInstance() override
Return an empty query on this database.
bool IsSupported(int feature) override
Return whether a feature is supported by the database.
vtkStdString GetColumnSpecification(vtkSQLDatabaseSchema *schema, int tblHandle, int colHandle) override
Return the SQL string with the syntax to create a column inside a "CREATE TABLE" SQL statement.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void Close() override
Close the connection to the database.
bool ParseURL(const char *url) override
Overridden to determine connection parameters given the URL.
~vtkMySQLDatabase() override
vtkStdString GetURL() override
Get the URL of the database.
vtkSQLQuery implementation for MySQL databases
Definition: vtkMySQLQuery.h:48
represent an SQL database schema
maintain a connection to an sql database
executes an sql query and retrieves results
Definition: vtkSQLQuery.h:69
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:105
a vtkAbstractArray subclass for strings
#define VTK_INT_MAX
Definition: vtkType.h:155