Documentation Home
MySQL NDB Cluster API Developer Guide
Download this Manual

2.3.4.39 Dictionary::listObjects()

Description.  This method is used to obtain a list of objects in the dictionary. It is possible to get all of the objects in the dictionary, or to restrict the list to objects of a single type.

Signature.  This method has two signatures:

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

and

int listObjects
    (
      List&        list,
      Object::Type type,
      bool         fullyQualified
    ) const

Parameters.  A reference to a List object is required—this is the list that contains the dictionary's objects after listObjects() is called. (See Section 2.3.14, “The List Class”.) An optional second argument type may be used to restrict the list to only those objects of the given type—that is, of the specified Object::Type. (See Section 2.3.31.6, “Object::Type”.) If type is not given, then the list contains all of the dictionary's objects.

You can also specify whether or not the object names in the list are fully qualified (that is, whether the object name includes the database, schema, and possibly the table name). If you specify fullyQualified, then you must also specify the type.

Return value.  0 on success, -1 on failure.


User Comments
User comments in this section are, as the name implies, provided by MySQL users. The MySQL documentation team is not responsible for, nor do they endorse, any of the information provided here.
Sign Up Login You must be logged in to post a comment.