search

terminus-plugin-project / terminus-pancakes-plugin

Terminus Plugin to open Pantheon Site Databases in your Favorite SQL Client
MIT License
26 stars 20 forks source link
composer drupal heidisql mysql-workbench pancakes pantheon-site-database sequelpro terminus-plugin

readme

Pancakes

Terminus v2.x Compatible Terminus v1.x Compatible Terminus v0.x Compatible

Terminus plugin to open any Pantheon site database using a SQL GUI client.

Installation

Terminus v3

terminus self:plugin:install terminus-plugin-project/terminus-pancakes-plugin

Composer (Terminus v2 - Deprecated)

For quick install using Composer, install using:

composer create-project --stability=beta -d ~/.terminus/plugins/ terminus-plugin-project/terminus-pancakes-plugin:~2

Manually

Download project and unzip to ~/.terminus/plugins/terminus-pancakes-plugin

Note: For versions before Terminus 1.x, including v0.13, go here.

Supported:

HeidiSQL (Windows)

Sequel Pro (Mac)

MySQL Workbench (Mac, Linux and Windows)

MySQL CLI (Mac and Linux)

Note: The latest version of MySQL Workbench for Mac (version 6.3.6) is not compatible with this plugin.

Please download version 6.2.5 instead. Click on the Looking for previous GA versions? link to locate.

Examples:

Simply running the new site command "pancakes" or "pc" will auto-detect the application you have installed:

$ terminus site:pancakes

$ terminus site:pc

$ terminus pc

$ terminus pc site.dev

You can also be specific with the app you want if you have multiple installed:

$ terminus site:pc --app=sequel

$ terminus site:pc --app=workbench

$ terminus site:pc --app=heidi

Windows:

The plugin will automatically attempt to find the HeidiSQL executable within your Program Files directory. If your version of HeidiSQL is installed in a non-standard location or you are using the portable version of HeidiSQL, ensure the full path to heidisql.exe (including the executable itself) is set in the TERMINUS_PANCAKES_HEIDISQL_LOC environment variable.

Likewise, if your version of MySQL Workbench is installed outside the Program Files directory, make sure the TERMINUS_PANCAKES_MYSQLWORKBENCH_LOC environment variable is set.

Help:

Run terminus help site:pancakes for help.

Refer to the Terminus Getting Started.