PolarLava::MyClient::Documentation - A MySQL Web Client (original) (raw)

Last Updated: January 21, 2008

Introduction top

The most current version of this documentation can always be found on the MyClient homepage. This documentation is for versions >= 3.0.0. If you are looking for documentation for V1.x or V2.x, you will find that here.

MyClient is a simple MySQL web client interface. Largely it is a web-ified version of the "MySQL" command-line query interface with the added benefit of multiple connection interfaces. It does not contain a lot of bells and whistles like some other MySQL administrative oriented programs such as the very good phpMyAdmin. The target audience of MyClient are those who want a fast, simple web based MySQL query interface and/or those who don't want or need the helper tools provided by a full bore administrative package.

MyClient is ideally suited for those who have web sites that are virtually hosted and they only have access to their database(s), not the entire MySQL database server. It's also ideal for those who have SSH access to their server, but because of an idle timeout frequently get disconnected. This was one of the primary reason this application was originally developed. MyClient allows you to quickly and easily connect and rule your little corner of the MySQL universe.

Features top

• Runs with PHP Register Globals OFF.
• Validates as XHTML Strict Compliant.
• Validates as CSS Compliant.
• CSS control of display layout.
• Session support so you may leave MyClient and return without having to login again.
• Multiple (with a default of 5) SQL query interface windows. Each interface stores its query window contents in session so you can switch between interfaces without losing your current work.
• Ability to save and load queries. These queries can either be saved on the server, downloaded or e-mailed to multiple recipients.
• One click query result sorting by simply clicking on the column name.
• One button table describe and indexing information.
• One button database switching functionality.
• Ability to save query results. These results can either be saved on the server, downloaded or e-mailed to multiple recipients.
• Fully localized to allow all displaying in the language of your choice. Currently MyClient includes English, German, Japanese and Spanish language files.

Requirements top

• PHP4 >= 4.1.0
• MySQL
• Web Server
• Web Browser w/cookies enabled

Installation top

1. Download a MyClient release.
2. Untar the archive in your web directory. A directory will be created of the format "myclient_vXX", where "XX" is the version number. (e.g. "myclient_v300" for MyClient V3.0.0)
3. Rename the directory to "myclient" (or whatever you'd like to call it) or create a "myclient"" symbolic link to the current release directory.
4. Review and complete if necessary the creation of a .htacess file as covered in the .htaccess section below.
5. If you are upgrading from a previous version, please skip to the Upgrading from a previous version section below.
   New Users:
   • In the MyClient config directory (myclient/config/), copy config.php.dist to config.php
   • Edit the config.php file to setup your configuration. See the Configuration section below for information on the various configuration options.
6. Point your web browser at: http://www.your-domain.com/myclient/
7. Enjoy!

Upgrading from a previous version top

If you are upgrading from an older version of MyClient, this section contains instructions on any necessary steps that must be taken to install the newer version. You should review the MyClient HISTORY file to see a complete list of changes made in the release. The following are the standard upgrade procedures:

1. Begin by following the instruction in the Installation section above. You will be told when to return here.
2. Copy your configuration file (myclient/config/config.php) to your upgraded installation.
3. You advised to read the HISTORY file and check the Development Blog for more information.

• V2.5.1 to V3.0.0 (Hydra)
  • Perform the general Upgrading instructions above.
  • Because MyClient V3.0.0 is a complete rewrite, the configuration file is completely new. You will need to follow the instruction for a new installation to upgrade to this version.
• V3.0.0 to V3.0.1
  • V3.0.1 is very minor bug fix for V3.0.0. If you are already running V3.0.0, there is no need for you to upgrade.
• V3.0.1 to V3.0.2
  • V3.0.2 is a bug fix to correct a problem with overly restrictive data validation preventing valid user or hostnames from logging in. There are no configuration changes in this release so you only need to perform the general Upgrading instructions above.
• V3.0.2 to V3.1.0 (Night Monkey)
  • Perform the general Upgrading instructions above.
  • The following configuration options have been added:
    * Added the MYSQLI_ENABLE configuration option.
  • No further actions are required.
• V3.1.0 to V3.1.1
  • V3.1.1 is a bug fix to correct a seriously broken MySQL connection/login problem. There are no configuration changes in this release so you only need to perform the general Upgrading instructions above.
• V3.1.1 to V3.1.2
  • V3.1.2 is a bug fix to disable set_time_limit() when PHP Safe Mode is enabled.
  • Japanese language translation files in EUC-JP, Shift-JIS and UTF-8 formats as graciously donated to the project by Taira Hajime have been added.
  • There are no configuration changes in this release perse, so you only need to perform the general Upgrading instructions above. Obviously TIME_LIMIT is now disabled when running in PHP Safe Mode.
• V3.1.2 to V3.1.3
  • V3.1.3 primarily fixes the problem with not being able to save query results.
  • There are no configuration changes in this release per se, so you only need to perform the general Upgrading instructions above.
• V3.1.3 to V3.1.4
  • V3.1.4 fixes a problem with the interface HTML being appended to saved queries or results when downloaded.
  • There are no configuration changes in this release per se, so you only need to perform the general Upgrading instructions above.
• V3.1.4 to V3.2.0
  • Updated to operate with E_STRICT error_reporting.
  • Added support to display serialized and session data.
  • There are no configuration changes in this release per se, so you only need to perform the general Upgrading instructions above.
• V3.2.0 to V3.2.1
  • Bad path for include corrected.
  • There are no configuration changes in this release per se, so you only need to perform the general Upgrading instructions above.

.htaccess File top

If your PHP installation is running with register_globals ON (very common on hosted/ISP systems), it is HIGHLY RECOMMENDED that it be turned off for MyClient. It is recommend that use_trans_sid (more info/why?) which allows session ID's to be appended to a URL also be disabled as it too is a potential security risk. If your hosting provider (ISP) supports .htaccess files (as most do), then you can create a .htaccess file in your MyClient directory. This file should have 644 (u+rw,g+r,o+r) permissions and contain the following:

<IfModule mod_php5.c>
  php_flag register_globals off
  php_flag session.use_trans_sid off
</IfModule>
    

Configuration top

There are a number of user configurable options that affect the way MyClient looks and behaves. All user adjustable settings are contained in the "config.php" file located in the "config" sub-directory. For a new installation you will need to copy "config.dist.php" to "config.php". Below is a listing of the various configuration options, their default values and an explanation of what each option does.

Paths & Session Configuration top

Localization top

MyClient provides the ability to localize your configuration to display all system text, dates and times in your local format. Localization support was added in MyClient V3.0.0.

Display Configuration top

MyClient has a number of settings that affect its look and operation.

Save Defaults top

MyClient provides the ability save your queries and query results in a number of different ways. The following setting set the default values for the save options.

Output Compression top

MyClient provides the ability to compress your saved queries, query results and the HTML output to your browser. The following settings will allow you to utilize these options if your PHP installation was built with support for Zlib Compression.

Mail Setup top

MyClient provides the ability to email your saved queries and query results. The following settings will allow you to utilize this option. MyClient uses the PHPMailer class to send email.

Database Configuration top

The MyClient database configuration section is a bit different than the constant definitions of the other configuration settings. The database configuration is a multi-dimensional array (hash) that consists of a default configuratin for any undefined tabs (element 0) and as many tab (elements) configurations you care to define.

Database Configuration Explanation top

Each level of the database configuration array defines the connection parameters for a tab (or the default) and consists of the following sub-elements:

Database Configuration Example top

The following example shows how to configure a default connection parameter (element 0) and different connection parameters for tab interfaces #1 and #2. Tab #1 uses the AUTO db_list option, while tab #2 uses a defined list for the db_list option. Assuming you were using the default of 5 tabs, tabs 3, 4 and 5 would use the default connection parameters.

//--- Database Connection
$db_connect = array(
        0 => array(
            'db_host'	=> 'localhost',
            'db_user'	=> 'your_username',
            'db_name'	=> 'your_db_name',
            'db_connect'	=> 'standard',
            'db_port'	=> 3306
             ),
        1 => array(
            'db_host'	=> 'localhost',
            'db_user'	=> 'override_username',
            'db_name'	=> 'override_db_name',
            'db_connect'	=> 'standard',
            'db_port'	=> 3306,
            'db_list'	=> 'AUTO'
             ),
        2 => array(
            'db_host'	=> 'localhost',
            'db_user'	=> 'override_username',
            'db_name'	=> array('db_name1', 'db_name2', 'db_nameN'),
            'db_connect'	=> 'standard',
            'db_port'	=> 3306,
            'db_list'	=> array('db_name1', 'db_name2', 'db_nameN')
             ),
      );
    

Operation top

Most of the operations within MyClient are fairly self-explanatory. If you do run into problems and have a question, or if you have a suggestion for improvement/enhancement, please either join the MyClient Mailing List, or email me directly: kevinp ~AT~ polarlava.com.

A. Acknowledgments top

MyClient would not exist if not for the contributions and support of a number of people and their work.

• Philipp Becker. Philipp provided the German language translation file.
• Vicente D.Fernandez. Vicente provided the Spanish language translation file.
• PHPMailer Team. For the PHPMailer class.

MyClient is copyright 2001-2008 Kevin L. Papendick. Other sub-components packaged with MyClient are copyrighted by their respective owners.