MySQL Shell API  8.0.17
Unified development interface for MySQL Products
Modules | Classes | Functions
ShellAPI

Modules

 mysql
 Encloses the functions and classes available to interact with a MySQL Server using the traditional MySQL Protocol.
 
 util
 Global object that groups miscellaneous tools like upgrade checker and JSON import.
 

Classes

class  ClassicResult
 Allows browsing through the result information after performing an operation on the database through the MySQL Protocol. More...
 
class  ClassicSession
 Enables interaction with a MySQL Server using the MySQL Protocol. More...
 
class  Shell
 Gives access to general purpose functions and properties. More...
 
class  Options
 
class  Reports
 Gives access to built-in and user-defined reports. More...
 
class  Sys
 Gives access to system specific parameters. More...
 
class  DatabaseObject
 Provides base functionality for database objects. More...
 
class  Column
 Represents the a Column definition on a result. More...
 
class  Row
 Represents the a Row in a Result. More...
 

Functions

Array dir (Object object)
 SHELLAPI_DIR_BRIEF More...
 

Detailed Description

Shell API and backward compatibility API for MySQL Servers not supporting the X DevAPI.

Function Documentation

◆ dir()

Array dir ( Object  object)

SHELLAPI_DIR_BRIEF

Parameters
objectThe object whose properties will be listed.
Returns
The list of enumerable properties on the object.

Traverses the object retrieving its enumerable properties. The content of the returned list will depend on the object:

  • For a dictionary, returns the list of keys.
  • For an API object, returns the list of members.

Behavior of the function passing other types of objects is undefined and also unsupported.