vtkMySQLDatabase Class Reference

maintain a connection to a MySQL database More...

#include <vtkMySQLDatabase.h>

Inheritance diagram for vtkMySQLDatabase:

Collaboration diagram for vtkMySQLDatabase:

List of all members.

Public Types
typedef vtkSQLDatabase	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkMySQLDatabase *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
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 ()
virtual vtkStdString	GetURL ()
virtual vtkStdString	GetTablePreamble (bool b)
bool	CreateDatabase (const char *dbName, bool dropExisting)
bool	DropDatabase (const char *dbName)
virtual bool	ParseURL (const char *url)
virtual char *	GetDatabaseType ()
virtual void	SetHostName (const char *)
virtual char *	GetHostName ()
virtual void	SetUser (const char *)
virtual char *	GetUser ()
virtual void	SetPassword (const char *)
virtual void	SetDatabaseName (const char *)
virtual char *	GetDatabaseName ()
virtual void	SetReconnect (int)
virtual int	GetReconnect ()
virtual void	ReconnectOn ()
virtual void	ReconnectOff ()
virtual void	SetServerPort (int)
virtual int	GetServerPort ()
virtual vtkStdString	GetColumnSpecification (vtkSQLDatabaseSchema *schema, int tblHandle, int colHandle)
virtual vtkStdString	GetIndexSpecification (vtkSQLDatabaseSchema *schema, int tblHandle, int idxHandle, bool &skipped)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkMySQLDatabase *	SafeDownCast (vtkObjectBase *o)
static vtkMySQLDatabase *	New ()
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkMySQLDatabase ()
	~vtkMySQLDatabase ()
Friends
class	vtkMySQLQuery

---

Detailed Description

maintain a connection to a MySQL database

This class provides a VTK interface to MySQL (http://www.mysql.com). Unlike file-based databases like SQLite, you talk to MySQL through a client/server connection. You must specify the hostname, (optional) port to connect to, username, password and database name in order to connect.

See also:

vtkMySQLQuery

Tests:

vtkMySQLDatabase (Tests)

Definition at line 49 of file vtkMySQLDatabase.h.

---

Member Typedef Documentation

typedef vtkSQLDatabase vtkMySQLDatabase::Superclass

Reimplemented from vtkSQLDatabase.

Definition at line 56 of file vtkMySQLDatabase.h.

---

Constructor & Destructor Documentation

vtkMySQLDatabase::vtkMySQLDatabase

(

)

[protected]

vtkMySQLDatabase::~vtkMySQLDatabase

(

)

[protected]

---

Member Function Documentation

static int vtkMySQLDatabase::IsTypeOf

(

const char *

name

)

[static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkSQLDatabase.

virtual int vtkMySQLDatabase::IsA

(

const char *

name

)

[virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkSQLDatabase.

static vtkMySQLDatabase* vtkMySQLDatabase::SafeDownCast

(

vtkObjectBase *

o

)

[static]

Reimplemented from vtkSQLDatabase.

virtual vtkObjectBase* vtkMySQLDatabase::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkSQLDatabase.

vtkMySQLDatabase* vtkMySQLDatabase::NewInstance

(

)

const

Reimplemented from vtkSQLDatabase.

void vtkMySQLDatabase::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		[virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkSQLDatabase.

static vtkMySQLDatabase* vtkMySQLDatabase::New

(

)

[static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

bool vtkMySQLDatabase::Open

(

const char *

password = 0

)

[virtual]

Open a new connection to the database. You need to set the filename before calling this function. Returns true if the database was opened successfully; false otherwise.

Implements vtkSQLDatabase.

void vtkMySQLDatabase::Close

(

)

[virtual]

Close the connection to the database.

Implements vtkSQLDatabase.

bool vtkMySQLDatabase::IsOpen

(

)

[virtual]

Return whether the database has an open connection

Implements vtkSQLDatabase.

vtkSQLQuery* vtkMySQLDatabase::GetQueryInstance

(

)

[virtual]

Return an empty query on this database.

Implements vtkSQLDatabase.

vtkStringArray* vtkMySQLDatabase::GetTables

(

)

[virtual]

Get the list of tables from the database

Implements vtkSQLDatabase.

vtkStringArray* vtkMySQLDatabase::GetRecord

(

const char *

table

)

[virtual]

Get the list of fields for a particular table

Implements vtkSQLDatabase.

bool vtkMySQLDatabase::IsSupported

(

int

feature

)

Return whether a feature is supported by the database.

bool vtkMySQLDatabase::HasError

(

)

[virtual]

Did the last operation generate an error

Implements vtkSQLDatabase.

const char* vtkMySQLDatabase::GetLastErrorText

(

)

[virtual]

Get the last error text from the database

Implements vtkSQLDatabase.

virtual char* vtkMySQLDatabase::GetDatabaseType

(

)

[virtual]

String representing database type (e.g. "mysql").

Implements vtkSQLDatabase.

virtual void vtkMySQLDatabase::SetHostName

(

const char *

)

[virtual]

The database server host name.

virtual char* vtkMySQLDatabase::GetHostName

(

)

[virtual]

The database server host name.

virtual void vtkMySQLDatabase::SetUser

(

const char *

)

[virtual]

The user name for connecting to the database server.

virtual char* vtkMySQLDatabase::GetUser

(

)

[virtual]

The user name for connecting to the database server.

virtual void vtkMySQLDatabase::SetPassword

(

const char *

)

[virtual]

The user's password for connecting to the database server.

virtual void vtkMySQLDatabase::SetDatabaseName

(

const char *

)

[virtual]

The name of the database to connect to.

virtual char* vtkMySQLDatabase::GetDatabaseName

(

)

[virtual]

The name of the database to connect to.

virtual void vtkMySQLDatabase::SetReconnect

(

int

)

[virtual]

Should automatic reconnection be enabled? This defaults to true. If you change its value, you must do so before any call to Open().

virtual int vtkMySQLDatabase::GetReconnect

(

)

[virtual]

Should automatic reconnection be enabled? This defaults to true. If you change its value, you must do so before any call to Open().

virtual void vtkMySQLDatabase::ReconnectOn

(

)

[virtual]

Should automatic reconnection be enabled? This defaults to true. If you change its value, you must do so before any call to Open().

virtual void vtkMySQLDatabase::ReconnectOff

(

)

[virtual]

Should automatic reconnection be enabled? This defaults to true. If you change its value, you must do so before any call to Open().

virtual void vtkMySQLDatabase::SetServerPort

(

int

)

[virtual]

The port used for connecting to the database.

virtual int vtkMySQLDatabase::GetServerPort

(

)

[virtual]

The port used for connecting to the database.

virtual vtkStdString vtkMySQLDatabase::GetURL

(

)

[virtual]

Get the URL of the database.

Implements vtkSQLDatabase.

virtual vtkStdString vtkMySQLDatabase::GetTablePreamble

(

bool

b

)

[inline, virtual]

Return the SQL string with the syntax of the preamble following a "CREATE TABLE" SQL statement. NB: this method implements the MySQL-specific IF NOT EXISTS syntax, used when b = false.

Reimplemented from vtkSQLDatabase.

Definition at line 137 of file vtkMySQLDatabase.h.

virtual vtkStdString vtkMySQLDatabase::GetColumnSpecification	(	vtkSQLDatabaseSchema *	schema,
		int	tblHandle,
		int	colHandle
	)		[virtual]

Return the SQL string with the syntax to create a column inside a "CREATE TABLE" SQL statement. NB1: this method implements the MySQL-specific syntax:

`<column name>` <column type>
      <column attributes> 

NB2: if a column has type SERIAL in the schema, this will be turned into INT NOT NULL AUTO_INCREMENT. Therefore, one should not pass NOT NULL as an attribute of a column whose type is SERIAL.

Reimplemented from vtkSQLDatabase.

virtual vtkStdString vtkMySQLDatabase::GetIndexSpecification	(	vtkSQLDatabaseSchema *	schema,
		int	tblHandle,
		int	idxHandle,
		bool &	skipped
	)		[virtual]

Return the SQL string with the syntax to create an index inside a "CREATE TABLE" SQL statement. NB1: this method implements the MySQL-specific syntax:

<index type> [<index name>] 
      (`<column name 1>`,... ) 

NB2: since MySQL supports INDEX creation within a CREATE TABLE statement, skipped is always returned false.

Reimplemented from vtkSQLDatabase.

bool vtkMySQLDatabase::CreateDatabase	(	const char *	dbName,
		bool	dropExisting
	)

Create a new database, optionally dropping any existing database of the same name. Returns true when the database is properly created and false on failure.

bool vtkMySQLDatabase::DropDatabase

(

const char *

dbName

)

Drop a database if it exists. Returns true on success and false on failure.

virtual bool vtkMySQLDatabase::ParseURL

(

const char *

url

)

[virtual]

Overridden to determine connection parameters given the URL. This is called by CreateFromURL() to initialize the instance. Look at CreateFromURL() for details about the URL format.

Implements vtkSQLDatabase.

---

Friends And Related Function Documentation

friend class vtkMySQLQuery [friend]

Definition at line 52 of file vtkMySQLDatabase.h.

---

The documentation for this class was generated from the following file:

• dox/IO/MySQL/vtkMySQLDatabase.h