maintain a connection to an SQLite database More...

#include <vtkSQLiteDatabase.h>

Inheritance diagram for vtkSQLiteDatabase:

Collaboration diagram for vtkSQLiteDatabase:

Public Types
enum	{ USE_EXISTING , USE_EXISTING_OR_CREATE , CREATE_OR_CLEAR , CREATE }

typedef vtkSQLDatabase	Superclass

Public Types inherited from vtkSQLDatabase
typedef vtkObject	Superclass

typedef vtkSQLDatabase (	CreateFunction) (const char *URL)
	Type for CreateFromURL callback.

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkSQLiteDatabase *	NewInstance () const

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	IsOpen () override
	Return whether the database has an open connection.

vtkSQLQuery *	GetQueryInstance () override
	Return an empty query on this database.

vtkStringArray *	GetTables () override
	Get the list of tables from the database.

vtkStringArray *	GetRecord (const char *table) override
	Get the list of fields for a particular table.

bool	IsSupported (int feature) override
	Return whether a feature is supported by the database.

bool	HasError () override
	Did the last operation generate an error.

const char *	GetLastErrorText () override
	Get the last error text from the database.

vtkStdString	GetURL () override
	Get the URL of 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.


bool	Open (const char *password) override
	Open a new connection to the database.

bool	Open (const char *password, int mode)
	Open a new connection to the database.


const char *	GetDatabaseType () override
	String representing database type (e.g.


	vtkGetFilePathMacro (DatabaseFileName)
	String representing the database filename.

	vtkSetFilePathMacro (DatabaseFileName)
	String representing the database filename.

Public Member Functions inherited from vtkSQLDatabase
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkSQLDatabase *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual bool	Open (const char *password)=0
	Open a new connection to the database.

virtual void	Close ()=0
	Close the connection to the database.

virtual bool	IsOpen ()=0
	Return whether the database has an open connection.

virtual vtkSQLQuery *	GetQueryInstance ()=0
	Return an empty query on this database.

virtual bool	HasError ()=0
	Did the last operation generate an error.

virtual const char *	GetLastErrorText ()=0
	Get the last error text from the database I'm using const so that people do NOT use the standard vtkGetStringMacro in their implementation, because 99% of the time that will not be the correct thing to do...

virtual const char *	GetDatabaseType ()=0
	Get the type of the database (e.g.

virtual vtkStringArray *	GetTables ()=0
	Get the list of tables from the database.

virtual vtkStringArray *	GetRecord (const char *table)=0
	Get the list of fields for a particular table.

virtual bool	IsSupported (int vtkNotUsed(feature))
	Return whether a feature is supported by the database.

virtual vtkStdString	GetURL ()=0
	Get the URL of the database.

virtual vtkStdString	GetTablePreamble (bool)
	Return the SQL string with the syntax of the preamble following a "CREATE TABLE" SQL statement.

virtual vtkStdString	GetColumnSpecification (vtkSQLDatabaseSchema *schema, int tblHandle, int colHandle)
	Return the SQL string with the syntax to create a column inside a "CREATE TABLE" SQL statement.

virtual vtkStdString	GetIndexSpecification (vtkSQLDatabaseSchema *schema, int tblHandle, int idxHandle, bool &skipped)
	Return the SQL string with the syntax to create an index inside a "CREATE TABLE" SQL statement.

virtual vtkStdString	GetTriggerSpecification (vtkSQLDatabaseSchema *schema, int tblHandle, int trgHandle)
	Return the SQL string with the syntax to create a trigger using a "CREATE TRIGGER" SQL statement.

virtual bool	EffectSchema (vtkSQLDatabaseSchema *, bool dropIfExists=false)
	Effect a database schema.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkSQLiteDatabase *	SafeDownCast (vtkObjectBase *o)

static vtkSQLiteDatabase *	New ()

Static Public Member Functions inherited from vtkSQLDatabase
static vtkTypeBool	IsTypeOf (const char *type)

static vtkSQLDatabase *	SafeDownCast (vtkObjectBase *o)

static vtkSQLDatabase *	CreateFromURL (const char *URL)
	Create a the proper subclass given a URL.

static vtkInformationObjectBaseKey *	DATABASE ()
	Stores the database class pointer as an information key.

static void	RegisterCreateFromURLCallback (CreateFunction callback)
	Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkSQLDatabase to handle different protocols.

static void	UnRegisterCreateFromURLCallback (CreateFunction callback)
	Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkSQLDatabase to handle different protocols.

static void	UnRegisterAllCreateFromURLCallbacks ()
	Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkSQLDatabase to handle different protocols.

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkSQLiteDatabase ()

	~vtkSQLiteDatabase () override

bool	ParseURL (const char *url) override
	Overridden to determine connection parameters given the URL.

Protected Member Functions inherited from vtkSQLDatabase
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkSQLDatabase ()

	~vtkSQLDatabase () override

virtual bool	ParseURL (const char *url)=0
	Subclasses should override this method to determine connection parameters given the URL.

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Friends
class	vtkSQLiteQuery

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

maintain a connection to an SQLite database

SQLite (http://www.sqlite.org) is a public-domain SQL database written in C++. It's small, fast, and can be easily embedded inside other applications. Its databases are stored in files.

This class provides a VTK interface to SQLite. You do not need to download any external libraries: we include a copy of SQLite 3.3.16 in VTK/Utilities/vtksqlite.

If you want to open a database that stays in memory and never gets written to disk, pass in the URL sqlite://:memory:; otherwise, specify the file path by passing the URL sqlite://<file_path>.

Thanks:: Thanks to Andrew Wilson and Philippe Pebay from Sandia National Laboratories for implementing this class.

See also: vtkSQLiteQuery

Examples:: vtkSQLiteDatabase (Examples)

Tests:: vtkSQLiteDatabase (Tests)

Definition at line 48 of file vtkSQLiteDatabase.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSQLDatabase vtkSQLiteDatabase::Superclass

Definition at line 54 of file vtkSQLiteDatabase.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
USE_EXISTING
USE_EXISTING_OR_CREATE
CREATE_OR_CLEAR
CREATE

Definition at line 58 of file vtkSQLiteDatabase.h.

Constructor & Destructor Documentation

◆ vtkSQLiteDatabase()

vtkSQLiteDatabase::vtkSQLiteDatabase ( )

protected

◆ ~vtkSQLiteDatabase()

vtkSQLiteDatabase::~vtkSQLiteDatabase ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkSQLiteDatabase::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkSQLiteDatabase::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.

◆ SafeDownCast()

static vtkSQLiteDatabase * vtkSQLiteDatabase::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkSQLiteDatabase::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkSQLDatabase.

◆ NewInstance()

vtkSQLiteDatabase * vtkSQLiteDatabase::NewInstance ( ) const

◆ PrintSelf()

void vtkSQLiteDatabase::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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.

◆ New()

static vtkSQLiteDatabase * vtkSQLiteDatabase::New ( )

static

◆ Open() [1/2]

bool vtkSQLiteDatabase::Open ( const char * password )

overridevirtual

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.

USE_EXISTING (default) - Fail if the file does not exist.
USE_EXISTING_OR_CREATE - Create a new file if necessary.
CREATE_OR_CLEAR - Create new or clear existing file.
CREATE - Create new, fail if file exists.

Implements vtkSQLDatabase.

◆ Open() [2/2]

bool vtkSQLiteDatabase::Open	(	const char *	password,
		int	mode
	)

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.

USE_EXISTING (default) - Fail if the file does not exist.
USE_EXISTING_OR_CREATE - Create a new file if necessary.
CREATE_OR_CLEAR - Create new or clear existing file.
CREATE - Create new, fail if file exists.

◆ Close()

void vtkSQLiteDatabase::Close ( )

overridevirtual

Close the connection to the database.

Implements vtkSQLDatabase.

◆ IsOpen()

bool vtkSQLiteDatabase::IsOpen ( )

overridevirtual

Return whether the database has an open connection.

Implements vtkSQLDatabase.

◆ GetQueryInstance()

vtkSQLQuery * vtkSQLiteDatabase::GetQueryInstance ( )

overridevirtual

Return an empty query on this database.

Implements vtkSQLDatabase.

◆ GetTables()

vtkStringArray * vtkSQLiteDatabase::GetTables ( )

overridevirtual

Get the list of tables from the database.

Implements vtkSQLDatabase.

◆ GetRecord()

vtkStringArray * vtkSQLiteDatabase::GetRecord ( const char * table )

overridevirtual

Get the list of fields for a particular table.

Implements vtkSQLDatabase.

◆ IsSupported()

bool vtkSQLiteDatabase::IsSupported ( int feature )

override

Return whether a feature is supported by the database.

◆ HasError()

bool vtkSQLiteDatabase::HasError ( )

overridevirtual

Did the last operation generate an error.

Implements vtkSQLDatabase.

◆ GetLastErrorText()

const char * vtkSQLiteDatabase::GetLastErrorText ( )

overridevirtual

Get the last error text from the database.

Implements vtkSQLDatabase.

◆ GetDatabaseType()

const char * vtkSQLiteDatabase::GetDatabaseType ( )

inlineoverridevirtual

String representing database type (e.g.

"sqlite").

Implements vtkSQLDatabase.

Definition at line 124 of file vtkSQLiteDatabase.h.

◆ vtkGetFilePathMacro()

vtkSQLiteDatabase::vtkGetFilePathMacro ( DatabaseFileName )

String representing the database filename.

◆ vtkSetFilePathMacro()

vtkSQLiteDatabase::vtkSetFilePathMacro ( DatabaseFileName )

String representing the database filename.

◆ GetURL()

vtkStdString vtkSQLiteDatabase::GetURL ( )

overridevirtual

Get the URL of the database.

Implements vtkSQLDatabase.

◆ GetColumnSpecification()

vtkStdString vtkSQLiteDatabase::GetColumnSpecification	(	vtkSQLDatabaseSchema *	schema,
		int	tblHandle,
		int	colHandle
	)

overridevirtual

Return the SQL string with the syntax to create a column inside a "CREATE TABLE" SQL statement.

NB: this method implements the SQLite-specific syntax:

Reimplemented from vtkSQLDatabase.

◆ ParseURL()

bool vtkSQLiteDatabase::ParseURL ( const char * url )

overrideprotectedvirtual

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 Symbol Documentation

◆ vtkSQLiteQuery

friend class vtkSQLiteQuery

friend

Definition at line 51 of file vtkSQLiteDatabase.h.

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

IO/SQL/vtkSQLiteDatabase.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkSQLiteDatabase()

◆ ~vtkSQLiteDatabase()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ Open() [1/2]

◆ Open() [2/2]

◆ Close()

◆ IsOpen()

◆ GetQueryInstance()

◆ GetTables()

◆ GetRecord()

◆ IsSupported()

◆ HasError()

◆ GetLastErrorText()

◆ GetDatabaseType()

◆ vtkGetFilePathMacro()

◆ vtkSetFilePathMacro()

◆ GetURL()

◆ GetColumnSpecification()

◆ ParseURL()

Friends And Related Symbol Documentation

◆ vtkSQLiteQuery