Console Plugin

console is a protocol plugin that instead of providing access to Drizzle through a network port or UNIX socket provides a direct interactive text console via stdin and stdout. It allows you to use Drizzle in a similar way that the sqlite command line client allows you to use sqlite.

Loading

To load this plugin, start drizzled with:

--plugin-add=console

See also

Plugin Options for more information about adding and removing plugins.

Configuration

--console.enable
Default:false

Enables the console.

--consoe.debug
Default:false

Turns on extra debugging output

--console.username ARG
Default:current logged in user

The username to authenticate to Drizle as. This option works the same way as connecting as a username over other protocols.

--console.password ARG

The password to use to authenticate with.

--console.catalog ARG
Default:LOCAL

Which catalog to connect to. In current released versions of Drizzle, only the LOCAL catalog is supported, althoug in the future other catalogs will be usable.

--console.schema ARG

Which schema to connect to.

Variables

This plugin does not register any variables.

Examples

To use the Drizzle console, start Drizzle like:

$ sbin/drizzled --plugin-add=console --console.enable

You can now interact with Drizzle in pretty much the same way you can as through the command line client.

You probably never want to enable the console plugin in the configuration file.

Limitations

There is currently no way to change your authentication credentials once you’ve launched Drizzle with the console plugin.

Authors

Code:Eric Day
Documentation:Stewart Smith

Version

This documentation applies to console 0.2.

To see which version of the plugin a Drizzle server is running, execute:

SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='console'

Changelog

v0.1

  • First release.

v0.2

  • Support connecting to a CATALOG
  • Rename db parameter to schema

Table Of Contents

Previous topic

CONNECTION_ID Function

Next topic

CRC32 Function

This Page