MySQL Workbench Manual  /  Configuration  /  MySQL Workbench Settings and Log Files

3.3 MySQL Workbench Settings and Log Files

MySQL Workbench saves configuration, cache, and log related files and directories on your system. These files are saved in your user's MySQL Workbench directory as defined by MySQL Workbench, with this base defaulting to:

Table 3.1 Default Local Configuration Base File Path

Operating System File Path
Windows %AppData%\MySQL\Workbench\
OS X ~username/Library/Application Support/MySQL/Workbench/
Linux ~username/.mysql/workbench/

A brief description of these directories and files:

Table 3.2 Local Workbench Files and Directory Descriptions

Directory or File Description
cache/ General behaviors are stored per-connection in *.cache files, and column widths as *.column_widths files
log/ Log files include Workbench startup information, and also per-connection SQL action results performed in Workbench
modules/ Home of installed plugins, for additional information see Section C.3, “Plugins and Tools”
sql_history/ Queries executed in Workbench are stored here, and are available from within MySQL Workbench
snippets/ Saved SQL snippets are stored here, for additional information see Section 8.1.5, “SQL Snippets Tab”
audit_cache/ Cache storage by the Audit Log inspector, for additional information see Section 6.6, “MySQL Audit Inspector Interface”
connections.xml Saved MySQL server connection information, as seen on the home screen. For information about backing up and restoring this file, see Section 9.1.1.1.7, “The Tools Menu”
server_instances.xml Stores your MySQL server information, as it relates to your MySQL connections
wb_options.xml Stores your preferences, both configured and default

The cache/ directory

The cache/ directory contains cache files in the user's MySQL Workbench directory. All cache files are stored as SQLite 3 databases, and they are not meant to be edited outside of MySQL Workbench. The types of cache files are:

  • *.column_widths:

    These are the saved column widths after adjusting columns in the SQL editor's results grid. The fields include column_id, stored as column_name::db_name::table_name, and width, stored as an integer of character length.

  • *.cache:

    This information (schemas, engines, and other global information) serves as a quick lookup source for the SQL editor's auto completion functionality, and is implicitly updated whenever the schema tree is updated.

All cache/ file names begin with the MySQL connection name. For example, the column width file is named Local_instance_3306.column_widths for a MySQL connection named "Local Instance 3306".

Cached files remain after a connection is either renamed or deleted.

The log/ directory

MySQL Workbench start up and SQL actions are logged and stored in the log/ directory. This directory is in the user's MySQL Workbench directory.

Note

To find these text files, from the main Workbench navigation menu choose Help and then Show Log Files.

  • wb*.log:

    Debugging information is generated when MySQL Workbench is started and unexpectedly stopped. Information includes paths used, modules and plugins loaded, system information, and more. The log files are useful when reporting a MySQL Workbench bug.

    The log files rotates when MySQL Workbench is started, in that wb.log is renamed to wb.1.log, wb.log is reset, and the previous wb.1.log file is renamed to wb.2.log, and so on, all the way up to wb.9.log.

  • sql_actions_*.log:

    A log of all SQL execution results but without the data, for debugging purposes.

    The SQL editor's SQL history does not originate from here, as it is stored in the sql_history directory.

The modules/ directory

Custom plugins (modules) are stored in the modules directory. For additional information about MySQL Workbench plugins, see Section C.3, “Plugins and Tools”.

The sql_history/ directory

SQL statements executed in the SQL editor are saved in the sql_history directory. They are stored as plain text files that are separated one per day (such as 2015-12-15) and they contain your MySQL Workbench SQL statement history for all MySQL connections. For additional information, see Section 8.1.7, “Output History Panel”.

The snippets/ directory

SQL snippets used by the SQL editor are stored in the snippets directory. These files include bundled snippets (such as "SQL DDL Statements") and custom snippets saved under the "My Snippets" tab. For additional information, see Section 8.1.5, “SQL Snippets Tab”.


User Comments
Sign Up Login You must be logged in to post a comment.