NdbDictionary::Dictionary Class Reference

#include <NdbDictionary.hpp>

List of all members.

Detailed Description

Dictionary for defining and retreiving meta data.

Public Member Functions

General

int listObjects (List &list, Object::Type type=Object::TypeUndefined)
int listObjects (List &list, Object::Type type=Object::TypeUndefined) const
NdbError & getNdbError () const

Retrieving references to Tables and Indexes

const Table * getTable (const char *name) const
const Index * getIndex (const char *indexName, const char *tableName) const
const Index * getIndex (const char *indexName, const Table &table) const
int listIndexes (List &list, const char *tableName)
int listIndexes (List &list, const char *tableName) const

Table creation

These methods should normally not be used in an application as the result will not be visible from the MySQL Server

int createTable (const Table &table)
int dropTable (Table &table)
int dropTable (const char *name)
void removeCachedTable (const char *table)
void removeCachedIndex (const char *index, const char *table)

Index creation

These methods should normally not be used in an application as the result will not be visible from the MySQL Server

int createIndex (const Index &index)
int dropIndex (const char *indexName, const char *tableName)
int dropIndex (const Index &)

Classes

class List
Structure for retrieving lists of object names. More...

Member Function Documentation

int NdbDictionary::Dictionary::listObjects	(	List &	list,
		Object::Type	type = `Object::TypeUndefined`
	)

Fetch list of all objects, optionally restricted to given type.

Parameters:

	list	List of objects returned in the dictionary
	type	Restrict returned list to only contain objects of this type

Returns:: -1 if error.

struct NdbError& NdbDictionary::Dictionary::getNdbError ( ) const [read]

Get the latest error

Returns:: Error object.

const Table* NdbDictionary::Dictionary::getTable ( const char * name ) const

Get table with given name, NULL if undefined

Parameters:

name

Name of table to get

Returns:: table if successful otherwise NULL.

const Index* NdbDictionary::Dictionary::getIndex	(	const char *	indexName,
		const char *	tableName
	)			const

Get index with given name, NULL if undefined

Parameters:

	indexName	Name of index to get.
	tableName	Name of table that index belongs to.

Returns:: index if successful, otherwise 0.

const Index* NdbDictionary::Dictionary::getIndex	(	const char *	indexName,
		const Table &	table
	)			const

Get index with given name, NULL if undefined

Parameters:

	indexName	Name of index to get.
	Table	instance table that index belongs to.

Returns:: index if successful, otherwise 0.

int NdbDictionary::Dictionary::listIndexes	(	List &	list,
		const char *	tableName
	)

Fetch list of indexes of given table.

Parameters:

	list	Reference to list where to store the listed indexes
	tableName	Name of table that index belongs to.

Returns:: 0 if successful, otherwise -1

int NdbDictionary::Dictionary::createTable ( const Table & table )

Create defined table given defined Table instance

Parameters:

Table

instance to create

Returns:: 0 if successful otherwise -1.

int NdbDictionary::Dictionary::dropTable ( Table & table )

Drop table given retrieved Table instance

Parameters:

Table

instance to drop

Returns:: 0 if successful otherwise -1.

int NdbDictionary::Dictionary::dropTable ( const char * name )

Drop table given table name

Parameters:

name

Name of table to drop

Returns:: 0 if successful otherwise -1.

void NdbDictionary::Dictionary::removeCachedTable ( const char * table )

Remove table from local cache

void NdbDictionary::Dictionary::removeCachedIndex	(	const char *	index,
		const char *	table
	)

Remove index from local cache

int NdbDictionary::Dictionary::createIndex ( const Index & index )

Create index given defined Index instance

Parameters:

index

Index to create

Returns:: 0 if successful otherwise -1.

int NdbDictionary::Dictionary::dropIndex	(	const char *	indexName,
		const char *	tableName
	)

Drop index with given name

Parameters:

	indexName	Name of index to drop.
	tableName	Name of table that index belongs to.

Returns:: 0 if successful otherwise -1.

int NdbDictionary::Dictionary::dropIndex ( const Index & )

Drop index the defined Index instance

Parameters:

Index

to drop

Returns:: 0 if successful otherwise -1.