XSQL Console Commands

When entering a command in the XSQL console, structure it as follows: odl:xsql <XSQL command>

The following table describes the commands supported in the OpenDaylight Helium release.

 

Table 3.1. Supported XSQL Console Commands

Command

Description

r

Repeats the last command you executed.

list vtables

Lists the schema node containers that are currently installed. Whenever an OpenDaylight module is installed, its YANG model is placed in the Schema Context. At that point, the XSQL receives a notification, confirms that the module’s YANG model resides in the Schema Context, and then maps the model to XSQL by setting up the necessary vtables and vfields. This command is useful when you need to determine vtable information for a query.

list vfields <vtable name>

Lists the vfields present in a specific vtable. This command is useful when you need to determine vfields information for a query.

jdbc <ip address>

When the ODL server is behind a firewall, and the JDBC client cannot connect to the JDBC server, run this command to start the client as if it was a server and establish a connection.

exit

Closes the console.

tocsv

Enables/disables the forwarding of query output as a .csv file.

filename <filename>

Specifies the .tocsv file to which query data is exported. If you do not specify a value for this option when the toccsv option is enabled, the filename for the query data file is generated automatically.



loading table of contents...